Methods
(async, inner) cancelBookingById(bookingId) → {Promise.<response>}
Cancel a booking.
Parameters:
| Name | Type | Description |
|---|---|---|
bookingId |
string | ID of the booking to cancel. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) checkInBookingById(bookingId) → {Promise.<response>}
Check in a booking.
Parameters:
| Name | Type | Description |
|---|---|---|
bookingId |
string | ID of the booking to check in. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) checkOutBookingById(bookingId) → {Promise.<response>}
Check out a booking.
Parameters:
| Name | Type | Description |
|---|---|---|
bookingId |
string | ID of the booking to check out. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) createBooking(data) → {Promise.<response>}
Create a new booking.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
object | The data to create the new booking. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getBillsForBooking(bookingId) → {Promise.<response>}
Retrieve a list of bills for a booking.
Parameters:
| Name | Type | Description |
|---|---|---|
bookingId |
string | ID of the booking. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getBookingById(bookingSetId) → {Promise.<response>}
Get a specific booking given its ID.
Parameters:
| Name | Type | Description |
|---|---|---|
bookingSetId |
string | ID of the booking to retrieve. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getBookings(params) → {Promise.<response>}
Get all bookings for a hotel.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
params |
object | {} | Optional params to be passed to request. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) getGuestsForBooking(bookingId) → {Promise.<response>}
Retrieve a list of all guests for a booking.
Parameters:
| Name | Type | Description |
|---|---|---|
bookingId |
string | ID of the booking. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>
(async, inner) updateBookingById(bookingId, data) → {Promise.<response>}
Update a specific booking given its ID.
Parameters:
| Name | Type | Description |
|---|---|---|
bookingId |
string | ID of the booking to update. |
data |
object | The updates to be applied to the booking. |
- Source:
Returns:
response to the request.
- Type
- Promise.<response>