New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
liteapi-travel
Advanced tools
liteapi-travel - npm Package Compare versions
Comparing version 2.0.0 to 2.0.1
@@ -16,12 +16,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -28,0 +22,0 @@ /** |
@@ -15,12 +15,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -27,0 +21,0 @@ /** |
@@ -15,12 +15,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -27,0 +21,0 @@ /** |
@@ -15,12 +15,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -27,0 +21,0 @@ /** |
@@ -15,12 +15,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -27,0 +21,0 @@ /** |
@@ -16,12 +16,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -73,3 +67,3 @@ /** | ||
| this.defaultHeaders = { | ||
| 'User-Agent': 'OpenAPI-Generator/2.0.0/Javascript' | ||
| 'User-Agent': 'liteAPI/2.0.0/Javascript' | ||
| }; | ||
@@ -76,0 +70,0 @@ |
@@ -20,12 +20,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -32,0 +26,0 @@ /** |
@@ -18,12 +18,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -30,0 +24,0 @@ /** |
@@ -18,12 +18,6 @@ "use strict"; | ||
| function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /** | ||
| * Lite API | ||
| * The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * liteAPI | ||
| * The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination | ||
| * | ||
| * The version of the OpenAPI document: 2.0.0 | ||
| * | ||
| * | ||
| * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). | ||
| * https://openapi-generator.tech | ||
| * Do not edit the class manually. | ||
| * | ||
| */ | ||
@@ -30,0 +24,0 @@ /** |
| { | ||
| "name": "liteapi-travel", | ||
| "version": "2.0.0", | ||
| "description": "The **Lite API** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination", | ||
| "version": "2.0.1", | ||
| "description": "The **liteAPI** can be used to to do the following Get room rates & availability for a set of hotels Select a specific hotel with room availability and make a booking Manage the bookings - retrieve and cancel existing bookings Get static content for hotels, search hotels by destination", | ||
| "license": "Unlicense", | ||
@@ -6,0 +6,0 @@ "main": "dist/index.js", |
944
README.md
@@ -1,169 +0,897 @@ | ||
| # liteapi-travel | ||
| # liteAPI SDK | ||
| LiteApi - JavaScript client for liteapi-travel | ||
| The **Lite API** can be used to to do the following | ||
| ## Table of Contents | ||
| - [liteAPI SDK](#liteapi-sdk) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Introduction](#introduction) | ||
| - [Installing](#installing) | ||
| - [Usage](#usage) | ||
| - [Static data](#static-data) | ||
| - [List of cities](#list-of-cities) | ||
| - [List of Countries](#list-of-countries) | ||
| - [List of available currencies](#list-of-available-currencies) | ||
| - [List of hotels](#list-of-hotels) | ||
| - [Hotel details](#hotel-details) | ||
| - [IATA code list](#iata-code-list) | ||
| - [Booking flow](#booking-flow) | ||
| - [Search](#search) | ||
| - [Hotel Minimum Rates availability](#hotel-minimum-rates-availability) | ||
| - [Hotel full rates availability](#hotel-full-rates-availability) | ||
| - [book](#book) | ||
| - [Hotel rate prebook](#hotel-rate-prebook) | ||
| - [Hotel rate book](#hotel-rate-book) | ||
| - [Booking management](#booking-management) | ||
| - [Booking list](#booking-list) | ||
| - [Booking retrieve](#booking-retrieve) | ||
| - [Booking cancel](#booking-cancel) | ||
| Get room rates & availability for a set of hotels | ||
| Select a specific hotel with room availability and make a booking | ||
| Manage the bookings - retrieve and cancel existing bookings | ||
| Get static content for hotels, search hotels by destination | ||
| This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: | ||
| # Introduction | ||
| [liteAPI](https://www.liteapi.travel/) The fastest way to build travel apps | ||
| Launch your hospitality product in minutes. Effortlessly monetize by selling accommodations at over 2 million properties worldwide. | ||
| - API version: 2.0.0 | ||
| - Package version: 2.0.0 | ||
| - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen | ||
| ## Installation | ||
| The liteAPI can be used to to do the following: | ||
| - Get room rates & availability for a set of hotels. | ||
| - Select a specific hotel with room availability and make a booking | ||
| - Manage the bookings | ||
| - retrieve and cancel existing bookings. | ||
| - Get static content for hotels. | ||
| - Search hotels by destination. | ||
| ### For [Node.js](https://nodejs.org/) | ||
| Don't have an account yet? Sign Up [Here](https://dashboard.liteapi.travel/register/). | ||
| #### npm | ||
| To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). | ||
| ## Installing | ||
| Then install it via: | ||
| Install the package with: | ||
| ```shell | ||
| npm install liteapi-travel --save | ||
| ```sh | ||
| npm install liteapi-travel | ||
| # or | ||
| yarn add liteapi-travel | ||
| ``` | ||
| Finally, you need to build the module: | ||
| ## Usage | ||
| The package needs to be configured with your account's apikey, which is | ||
| available in the [liteAPI Dashboard](https://dashboard.liteapi.travel/apikeys/). Require it with the key's | ||
| value: | ||
| ```shell | ||
| npm run build | ||
| ```js | ||
| const liteApi = require('liteapi-travel'); | ||
| const defaultClient = liteApi.ApiClient.instance; | ||
| const apikeyAuth = defaultClient.authentications['apikeyAuth']; | ||
| apikeyAuth.apiKey = "YOUR API KEY" | ||
| ``` | ||
| ##### Local development | ||
| ## Static data | ||
| To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: | ||
| ### List of cities | ||
| ```shell | ||
| npm install | ||
| The API returns a list of city names from a specific country. The country codes needs be is in ISO-2 format. To get the country codes in ISO-2 for all countries please use the GET Country list endpoint | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchCitiesByCountryCode = (countryCode: string) => { | ||
| const apiInstance = new liteApi.StaticDataApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.dataCitiesGet(countryCode, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getDataCities() { | ||
| try { | ||
| let countryCode = "US"; | ||
| const data = await this.fetchCitiesByCountryCode(countryCode); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: | ||
| ```shell | ||
| npm link | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **countryCode** | **string**| Country code in iso-2 format (example: US) | [required] | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An array of city objects containing the following properties: | ||
| Field | Type | Description | ||
| ------|------|------------ | ||
| **city** | **string** | The name of the city. | ||
| ### List of Countries | ||
| The API returns the list of countries available along with its ISO-2 code. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchCountries = () => { | ||
| const apiInstance = new liteApi.StaticDataApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.dataCountriesGet((error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getDataCountries() { | ||
| try { | ||
| const data = await this.fetchCountries(); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| To use the link you just defined in your project, switch to the directory you want to use your liteapi-travel from, and run: | ||
| This endpoint does not need any parameter. | ||
| ```shell | ||
| npm link /path/to/<JAVASCRIPT_CLIENT_DIR> | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An array of country objects containing the following properties: | ||
| Field | Type | Description | ||
| ------|------|------------ | ||
| **code** | **string** | The country code in iso-2 format. | ||
| **name** | **string** | The name of the country. | ||
| ### List of available currencies | ||
| The API returns all available currency codes along with its name and the list of supported countries that the currency applies to. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchCurrencies = () => { | ||
| const apiInstance = new liteApi.StaticDataApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.dataCurrenciesGet((error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getDataCurrencies() { | ||
| try { | ||
| const data = await this.fetchCurrencies(); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Finally, you need to build the module: | ||
| This endpoint does not need any parameter. | ||
| ```shell | ||
| npm run build | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An array of currency objects containing the following properties: | ||
| | Name | Type | Description | | ||
| | -------- | ----- | ----------------------------------------------------------- | | ||
| | **code** | **string** | The currency code. | | ||
| | **currency** | **string** | The name of the currency. | | ||
| | **countries** | **Array** | An array of countries where the currency is used. | | ||
| ### List of hotels | ||
| The API returns a list of hotels available based on different search criterion. The minimum required information is the county code in ISO-2 format. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchHotels = (countryCode: string,cityName: string,opts:any) => { | ||
| const apiInstance = new liteApi.StaticDataApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.dataHotelsGet(countryCode, cityName, opts, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getDataHotels() { | ||
| let countryCode = "SG"; | ||
| let cityName = "Singapore"; | ||
| let opts = { | ||
| 'offset': 0, | ||
| 'limit': 1000, | ||
| 'longitude': -115.16988, | ||
| 'latitude': 36.12510, | ||
| 'distance': 1000 | ||
| }; | ||
| try { | ||
| const data = await this.fetchHotels(countryCode,cityName,opts); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| #### git | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **countryCode** | **string**| country code ISO-2 code - example (US) | [required] | ||
| **cityName** | **string**| name of the city | [required] | ||
| **offset** | **number**| specifies the number of rows to skip before starting to return rows | [optional] | ||
| **limit** | **number**| limit number of results (max 1000) | [optional] | ||
| **longitude** | **number** | longitude geo coordinates | [optional] | ||
| **latitude** | **number** | latitude geo coordinates | [optional] | ||
| **distance** | **number** | distance in meters (min 1000m) | [optional] | ||
| If the library is hosted at a git repository, e.g.https://github.com/liteapi-travel/javascript-sdk | ||
| then install it via: | ||
| ```shell | ||
| npm install liteapi-travel/javascript-sdk --save | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An array of hotel objects containing the following properties: | ||
| | Name | Type | Description | | ||
| | --------------- | ------ | --------------------------------------------------------------------------------------------------------- | | ||
| | **id** | **string** | The unique identifier of the hotel. | | ||
| | **name** | **string** | The name of the hotel. | | ||
| | **hotelDescription**| **string** | The description of the hotel. | | ||
| | **currency** | **string** | The currency used in the hotel. | | ||
| | **country** | **string** | The country code of the hotel. | | ||
| | **city** | **string** | The city where the hotel is located. | | ||
| | **latitude** | **number** | The latitude coordinates of the hotel's location. | | ||
| | **longitude** | **number** | The longitude coordinates of the hotel's location. | | ||
| | **address** | **string** | The address of the hotel. | | ||
| | **zip** | **string** | The postal code of the hotel. | | ||
| | **main_photo** | **string** | The URL of the main photo of the hotel. | | ||
| | **stars** | **number** | The star rating of the hotel. | | ||
| ### Hotel details | ||
| The hotel details API returns all the static contents details of a hotel or property if the hotel ID is provided. The static content include name, description, address, amenities, cancellation policies, images and more. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchHotelDetails = (hotelId: string) => { | ||
| const apiInstance = new liteApi.StaticDataApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.dataHotelGet(hotelId, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getDataHotelDetails() { | ||
| let hotelId = "lp19c06"; | ||
| try { | ||
| const data = await this.fetchHotelDetails(hotelId); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **hotelId** | **string**| Unique ID of a hotel | [required] | ||
| ### For browser | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following | ||
| the above steps with Node.js and installing browserify with `npm install -g browserify`, | ||
| perform the following (assuming *main.js* is your entry file): | ||
| | Name | Type | Description | | ||
| | --------------- | ------ | --------------------------------------------------------------------------------------------------------- | | ||
| | **id** | **string** | The unique identifier of the hotel. | | ||
| | **name** | **string** | The name of the hotel. | | ||
| | **hotelDescription** | **string** | The description of the hotel. | | ||
| | **checkinCheckoutTimes** | **Object** | An object containing the check-in and check-out times of the hotel. | | ||
| | **checkout** | **string** | The check-out time of the hotel. | | ||
| | **checkin** | **string** | The check-in time of the hotel. | | ||
| | **hotelImages** | **Array** | An array of hotel image objects containing the following properties: | | ||
| | **url** | **string** | The URL of the hotel image. | | ||
| | **thumbnailUrl** | **string** | The thumbnail URL of the hotel image. | | ||
| | **caption** | **string** | The caption of the hotel image. | | ||
| | **order** | **string** | The order of the hotel image (null if not applicable). | | ||
| | **defaultImage** | **boolean** | Indicates whether the hotel image is the default image or not. | | ||
| | **currency** | **string** | The currency used in the hotel. | | ||
| | **country** | **string** | The country code of the hotel. | | ||
| | **city** | **string** | The city where the hotel is located. | | ||
| | **starRating** | **number** | The star rating of the hotel. | | ||
| | **location** | **Object** | An object containing the latitude and longitude coordinates of the hotel's location. | | ||
| | **latitude** | **number** | The latitude coordinate of the hotel's location. | | ||
| | **longitude** | **number** | The longitude coordinate of the hotel's location. | | ||
| | **address** | **string** | The address of the hotel. | | ||
| | **zip** | **string** | The postal code of the hotel. | | ||
| | **chainId** | **string** | The unique identifier of the hotel chain. | | ||
| | **hotelFacilities** | **Array** | An array of hotel facilities offered by the hotel. | | ||
| ```shell | ||
| browserify main.js > bundle.js | ||
| ### IATA code list | ||
| The API returns the IATA (International Air Transport Association) codes for all available airports along with the name of the airport, geographical coordinates and country code in ISO-2 format. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchIataCode = () => { | ||
| const apiInstance = new liteApi.StaticDataApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.dataIataCodesGet((error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getDataIataCode() { | ||
| try { | ||
| const data = await this.fetchIataCode(); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Then include *bundle.js* in the HTML pages. | ||
| This endpoint does not need any parameter. | ||
| ### Webpack Configuration | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| Using Webpack you may encounter the following error: "Module not found: Error: | ||
| Cannot resolve module", most certainly you should disable AMD loader. Add/merge | ||
| the following section to your webpack config: | ||
| An array of IATA objects with the following properties: | ||
| ```javascript | ||
| module: { | ||
| rules: [ | ||
| { | ||
| parser: { | ||
| amd: false | ||
| } | ||
| | Name | Type | Description | | ||
| | ----------- | ------ | ------------------------------------------------ | | ||
| | **code** | **string** | The IATA code. | | ||
| | **name** | **string** | The name of the IATA. | | ||
| | **latitude** | **number** | The latitude coordinates of the IATA. | | ||
| | **longitude** | **number** | The longitude coordinates of the IATA. | | ||
| | **countryCode** | **string** | The country code of the IATA. | | ||
| ## Booking flow | ||
| liteAPI is a comprehensive and simple to implement Hotel Booking API. The booking flow consists of 3 section: Search, Book, and | ||
| booking management. | ||
| ### Search | ||
| #### Hotel Minimum Rates availability | ||
| Hotel Minimum Rates API is to search and return the minimum room rates that are available for a list of hotel ID's on the specified search dates. | ||
| For each hotel ID, the minimum room rate that is available is returned. | ||
| The API also has a built in loyalty rewards system. The system rewards return users who have made prior bookings. | ||
| If the search is coming from a known guest ID, the guest level is also returned along with the pricing that's appropriate for the guest level. | ||
| If it is a new user, the guest ID will be generated at the time of the first confirmed booking. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchHotelMinimumRates = (hotelIds: string,checkin: string,checkout: string,currency: string,guestNationality: string,adults: number, opts: any) => { | ||
| const apiInstance = new liteApi.SearchApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.hotelsGet(hotelIds, checkin, checkout, currency, guestNationality, adults, opts, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getHotelMinimumRates() { | ||
| let hotelIds = "lp3803c,lp1f982,lp19b70,lp19e75"; | ||
| let checkin = "2023-11-15"; | ||
| let checkout = "2023-11-16"; | ||
| let currency = "USD"; | ||
| let guestNationality = "US"; | ||
| let adults = 1; | ||
| let opts = { | ||
| 'children': "12,9", | ||
| 'guestId': "testtraveler1" | ||
| }; | ||
| try { | ||
| const data = await this.fetchHotelMinimumRates(hotelIds,checkin,checkout,currency,guestNationality,adults,opts); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| ## Getting Started | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **hotelIds** | **string**| List of hotelIds | [required] | ||
| **checkin** | **string**| Check in data in YYYY-MM-DD format | [required] | ||
| **checkout** | **string**| Check out data in YYYY-MM-DD format | [required] | ||
| **currency** | **string**| Currency code - example (USD) | [required] | ||
| **guestNationality** | **string**| Guest nationality ISO-2 code - example (SG) | [required] | ||
| **adults** | **number**| Number of adult guests staying | [required] | ||
| **children** | **string**| Number of children staying if any | [optional] | ||
| **guestId** | **string**| Unique traveler ID if available | [optional] | ||
| Please follow the [installation](#installation) instruction and execute the following JS code: | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| ```javascript | ||
| var LiteApi = require('liteapi-travel'); | ||
| An array of hotel minimum rates objects with the following properties: | ||
| var defaultClient = LiteApi.ApiClient.instance; | ||
| // Configure API key authorization: apikeyAuth | ||
| var apikeyAuth = defaultClient.authentications['apikeyAuth']; | ||
| apikeyAuth.apiKey = "YOUR API KEY" | ||
| // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) | ||
| //apikeyAuth.apiKeyPrefix['X-API-Key'] = "Token" | ||
| | Name | Type | Description | | ||
| | ------------ | ------ | ------------------------------------------------ | | ||
| | **hotelId** | **string** | The ID of the hotel. | | ||
| | **currency** | **string** | The currency code for the price. | | ||
| | **price** | **number** | The price of the hotel. | | ||
| | **supplierId** | **number** | The ID of the supplier. | | ||
| | **supplier** | **string** | The name of the supplier. | | ||
| var api = new LiteApi.BookApi() | ||
| var opts = { | ||
| 'ratesBookPostRequest': {"prebookId":"UwfMkUWH6","guestInfo":{"guestFirstName":"Kim","guestLastName":"James","guestEmail":"test@nlite.ml"},"payment":{"holderName":"Kim James","number":"4242424242424242","expireDate":"11/29","cvc":"456","method":"CREDIT_CARD"}} // {RatesBookPostRequest} | ||
| }; | ||
| var callback = function(error, data, response) { | ||
| if (error) { | ||
| console.error(error); | ||
| } else { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| #### Hotel full rates availability | ||
| The Full Rates API is to search and return all available rooms along with its rates, cancellation policies for a list of hotel ID's based on the search dates. | ||
| For each hotel ID, all available room information is returned. | ||
| The API also has a built in loyalty rewards system. The system rewards return users who have made prior bookings. | ||
| If the search is coming from a known guest ID, the guest level is also returned along with the pricing that's appropriate for the guest level. | ||
| If it is a new user, the guest ID will be generated at the time of the first confirmed booking. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchHotelFullRates = (hotelIds: string,checkin: string,checkout: string,currency: string,guestNationality: string,adults: number, opts: any) => { | ||
| const apiInstance = new liteApi.SearchApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.hotelsRatesGet(hotelIds, checkin, checkout, currency, guestNationality, adults, opts, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getHotelFullRates() { | ||
| let hotelIds = "lp3803c,lp1f982,lp19b70,lp19e75"; | ||
| let checkin = "2023-11-15"; | ||
| let checkout = "2023-11-16"; | ||
| let currency = "USD"; | ||
| let guestNationality = "US"; | ||
| let adults = 1; | ||
| let opts = { | ||
| 'children': "12,9", | ||
| 'guestId': "testtraveler1" | ||
| }; | ||
| try { | ||
| const data = await this.fetchHotelFullRates(hotelIds,checkin,checkout,currency,guestNationality,adults,opts); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| }; | ||
| api.ratesBookPost(opts, callback); | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **hotelIds** | **string**| List of hotelIds | [required] | ||
| **checkin** | **string**| Check in data in YYYY-MM-DD format | [required] | ||
| **checkout** | **string**| Check out data in YYYY-MM-DD format | [required] | ||
| **currency** | **string**| Currency code - example (USD) | [required] | ||
| **guestNationality** | **string**| Guest nationality ISO-2 code - example (SG) | [required] | ||
| **adults** | **number**| Number of adult guests staying | [required] | ||
| **children** | **string**| Number of children staying if any | [optional] | ||
| **guestId** | **string**| Unique traveler ID if available | [optional] | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An array of hotel full rates with the following properties: | ||
| | Name | Type | Description | | ||
| | ------------ | ------ | ------------------------------------------------ | | ||
| | **roomTypeId** | string | The ID of the room type. | | ||
| | **supplier** | string | The name of the supplier. | | ||
| | **supplierId** | number | The ID of the supplier. | | ||
| | **rates** | Array | An array of rate objects containing the pricing and details for each rate within the room type. | | ||
| | **rateId** | string | The ID of the rate. | | ||
| | **name** | string | The name of the rate. | | ||
| | **maxOccupancy** | number | The maximum occupancy of the room. | | ||
| | **boardType** | string | The type of board included (e.g., Bed Only). | | ||
| | **boardName** | string | The name of the board (e.g., Bed Only). | | ||
| | **priceType** | string | The type of pricing (e.g., commission). | | ||
| | **commission** | Array | An array of commission objects containing the commission amount and currency. | | ||
| | **retailRate** | Object | An object containing the retail rate information, including total price, MSP (Marked Selling Price), and taxes and fees. | | ||
| | **total** | Array | An array of total price objects containing the amount and currency. | | ||
| | **msp** | Array | An array of MSP (Marked Selling Price) objects containing the amount and currency. | | ||
| | **taxesAndFees** | Array | An array of taxes and fees objects containing information about included or additional charges. | | ||
| | **cancellationPolicies** | Object | An object containing cancellation policy information. | | ||
| | **cancelPolicyInfos** | Array | An array of cancellation policy info objects containing information about cancellation time, amount, currency, and type. | | ||
| | **hotelRemarks** | Array | An array of hotel remarks. | | ||
| | **refundableTag** | string | The tag indicating if the rate is refundable or non-refundable. | | ||
| ### book | ||
| #### Hotel rate prebook | ||
| This API is used to confirm if the room and rates for the search criterion. The input to the endpoint is a specific rate Id coming from the GET hotel full rates availability API. | ||
| In response, the API generates a prebook Id, a new rate Id and contains information if price, cancellation policy or boarding information has changed. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchHotelRatePrebook = (opts: any) => { | ||
| const apiInstance = new liteApi.BookApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.ratesPrebookPost(opts, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getHotelRatePrebook() { | ||
| let opts = { | ||
| 'body': {"rateId":"2_3P6L4TRYIFKLFM3DRKUQ4SBFCSO3QJBU27UQ76RU6HTAVUULOUZN3HLFLDS6HRUUQXXZNPELVXHLEXZF3J26PGYXGZEMZOPATZGAUBZLMB7BR6OL7QW4FIAIWTOCOLVHBIRGQFE7UJLTQP5RB6AXVPADIRT34YR56BBBSLSAWK2BMTRYBFRZCYG6HQKMULTSO6JIWWTEGVSBOHNFO7KTFXFMGCULXME2B4PZDCFWK62PT3EL4XUVOEB37V2EA7CWJKOZZU4OYDFB36YWUCID6LWVCCRMVU4PYZH2WBTJ6SLVVEGVZHTVGCVXA5GXEOCUE4ARMWXCIGRPASA5WBFI2T557GWUUZ6YMBZZMPUPCWI7DVO2OG6KY36WWASVBLEJRYFHJRRGQKDV5HY6INAD3YARYKVNFMITJ6BX5LVBVXNF33OZF34ZQDE5S74ND73FMHCYSSTZFOBCOBKYDHQ5BWGRYS7GALROITVAFG2OIFSXLUSKRT3MEURPJL7S3MHWEJMAYJFGGPMRZBEQZXAXDJI"} | ||
| }; | ||
| try { | ||
| const data = await this.fetchHotelRatePrebook(opts); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| ## Documentation for API Endpoints | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **body** | **Object**| | [required] | ||
| **rateId** | **string**| rate id retrieved from rates response| [required] | ||
| All URIs are relative to *https://api.liteapi.travel/v2.0* | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| Class | Method | HTTP request | Description | ||
| ------------ | ------------- | ------------- | ------------- | ||
| *LiteApi.BookApi* | [**ratesBookPost**](docs/BookApi.md#ratesBookPost) | **POST** /rates/book | hotel rate book | ||
| *LiteApi.BookApi* | [**ratesPrebookPost**](docs/BookApi.md#ratesPrebookPost) | **POST** /rates/prebook | hotel rate prebook | ||
| *LiteApi.BookingManagementApi* | [**bookingsBookingIdGet**](docs/BookingManagementApi.md#bookingsBookingIdGet) | **GET** /bookings/{bookingId} | Booking retrieve | ||
| *LiteApi.BookingManagementApi* | [**bookingsBookingIdPut**](docs/BookingManagementApi.md#bookingsBookingIdPut) | **PUT** /bookings/{bookingId} | Booking cancel | ||
| *LiteApi.BookingManagementApi* | [**bookingsGet**](docs/BookingManagementApi.md#bookingsGet) | **GET** /bookings | Booking list | ||
| *LiteApi.GuestAndLoyaltyApi* | [**guestsGet**](docs/GuestAndLoyaltyApi.md#guestsGet) | **GET** /guests | guests | ||
| *LiteApi.SearchApi* | [**hotelsGet**](docs/SearchApi.md#hotelsGet) | **GET** /hotels | hotel minimum rates availability | ||
| *LiteApi.SearchApi* | [**hotelsRatesGet**](docs/SearchApi.md#hotelsRatesGet) | **GET** /hotels/rates | hotel full rates availability | ||
| *LiteApi.StaticDataApi* | [**dataCitiesGet**](docs/StaticDataApi.md#dataCitiesGet) | **GET** /data/cities | City list | ||
| *LiteApi.StaticDataApi* | [**dataCountriesGet**](docs/StaticDataApi.md#dataCountriesGet) | **GET** /data/countries | Country list | ||
| *LiteApi.StaticDataApi* | [**dataCurrenciesGet**](docs/StaticDataApi.md#dataCurrenciesGet) | **GET** /data/currencies | Currency list | ||
| *LiteApi.StaticDataApi* | [**dataHotelGet**](docs/StaticDataApi.md#dataHotelGet) | **GET** /data/hotel | Hotel details | ||
| *LiteApi.StaticDataApi* | [**dataHotelsGet**](docs/StaticDataApi.md#dataHotelsGet) | **GET** /data/hotels | Hotel list | ||
| *LiteApi.StaticDataApi* | [**dataIataCodesGet**](docs/StaticDataApi.md#dataIataCodesGet) | **GET** /data/iataCodes | IATA code list | ||
| An object containing prebook information and room type details. | ||
| | Name | Type | Description | | ||
| | ------------------------- | ------ | ------------------------------------------------------------------------------------------------------ | | ||
| | **prebookId** | **string** | The ID of the prebook. | | ||
| | **hotelId** | **string** | The ID of the hotel. | | ||
| | **currency** | **string** | The currency used for pricing. | | ||
| | **termsAndConditions** | **string** | The terms and conditions (if available). | | ||
| | **roomTypes** | **Array** | An array of room type objects containing the following properties: | | ||
| | **rates** | **Array** | An array of rate objects containing pricing and details for each rate within the room type. | | ||
| | **rateId** | **string** | The ID of the rate. | | ||
| | **name** | **string** | The name of the rate. | | ||
| | **maxOccupancy** | **number** | The maximum occupancy of the room. | | ||
| | **boardType** | **string** | The type of board included (e.g., Bed Only). | | ||
| | **boardName** | **string** | The name of the board (e.g., Bed Only). | | ||
| | **priceType** | **string** | The type of pricing (e.g., commission). | | ||
| | **commission** | **Object** | An array of commission objects containing the commission amount and currency. | | ||
| | **retailRate** | **Object** | An object containing the retail rate information, including total price, MSP (Marked Selling Price), and taxes and fees. | | ||
| | **total** | **Object** | An array of total price objects containing the amount and currency. | | ||
| | **msp** | **Object** | An array of MSP (Marked Selling Price) objects containing the amount and currency. | | ||
| | **taxesAndFees** | **Object** | An array of taxes and fees objects containing information about included or additional charges. | | ||
| | **cancellationPolicies** | **Object** | An object containing cancellation policy information. | | ||
| | **cancelPolicyInfos** | **Object** | An array of cancellation policy info objects containing information about cancellation time, amount, and type. | | ||
| | **hotelRemarks** | **Array** | An array of hotel remarks. | | ||
| | **refundableTag** | **string** | The tag indicating if the rate is refundable or non-refundable. | | ||
| | **msp** | **number** | The Marked Selling Price (MSP) for the prebook. | | ||
| | **commission** | **number** | The commission amount for the prebook. | | ||
| | **price** | **number** | The price of the prebook. | | ||
| | **priceType** | **string** | The type of pricing (e.g., commission). | | ||
| | **priceDifferencePercent**| **number** | The percentage difference between the retail rate and the Marked Selling Price (MSP). | | ||
| | **cancellationChanged** | **boolean** | Indicates if there were changes to the cancellation policy. | | ||
| | **boardChanged** | **boolean** | Indicates if there were changes to the board type. | | ||
| | **supplier** | **string** | The name of the supplier. | | ||
| | **supplierId** | **number** | The ID of the supplier. | | ||
| ## Documentation for Models | ||
| #### Hotel rate book | ||
| - [LiteApi.RatesBookPostRequest](docs/RatesBookPostRequest.md) | ||
| - [LiteApi.RatesBookPostRequestGuestInfo](docs/RatesBookPostRequestGuestInfo.md) | ||
| - [LiteApi.RatesBookPostRequestPayment](docs/RatesBookPostRequestPayment.md) | ||
| This API confirms a booking when the prebook Id and the rate Id from the pre book stage along with the guest and payment information are passed. | ||
| The guest information is an object that should include the guest first name, last name and email. | ||
| ## Documentation for Authorization | ||
| The payment information is an object that should include the name, credit card number, expiry and CVC number. | ||
| The response will confirm the booking along with a booking Id and a hotel confirmation code. It will also include the booking details including the dates, price and the cancellation policies. | ||
| Authentication schemes defined for the API: | ||
| ### apikeyAuth | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchHotelRateBook = (opts: any) => { | ||
| const apiInstance = new liteApi.BookApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.ratesBookPost(opts, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| - **Type**: API key | ||
| - **API key parameter name**: X-API-Key | ||
| - **Location**: HTTP header | ||
| public async getHotelRateBook() { | ||
| let opts = { | ||
| 'ratesBookPostRequest': { | ||
| "prebookId":"UwfMkUWH6", | ||
| "guestInfo":{"guestFirstName":"Kim","guestLastName":"James","guestEmail":"test@nlite.ml"}, | ||
| "payment":{"holderName":"Kim James","number":"4242424242424242","expireDate":"11/29","cvc":"456","method":"CREDIT_CARD"}} | ||
| }; | ||
| try { | ||
| const data = await this.fetchHotelRateBook(opts); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **body** | **Object**| | [required] | ||
| **rateId** | **string**| rate id retrieved from rates response| [required] | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An object containing booking information and room details. | ||
| | Name | Type | Description | | ||
| | ------------------------- | ------- | ------------------------------------ | | ||
| | **bookingId** | **string** | The ID of the booking. | | ||
| | **clientReference** | **string** | The client reference. | | ||
| | **supplierBookingId** | **string** | The supplier booking ID. | | ||
| | **supplierBookingName** | **string** | The supplier booking name. | | ||
| | **supplier** | **string** | The supplier. | | ||
| | **supplierId** | **number** | The ID of the supplier. | | ||
| | **status** | **string** | The status of the booking. | | ||
| | **hotelConfirmationCode** | **string** | The hotel confirmation code. | | ||
| | **checkin** | **string** | The check-in date. | | ||
| | **checkout** | **string** | The check-out date. | | ||
| | **hotel** | **object** | An object containing hotel details. | | ||
| | **bookedRooms** | **array** | An array of booked room objects. | | ||
| | **roomType** | **object** | An object containing room type details. | | ||
| | **adults** | **number** | The number of adults. | | ||
| | **children** | **number** | The number of children. | | ||
| | **rate** | **object** | An object containing rate details. | | ||
| | **maxOccupancy** | **number** | The maximum occupancy. | | ||
| | **retailRate** | **object** | An object containing the retail rate information, including total price. | | ||
| | **guestInfo** | **object** | An object containing guest details. | | ||
| | **createdAt** | **string** | The creation date of the booking. | | ||
| | **cancellationPolicies** | **object** | An object containing cancellation policies information. | ||
| | **cancelPolicyInfos** | **Object** | An array of cancellation policy info objects containing information about cancellation time, amount, and type. | | ||
| | **hotelRemarks** | **Array** | An array of hotel remarks. | | ||
| | **refundableTag** | **string** | The tag indicating if the rate is refundable or non-refundable. | ||
| | **price** | **number** | The price of the booking. | | ||
| | **msp** | **number** | The MSP (Merchant Service Provider) price. | | ||
| | **commission** | **number** | The commission amount. | | ||
| | **currency** | **string** | The currency of the booking. | | ||
| ### Booking management | ||
| #### Booking list | ||
| The API returns the list of booking Id's for a given guest Id. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchBookingListByGuestId = (guestId: string) => { | ||
| const apiInstance = new liteApi.BookingManagementApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.bookingsGet(guestId, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getBookingList() { | ||
| let guestId = "FrT56hfty"; | ||
| try { | ||
| const data = await this.fetchBookingListByGuestId(guestId); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **guestId** | **string** | The Guest Id of the user | [required] | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An array containing objects with the following properties: | ||
| | Name | Type | Description | | ||
| | ----------- | ------ | ------------------ | | ||
| | **bookingId** | **string** | The booking ID. | | ||
| #### Booking retrieve | ||
| The API returns the status and the details for the a specific booking Id. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| fetchBookingDetailsByBookingId = (bookingId: string) => { | ||
| const apiInstance = new liteApi.BookingManagementApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.bookingsBookingIdGet(bookingId, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async getBookingDetails() { | ||
| let bookingId = "uSQ6Zsc5R"; | ||
| try { | ||
| const data = await this.fetchBookingDetailsByBookingId(bookingId); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **bookingId** | **string** | The Booking Id that needs to be retrieved | [required] | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| An object containing booking information and room details. | ||
| | Name | Type | Description | | ||
| | --------------------- | ------ | -------------------------------- | | ||
| | **bookingId** | **string** | The booking ID. | | ||
| | **clientReference** | **string** | The client reference. | | ||
| | **status** | **string** | The booking status. | | ||
| | **hotelConfirmationCode** | **string** | The hotel confirmation code. | | ||
| | **checkin** | **string** | The check-in date. | | ||
| | **checkout** | **string** | The check-out date. | | ||
| | **hotel** | **object** | An object containing hotel details. | | ||
| | **bookedRooms** | **array** | An array of booked room objects. | | ||
| | **roomType** | **object** | An object containing room type details. | | ||
| | **adults** | **number** | The number of adults. | | ||
| | **children** | **number** | The number of children. | | ||
| | **rate** | **object** | An object containing rate details. | | ||
| | **maxOccupancy** | **number** | The maximum occupancy. | | ||
| | **boardType** | **string** | The board type. | | ||
| | **boardName** | **string** | The board name. | | ||
| | **retailRate** | **object** | An object containing the retail rate information, including total price. | | ||
| | **guestInfo** | **object** | An object containing guest information. | | ||
| | **createdAt** | **string** | The creation date of the booking. | | ||
| | **cancellationPolicies** | **object** | An object containing cancellation policy details. | | ||
| | **cancelPolicyInfos** | **Object** | An array of cancellation policy info objects containing information about cancellation time, amount, and type. | | ||
| | **hotelRemarks** | **Array** | An array of hotel remarks. | | ||
| | **refundableTag** | **string** | The tag indicating if the rate is refundable or non-refundable. | ||
| | **currency** | **string** | The currency code. | | ||
| | **price** | **number** | The price of the booking. | | ||
| #### Booking cancel | ||
| This API is used to request a cancellation of an existing confirmed booking. Cancellation policies and conditions will be used to determine the success of the cancellation. For example a booking with non-refundable (NRFN) tag or a booking with a cancellation policy that was requested past the cancellation date will not be able to cancel the confirmed booking. | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Example :</h4> | ||
| ```js | ||
| cancelationBookingByBookingId = (bookingId: string) => { | ||
| const apiInstance = new liteApi.BookingManagementApi(); | ||
| return new Promise((resolve, reject) => { | ||
| apiInstance.bookingsBookingIdPut(bookingId, (error, data) => { | ||
| if (error) { | ||
| reject(error); | ||
| } else { | ||
| resolve(data.data); | ||
| } | ||
| }); | ||
| }); | ||
| }; | ||
| public async cancelationBooking() { | ||
| let bookingId = "uSQ6Zsc5R"; | ||
| try { | ||
| const data = await this.cancelationBookingByBookingId(bookingId); | ||
| return {data }; | ||
| } catch (error) { | ||
| console.error(error); | ||
| return { error }; | ||
| } | ||
| } | ||
| ``` | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Parameters :</h4> | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **bookingId** | **string** | The unique identifier of the booking you would like to update. | [required] | ||
| * <h4 style="color:#9155fd; font-weight: 800;"> Return type :</h4> | ||
| | Name | Type | Description | | ||
| | ---------------- | ------ | --------------------------- | | ||
| | **bookingId** | **string** | The booking ID. | | ||
| | **status** | **string** | The booking status. | | ||
| | **cancellation_fee** | **number** | The cancellation fee. | | ||
| | **refund_amount** | **number** | The refund amount. | | ||
| | **currency** | **string** | The currency of the booking. | |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by13.56%
161776
- Number of lines in readme file
- increased by428.24%
898
Worsened metrics
- Lines of code
- decreased by-2.76%
1905
No dependency changes