0.0.2 • Published 5 years ago

swifter-api-sdk-nodejs v0.0.2

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

swift_shift_api

SwiftShiftApi - JavaScript client for swift_shift_api Home healthcare schduling and hiring API This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 4.0.0
  • Package version: 4.0.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.swiftshift.com

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 swift_shift_api --save

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 SwiftShiftApi = require('swift_shift_api');


var api = new SwiftShiftApi.AccessLogApi()
var id = "id_example"; // {String} The id of the access log.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccessLog(id, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

ClassMethodHTTP requestDescription
SwiftShiftApi.AccessLogApigetAccessLogGET /access_logs/{id}Gets access log by id
SwiftShiftApi.AccessLogApilistAccessLogsGET /access_logsGets list of all access logs
SwiftShiftApi.AgencyApideleteOrganizationDELETE /organizations/{organization_id}
SwiftShiftApi.AgencyApideleteSiteDELETE /organizations/{organization_id}/sites/{site_id}
SwiftShiftApi.AgencyApigetOrganizationGET /organizations/{organization_id}
SwiftShiftApi.AgencyApigetSiteGET /organizations/{organization_id}/sites/{site_id}
SwiftShiftApi.AgencyApigetSiteSettingsGET /organizations/{organization_id}/sites/{site_id}/settings
SwiftShiftApi.AgencyApigetSiteStatsGET /organizations/{organization_id}/sites/{site_id}/statistics/{view_name}
SwiftShiftApi.AgencyApilistOrganizationsGET /organizationslist organizations
SwiftShiftApi.AgencyApilistSitesGET /organizations/{organization_id}/siteslist sites
SwiftShiftApi.AgencyApipostOrganizationPOST /organizationscreates an organization
SwiftShiftApi.AgencyApipostSitePOST /organizations/{organization_id}/sitescreates a site
SwiftShiftApi.AgencyApiputOrganizationPUT /organizations/{organization_id}
SwiftShiftApi.AgencyApiputSitePUT /organizations/{organization_id}/sites/{site_id}
SwiftShiftApi.ApplicationApiapplyToShiftPOST /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/applications/{caregiver_id}Apply for shift
SwiftShiftApi.ApplicationApideleteShiftApplicationDELETE /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/applications/{caregiver_id}delete shift application
SwiftShiftApi.ApplicationApilistShiftApplicationDetailsGET /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/applicationsList shift applications
SwiftShiftApi.CalendarApigetCalendarGET /caregivers/{caregiver_id}/calendaruser's calendar
SwiftShiftApi.CaregiverApideleteCaregiverDELETE /caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApideleteOrganizationCaregiverDELETE /organizations/{organization_id}/caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApideleteSiteCaregiverDELETE /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApigetCaregiverGET /caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApigetCaregiverInterviewGET /caregivers/{caregiver_id}/interviews/{interview_id}
SwiftShiftApi.CaregiverApigetOrganizationCaregiverGET /organizations/{organization_id}/caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApigetSiteCaregiverGET /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApilistCaregiverInterviewsGET /caregivers/{caregiver_id}/interviewsList interviews.
SwiftShiftApi.CaregiverApilistCaregiversGET /caregiversList caregivers.
SwiftShiftApi.CaregiverApilistOrganizationCaregiversGET /organizations/{organization_id}/caregiversList organization caregivers.
SwiftShiftApi.CaregiverApilistSiteCaregiversGET /organizations/{organization_id}/sites/{site_id}/caregiversList site caregivers.
SwiftShiftApi.CaregiverApipostCaregiverPOST /caregiversCreates a caregiver.
SwiftShiftApi.CaregiverApipostOrganizationCaregiverPOST /organizations/{organization_id}/caregiversCreates a caregiver.
SwiftShiftApi.CaregiverApipostSiteCaregiverPOST /organizations/{organization_id}/sites/{site_id}/caregiversCreates a caregiver.
SwiftShiftApi.CaregiverApiputCaregiverPUT /caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApiputCaregiverInterviewPUT /caregivers/{caregiver_id}/interviews/{interview_id}
SwiftShiftApi.CaregiverApiputOrganizationCaregiverPUT /organizations/{organization_id}/caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApiputSiteCaregiverPUT /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}
SwiftShiftApi.CaregiverApiregisterUnverifiedCaregiverPOST /open/register_unverifiedRegister unverified caregiver.
SwiftShiftApi.CaregiverApiverifyCaregiverPOST /unverified/caregivers/{caregiver_id}/verify
SwiftShiftApi.CrtificateApideleteCertificateDELETE /caregivers/{caregiver_id}/certificates/{certificate_id}
SwiftShiftApi.CrtificateApigetCertificateGET /caregivers/{caregiver_id}/certificates/{certificate_id}Gets a certificate.
SwiftShiftApi.CrtificateApipostCertificatePOST /caregivers/{caregiver_id}/certificatesCreates a certificate.
SwiftShiftApi.CrtificateApiputCertificatePUT /caregivers/{caregiver_id}/certificates/{certificate_id}Updates a certificate.
SwiftShiftApi.HealthCheckApideleteHealthCheckDELETE /health_checks/{id}Deletes health check by id
SwiftShiftApi.HealthCheckApilistHealthChecksGET /health_checksGets list of all health checks
SwiftShiftApi.HealthCheckApipostHealthCheckPOST /health_checksCreates a health check
SwiftShiftApi.HealthCheckApiputHealthCheckPUT /health_checks/{id}Updates health check by id
SwiftShiftApi.InterviewApideleteSiteInterviewDELETE /organizations/{organization_id}/sites/{site_id}/interviews/{interview_id}
SwiftShiftApi.InterviewApigetCaregiverInterviewGET /caregivers/{caregiver_id}/interviews/{interview_id}
SwiftShiftApi.InterviewApigetSiteInterviewGET /organizations/{organization_id}/sites/{site_id}/interviews/{interview_id}
SwiftShiftApi.InterviewApilistCaregiverInterviewsGET /caregivers/{caregiver_id}/interviewsList interviews.
SwiftShiftApi.InterviewApilistInterviewsGET /interviewsList interviews.
SwiftShiftApi.InterviewApilistOrganizationInterviewsGET /organizations/{organization_id}/interviewsList organization interviews.
SwiftShiftApi.InterviewApilistSiteInterviewsGET /organizations/{organization_id}/sites/{site_id}/interviewsList site interviews.
SwiftShiftApi.InterviewApipostSiteInterviewPOST /organizations/{organization_id}/sites/{site_id}/interviewsCreates an interview
SwiftShiftApi.InterviewApiputCaregiverInterviewPUT /caregivers/{caregiver_id}/interviews/{interview_id}
SwiftShiftApi.InterviewApiputSiteInterviewPUT /organizations/{organization_id}/sites/{site_id}/interviews/{interview_id}
SwiftShiftApi.JobroleApideleteJobroleDELETE /jobroles/{id}
SwiftShiftApi.JobroleApideleteSiteJobroleDELETE /organizations/{organization_id}/sites/{site_id}/jobroles/{jobrole_id}
SwiftShiftApi.JobroleApigetJobroleGET /jobroles/{id}Gets jobrole by id
SwiftShiftApi.JobroleApigetSiteJobroleGET /organizations/{organization_id}/sites/{site_id}/jobroles/{jobrole_id}Gets site jobrole
SwiftShiftApi.JobroleApilistJobrolesGET /jobrolesGets list of all jobroles
SwiftShiftApi.JobroleApilistSiteJobrolesGET /organizations/{organization_id}/sites/{site_id}/jobrolesGets site jobroles
SwiftShiftApi.JobroleApipostJobrolePOST /jobrolesCreates a jobrole
SwiftShiftApi.JobroleApipostSiteJobrolePOST /organizations/{organization_id}/sites/{site_id}/jobrolesCreates site jobrole
SwiftShiftApi.JobroleApiputJobrolePUT /jobroles/{id}Updates jobrole by id
SwiftShiftApi.JobroleApiputSiteJobrolePUT /organizations/{organization_id}/sites/{site_id}/jobroles/{jobrole_id}Updates site jobrole
SwiftShiftApi.JobroleVerificationApideleteJobroleVerificationDELETE /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}/jobrole_verifications/{jobrole_id}
SwiftShiftApi.JobroleVerificationApigetJobroleVerificationGET /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}/jobrole_verifications/{jobrole_id}
SwiftShiftApi.JobroleVerificationApilistJobroleVerificationsGET /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}/jobrole_verificationsList Jobrole Verification.
SwiftShiftApi.JobroleVerificationApipostJobroleVerificationPOST /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}/jobrole_verificationsCreates a jobrole verification object.
SwiftShiftApi.LogsApilistShiftLogsGET /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/logsList shift access logs
SwiftShiftApi.ManagerApideleteSiteInterviewDELETE /organizations/{organization_id}/sites/{site_id}/interviews/{interview_id}
SwiftShiftApi.ManagerApigetSiteInterviewGET /organizations/{organization_id}/sites/{site_id}/interviews/{interview_id}
SwiftShiftApi.ManagerApilistInterviewsGET /interviewsList interviews.
SwiftShiftApi.ManagerApilistOrganizationInterviewsGET /organizations/{organization_id}/interviewsList organization interviews.
SwiftShiftApi.ManagerApilistSiteInterviewsGET /organizations/{organization_id}/sites/{site_id}/interviewsList site interviews.
SwiftShiftApi.ManagerApipostSiteInterviewPOST /organizations/{organization_id}/sites/{site_id}/interviewsCreates an interview
SwiftShiftApi.ManagerApiputSiteInterviewPUT /organizations/{organization_id}/sites/{site_id}/interviews/{interview_id}
SwiftShiftApi.OrganizationApideleteOrganizationDELETE /organizations/{organization_id}
SwiftShiftApi.OrganizationApideleteOrganizationCaregiverDELETE /organizations/{organization_id}/caregivers/{caregiver_id}
SwiftShiftApi.OrganizationApigetOrganizationGET /organizations/{organization_id}
SwiftShiftApi.OrganizationApigetOrganizationCaregiverGET /organizations/{organization_id}/caregivers/{caregiver_id}
SwiftShiftApi.OrganizationApilistOrganizationCaregiversGET /organizations/{organization_id}/caregiversList organization caregivers.
SwiftShiftApi.OrganizationApilistOrganizationsGET /organizationslist organizations
SwiftShiftApi.OrganizationApipostOrganizationPOST /organizationscreates an organization
SwiftShiftApi.OrganizationApipostOrganizationCaregiverPOST /organizations/{organization_id}/caregiversCreates a caregiver.
SwiftShiftApi.OrganizationApiputOrganizationPUT /organizations/{organization_id}
SwiftShiftApi.OrganizationApiputOrganizationCaregiverPUT /organizations/{organization_id}/caregivers/{caregiver_id}
SwiftShiftApi.PatientApideleteOrganizationPatientDELETE /organizations/{organization_id}/patients/{patient_id}
SwiftShiftApi.PatientApideletePatientDELETE /organizations/{organization_id}/sites/{site_id}/patients/{patient_id}
SwiftShiftApi.PatientApigetPatientGET /organizations/{organization_id}/sites/{site_id}/patients/{patient_id}
SwiftShiftApi.PatientApilistOrganizationPatientsGET /organizations/{organization_id}/patientsList organization patients.
SwiftShiftApi.PatientApilistPatientsGET /patientsList patients.
SwiftShiftApi.PatientApilistSitePatientsGET /organizations/{organization_id}/sites/{site_id}/patientsList site patients.
SwiftShiftApi.PatientApipostPatientPOST /organizations/{organization_id}/sites/{site_id}/patientsCreates a patient.
SwiftShiftApi.PatientApiputPatientPUT /organizations/{organization_id}/sites/{site_id}/patients/{patient_id}
SwiftShiftApi.ServiceApideleteServiceDELETE /organizations/{organization_id}/sites/{site_id}/services/{id}
SwiftShiftApi.ServiceApigetServiceGET /organizations/{organization_id}/sites/{site_id}/services/{id}Gets service by id
SwiftShiftApi.ServiceApilistServicesGET /organizations/{organization_id}/sites/{site_id}/servicesGets list of all services
SwiftShiftApi.ServiceApipostServicePOST /organizations/{organization_id}/sites/{site_id}/servicesCreates a service
SwiftShiftApi.ServiceApiputServicePUT /organizations/{organization_id}/sites/{site_id}/services/{id}Updates service by id
SwiftShiftApi.ShiftApiapplyToShiftPOST /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/applications/{caregiver_id}Apply for shift
SwiftShiftApi.ShiftApideleteShiftApplicationDELETE /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/applications/{caregiver_id}delete shift application
SwiftShiftApi.ShiftApigetShiftGET /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}Get shift details
SwiftShiftApi.ShiftApilistOrganizationShiftsGET /organizations/{organization_id}/shiftsList shifts for an organization
SwiftShiftApi.ShiftApilistShiftApplicationDetailsGET /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/applicationsList shift applications
SwiftShiftApi.ShiftApilistShiftLogsGET /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/logsList shift access logs
SwiftShiftApi.ShiftApilistShiftsGET /shiftsList all shifts
SwiftShiftApi.ShiftApilistSiteShiftsGET /organizations/{organization_id}/sites/{site_id}/shiftsList shifts for a site
SwiftShiftApi.ShiftApiorganizationShiftDeleteDELETE /organizations/{organization_id}/shifts/{shift_id}
SwiftShiftApi.ShiftApipostShiftPOST /organizations/{organization_id}/sites/{site_id}/shifts
SwiftShiftApi.ShiftApiputShiftPUT /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}
SwiftShiftApi.ShiftApishiftAssignPOST /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/assign
SwiftShiftApi.ShiftApishiftCancelDELETE /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/cancel
SwiftShiftApi.ShiftApishiftCoverPUT /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}/cover
SwiftShiftApi.ShiftApishiftDeleteDELETE /organizations/{organization_id}/sites/{site_id}/shifts/{shift_id}
SwiftShiftApi.ShiftCaregiverApilistShiftAvailableCaregiversGET /organizations/{organization_id}/sites/{site_id}/caregivers/availableGet shift available caregivers
SwiftShiftApi.SiteApideleteSiteDELETE /organizations/{organization_id}/sites/{site_id}
SwiftShiftApi.SiteApideleteSiteCaregiverDELETE /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}
SwiftShiftApi.SiteApideleteSiteJobroleDELETE /organizations/{organization_id}/sites/{site_id}/jobroles/{jobrole_id}
SwiftShiftApi.SiteApideleteSiteSkillDELETE /organizations/{organization_id}/sites/{site_id}/skills/{skill_id}
SwiftShiftApi.SiteApigetSiteGET /organizations/{organization_id}/sites/{site_id}
SwiftShiftApi.SiteApigetSiteCaregiverGET /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}
SwiftShiftApi.SiteApigetSiteJobroleGET /organizations/{organization_id}/sites/{site_id}/jobroles/{jobrole_id}Gets site jobrole
SwiftShiftApi.SiteApigetSiteSettingsGET /organizations/{organization_id}/sites/{site_id}/settings
SwiftShiftApi.SiteApigetSiteSkillGET /organizations/{organization_id}/sites/{site_id}/skills/{skill_id}Gets site skill
SwiftShiftApi.SiteApigetSiteStatsGET /organizations/{organization_id}/sites/{site_id}/statistics/{view_name}
SwiftShiftApi.SiteApigetSiteUsersGET /organizations/{organization_id}/sites/{site_id}/users
SwiftShiftApi.SiteApilistSiteCaregiversGET /organizations/{organization_id}/sites/{site_id}/caregiversList site caregivers.
SwiftShiftApi.SiteApilistSiteJobrolesGET /organizations/{organization_id}/sites/{site_id}/jobrolesGets site jobroles
SwiftShiftApi.SiteApilistSiteSkillsGET /organizations/{organization_id}/sites/{site_id}/skillsGets site skills
SwiftShiftApi.SiteApilistSitesGET /organizations/{organization_id}/siteslist sites
SwiftShiftApi.SiteApipostSitePOST /organizations/{organization_id}/sitescreates a site
SwiftShiftApi.SiteApipostSiteCaregiverPOST /organizations/{organization_id}/sites/{site_id}/caregiversCreates a caregiver.
SwiftShiftApi.SiteApipostSiteJobrolePOST /organizations/{organization_id}/sites/{site_id}/jobrolesCreates site jobrole
SwiftShiftApi.SiteApipostSiteSkillPOST /organizations/{organization_id}/sites/{site_id}/skillsCreates site skill
SwiftShiftApi.SiteApiputSitePUT /organizations/{organization_id}/sites/{site_id}
SwiftShiftApi.SiteApiputSiteCaregiverPUT /organizations/{organization_id}/sites/{site_id}/caregivers/{caregiver_id}
SwiftShiftApi.SiteApiputSiteJobrolePUT /organizations/{organization_id}/sites/{site_id}/jobroles/{jobrole_id}Updates site jobrole
SwiftShiftApi.SiteApiputSiteSkillPUT /organizations/{organization_id}/sites/{site_id}/skills/{skill_id}Updates site skill
SwiftShiftApi.SkillApicreateSkillPOST /skillsCreates a skill
SwiftShiftApi.SkillApideleteSiteSkillDELETE /organizations/{organization_id}/sites/{site_id}/skills/{skill_id}
SwiftShiftApi.SkillApideleteSkillDELETE /skills/{id}
SwiftShiftApi.SkillApigetSiteSkillGET /organizations/{organization_id}/sites/{site_id}/skills/{skill_id}Gets site skill
SwiftShiftApi.SkillApigetSkillGET /skills/{id}Gets skill by id
SwiftShiftApi.SkillApilistSiteSkillsGET /organizations/{organization_id}/sites/{site_id}/skillsGets site skills
SwiftShiftApi.SkillApilistSkillsGET /skillsGets list of all skills
SwiftShiftApi.SkillApipostSiteSkillPOST /organizations/{organization_id}/sites/{site_id}/skillsCreates site skill
SwiftShiftApi.SkillApiputSiteSkillPUT /organizations/{organization_id}/sites/{site_id}/skills/{skill_id}Updates site skill
SwiftShiftApi.SkillApiputSkillPUT /skills/{id}Updates skill by id
SwiftShiftApi.StatisticsApigetSiteStatsGET /organizations/{organization_id}/sites/{site_id}/statistics/{view_name}
SwiftShiftApi.UserApiforgotPasswordPOST /open/forgot_passwordinit forgot password flow
SwiftShiftApi.UserApigetSiteUsersGET /organizations/{organization_id}/sites/{site_id}/users
SwiftShiftApi.UserApigetUserAccountGET /users/{user_id}/account
SwiftShiftApi.UserApiresetPasswordPOST /open/reset_passwordreset password
SwiftShiftApi.UserApisignUpPOST /open/sign_upinitialize sign up flow
SwiftShiftApi.UserApisignUpCompletePOST /open/sign_up/completecomplete sign up flow
SwiftShiftApi.UserApiverifyCodePOST /open/verify_codeverify code

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.