1.0.2 • Published 2 years ago

tense_api v1.0.2

Weekly downloads
-
License
Unlicense
Repository
-
Last release
2 years ago

tense_api

TenseApi - JavaScript client for tense_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1
  • Package version: 1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install tense_api --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your tense_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TenseApi = require('tense_api');

var defaultClient = TenseApi.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new TenseApi.AdminControllerApi()
var id = 56; // {Number} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteMonthlyPricingEngagement(id, callback);

Documentation for API Endpoints

All URIs are relative to https://dev.tense.jahnelgroup.com

ClassMethodHTTP requestDescription
TenseApi.AdminControllerApideleteMonthlyPricingEngagementDELETE /api/admin/monthly-pricing-engagements
TenseApi.AdminControllerApifindAdminOverviewTotalGET /api/admin/overview
TenseApi.AdminControllerApifindAdminProjectUsersGET /api/admin/projects/{projectId}/users
TenseApi.AdminControllerApifindAllAdminProjectMonthTotalsGET /api/admin/projects/month/totals
TenseApi.AdminControllerApifindMonthlyPricingEngagementEntriesGET /api/admin/monthly-pricing-engagement-entries
TenseApi.AdminControllerApifindMonthlyPricingEngagementsGET /api/admin/monthly-pricing-engagements
TenseApi.AdminControllerApifindOneAdminProjectMonthTotalGET /api/admin/projects/{projectId}/month/totals
TenseApi.AdminControllerApifindProjectHourlyRatesGET /api/admin/projects/{projectId}/hourly-rates
TenseApi.AdminControllerApisaveMonthlyPricingEngagementPOST /api/admin/monthly-pricing-engagements
TenseApi.AdminControllerApisaveTimeEntryPOST /api/admin/time-entries
TenseApi.AdminControllerApiupdateMonthlyPricingEngagementEntriesPOST /api/admin/monthly-pricing-engagement-entries
TenseApi.AuthControllerApiauthenticateUserPOST /api/auth/login
TenseApi.AuthControllerApifindPasswordResetTokenGET /api/auth/reset-password
TenseApi.AuthControllerApiprocessForgotPasswordPOST /api/auth/forgot-password
TenseApi.AuthControllerApirefreshTokenPOST /api/auth/refresh
TenseApi.AuthControllerApiresetPasswordPOST /api/auth/reset-password
TenseApi.AuthControllerApirevokeTokenPOST /api/auth/revoke-token
TenseApi.BucketControllerApifindAllBucketsGET /api/buckets
TenseApi.BucketControllerApisaveBucketPOST /api/buckets
TenseApi.ClientControllerApideleteImageDELETE /api/clients/{id}/image
TenseApi.ClientControllerApifindAll5GET /api/clients
TenseApi.ClientControllerApifindOneGET /api/clients/{id}
TenseApi.ClientControllerApisave3POST /api/clients
TenseApi.EventControllerApiemitEventPOST /applicationEvents
TenseApi.GroupControllerApifindAll11GET /api/groups
TenseApi.ProjectContractControllerApifindAll4GET /api/project-contracts
TenseApi.ProjectContractControllerApisave2POST /api/project-contracts
TenseApi.ProjectControllerApicreateProjectPOST /api/projects
TenseApi.ProjectControllerApideleteImage1DELETE /api/projects/{projectId}/image
TenseApi.ProjectControllerApideleteProjectUserDELETE /api/projects/{projectId}/users/{userId}
TenseApi.ProjectControllerApideleteProjectUserSideHustleHistoryRecordDELETE /api/projects/{projectId}/team/side-hustle/{recordId}
TenseApi.ProjectControllerApifindAll6GET /api/projects
TenseApi.ProjectControllerApifindAllProjectMonthTotalsGET /api/projects/month/totals
TenseApi.ProjectControllerApifindAllProjectMonthUserTotalGET /api/projects/{id}/month/users/totals
TenseApi.ProjectControllerApifindOne1GET /api/projects/{id}
TenseApi.ProjectControllerApifindOneProjectInvoiceGET /api/projects/{projectId}/invoice
TenseApi.ProjectControllerApifindOneProjectMonthTotalGET /api/projects/{id}/month/totals
TenseApi.ProjectControllerApifindOneProjectMonthUserTotalsGET /api/projects/month/users/{userId}/totals
TenseApi.ProjectControllerApifindOneProjectUserGET /api/projects/{projectId}/users/{userId}
TenseApi.ProjectControllerApifindProjectProfilesGET /api/projects/profiles
TenseApi.ProjectControllerApifindProjectSideHustleHistoryGET /api/projects/{projectId}/team/side-hustle
TenseApi.ProjectControllerApifindProjectUsersByProjectGET /api/projects/{id}/users
TenseApi.ProjectControllerApisaveProjectInvoicePOST /api/projects/{id}/invoice
TenseApi.ProjectControllerApisaveProjectUserPOST /api/projects/{id}/users
TenseApi.ProjectControllerApisaveProjectUserSideHustleHistoryRecordPOST /api/projects/{projectId}/team/side-hustle
TenseApi.ProjectControllerApiupdateProjectPUT /api/projects/{projectId}
TenseApi.ProjectControllerApiupdateProjectInvoicePUT /api/projects/{projectId}/invoice/{invoiceId}
TenseApi.ProjectControllerApiuploadImagePOST /api/projects/image
TenseApi.ProjectHistoryControllerApifindProjectOverallHistoryGET /api/project-history/{id}/history/overall
TenseApi.ProjectHistoryControllerApifindProjectUserHistoryGET /api/project-history/{id}/history/users
TenseApi.ProjectNoteControllerApifindAll3GET /api/project-notes
TenseApi.ProjectNoteControllerApisave1POST /api/project-notes
TenseApi.ProjectRoleControllerApidelete1DELETE /api/project-roles/{id}
TenseApi.ProjectRoleControllerApifindAll8GET /api/project-roles
TenseApi.ProjectRoleControllerApisave4POST /api/project-roles
TenseApi.ProjectScorecardControllerApicreatePOST /api/project-scorecards
TenseApi.ProjectScorecardControllerApifindAll7GET /api/project-scorecards
TenseApi.ProjectScorecardControllerApifindAllPagedGET /api/project-scorecards/paged
TenseApi.ProjectScorecardControllerApifindProjectScorecardConfigurationGET /api/project-scorecards/configurations
TenseApi.ProjectScorecardControllerApiupdatePUT /api/project-scorecards/{id}
TenseApi.ProjectUserControllerApifindAll1GET /api/project-users
TenseApi.PtoRequestControllerApifindAll10GET /api/pto-requests
TenseApi.PtoRequestControllerApifindOne2GET /api/users/{userId}/pto-requests/{requestId}
TenseApi.PtoRequestControllerApifindPtoRequestDetailPagedGET /api/pto-requests/details/paged
TenseApi.PtoRequestControllerApifindPtoRequestDetailTotalGET /api/pto-requests/details/totals
TenseApi.PtoRequestControllerApisave5POST /api/users/{userId}/pto-requests
TenseApi.ReportControllerApidoDoubleChecksGET /api/reports/double-checks
TenseApi.ReportControllerApifindAvailabilityGET /api/reports/availability
TenseApi.ReportControllerApifindAverageEntryRatesGET /api/reports/avg-entry-rate
TenseApi.ReportControllerApifindAverageTargetRatesGET /api/reports/avg-target-rate
TenseApi.ReportControllerApifindBillingRecordsGET /api/reports/billing-records
TenseApi.ReportControllerApifindBlendedRateGET /api/reports/blended-rate
TenseApi.ReportControllerApifindCurrentProjectsGET /api/reports/current-projects
TenseApi.ReportControllerApifindEmployeeCountReportGET /api/reports/employee-count
TenseApi.ReportControllerApifindLongevityReportGET /api/reports/longevity
TenseApi.ReportControllerApifindMonthlySideHustleGET /api/reports/monthly-side-hustle
TenseApi.ReportControllerApifindNewClientRevenueGET /api/reports/new-client-revenue
TenseApi.ReportControllerApifindPtoReportByDayGET /api/reports/pto-report-daily
TenseApi.ReportControllerApifindPtoReportMonthsGET /api/reports/pto-report
TenseApi.ReportControllerApifindRampingDownRecordGET /api/reports/ramping-down
TenseApi.ReportControllerApifindRequiredProjectContractsGET /api/reports/project-contracts
TenseApi.ReportControllerApifindSummaryReportGET /api/reports/summary
TenseApi.ReportControllerApifindTimeEntryReportDelayByUserGET /api/reports/time-entry-delay/user
TenseApi.ReportControllerApifindTimeEntryReportDelayByWeekGET /api/reports/time-entry-delay/week
TenseApi.ReportControllerApifindTimeEntryReportDelayOverallGET /api/reports/time-entry-delay/overall
TenseApi.ReportControllerApifindUserBillingGET /api/reports/user-billing
TenseApi.ReportControllerApifindUserComparisonGET /api/reports/user-comparison
TenseApi.ReportControllerApifindUserTargetRateReportGET /api/reports/target-rate
TenseApi.ReportControllerApifindUtilizationReportViewGET /api/reports/utilization
TenseApi.ReportControllerApifindWhosGrindingGET /api/reports/whos-grinding
TenseApi.ReportControllerApifindWorkdaysPerMonthGET /api/reports/workdays
TenseApi.ReportControllerApifindWorkdaysPerQuarterGET /api/reports/workdays-qtr
TenseApi.ReportControllerApisaveUtilizationReportRecordPOST /api/reports/utilization/records
TenseApi.SettingsControllerApifindAllTagsGET /api/settings/tags
TenseApi.SettingsControllerApifindAllUtilizationReportResultsGET /api/settings/utilization-reports/results
TenseApi.SettingsControllerApirunUtilizationReportPOST /api/settings/utilization-reports/run
TenseApi.SettingsControllerApisaveTagPOST /api/settings/tags
TenseApi.SettingsControllerApiupdateUtilizationReportLockPOST /api/settings/utilization-reports/lock
TenseApi.TeamControllerApicallDeleteDELETE /api/teams/{id}
TenseApi.TeamControllerApifindAll2GET /api/teams
TenseApi.TeamControllerApisavePOST /api/teams
TenseApi.TimeEntryControllerApieatHoursPOST /api/time-entries/eat-hours
TenseApi.TimeEntryControllerApieditInvoicePOST /api/time-entries/edit-invoice
TenseApi.TimeEntryControllerApieditRatePOST /api/time-entries/edit-rate
TenseApi.TimeEntryControllerApifindAll9GET /api/time-entries
TenseApi.TimeEntryControllerApifindAllByProjectGET /api/projects/{projectId}/time-entries
TenseApi.TimeEntryControllerApifindAllByUser1GET /api/users/{userId}/time-entries
TenseApi.TimeEntryControllerApifindAllPaged1GET /api/time-entries/paged
TenseApi.TimeEntryControllerApifindTotalsGET /api/time-entries/totals
TenseApi.TimeEntryControllerApisaveTimeEntry1POST /api/users/{userId}/time-entries
TenseApi.TimeEntryLockControllerApifindAllTimeEntriesLockGET /api/time-entry-locks
TenseApi.TimeEntryLockControllerApisaveTimeEntryLockPOST /api/time-entry-locks
TenseApi.UserControllerApideleteTargetRateDELETE /api/users/target-rate/{id}
TenseApi.UserControllerApifindAll12GET /api/users
TenseApi.UserControllerApifindAllByUserTargetRateGET /api/users/target-rate/user/{userId}
TenseApi.UserControllerApifindAllProjectUsersByUserGET /api/users/{id}/projects
TenseApi.UserControllerApifindAllSideHustleProjectsByUserGET /api/users/{id}/side-hustle-projects
TenseApi.UserControllerApifindAllTargetRateGET /api/users/target-rate
TenseApi.UserControllerApifindOne3GET /api/users/{id}
TenseApi.UserControllerApifindOneTargetRateGET /api/users/target-rate/{id}
TenseApi.UserControllerApifindUserHoursPerWeekGET /api/users/{id}/hours-per-week
TenseApi.UserControllerApifindUserProjectHoursGET /api/users/{id}/project-hours
TenseApi.UserControllerApifindUserPtoByYearGET /api/users/{id}/user-pto-by-year/years/{year}
TenseApi.UserControllerApifindUserPtoByYearListGET /api/users/user-pto-by-year
TenseApi.UserControllerApifindUserPtoVarianceListGET /api/users/user-pto-variance
TenseApi.UserControllerApigetTargetFrequencyGET /api/users/target-rate/frequency
TenseApi.UserControllerApigetTargetRateAllTimeStatsGET /api/users/target-rate/all-time-stats
TenseApi.UserControllerApigetTargetRateComparisonMonthGET /api/users/target-rate/comparison-month
TenseApi.UserControllerApigetTargetRateComparisonYearGET /api/users/target-rate/comparison-year
TenseApi.UserControllerApigetTargetRateHistoryGET /api/users/target-rate/history
TenseApi.UserControllerApisave6POST /api/users
TenseApi.UserControllerApisaveGroupUserPOST /api/users/{id}/groups/{groupId}
TenseApi.UserControllerApisaveProjectUser1POST /api/users/{id}/projects
TenseApi.UserControllerApisaveProjectUserFavoritePOST /api/users/{id}/projects/{projectId}/favorite
TenseApi.UserControllerApisaveTargetRatePOST /api/users/target-rate
TenseApi.UserControllerApisaveUserPtoByYearPOST /api/users/{id}/user-pto-by-year
TenseApi.UserControllerApisaveUserPtoVariancePOST /api/users/{id}/user-pto-variance
TenseApi.UserControllerApiupdatePasswordPOST /api/users/{id}/password
TenseApi.UserControllerApiupdateSideHustlePOST /api/users/{id}/sideHustle
TenseApi.UserExceptionControllerApifindAllGET /api/exceptions
TenseApi.UserExceptionControllerApifindAllByUserGET /api/exceptions/users/{id}
TenseApi.UserNotesControllerApifindAllUserNotesGET /api/user-notes
TenseApi.UserNotesControllerApisaveUserNotePOST /api/user-notes

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: Bearer authentication (JWT)
1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago