impala
Module impala
API
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_impala_0.2.0.png)
ballerinax/impala Ballerina library
Overview
This is a generated connector for Impala API v1.0.0 OpenAPI specification.
The Impala API provides the capability to search, book or sell hotels rooms.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an Impala account.
- Obtain tokens - Follow this guide.
Clients![](/images/permalink.svg)
impala: Client![](/images/permalink.svg)
This is a generated connector for Impala API v1.0.0 OpenAPI specification.
The Impala API provides the capability to search, book or sell hotels rooms.
Add room selling to your app with ease, or expand your existing hotel portfolio. Access all the marketing material you need to sell a room, from hotel amenities to images. Constantly updated, ever expanding and always correct. Impala allows you to start selling hotel rooms and earn a commission with every booking in hours.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an Impala account and obtain tokens using this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://sandbox.impala.travel/v1/" - URL of the target service
getHotel![](/images/permalink.svg)
Retrieve a hotel
Parameters
- hotelId string - (Required) The unique identifier of this hotel on the Impala platform.
- 'start string? (default ()) - The arrival day of the desired stay range in ISO 8601 format (
YYYY-MM-DD
).
- end string? (default ()) - The departure day of the desired stay range in ISO 8601 format (
YYYY-MM-DD
).
listRatePlans![](/images/permalink.svg)
function listRatePlans(string hotelId, decimal? updatedatLt, decimal? updatedatLte, decimal? updatedatEq, decimal? updatedatGt, decimal? updatedatGte, int? size, int? offset) returns json|error
List all rate plans (rate calendar) for a hotel (Beta endpoint)
Parameters
- hotelId string - (Required) The uuid of hotel for which rate plans are being fetched.
- updatedatLt decimal? (default ()) - Returns rate plans changed after the supplied date.
- updatedatLte decimal? (default ()) - Returns rate plans changed after the supplied date.
- updatedatEq decimal? (default ()) - Returns rate plans changed after the supplied date.
- updatedatGt decimal? (default ()) - Returns rate plans changed after the supplied date.
- updatedatGte decimal? (default ()) - Returns rate plans changed after the supplied date.
- size int? (default ()) - Number of hotels returned on a given page (pagination).
- offset int? (default ()) - Offset from the first hotel in the result (for pagination).
Return Type
- json|error - OK
listHotels![](/images/permalink.svg)
function listHotels(string? nameEq, string? nameLike, int? starratingLt, int? starratingLte, int? starratingEq, int? starratingGt, int? starratingGte, string? countryEq, string? 'start, string? end, decimal? latitude, decimal? longitude, int? radius, string? hotelIds, decimal? createdLt, decimal? createdLte, decimal? createdEq, decimal? createdGt, decimal? createdGte, decimal? updatedLt, decimal? updatedLte, decimal? updatedEq, decimal? updatedGt, decimal? updatedGte, int? size, int? offset, string? sortBy) returns ListOfHotels|error
List all hotels
Parameters
- nameEq string? (default ()) - Allows for filtering based on the property name. Available modifiers include equal to (
eq
) or case insensitive search (like
). Usage example:?name[like]=palace
- nameLike string? (default ()) - Allows for filtering based on the property name. Available modifiers include equal to (
eq
) or case insensitive search (like
). Usage example:?name[like]=palace
- starratingLt int? (default ()) - Allows for filtering based on the starRating of a property. Available modifiers include less than (
lt
), greater than (gt
), less than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?starRating[gt]=3&starRating[lt]=5
- starratingLte int? (default ()) - Allows for filtering based on the starRating of a property. Available modifiers include less than (
lt
), greater than (gt
), less than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?starRating[gt]=3&starRating[lt]=5
- starratingEq int? (default ()) - Allows for filtering based on the starRating of a property. Available modifiers include less than (
lt
), greater than (gt
), less than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?starRating[gt]=3&starRating[lt]=5
- starratingGt int? (default ()) - Allows for filtering based on the starRating of a property. Available modifiers include less than (
lt
), greater than (gt
), less than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?starRating[gt]=3&starRating[lt]=5
- starratingGte int? (default ()) - Allows for filtering based on the starRating of a property. Available modifiers include less than (
lt
), greater than (gt
), less than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?starRating[gt]=3&starRating[lt]=5
- countryEq string? (default ()) - Allows for filtering based on the country of a property. The only available modifier for this parameter is equal to (
eq
). Usage example:?country[eq]=GBR
- 'start string? (default ()) - The arrival day of the desired stay range in ISO 8601 format (
YYYY-MM-DD
).
- end string? (default ()) - The departure day of the desired stay range in ISO 8601 format (
YYYY-MM-DD
).
- latitude decimal? (default ()) - The WGS 84 latitude of the location to search around (e.g.
58.386186
).
- longitude decimal? (default ()) - The WGS 84 longitude of the location to search around (e.g.
-9.952549
).
- radius int? (default ()) - The distance (in meters) to search around the specified location (e.g.
10000
for 10 km).
- hotelIds string? (default ()) - A comma-separated list of hotel ids you wish to filter by (e.g.
60a06628-2c71-44bf-9685-efbd2df4179e,60a06628-2c71-44bf-9685-efbd2df4179e
).
- createdLt decimal? (default ()) - Allows for filtering based on the date and time when this hotel was first added to the Impala platform, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdLte decimal? (default ()) - Allows for filtering based on the date and time when this hotel was first added to the Impala platform, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdEq decimal? (default ()) - Allows for filtering based on the date and time when this hotel was first added to the Impala platform, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdGt decimal? (default ()) - Allows for filtering based on the date and time when this hotel was first added to the Impala platform, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdGte decimal? (default ()) - Allows for filtering based on the date and time when this hotel was first added to the Impala platform, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- updatedLt decimal? (default ()) - Allows for filtering based on the date and time the content of this hotel was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedLte decimal? (default ()) - Allows for filtering based on the date and time the content of this hotel was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedEq decimal? (default ()) - Allows for filtering based on the date and time the content of this hotel was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedGt decimal? (default ()) - Allows for filtering based on the date and time the content of this hotel was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedGte decimal? (default ()) - Allows for filtering based on the date and time the content of this hotel was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- size int? (default ()) - Number of hotels returned on a given page (pagination).
- offset int? (default ()) - Offset from the first hotel in the result (for pagination).
- sortBy string? (default ()) - Order in which the results should be sorted. Currently allows you to sort by
name
(alphabetical), starrating
, anddistance_m
in meters from the specified latitude/longitude. Allows for a comma-separated list of of arguments with modifiers for:asc
(ascending) and:desc
(descending) ordering.
Return Type
- ListOfHotels|error - OK
getBooking![](/images/permalink.svg)
Retrieve a booking
Parameters
- bookingId string - (Required) The unique identifier of the booking you would like to update.
Return Type
- json|error - OK
updateBooking![](/images/permalink.svg)
Change a booking
Parameters
- bookingId string - (Required) The unique identifier of the booking you would like to update.
- payload json -
- contentType string? (default ()) -
Return Type
- json|error - OK
cancelBooking![](/images/permalink.svg)
Cancel a booking
Parameters
- bookingId string - (Required) The unique identifier of the booking you would like to update.
Return Type
- json|error - OK
updateBookingWithRateDetails![](/images/permalink.svg)
function updateBookingWithRateDetails(string bookingId, json payload, string? contentType) returns json|error
Change a booking with rate details
Parameters
- bookingId string - (Required) The unique identifier of the booking you would like to update.
- payload json -
- contentType string? (default ()) -
Return Type
- json|error - OK
updateBookingContact![](/images/permalink.svg)
function updateBookingContact(string bookingId, json payload, string? contentType) returns json|error
Change a booking contact
Parameters
- bookingId string - (Required) The unique identifier of the booking you would like to update.
- payload json -
- contentType string? (default ()) -
Return Type
- json|error - OK
listBookings![](/images/permalink.svg)
function listBookings(string? startLt, string? startLte, string? startEq, string? startGt, string? startGte, string? endLt, string? endLte, string? endEq, string? endGt, string? endGte, decimal? createdLt, decimal? createdLte, decimal? createdEq, decimal? createdGt, decimal? createdGte, decimal? updatedLt, decimal? updatedLte, decimal? updatedEq, decimal? updatedGt, decimal? updatedGte, int? size, int? offset) returns json|error
List all bookings
Parameters
- startLt string? (default ()) - Allows for filtering based on arrival date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?start[lte]=2021-12-20&start[gte]=2021-12-10
- startLte string? (default ()) - Allows for filtering based on arrival date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?start[lte]=2021-12-20&start[gte]=2021-12-10
- startEq string? (default ()) - Allows for filtering based on arrival date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?start[lte]=2021-12-20&start[gte]=2021-12-10
- startGt string? (default ()) - Allows for filtering based on arrival date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?start[lte]=2021-12-20&start[gte]=2021-12-10
- startGte string? (default ()) - Allows for filtering based on arrival date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?start[lte]=2021-12-20&start[gte]=2021-12-10
- endLt string? (default ()) - Allows for filtering based on departure date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?end[lte]=2021-12-25&end[gte]=2021-12-15
- endLte string? (default ()) - Allows for filtering based on departure date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?end[lte]=2021-12-25&end[gte]=2021-12-15
- endEq string? (default ()) - Allows for filtering based on departure date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?end[lte]=2021-12-25&end[gte]=2021-12-15
- endGt string? (default ()) - Allows for filtering based on departure date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?end[lte]=2021-12-25&end[gte]=2021-12-15
- endGte string? (default ()) - Allows for filtering based on departure date of the booking in ISO 8601 format (e.g.
2021-12-01
). Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?end[lte]=2021-12-25&end[gte]=2021-12-15
- createdLt decimal? (default ()) - Allows for filtering based on creation date and time of the booking in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdLte decimal? (default ()) - Allows for filtering based on creation date and time of the booking in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdEq decimal? (default ()) - Allows for filtering based on creation date and time of the booking in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdGt decimal? (default ()) - Allows for filtering based on creation date and time of the booking in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdGte decimal? (default ()) - Allows for filtering based on creation date and time of the booking in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- updatedLt decimal? (default ()) - Allows for filtering based on the date and time the booking was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedLte decimal? (default ()) - Allows for filtering based on the date and time the booking was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedEq decimal? (default ()) - Allows for filtering based on the date and time the booking was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedGt decimal? (default ()) - Allows for filtering based on the date and time the booking was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedGte decimal? (default ()) - Allows for filtering based on the date and time the booking was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- size int? (default ()) - Pagination size. Defaults to 100 if omitted.
- offset int? (default ()) - Pagination offset. Defaults to 0 if omitted.
Return Type
- json|error - OK
createBooking![](/images/permalink.svg)
Create a booking
Return Type
- json|error - Accepted
createBookingWithRateDetails![](/images/permalink.svg)
Create a booking with rate details
Return Type
- json|error - Accepted
listHotelAgreements![](/images/permalink.svg)
List all hotel agreements for a deal request
Parameters
- dealRequestId string - (Required) The unique identifier for this deal request
Return Type
- json|error - OK
getHotelAgreement![](/images/permalink.svg)
Retrieve a hotel agreement
Parameters
- dealRequestId string - (Required) The unique identifier for this deal request
- agreementId string - (Required) The unique identifier for this hotel agreement
Return Type
- json|error - OK
getDealRequest![](/images/permalink.svg)
Retrieve a deal request
Parameters
- dealRequestId string - (Required) The unique identifier for this deal request
Return Type
- json|error - OK
listDealRequests![](/images/permalink.svg)
function listDealRequests(string? hotelIds, decimal? createdLt, decimal? createdLte, decimal? createdEq, decimal? createdGt, decimal? createdGte, string? hasHotelAgreementsWithStatus, decimal? updatedLt, decimal? updatedLte, decimal? updatedEq, decimal? updatedGt, decimal? updatedGte, int? size, int? offset, string? sortBy) returns json|error
List all deal requests
Parameters
- hotelIds string? (default ()) - A comma-separated list of hotel ids you wish to filter by (e.g.
60a06628-2c71-44bf-9685-efbd2df4179e,60a06628-2c71-44bf-9685-efbd2df4179e
). Returns deals that have been requested from any of thehotelIds
specified are returned.
- createdLt decimal? (default ()) - Allows for filtering based on the date and time when this deal request was first created, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdLte decimal? (default ()) - Allows for filtering based on the date and time when this deal request was first created, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdEq decimal? (default ()) - Allows for filtering based on the date and time when this deal request was first created, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdGt decimal? (default ()) - Allows for filtering based on the date and time when this deal request was first created, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- createdGte decimal? (default ()) - Allows for filtering based on the date and time when this deal request was first created, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?created[lte]=2020-11-04T19:37:37Z&created[gte]=2020-11-04T15:56:37.000Z
- hasHotelAgreementsWithStatus string? (default ()) - A comma-separated list of hotel agreement status (
PENDING
,ACCEPTED
and/orREJECTED
) to filter by. Deals with one or more connected hotel agreements of the defined status are returned. This allows you to e.g. limit to return only deal requests where at least one hotel has agreed to the terms.
- updatedLt decimal? (default ()) - Allows for filtering based on the date and time the content (e.g. conditions of the detail) of this deal request was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedLte decimal? (default ()) - Allows for filtering based on the date and time the content (e.g. conditions of the detail) of this deal request was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedEq decimal? (default ()) - Allows for filtering based on the date and time the content (e.g. conditions of the detail) of this deal request was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedGt decimal? (default ()) - Allows for filtering based on the date and time the content (e.g. conditions of the detail) of this deal request was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- updatedGte decimal? (default ()) - Allows for filtering based on the date and time the content (e.g. conditions of the detail) of this deal request was last updated, in ISO 8601 format (e.g.
2020-11-04T17:37:37Z
) and UTC timezone. Available modifiers include less than (lt
), greater than (gt
), lower than or equal to (lte
), greater than or equal to (gte
) and equal to (eq
). Usage example:?updated[lte]=2020-11-04T19:37:37Z&updated[gte]=2020-11-04T15:56:37.000Z
- size int? (default ()) - Number of deal requests returned on a given page (pagination).
- offset int? (default ()) - Offset from the first deal request in the result (for pagination).
- sortBy string? (default ()) - Order in which the results should be sorted. Currently allows you to sort by
createdAt
andupdatedAt
.
Return Type
- json|error - OK
makePayment![](/images/permalink.svg)
Make a Payment
Return Type
- json|error - OK
Records![](/images/permalink.svg)
impala: Address![](/images/permalink.svg)
Fields
- line1 string? -
- line2 string? -
- city string? -
- region string? -
- country string? -
- countryName string? -
- postalCode string? -
impala: Amenities![](/images/permalink.svg)
Fields
- code decimal? -
- formatted string? -
impala: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Provide your API Key as Api-Token. Eg: {x-api-key : <Your API Key>} Your API key can be found in your account
impala: Hotel![](/images/permalink.svg)
Fields
- hotelId string -
- name string -
- currency string -
- starRating float -
- description HotelDescription? -
- contractable boolean? -
- emails string[] -
- websiteUrl string? -
- externalUrls HotelExternalurls[]? -
- phoneNumbers string[] -
- images Image[]? -
- timezone string? -
- amenities Amenities[]? -
- roomTypes RoomTypes[]? -
- roomCount decimal? -
- termsAndConditions string? -
- createdAt string? -
- updatedAt string? -
impala: HotelDescription![](/images/permalink.svg)
Fields
- short string? -
impala: HotelExternalurls![](/images/permalink.svg)
Fields
- name string? -
- url string? -
impala: Image![](/images/permalink.svg)
Fields
- altText string? -
- height decimal? -
- width decimal? -
- url string? -
impala: ListOfHotels![](/images/permalink.svg)
Fields
- data Hotel[] -
- pagination Pagination -
impala: Location![](/images/permalink.svg)
Fields
- latitude int? -
- longitude int? -
impala: Pagination![](/images/permalink.svg)
Fields
- count int? -
- total int? -
- next string? -
- prev string? -
impala: RoomRate![](/images/permalink.svg)
Fields
- rateId string? -
- 'start string? -
- end string? -
- maxOccupancy int? -
- retailRate record {}? -
impala: RoomTypes![](/images/permalink.svg)
Fields
- roomTypeId string? -
- name string? -
- description string? -
- maxOccupancy int? -
- rates RoomRate[]? -
- images Image[]? -
- amenities Amenities[]? -
Import
import ballerinax/impala;
Metadata
Released date: over 2 years ago
Version: 0.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.3
GraalVM compatible: Yes
Pull count
Total: 37
Current verison: 29
Weekly downloads
Keywords
Sales & CRM/Scheduling & Booking
Cost/Freemium
Contributors
Dependencies