@happy-pet/[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 @happy-pet/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthApi | apiAuthLoginPost | POST /api/auth/login | Login AuthApi | apiAuthLogoutPost | POST /api/auth/logout | Logout AuthApi | apiAuthMeGet | GET /api/auth/me | Get current user profile AuthApi | apiAuthRefreshPost | POST /api/auth/refresh | Refresh access token AuthApi | apiAuthRegisterPost | POST /api/auth/register | Register a new user AuthApi | apiAuthResendVerificationCodePost | POST /api/auth/resend-verification-code | Resend email verification code AuthApi | apiAuthSendVerificationCodePost | POST /api/auth/send-verification-code | Send email verification code AuthApi | apiAuthVerifyEmailPost | POST /api/auth/verify-email | Verify email with code EventsApi | apiEventsCalendarGet | GET /api/events/calendar | Get events for calendar EventsApi | apiEventsGet | GET /api/events | Get events EventsApi | apiEventsIdCancelPost | POST /api/events/{id}/cancel | Cancel event EventsApi | apiEventsIdCompletePost | POST /api/events/{id}/complete | Complete event EventsApi | apiEventsIdDelete | DELETE /api/events/{id} | Delete event EventsApi | apiEventsIdGet | GET /api/events/{id} | Get event by ID EventsApi | apiEventsIdPut | PUT /api/events/{id} | Update event EventsApi | apiEventsIdReschedulePost | POST /api/events/{id}/reschedule | Reschedule event EventsApi | apiEventsIdStartPost | POST /api/events/{id}/start | Start event EventsApi | apiEventsOverdueGet | GET /api/events/overdue | Get overdue events EventsApi | apiEventsPost | POST /api/events | Create event EventsApi | apiEventsSearchGet | GET /api/events/search | Search events EventsApi | apiEventsStatisticsGet | GET /api/events/statistics | Get event statistics EventsApi | apiEventsUpcomingGet | GET /api/events/upcoming | Get upcoming events FoodsApi | apiFoodsAlertsExpiredGet | GET /api/foods/alerts/expired | Get expired foods FoodsApi | apiFoodsAlertsRunningLowGet | GET /api/foods/alerts/running-low | Get running-low foods FoodsApi | apiFoodsIdConsumePost | POST /api/foods/{id}/consume | Consume food amount FoodsApi | apiFoodsIdDelete | DELETE /api/foods/{id} | Delete food FoodsApi | apiFoodsIdGet | GET /api/foods/{id} | Get food by ID FoodsApi | apiFoodsIdPut | PUT /api/foods/{id} | Update food FoodsApi | apiFoodsIdRefillPost | POST /api/foods/{id}/refill | Refill food amount FoodsApi | apiFoodsIdRemindersPut | PUT /api/foods/{id}/reminders | Update feeding reminders FoodsApi | apiFoodsPetPetIdGet | GET /api/foods/pet/{petId} | Get pet foods FoodsApi | apiFoodsPost | POST /api/foods | Create food FoodsApi | apiFoodsRemindersGet | GET /api/foods/reminders | Get feeding reminders FoodsApi | apiFoodsScheduleAutoFeedingPost | POST /api/foods/schedule/auto-feeding | Schedule automatic feeding simulation FoodsApi | apiFoodsScheduleStatsPetIdGet | GET /api/foods/schedule/stats/{petId} | Get feeding schedule stats FoodsApi | apiFoodsStatsGet | GET /api/foods/stats | Get food statistics FoodsApi | apiFoodsTypesGet | GET /api/foods/types | Get food types and units HealthApi | healthGet | GET /health | Health check MedicationsApi | apiMedicationsPetIdActiveCurrentGet | GET /api/medications/{petId}/active/current | Get currently active medications MedicationsApi | apiMedicationsPetIdEndingSoonGet | GET /api/medications/{petId}/ending-soon | Get medications ending soon MedicationsApi | apiMedicationsPetIdGet | GET /api/medications/{petId} | Get medications by pet MedicationsApi | apiMedicationsPetIdIdCompletePatch | PATCH /api/medications/{petId}/{id}/complete | Complete medication MedicationsApi | apiMedicationsPetIdIdDelete | DELETE /api/medications/{petId}/{id} | Delete medication MedicationsApi | apiMedicationsPetIdIdDiscontinuePatch | PATCH /api/medications/{petId}/{id}/discontinue | Discontinue medication MedicationsApi | apiMedicationsPetIdIdGet | GET /api/medications/{petId}/{id} | Get medication by ID MedicationsApi | apiMedicationsPetIdIdPausePatch | PATCH /api/medications/{petId}/{id}/pause | Pause medication MedicationsApi | apiMedicationsPetIdIdPut | PUT /api/medications/{petId}/{id} | Update medication MedicationsApi | apiMedicationsPetIdIdReminderPatch | PATCH /api/medications/{petId}/{id}/reminder | Update medication reminder MedicationsApi | apiMedicationsPetIdIdResumePatch | PATCH /api/medications/{petId}/{id}/resume | Resume medication MedicationsApi | apiMedicationsPetIdPost | POST /api/medications/{petId} | Create medication for a pet MedicationsApi | apiMedicationsPetIdSearchGet | GET /api/medications/{petId}/search | Search medications MedicationsApi | apiMedicationsPetIdStatsGet | GET /api/medications/{petId}/stats | Get medication statistics PetsApi | apiPetsGet | GET /api/pets | Get user pets PetsApi | apiPetsIdDelete | DELETE /api/pets/{id} | Delete pet PetsApi | apiPetsIdPut | PUT /api/pets/{id} | Update pet PetsApi | apiPetsPost | POST /api/pets | Create pet UsersApi | apiUsersProfileGet | GET /api/users/profile | Get user profile UsersApi | apiUsersProfilePut | PUT /api/users/profile | Update user profile VaccinationsApi | apiVaccinationsGet | GET /api/vaccinations | Get vaccinations by pet VaccinationsApi | apiVaccinationsIdCancelPost | POST /api/vaccinations/{id}/cancel | Cancel vaccination VaccinationsApi | apiVaccinationsIdCompletePost | POST /api/vaccinations/{id}/complete | Mark vaccination as completed VaccinationsApi | apiVaccinationsIdDelete | DELETE /api/vaccinations/{id} | Delete vaccination VaccinationsApi | apiVaccinationsIdGet | GET /api/vaccinations/{id} | Get vaccination by ID VaccinationsApi | apiVaccinationsIdPut | PUT /api/vaccinations/{id} | Update vaccination VaccinationsApi | apiVaccinationsIdReschedulePost | POST /api/vaccinations/{id}/reschedule | Reschedule vaccination VaccinationsApi | apiVaccinationsPost | POST /api/vaccinations | Create vaccination VaccinationsApi | apiVaccinationsRecommendationsPetIdGet | GET /api/vaccinations/recommendations/{petId} | Get vaccination recommendations VaccinationsApi | apiVaccinationsSearchGet | GET /api/vaccinations/search | Search vaccinations VaccinationsApi | apiVaccinationsStatsPetIdGet | GET /api/vaccinations/stats/{petId} | Get vaccination statistics VaccinationsApi | apiVaccinationsStatusPetIdGet | GET /api/vaccinations/status/{petId} | Get vaccination status summary

Documentation For Models

• ApiAuthRefreshPostRequest
• ApiFoodsIdConsumePostRequest
• ApiFoodsIdRefillPostRequest
• ApiFoodsIdRemindersPutRequest
• ApiFoodsRemindersGet200Response
• ApiFoodsScheduleAutoFeedingPostRequest
• ApiFoodsStatsGet200Response
• ApiFoodsTypesGet200Response
• ApiFoodsTypesGet200ResponseData
• AuthResponse
• AuthResponseData
• AuthTokens
• CreateEventRequest
• CreateFoodRequest
• CreateMedicationRequest
• CreatePetRequest
• CreateVaccinationRequest
• ErrorResponse
• Event
• EventCancelRequest
• EventCompleteRequest
• EventListResponse
• EventResponse
• EventStartRequest
• Food
• FoodListResponse
• FoodResponse
• HealthGet200Response
• LoginRequest
• Medication
• MedicationListResponse
• MedicationReminderUpdateRequest
• MedicationResponse
• Pet
• PetListResponse
• PetResponse
• RegisterRequest
• RescheduleRequest
• SendVerificationCodeRequest
• SuccessResponse
• UpdateEventRequest
• UpdateFoodRequest
• UpdateMedicationRequest
• UpdatePetRequest
• UpdateUserProfileRequest
• UpdateVaccinationRequest
• User
• UserProfileResponse
• Vaccination
• VaccinationListResponse
• VaccinationResponse
• VerifyEmailRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)