@joao.sumi/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @joao.sumi/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthResourceApi | authPost | POST /auth | Generate User Token CalendarResourceApi | calendarYearMonthAvailableGet | GET /calendar/{year}/{month}/available | Available Schedule CalendarResourceApi | calendarYearMonthScheduledGet | GET /calendar/{year}/{month}/scheduled | Scheduled Treatment ClientResourceApi | clientsIdDelete | DELETE /clients/{id} | Delete Client ClientResourceApi | clientsIdGet | GET /clients/{id} | Find Client By Id ClientResourceApi | clientsIdPut | PUT /clients/{id} | Update Client ClientResourceApi | clientsPost | POST /clients | Create Client ScheduleExceptionResourceApi | scheduleExceptionsGet | GET /schedule-exceptions | Get Schedule Exceptions ScheduleExceptionResourceApi | scheduleExceptionsIdDelete | DELETE /schedule-exceptions/{id} | Delete Schedule Exception By Id ScheduleExceptionResourceApi | scheduleExceptionsIdGet | GET /schedule-exceptions/{id} | Find Schedule Exception By Id ScheduleExceptionResourceApi | scheduleExceptionsIdPut | PUT /schedule-exceptions/{id} | Update Schedule Exception ScheduleExceptionResourceApi | scheduleExceptionsPost | POST /schedule-exceptions | Create Schedule Exception ScheduleResourceApi | schedulesGet | GET /schedules | Get Schedules ScheduleResourceApi | schedulesIdDelete | DELETE /schedules/{id} | Delete Schedule By Id ScheduleResourceApi | schedulesIdGet | GET /schedules/{id} | Find Schedule By Id ScheduleResourceApi | schedulesIdPut | PUT /schedules/{id} | Update Schedule ScheduleResourceApi | schedulesPost | POST /schedules | Create Schedule ShiftResourceApi | shiftsGet | GET /shifts | Get Shifts ShiftResourceApi | shiftsIdDelete | DELETE /shifts/{id} | Delete Shift By Id ShiftResourceApi | shiftsIdGet | GET /shifts/{id} | Find Shift By Id ShiftResourceApi | shiftsIdPut | PUT /shifts/{id} | Update Shift ShiftResourceApi | shiftsPost | POST /shifts | Create Shift TreatmentResourceApi | treatmentsGet | GET /treatments | Get Treatments TreatmentResourceApi | treatmentsIdDelete | DELETE /treatments/{id} | Delete Treatment By Id TreatmentResourceApi | treatmentsIdGet | GET /treatments/{id} | Find Treatment By Id TreatmentResourceApi | treatmentsIdPut | PUT /treatments/{id} | Update Treatment TreatmentResourceApi | treatmentsPost | POST /treatments | Create Treatment UserResourceApi | usersIdGet | GET /users/{id} | Find User By Id UserResourceApi | usersPost | POST /users | Create User

Documentation For Models

• AuthRequest
• AuthResponse
• CalendarListResponse
• CalendarResponse
• ClientCreateRequest
• ClientResponse
• ClientUpdateRequest
• DayOfWeek
• PageResponse
• ScheduleCreateRequest
• ScheduleExceptionBreakRequest
• ScheduleExceptionBreakResponse
• ScheduleExceptionCreateRequest
• ScheduleExceptionResponse
• ScheduleExceptionUpdateRequest
• ScheduleResponse
• ScheduleStatus
• ScheduleUpdateRequest
• ShiftBreakRequest
• ShiftBreakResponse
• ShiftCreateRequest
• ShiftResponse
• ShiftStatus
• ShiftUpdateRequest
• TreatmentCreateRequest
• TreatmentResponse
• TreatmentStatus
• TreatmentType
• TreatmentUpdateRequest
• UserCreateRequest
• UserResponse

Documentation For Authorization

Authentication schemes defined for the API:

SecurityScheme

• Type: Bearer authentication (JWT)