Module impala

ballerinax/impala Ballerina library

1.3.2

Overview

The Impala API v1.0.0 connector(https://docs.impala.travel/docs/booking-api/branches/v1.003/YXBpOjQwMDYwNDY-impala-hotel-booking-api) OpenAPI specification.
The Impala API provides the capability to search, book or sell hotels rooms.

Key Features

Programmatic access to create and manage resources via REST API
Manage user accounts and profiles
Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create an Impala account.
Obtain tokens - Follow this guide.

Clients

impala: Client

Isolated

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

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, ConnectionConfig config, string serviceUrl)

apiKeyConfig ApiKeysConfig - API keys for authorization

config ConnectionConfig {} - The configurations to be used when initializing the connector

serviceUrl string "https://sandbox.impala.travel/v1/" - URL of the target service

getHotel

Isolated FunctionRemote Function

function getHotel(string hotelId, string? 'start, string? end) returns Hotel|error

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).

Return Type

Hotel|error - OK

listRatePlans

Isolated FunctionRemote Function

function listRatePlans(string hotelId, decimal? updatedatLt, decimal? updatedatLte, decimal? updatedatEq, decimal? updatedatGt, decimal? updatedatGte, int? size, int? offset) returns RatePlanInfo|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

RatePlanInfo|error - OK

listHotels

Isolated FunctionRemote Function

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), star rating, and distance_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

Isolated FunctionRemote Function

function getBooking(string bookingId) returns Booking|error

Retrieve a booking

Parameters

bookingId string - (Required) The unique identifier of the booking you would like to retrieve.

Return Type

Booking|error - OK

updateBooking

Isolated FunctionRemote Function

function updateBooking(string bookingId, UpdateBookingPayload payload, string? contentType) returns Booking|error

Change a booking

Parameters

bookingId string - (Required) The unique identifier of the booking you would like to update.

payload UpdateBookingPayload - Payload on updating a booking

contentType string? (default ()) - (optional) content-type header

Return Type

Booking|error - OK

cancelBooking

Isolated FunctionRemote Function

function cancelBooking(string bookingId) returns Booking|error

Cancel a booking

Parameters

bookingId string - (Required) The unique identifier of the booking you would like to update.

Return Type

Booking|error - OK

updateBookingWithRateDetails

Isolated FunctionRemote Function

function updateBookingWithRateDetails(string bookingId, UpdateBookingWithRateDetailsPayload payload, string? contentType) returns Booking|error

Change a booking with rate details

Parameters

bookingId string - (Required) The unique identifier of the booking you would like to update.

payload UpdateBookingWithRateDetailsPayload - Payload on updating a booking with rate details

contentType string? (default ()) - (optional) content-type header

Return Type

Booking|error - OK

updateBookingContact

Isolated FunctionRemote Function

function updateBookingContact(string bookingId, BookingidBookingcontactBody payload, string? contentType) returns Booking|error

Change a booking contact

Parameters

bookingId string - (Required) The unique identifier of the booking you would like to update.

payload BookingidBookingcontactBody - Payload on updating a booking with booking contact

contentType string? (default ()) - (optional) content-type header

Return Type

Booking|error - OK

listBookings

Isolated FunctionRemote Function

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 ListOfBookings|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

ListOfBookings|error - OK

createBooking

Isolated FunctionRemote Function

function createBooking(CreateBookingPayload payload, string? contentType) returns Booking|error

Create a booking

Parameters

payload CreateBookingPayload - payload on create booking

contentType string? (default ()) - (optional) content-type header

Return Type

Booking|error - Accepted

createBookingWithRateDetails

Isolated FunctionRemote Function

function createBookingWithRateDetails(CreateBookingWithRateDetailsPayload payload, string? contentType) returns Booking|error

Create a booking with rate details

Parameters

payload CreateBookingWithRateDetailsPayload - Payload on creating a booking with rate details

contentType string? (default ()) - (optional) content-type header

Return Type

Booking|error - Accepted

listHotelAgreements

Isolated FunctionRemote Function

function listHotelAgreements(string dealRequestId) returns ListOfHotelAgreements|error

List all hotel agreements for a deal request

Parameters

dealRequestId string - (Required) The unique identifier for this deal request

Return Type

ListOfHotelAgreements|error - OK

getHotelAgreement

Isolated FunctionRemote Function

function getHotelAgreement(string dealRequestId, string agreementId) returns HotelAgreement|error

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

HotelAgreement|error - OK

getDealRequest

Isolated FunctionRemote Function

function getDealRequest(string dealRequestId) returns DealRequest|error

Retrieve a deal request

Parameters

dealRequestId string - (Required) The unique identifier for this deal request

Return Type

DealRequest|error - OK

listDealRequests

Isolated FunctionRemote Function

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 ListOfDealRequets|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 the hotelIds 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/or REJECTED) 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 and updatedAt.

Return Type

ListOfDealRequets|error - OK

makePayment

Isolated FunctionRemote Function

function makePayment(PaymentBody payload, string? contentType) returns Payment|error

Make a Payment

Parameters

payload PaymentBody - Payload on payment booking

contentType string? (default ()) - (optional) content-type header

Return Type

Payment|error - OK

Records

impala: Address

Fields

line1 string? -

line2? string? -

city string -

region? string? -

country string -

countryName string -

postalCode string -

impala: Adjustment

Fields

adjustmentId? string -

amount decimal -

'type string -

conditions? AdjustmentConditions -

impala: AdjustmentConditions

Fields

'type? string -

rules? AdjustmentConditionsRules -

impala: AdjustmentConditionsRules

Fields

bookableDataRange? HotelagreementStaydateranges -

nightsRange? AdjustmentConditionsRulesNightsrange -

impala: AdjustmentConditionsRulesNightsrange

Fields

min? decimal -

max? decimal -

impala: Amenity

Fields

code decimal -

formatted string -

impala: ApiKeysConfig

Closed record

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: BookedRooms

Fields

roomType BookedroomsRoomtype -

adults? int -

rate BookedroomsRate -

sellerToImpalaPayment? Money -

notes record { fromGuest string?, fromSeller string? } -

impala: BookedroomsRate

Fields

'start string -

end string -

hotelAgreement? HotelAgreement? -

retailRate BookedroomsRateRetailrate -

sellerCommissionPercentage float -

components BookedroomsRateComponents[] -

cancellationPolicies BookedroomsRateCancellationpolicies[] -

maxOccupancy? decimal -

impala: BookedroomsRateCancellationpolicies

Fields

'start? string -

end? string -

formatted? string -

fee? BookedroomsRateFee -

impala: BookedroomsRateComponents

Fields

formatted? string -

'type? string -

includedInRate? boolean -

impala: BookedroomsRateFee

Fields

'type? string -

count? decimal -

price? Money -

impala: BookedroomsRateRetailrate

Fields

total? Money -

taxesAndFees? BookedroomsRateRetailrateTaxesandfees -

impala: BookedroomsRateRetailrateTaxesandfees

Fields

payAtHotel? RoomrateRetailrateTaxesandfeesPayathotel[] -

includedInRate? RoomrateRetailrateTaxesandfeesPayathotel[] -

impala: BookedroomsRoomtype

Fields

roomTypeId string -

name string -

impala: Booking

Fields

bookingId string -

status string -

hotelConfirmationCode? string? -

'start string -

end string -

hotel BookingHotel -

bookedRooms BookedRooms[] -

contact Person -

notes BookingNotes -

createdAt string -

updatedAt string -

cancellation? BookingCancellation? -

paymentBearerToken? string? -

paymentClientSecret? string? -

impala: BookingCancellation

Fields

fee? BookingCancellationFee -

impala: BookingCancellationFee

Fields

'type? string -

count? string -

price? Money -

impala: BookingHotel

Fields

hotelId string -

name string -

currency? string -

starRating decimal -

emails? string[] -

phoneNumbers? string[] -

images Image[] -

address Address -

location Location -

timezone? string -

impala: BookingidBookingcontactBody

Fields

bookingContact? Person -

updateBookingVersionAtTimestamp? string -

impala: BookingNotes

Fields

fromGuest? string? -

fromSeller? string? -

impala: BookingsbookingidBookingcontact

Fields

firstName? string -

lastName? string -

email? string -

impala: BookingsbookingidRooms

Fields

rateId? string -

adults? decimal -

impala: BookingsbookingidwithratedetailsNotes

Fields

fromGuest? string -

fromSeller? string -

impala: BookingsbookingidwithratedetailsRooms

Fields

price? RatePlanSum -

ratePlanId? decimal -

roomTypeId? decimal -

adults? decimal -

notes? BookingsbookingidwithratedetailsNotes -

impala: BookingsRooms

Fields

rateId? decimal -

adults? decimal -

notes? BookingsbookingidwithratedetailsNotes -

impala: CancellationPolicy

Fields

count? decimal -

'type? string -

impala: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy? ProxyConfig - Proxy server related options

impala: Condition

Fields

cancellationPolicy string? -

cancellationDeadline string -

impala: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

impala: CreateBookingPayload

payload on booking creation

Fields

'start? string -

end? string -

dealId? string -

bookingContact? Person -

notes? BookingsbookingidwithratedetailsNotes -

rooms? BookingsRooms[] -

paymentType? string -

impala: CreateBookingWithRateDetailsPayload

payload on creating a booking with rate details

Fields

'start? string -

end? string -

dealId? string -

bookingContact? BookingsbookingidBookingcontact -

notes? BookingsbookingidwithratedetailsNotes -

rooms? BookingsbookingidwithratedetailsRooms[] -

paymentType? string -

updateBookingVersionAtTimestamp? string -

impala: CurrencyDetails

Fields

code? string -

impala: DealRequest

Fields

dealRequestId? string -

dealRequestStatus? string -

stayDateRanges? HotelagreementStaydateranges[] -

sellableInDateRanges? HotelagreementStaydateranges[] -

commission? record {} -

discount? record {} -

specialInstructions? string? -

lengthOfStay? DealrequestLengthofstay -

cancellationPolicy? record {} -

createdAt? string -

updatedAt? string -

bookingWindowRestriction? DealrequestBookingwindowrestriction? -

dealType? string -

impala: DealrequestBookingwindowrestriction

Fields

minDaysBeforeCheckIn? decimal -

maxDaysBeforeCheckIn? decimal -

impala: DealrequestLengthofstay

Fields

min? string -

max? string? -

impala: Hotel

Fields

hotelId string -

name string -

currency string -

starRating decimal -

description? HotelDescription -

contractable boolean -

emails string[] -

websiteUrl string? -

externalUrls HotelExternalurls[] -

phoneNumbers string[] -

images Image[] -

address? Address -

location? Location -

timezone? string -

amenities Amenity[] -

roomTypes RoomTypes[] -

roomCount decimal -

termsAndConditions string -

createdAt? string -

updatedAt? string -

checkIn HotelCheckin -

checkOut HotelCheckin -

impala: HotelAgreement

Fields

hotelAgreementId string -

hotelId? string -

hotelAgreementStatus? string -

stayDateRanges? HotelagreementStaydateranges -

sellableInDateRanges? HotelagreementStaydateranges -

commission? record { count decimal, 'type string } -

dealId string -

conditions string[] -

discount? HotelagreementDiscount -

specialInstructions string? -

dealsSellable? HotelagreementDealssellable -

href? string -

lengthOfStay? LengthOfStay -

cancellationPolicy? CancellationPolicy? -

createdAt? string -

updatedAt? string -

impala: HotelagreementDealssellable

Fields

remaining? int -

max? decimal -

impala: HotelagreementDiscount

Fields

count? int -

'type? string -

impala: HotelagreementStaydateranges

Fields

'start? string -

end? string -

impala: HotelCheckin

Fields

'from? string -

to? string -

impala: HotelDescription

Fields

short? string -

impala: HotelExternalurls

Fields

name? string -

url? string -

impala: Image

Fields

altText? string? -

height decimal -

width decimal -

url string -

impala: LengthOfStay

Fields

min? int -

max? int -

impala: ListOfBookings

Fields

data? Booking[] -

pagination? Pagination -

impala: ListOfDealRequets

Fields

data? DealRequest[] -

pagination? Pagination -

impala: ListOfHotelAgreements

Fields

data? HotelAgreement[] -

pagination? Pagination -

impala: ListOfHotels

Fields

data Hotel[] -

pagination Pagination -

impala: Location

Fields

latitude int -

longitude int -

impala: Money

Fields

amount int -

currency MoneyCurrency -

impala: MoneyCurrency

Fields

code string -

Fields

count? int -

total? int -

next? string? -

prev? string? -

impala: Payment

Fields

paymentId? string -

status? string -

authorisationRedirectUrl? string -

createdAt? string -

impala: PaymentBody

Fields

billing_details? V1paymentsBillingDetails -

card? V1paymentsCard -

redirectUri? string -

impala: Person

Fields

firstName string -

lastName string -

email string -

contactId? string -

impala: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

impala: RatePlanInfo

Fields

data? RateplaninfoData -

pagination? Pagination -

impala: RateplaninfoData

Fields

ratePlanId decimal -

hotelId string -

description string -

components? BookedroomsRateComponents[] -

conditions Condition -

restrictions Restriction -

roomTypes RoomTypes[] -

adjustments Adjustment[] -

impala: RatePlanSum

Fields

amount? int -

currency? CurrencyDetails -

impala: Restriction

Fields

lengthOfStay? AdjustmentConditionsRulesNightsrange -

impala: RoomRate

Fields

rateId string -

'start string -

end string -

maxOccupancy int -

retailRate RoomrateRetailrate -

sellerToImpalaPayment? Money -

sellerCommissionPercentage decimal -

components RoomrateComponents[] -

hotelAgreement RoomrateHotelagreement? -

impala: RoomrateComponents

Fields

formatted? string -

'type? string -

includedInRate? boolean -

impala: RoomrateHotelagreement

Fields

hotelAgreementId string -

dealId string -

conditions? string[] -

discount? RoomrateHotelagreementDiscount -

specialInstructions string -

dealsSellable? RoomrateHotelagreementDealssellable -

href? string -

impala: RoomrateHotelagreementDealssellable

Fields

remaining? decimal -

impala: RoomrateHotelagreementDiscount

Fields

count? decimal -

'type? string -

impala: RoomrateRetailrate

Fields

total? Money -

taxesAndFees? RoomrateRetailrateTaxesandfees? -

impala: RoomrateRetailrateTaxesandfees

Fields

payAtHotel? RoomrateRetailrateTaxesandfeesPayathotel[] -

includedInRate? RoomrateRetailrateTaxesandfeesPayathotel[] -

impala: RoomrateRetailrateTaxesandfeesPayathotel

Fields

formatted? string -

category? string -

charge? Money -

impala: RoomTypes

Fields

roomTypeId string -

name string -

description string -

maxOccupancy int -

rates? RoomRate[] -

images Image[] -

amenities Amenity[] -

impala: UpdateBookingPayload

Payload on updating a booking.

Fields

'start? string -

end? string -

bookingContact? BookingsbookingidBookingcontact -

rooms? BookingsbookingidRooms -

impala: UpdateBookingWithRateDetailsPayload

Fields

'start? string -

end? string -

dealId? string -

bookingContact? BookingsbookingidBookingcontact -

notes? BookingsbookingidwithratedetailsNotes -

rooms? BookingsbookingidwithratedetailsRooms[] -

paymentType? string -

updateBookingVersionAtTimestamp? string -

impala: V1paymentsBillingDetails

Fields

address? V1paymentsBillingDetailsAddress -

impala: V1paymentsBillingDetailsAddress

Fields

line1? string? -

line2? string? -

city? string -

country? string -

postalCode? string -

state? string -

impala: V1paymentsCard

Fields

expMonth? decimal -

expYear? decimal -

cardNumber? decimal -

cvc? decimal -

Import

import ballerinax/impala;

Other versions

1.3.2

1.3.1 1.3.0 1.2.0 1.0.0

Metadata

Released date: 9 days ago

Version: 1.3.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 68

Current verison: 8

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/Impala

Area/CRM & Sales

Sales & CRM/Scheduling & Booking

Cost/Freemium

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

ballerinax/impala Ballerina library

Overview

Key Features

Prerequisites

Clients

impala: Client

Constructor

getHotel

Parameters

Return Type

listRatePlans

Parameters

Return Type

listHotels

Parameters

Return Type

getBooking

Parameters

Return Type

updateBooking

Parameters

Return Type

cancelBooking

Parameters

Return Type

updateBookingWithRateDetails

Parameters

Return Type

updateBookingContact

Parameters

Return Type

listBookings

Parameters

Return Type

createBooking

Parameters

Return Type

createBookingWithRateDetails

Parameters

Return Type

listHotelAgreements

Parameters

Return Type

getHotelAgreement

Parameters

Return Type

getDealRequest

Parameters

Return Type

listDealRequests

Parameters

Return Type

makePayment

Parameters

Return Type

Records

impala: Address

Fields

impala: Adjustment

Fields

impala: AdjustmentConditions

Fields

impala: AdjustmentConditionsRules

Fields

impala: AdjustmentConditionsRulesNightsrange

Fields

impala: Amenity

Fields

impala: ApiKeysConfig

Fields

impala: BookedRooms

Fields

impala: BookedroomsRate

Fields

impala: BookedroomsRateCancellationpolicies

Fields

impala: BookedroomsRateComponents

Fields