@ahomevilla-hotel/node-sdk

@ahomevilla-hotel/node-sdk@latest

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)

$3

To build and compile the typescript sources to javascript use:
``npm install npm run build`

`$3`

First build the package then run npm publish

`$3`

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

_published:_

`npm install @ahomevilla-hotel/node-sdk@latest --save`

_unPublished (not recommended):_

`npm install PATH_TO_GENERATED_PACKAGE --save``

$3

All URIs are relative to http://localhost

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
AmenitiesApi | amenitiesControllerCreate | POST /api/amenities | Create new amenity
AmenitiesApi | amenitiesControllerFindMany | GET /api/amenities | Get amenities
AmenitiesApi | amenitiesControllerFindOne | GET /api/amenities/{id} | Get amenity by ID
AmenitiesApi | amenitiesControllerRemove | DELETE /api/amenities/{id} | Delete amenity
AmenitiesApi | amenitiesControllerUpdate | PUT /api/amenities/{id} | Update amenity
AnalyticsApi | analyticsControllerGetAnalyticsSummary | GET /api/analytics/summary | Get analytics summary for a branch
AnalyticsApi | analyticsControllerGetOccupancyRate | GET /api/analytics/occupancy | Get occupancy rate analytics
AnalyticsApi | analyticsControllerGetRevenueAnalytics | GET /api/analytics/revenue | Get revenue analytics
AnalyticsApi | analyticsControllerGetRoomPerformance | GET /api/analytics/room-performance | Get room performance analytics
AppApi | appControllerGetHello | GET / |
AuthApi | authControllerChangePassword | POST /api/auth/change-password | Change user password
AuthApi | authControllerGetActiveSessions | GET /api/auth/sessions | Get active sessions
AuthApi | authControllerGetProfile | GET /api/auth/profile | Get current user profile
AuthApi | authControllerGetSessionAnalytics | GET /api/auth/sessions/analytics | Get session analytics
AuthApi | authControllerGetSuspiciousActivities | GET /api/auth/users/{userId}/suspicious-activities | Get suspicious activities
AuthApi | authControllerInitiateForgotPassword | POST /api/auth/forgot-password/email/initiate | Initiate forgot password process
AuthApi | authControllerLogin | POST /api/auth/login |
AuthApi | authControllerLogout | POST /api/auth/logout | Logout user
AuthApi | authControllerRefreshTokens | POST /api/auth/refresh | Refresh access token
AuthApi | authControllerRegister | POST /api/auth/register |
AuthApi | authControllerResetPasswordWithOTP | POST /api/auth/forgot-password/email/reset | Reset password using OTP
AuthApi | authControllerRevokeSession | POST /api/auth/sessions/{sessionId}/revoke | Revoke specific session
AuthApi | authControllerUpdateProfile | PATCH /api/auth/profile | Update user profile
AuthApi | authControllerVerifyEmail | POST /api/auth/verify-email | Verify email with OTP code
AuthApi | authControllerVerifyForgotPasswordOTP | POST /api/auth/forgot-password/email/verify | Verify OTP code for forgot password
BookingApi | bookingControllerCancelBooking | PATCH /api/booking/cancel/{bookingId} | Cancel a booking
BookingApi | bookingControllerCreateBookingDirectly | POST /api/booking/directly | Create a new booking directly at the hotel
BookingApi | bookingControllerCreateBookingOnline | POST /api/booking | Create a new booking online
BookingApi | bookingControllerFindById | GET /api/booking/{bookingId} | Get booking details
BookingApi | bookingControllerGetBookings | GET /api/booking | Get all bookings with pagination and filters
BookingApi | bookingControllerGetMyBookings | GET /api/booking/my-bookings | Get all my bookings with pagination and filters
BookingApi | bookingControllerHandlePaymentWebhook | POST /api/booking/webhook/payment | Handle payment webhook from PayOS
BookingApi | bookingControllerUpdateBookingStatus | PATCH /api/booking/update-status/{bookingId} | Update booking status
BranchesApi | branchControllerCreate | POST /api/branches | Create a new branch
BranchesApi | branchControllerFindDeleted | GET /api/branches/deleted | Get all soft-deleted branches
BranchesApi | branchControllerFindMany | GET /api/branches | Get all branches with pagination and filters
BranchesApi | branchControllerFindManyInfinite | GET /api/branches/infinite | Get branches with infinite scroll for client app
BranchesApi | branchControllerFindOne | GET /api/branches/{idOrSlug} | Get branch by ID or slug
BranchesApi | branchControllerGetLatestBranches | GET /api/branches/latest | Get latest branches
BranchesApi | branchControllerRemove | DELETE /api/branches/{id} | Delete a branch
BranchesApi | branchControllerRestore | POST /api/branches/{id}/restore | Restore a soft-deleted branch
BranchesApi | branchControllerUpdate | PATCH /api/branches/{id} | Update a branch
EmailApi | emailControllerCheckHealth | GET /api/email/health | Check email service health status
EmailApi | emailControllerSendVerificationEmail | POST /api/email/send-verification | Send verification email
ImagesApi | imagesControllerGetImageByPublicId | GET /api/images/{publicId} | Get image by public id
ImagesApi | imagesControllerUploadIcon | POST /api/images/icon | Upload amenity icon
ImagesApi | imagesControllerUploadImages | POST /api/images | Upload multiple image
POEditorApi | poeditorControllerAddTranslation | POST /api/poeditor/translations | Add translations to POEditor project
POEditorApi | poeditorControllerGetTranslations | POST /api/poeditor/translations-list | Get translations from POEditor project
PayOSApi | payosControllerCancelPayment | POST /api/payos/cancel-payment | Cancel a payment link
PayOSApi | payosControllerCreatePaymentRequest | POST /api/payos/payment-request | Create a new payment request
PayOSApi | payosControllerGetPaymentStatus | GET /api/payos/payment-status/{paymentLinkId} | Get payment status
PayOSApi | payosControllerHandleWebhook | POST /api/payos/webhook | Handle payment confirmation webhook
ProvincesApi | provincesControllerCreate | POST /api/provinces | Create a new province
ProvincesApi | provincesControllerFindDeleted | GET /api/provinces/deleted | Get all soft-deleted provinces
ProvincesApi | provincesControllerFindMany | GET /api/provinces | Get all provinces with pagination and filters
ProvincesApi | provincesControllerFindOne | GET /api/provinces/{id} | Get province by ID
ProvincesApi | provincesControllerRemove | DELETE /api/provinces/{id} | Delete a province
ProvincesApi | provincesControllerRestore | POST /api/provinces/{id}/restore | Restore a soft-deleted province
ProvincesApi | provincesControllerUpdate | PATCH /api/provinces/{id} | Update a province
RoomDetailsApi | roomDetailControllerCreate | POST /api/room-details | Create a new room detail
RoomDetailsApi | roomDetailControllerFindDeleted | GET /api/room-details/deleted | Get all soft-deleted room details
RoomDetailsApi | roomDetailControllerFindMany | GET /api/room-details | Get all room details with pagination and filters
RoomDetailsApi | roomDetailControllerFindManyInfinite | GET /api/room-details/infinite | Get all room details with infinite pagination and filters
RoomDetailsApi | roomDetailControllerFindOne | GET /api/room-details/{id} | Get a room detail by id
RoomDetailsApi | roomDetailControllerRemove | DELETE /api/room-details/{id} | Soft delete a room detail
RoomDetailsApi | roomDetailControllerRestore | POST /api/room-details/{id}/restore | Restore a soft-deleted room detail
RoomDetailsApi | roomDetailControllerUpdate | PATCH /api/room-details/{id} | Update a room detail
RoomPriceHistoriesApi | roomPriceHistoryControllerCreate | POST /api/room-price-histories | Create a new room price history
RoomPriceHistoriesApi | roomPriceHistoryControllerFindManyByRoomDetail | GET /api/room-price-histories/room-detail/{roomDetailId} | Get all price histories for a specific room detail
RoomPriceHistoriesApi | roomPriceHistoryControllerRemove | DELETE /api/room-price-histories/{id} | Delete a room price history
RoomPriceHistoriesApi | roomPriceHistoryControllerUpdate | PATCH /api/room-price-histories/{id} | Update a room price history
RoomPromotionsApi | roomPromotionControllerCreate | POST /api/room-promotions | Create a new room promotion
RoomPromotionsApi | roomPromotionControllerFindDeleted | GET /api/room-promotions/deleted | Get all soft-deleted room promotions
RoomPromotionsApi | roomPromotionControllerFindMany | GET /api/room-promotions | Get all room promotions with pagination and filters
RoomPromotionsApi | roomPromotionControllerFindOne | GET /api/room-promotions/{id} | Get room promotion by ID
RoomPromotionsApi | roomPromotionControllerRemove | DELETE /api/room-promotions/{id} | Delete a room promotion
RoomPromotionsApi | roomPromotionControllerRestore | POST /api/room-promotions/{id}/restore | Restore a soft-deleted room promotion
RoomPromotionsApi | roomPromotionControllerUpdate | PATCH /api/room-promotions/{id} | Update a room promotion
RoomPromotionsApi | roomPromotionControllerValidatePromotionCode | GET /api/room-promotions/validate/{code}/room/{roomDetailId} | Validate a promotion code for a specific room
RoomsApi | roomControllerCreate | POST /api/rooms | Create a new room
RoomsApi | roomControllerFindDeleted | GET /api/rooms/deleted | Get all soft-deleted rooms
RoomsApi | roomControllerFindMany | GET /api/rooms | Get all rooms with pagination and filters
RoomsApi | roomControllerFindManyByBranchId | GET /api/rooms/in-branch/{branchId} | ADMIN - STAFF Get all rooms by branch ID
RoomsApi | roomControllerFindOne | GET /api/rooms/{id} | Get a room by id
RoomsApi | roomControllerPermanentDelete | DELETE /api/rooms/permanent-delete | ADMIN - Delete rooms permanently
RoomsApi | roomControllerRemove | DELETE /api/rooms/{id} | Soft delete a room
RoomsApi | roomControllerRestore | POST /api/rooms/{id}/restore | Restore a soft-deleted room
RoomsApi | roomControllerUpdate | PATCH /api/rooms/{id} | Update a room
UsersApi | usersControllerAdminGetUserDetail | GET /api/users/admin/{id} | Get detailed user information (Admin only)
UsersApi | usersControllerAdminUpdateUser | PATCH /api/users/admin/{id} | Update user information (Admin only)
UsersApi | usersControllerBlockUser | POST /api/users/block-action/{id} | Block or unblock a user
UsersApi | usersControllerDeleteUser | DELETE /api/users/{id} | Soft delete a user (Admin only)
UsersApi | usersControllerGetUsers | GET /api/users |
UsersApi | usersControllerRestoreUser | POST /api/users/{id}/restore | Restore a deleted user (Admin only)
VerificationApi | verificationControllerVerifyCode | POST /api/verification/verify | Verify a code
VerificationApi | verificationControllerVerifyEmailOTP | POST /api/verification/verify-email-otp | Verify an email OTP

$3

Documentation For Authorization

Authentication schemes defined for the API:

$3

- Type: Bearer authentication (JWT)