@findhotel/sapi 1.12.0 → 1.12.1

package/README.md

@@ -56,9 +56,9 @@ hotels, hotels\' offers and rooms.
     - [Callbacks](#callbacks-1)
     - [Response](#response-7)
   - [Rooms configuration](#rooms-configuration)
-      - [Examples](#examples)
+    - [Examples](#examples)
   - [How to generate `searchId`?](#how-to-generate-searchid)
-      - [Example](#example)
+    - [Example](#example)
 
 # Release process
 
@@ -68,71 +68,78 @@ releases SAPI SDK uses [Ship.js](https://github.com/algolia/shipjs)
 tool. It gives more control over the process. Ship.js automatically
 creates a PR before publishing every release, so this allows:
 
--   Confirm the next version is correct.
--   Confirm which commits are going to be released and discuss them with
-    colleagues.
--   Edit the automatically generated changelog for clarity &
-    readability.
+- Confirm the next version is correct.
+- Confirm which commits are going to be released and discuss them with
+  colleagues.
+- Edit the automatically generated changelog for clarity &
+  readability.
 
 ## GitHub Token
 
 GitHub token is required for the release process:
 
--   Go to [your GitHub account](https://github.com/settings/tokens/new)
--   Check \"repo(Full control of private repositories)\"
--   Generate/copy the token
--   Add it in your command line like: `GITHUB_TOKEN=xxx`
+- Go to [your GitHub account](https://github.com/settings/tokens/new)
+- Check \"repo(Full control of private repositories)\"
+- Generate/copy the token
+- Add it in your command line like: `GITHUB_TOKEN=xxx`
 
 ## New release
 
 To create and deploy a new release of SAPI SDK please follow the next
 steps:
 
--   Merge your changes. There can be multiple changes in one release
--   Checkout the latest version of the `main` branch
--   In the root directory run `make release` command - this
-    will start the release process
--   Review and confirm (or change) the new release version number
--   After installing dependencies and running deployment scripts a new
-    pull request will be automatically created
--   Review/update `CHANGELOG.md` in the root directory. Write down
-    changes with descriptions using [keep a changelog] guiding
-    principles and commit your changes to the newly created release
-    PR
--   Review the PR/ask SAPI engineer(s) for approval
--   `Squash and merge` the PR. This will trigger automated
-    release process using GitHub actions and after some time the new
-    release will be published to NMP
--   Check if the new version has been published to NPM
+- Merge your changes. There can be multiple changes in one release
+- Checkout the latest version of the `main` branch
+- In the root directory run `make release` command - this
+  will start the release process
+- Review and confirm (or change) the new release version number
+- After installing dependencies and running deployment scripts a new
+  pull request will be automatically created
+- Review/update `CHANGELOG.md` in the root directory. Write down
+  changes with descriptions using [keep a changelog] guiding
+  principles and commit your changes to the newly created release
+  PR
+- Review the PR/ask SAPI engineer(s) for approval
+- `Squash and merge` the PR. This will trigger automated
+  release process using GitHub actions and after some time the new
+  release will be published to NMP
+- Check if the new version has been published to NPM
 
 [keep a changelog]: https://keepachangelog.com/
 
 ## New release from a development branch
 
 Sometimes You might want to test your changes on the website for example on the local or custom/test environment before merging your branch to main and before making a new SAPI SDK release. To do so You can create and publish a pre-release.
-Pre-release publishes a new version to NPM with a tag other than `latest` (the default tag). 
+Pre-release publishes a new version to NPM with a tag other than `latest` (the default tag).
 To publish a pre-release please follow the next steps:
+
 - commit your changes to your development branch
 - build SAPI SDK from the root of the project:
   ```sh
   make core-build
   ```
 - create a new version `npm version prepatch (preminor, premajor) --preid=beta (alpha, beta, etc...)`:
+
   ```sh
   npm version prepatch --preid=beta
   ```
+
   this would result in something like this `1.4.1-beta.0`
+
   - If you’ve already released a pre-release and want to increment the pre-release part of the version only, run:
 
     ```sh
     npm version prerelease
     ```
+
     this would result in something like this `1.4.1-beta.1`
+
 - publish your changes with a tag other than `latest`:
 
   ```sh
   npm publish --tag=next
   ```
+
 - after the new version is published to npm, install it to your local environment specifying the new version:
 
   ```sh
@@ -153,20 +160,20 @@ npm install @findhotel/sapi
 Then, import SAPI into your project:
 
 ```js
-import sapi from '@findhotel/sapi'
+import sapi from "@findhotel/sapi";
 ```
 
 Create SAPI client:
 
 ```js
-const profileKey = 'profile-key'
+const profileKey = "profile-key";
 
 const sapiClient = await sapi(profileKey, {
-  anonymousId: 'fd9dbb5f-b337-4dd7-b640-1f177d1d3caa',
-  language: 'en',
-  currency: 'USD',
-  countryCode: 'US'
-})
+  anonymousId: "fd9dbb5f-b337-4dd7-b640-1f177d1d3caa",
+  language: "en",
+  currency: "USD",
+  countryCode: "US",
+});
 ```
 
 Now SAPI client is ready to be used in your application.
@@ -188,64 +195,67 @@ found [here](https://www.npmjs.com/package/react-native-get-random-values)
 ## Usage
 
 ### Search
+
 <a id="tutorial-hotels-search"></a>
 
 Search for the hotels and hotels\' offers:
 
 ```js
 const searchParameters = {
-  placeId: '47319',
-  checkIn: '2021-10-10',
-  checkOut: '2021-10-11',
-  rooms: '2'
-}
+  placeId: "47319",
+  checkIn: "2021-10-10",
+  checkOut: "2021-10-11",
+  rooms: "2",
+};
 
-const callbacks =  {
+const callbacks = {
   onStart: (response) => {
-    log('Search started', response)
+    log("Search started", response);
   },
   onAnchorReceived: (response) => {
-    log('Anchor received', response)
+    log("Anchor received", response);
   },
   onHotelsReceived: (response) => {
-    log('Hotels received', response)
+    log("Hotels received", response);
   },
   onOffersReceived: (response) => {
-    log('Offers received', response)
+    log("Offers received", response);
   },
   onComplete: (response) => {
-    log('Search completed', response)
-  }
-}
+    log("Search completed", response);
+  },
+};
 
-const search = await sapiClient.search(searchParameters, callbacks)
+const search = await sapiClient.search(searchParameters, callbacks);
 ```
 
 For full documentation, check [search method api](#search-method).
 
 ### Get hotel\'s rooms offers
+
 <a id="tutorial-get-rooms"></a>
 
 Get rooms data and rooms\' offers:
 
 ```js
 const rooms = await sapiClient.rooms({
-  hotelId: '47319',
-  checkIn: '2021-10-10',
-  checkOut: '2021-10-11',
-  rooms: '2'
-})
+  hotelId: "47319",
+  checkIn: "2021-10-10",
+  checkOut: "2021-10-11",
+  rooms: "2",
+});
 ```
 
 For full documentation, check [rooms method api](#rooms-method).
 
 ### Get hotel
+
 <a id="tutorial-get-hotel"></a>
 
 Get hotel by id:
 
 ```js
-const hotel = await sapiClient.hotel('1196472')
+const hotel = await sapiClient.hotel("1196472");
 ```
 
 For full documentation, check [hotel method api](#hotel-method).
@@ -255,7 +265,7 @@ For full documentation, check [hotel method api](#hotel-method).
 Get hotels by ids:
 
 ```js
-const hotels = await sapiClient.hotels(['1714808','1380416','1710829'])
+const hotels = await sapiClient.hotels(["1714808", "1380416", "1710829"]);
 ```
 
 For full documentation, check [hotels method api](#hotels-method).
@@ -266,22 +276,22 @@ Get offers for a single hotel:
 
 ```js
 const parameters = {
-  hotelId: '1196472'
-}
+  hotelId: "1196472",
+};
 
 const callbacks = {
-   onStart: (response) => {
-    log('Offers started', response)
+  onStart: (response) => {
+    log("Offers started", response);
   },
   onOffersReceived: (response) => {
-    log('Offers received', response)
+    log("Offers received", response);
   },
   onComplete: (response) => {
-    log('Offers completed', response)
-  }
-}
+    log("Offers completed", response);
+  },
+};
 
-const offers = await sapiClient.offers(parameters, callbacks)
+const offers = await sapiClient.offers(parameters, callbacks);
 ```
 
 For full documentation, check [offers method api](#offers-method).
@@ -292,26 +302,26 @@ Get hotel(s) availability:
 
 ```js
 const parameters = {
-  hotelIds: ['1380416','1359951'],
-  startDate: '2023-08-05',
-  endDate: '2023-08-12',
+  hotelIds: ["1380416", "1359951"],
+  startDate: "2023-08-05",
+  endDate: "2023-08-12",
   nights: 2,
-  rooms: '2',
-}
+  rooms: "2",
+};
 
 const callbacks = {
   onStart: (response) => {
-    log('Availability request started', response)
+    log("Availability request started", response);
   },
   onAvailabilityReceived: (response) => {
-    log('Availability received', response)
+    log("Availability received", response);
   },
   onComplete: (response) => {
-    log('Availability completed', response)
-  }
-}
+    log("Availability completed", response);
+  },
+};
 
-const response = await sapiClient.hotelAvailability(parameters, callbacks)
+const response = await sapiClient.hotelAvailability(parameters, callbacks);
 ```
 
 For full documentation, check [availability method api](#hotel-availability-method).
@@ -319,22 +329,22 @@ For full documentation, check [availability method api](#hotel-availability-meth
 # API Reference
 
 ## SAPI client
+
 <a id="sapi-client"></a>
 
 Create SAPI client:
 
 ```js
-const profileKey = 'profile-key'
+const profileKey = "profile-key";
 
 const sapiClient = await sapi(profileKey, {
-  anonymousId: 'fd9dbb5f-b337-4dd7-b640-1f177d1d3caa',
-  language: 'en',
-  currency: 'USD',
-  countryCode: 'US',
-  deviceType: 'mobile',
+  anonymousId: "fd9dbb5f-b337-4dd7-b640-1f177d1d3caa",
+  language: "en",
+  currency: "USD",
+  countryCode: "US",
+  deviceType: "mobile",
   pageSize: 20,
-  initWithAppConfig: {
-  },
+  initWithAppConfig: {},
   algoliaClientOptions: {
     timeouts: {
       connect: 1, // Connection timeout in seconds
@@ -344,24 +354,25 @@ const sapiClient = await sapi(profileKey, {
   },
   callbacks: {
     onConfigReceived: (config) => {
-      log('Config received', config)
-    }
+      log("Config received", config);
+    },
   },
   getTotalRate: (rate) => {
-    let totalRate = rate.base
-    if (includeTaxes) totalRate += rate.taxes
-    if (includeHotelFees) totalRate += rate.hotelFees
+    let totalRate = rate.base;
+    if (includeTaxes) totalRate += rate.taxes;
+    if (includeHotelFees) totalRate += rate.hotelFees;
 
-    return totalRate
-  }
-})
+    return totalRate;
+  },
+});
 ```
 
 ### Supported options
+
 <a id="client-options"></a>
 
 | name                   | required | type                     | default                             | description                                                                                                                   | example                                          |
-|------------------------|----------|--------------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
+| ---------------------- | -------- | ------------------------ | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
 | `anonymousId`          | yes      | `string`                 |                                     | Unique ID identifying users                                                                                                   | `2d360284-577b-4a53-8b91-68f72b9227fa`           |
 | `language`             | no       | `string`                 | `en`                                | 2-char language code                                                                                                          | `en`                                             |
 | `currency`             | no       | `string`                 | `USD`                               | 3-char uppercased ISO currency code                                                                                           | `USD`                                            |
@@ -375,6 +386,7 @@ const sapiClient = await sapi(profileKey, {
 | `getTotalRate`         | no       | `function`               | Total rate including taxes and fees | Function to calculate total display rate based on tax display logic. Used for price filter and sort by price functionalities. |                                                  |
 
 ### Available client callbacks
+
 <a id="client-callbacks"></a>
 
 1.  onConfigReceived(configs)
@@ -382,6 +394,7 @@ const sapiClient = await sapi(profileKey, {
     Returns configuration settings that are used by sapiClient.
 
 ### Response
+
 <a id="config-response"></a>
 
 ```json
@@ -411,22 +424,24 @@ const sapiClient = await sapi(profileKey, {
 ```
 
 ## `search()` method
+
 <a id="search-method"></a>
 
 Search is a method of **sapiClient** for searching hotels and offers for
 provided `searchParameters`:
 
 ```js
-const search = await sapiClient.search(searchParameters, callbacks)
+const search = await sapiClient.search(searchParameters, callbacks);
 ```
 
 ### Search parameters
+
 <a id="search-parameters"></a>
 
 All parameters are optional.
 
 | name                  | type                                            | description                                                                                                                                                                      | example                                                             |
-|-----------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
+| --------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
 | `hotelId`             | `string`                                        | Hotel Id for hotel search                                                                                                                                                        | `1371626`                                                           |
 | `placeId`             | `string`                                        | Place Id for place search                                                                                                                                                        | `47319`                                                             |
 | `geolocation`         | `{lat: number, lon: number, precision: string}` | Geolocation query                                                                                                                                                                | `{lat: 36.114303, lon: -115.178312}`                                |
@@ -456,6 +471,7 @@ All parameters are optional.
 | `sbc`                 | `string`                                        | [Split Booking Configuration](#splitbookingconfiguration). If present, searches for split booking offers                                                                         | `sbc: '2~3'`                                                        |
 
 #### Split Booking Configuration
+
 <a id="splitbookingconfiguration"></a>
 The format for the split booking configuration is as follows:
 
@@ -470,7 +486,7 @@ for example if we have these parameters:
 
 `checkOut:'2023-08-15'`
 
-`sbc:2~3` 
+`sbc:2~3`
 
 The first part of the split booking will be 2 nights and the second part will be 3 nights.
 So, SAPI searches for two stays:
@@ -479,13 +495,12 @@ split1: `checkIn: '2023-08-10'` `checkOut: '2023-08-12'`
 
 split2: `checkIn: '2023-08-12'` `checkOut: '2023-08-15'`
 
-
-
 #### Filters
+
 <a id="search-filters"></a>
 
 | name               | type       | description                                                                                        | example                        | filter scope |
-|--------------------|------------|----------------------------------------------------------------------------------------------------|--------------------------------|--------------|
+| ------------------ | ---------- | -------------------------------------------------------------------------------------------------- | ------------------------------ | ------------ |
 | `themeIds`         | `number[]` | Facet filtering by theme ids                                                                       | `[1, 2, 3]`                    | Hotel        |
 | `chainIds`         | `number[]` | Hotels' chain ids                                                                                  | `[4, 5]`                       | Hotel        |
 | `facilities`       | `string[]` | Facility ids used for facet filtering                                                              | `[299,7,6,21]`                 | Hotel        |
@@ -503,10 +518,11 @@ split2: `checkIn: '2023-08-12'` `checkOut: '2023-08-15'`
 | `isVr`             | `boolean`  | If true, then only vacation rentals are returned. If false, then vacation rentals are filtered out | `true`                         | Hotel        |
 
 ##### Facilities
+
 Some of the favourite facilities used for filtering:
 
 | name              | id  |
-|-------------------|-----|
+| ----------------- | --- |
 | `free_wifi`       | 299 |
 | `swimming_pool`   | 7   |
 | `restaurant`      | 5   |
@@ -518,22 +534,23 @@ Some of the favourite facilities used for filtering:
 | `air_conditioned` | 21  |
 
 ##### Property types
-Some of the property types used for filtering:
 
-| name        | id |
-|-------------|----|
-| `hotel`     | 0  |
-| `apartment` | 9  |
-| `hostel`    | 5  |
-| `motel`     | 1  |
+Some of the property types used for filtering:
 
+| name        | id  |
+| ----------- | --- |
+| `hotel`     | 0   |
+| `apartment` | 9   |
+| `hostel`    | 5   |
+| `motel`     | 1   |
 
 ##### Amenities
+
 <a id="filters-amenities"></a>
 Supported amenities:
 
 | name           | description                                                                          |
-|----------------|--------------------------------------------------------------------------------------|
+| -------------- | ------------------------------------------------------------------------------------ |
 | `breakfast`    |                                                                                      |
 | `lunch`        |                                                                                      |
 | `dinner`       |                                                                                      |
@@ -541,30 +558,30 @@ Supported amenities:
 | `fullBoard`    | "breakfast && lunch && dinner", or the hotel’s explicit use of the term "full-board" |
 | `allInclusive` | "all meals && all drinks" or the hotel’s explicit use of the term "all-inclusive"    |
 
-
 ### Callbacks
+
 <a id="search-callbacks"></a>
 
 Search method receives callbacks object as the second argument:
 
 ```js
-const callbacks =  {
+const callbacks = {
   onStart: (response) => {
-    log('Search started', response)
+    log("Search started", response);
   },
   onAnchorReceived: (response) => {
-    log('Anchor received', response)
+    log("Anchor received", response);
   },
   onHotelsReceived: (response) => {
-    log('Hotels received', response)
+    log("Hotels received", response);
   },
   onOffersReceived: (response) => {
-    log('Offers received', response)
+    log("Offers received", response);
   },
   onComplete: (response) => {
-    log('Search completed', response)
-  }
-}
+    log("Search completed", response);
+  },
+};
 ```
 
 Each callback returns the full search state available inside SAPI at the
@@ -616,6 +633,7 @@ the state can be repeated between different callbacks.
     The offers response with the detailed description can be found in the [Offers Response](./docs/offers.md)
 
 ### Response
+
 <a id="search-response"></a>
 
 The complete SAPI search response is too big to be displayed on the page
@@ -633,19 +651,24 @@ so there is a simplified example:
     "pageSize": 26,
     "placeDisplayName": "Bedrijventerrein Sloterdijk, Amsterdam",
     "priceBucketWidth": 19,
-    "_geoloc": {"lat": 52.388326, "lon": 4.837264, "precision": 5000, "radius": 20000}
+    "_geoloc": {
+      "lat": 52.388326,
+      "lon": 4.837264,
+      "precision": 5000,
+      "radius": 20000
+    }
   },
   "anchorHotelId": "1714808",
   "anchorType": "hotel",
   "facets": {
-    "facilities": {"1": 212, "2": 348, "3": 116},
-    "pricing.medianRateBkt": {"3": 4, "4": 12, "5": 19},
-    "pricing.medianRateMoFrBkt": {"3": 4, "4": 6, "5": 8, "6": 9},
-    "pricing.medianRateSaSuBkt": {"2": 2, "3": 4, "4": 6, "5": 10},
-    "pricing.minRateBkt": {"2": 22, "3": 38, "4": 46, "5": 98},
-    "propertyTypeId": {"0": 1030, "2": 6, "3": 601, "4": 86},
-    "starRating": {"1": 351, "2": 313, "3": 596, "4": 441, "5": 86},
-    "themeIds": {"1": 9, "2": 1373, "3": 143, "5": 1092, "8": 119}
+    "facilities": { "1": 212, "2": 348, "3": 116 },
+    "pricing.medianRateBkt": { "3": 4, "4": 12, "5": 19 },
+    "pricing.medianRateMoFrBkt": { "3": 4, "4": 6, "5": 8, "6": 9 },
+    "pricing.medianRateSaSuBkt": { "2": 2, "3": 4, "4": 6, "5": 10 },
+    "pricing.minRateBkt": { "2": 22, "3": 38, "4": 46, "5": 98 },
+    "propertyTypeId": { "0": 1030, "2": 6, "3": 601, "4": 86 },
+    "starRating": { "1": 351, "2": 313, "3": 596, "4": 441, "5": 86 },
+    "themeIds": { "1": 9, "2": 1373, "3": 143, "5": 1092, "8": 119 }
   },
   "hotelEntities": {
     "1041597": {
@@ -655,16 +678,39 @@ so there is a simplified example:
       "country": "NL",
       "displayAddress": "Stationsplein 49, Burgwallen-Nieuwe Zijde, Amsterdam, The Netherlands",
       "facilities": [1, 2, 5, 8, 9, 11],
-      "guestRating": {"cleanliness": 7.94, "dining": 7.51, "facilities": 7.54, "location": 8.09, "overall": 7.83, "service": 8.8},
-      "guestType": {"business": 793, "couples": 2558, "families": 1145, "groups": 1276, "solo": 398},
+      "guestRating": {
+        "cleanliness": 7.94,
+        "dining": 7.51,
+        "facilities": 7.54,
+        "location": 8.09,
+        "overall": 7.83,
+        "service": 8.8
+      },
+      "guestType": {
+        "business": 793,
+        "couples": 2558,
+        "families": 1145,
+        "groups": 1276,
+        "solo": 398
+      },
       "hotelName": "ibis Amsterdam Centre",
-      "imageURIs": ["https://i.travelapi.com/hotels/1000000/30000/25600/25525/c2387aed_w.jpg"],
+      "imageURIs": [
+        "https://i.travelapi.com/hotels/1000000/30000/25600/25525/c2387aed_w.jpg"
+      ],
       "isDeleted": false,
       "lastBooked": 1658320362,
       "objectID": "1041597",
       "parentChainID": "10",
       "placeDisplayName": "Burgwallen-Nieuwe Zijde, Amsterdam",
-      "pricing": {"medianRateBkt": 12, "medianRateMoFrBkt": 13, "medianRateSaSuBkt": 11, "minRate": 116, "minRateBkt": 75, "minRateBkt": 5, "priced": 1},
+      "pricing": {
+        "medianRateBkt": 12,
+        "medianRateMoFrBkt": 13,
+        "medianRateSaSuBkt": 11,
+        "minRate": 116,
+        "minRateBkt": 75,
+        "minRateBkt": 5,
+        "priced": 1
+      },
       "propertyTypeId": 0,
       "regularPriceRange": [224, 243],
       "reviewCount": 5766,
@@ -672,7 +718,7 @@ so there is a simplified example:
       "starRating": 3,
       "tags": ["b220918-1"],
       "themeIds": [2, 5, 12],
-      "_geoloc": {"lat": 52.37947, "lon": 4.89699}
+      "_geoloc": { "lat": 52.37947, "lon": 4.89699 }
     }
   },
   "hotelIds": ["1840170", "2766940", "3310443", "3035769"],
@@ -701,15 +747,11 @@ so there is a simplified example:
           "intermediaryProvider": "BKS",
           "roomName": "Standard Twin Room",
           "package": {
-            "amenities": [
-              "breakfast"
-            ],
+            "amenities": ["breakfast"],
             "canPayLater": false
           },
           "cancellationPenalties": [],
-          "tags": [
-            "top_offer"
-          ],
+          "tags": ["top_offer"],
           "metadata": {
             "feedID": ""
           }
@@ -742,37 +784,45 @@ so there is a simplified example:
 ```
 
 ### Load more results and load more offers for a hotel
+
 After the search is complete:
+
 ```js
-const search = await sapiClient.search(searchParameters, callbacks)
+const search = await sapiClient.search(searchParameters, callbacks);
 ```
+
 it resolves in the `search` object which has 2 methods:
+
 - `search.loadMore()` - SDK will return the next set of results ("next" page) for the given search. The same [callbacks](#search-callbacks) from original search will be used.
 - `search.loadOffers(hotelId, {filters, offersSort})` - will load all offers (up to 23) for the provided `hotelId`. You can also override [offers' scope filters](#filters) and [offers' sort order](#sort-offers).
 
 ## `suggest()` method
+
 <a id="suggest-method"></a>
 
 Suggest provides autosuggestions for a given query
 
 ```js
-const suggestions = await sapiClient.suggest('London', 6)
+const suggestions = await sapiClient.suggest("London", 6);
 ```
 
 ### Suggest parameters
+
 <a id="suggest-parameters"></a>
 
 | name            | type     | description                               | required | example  |
-|-----------------|----------|-------------------------------------------|----------|----------|
+| --------------- | -------- | ----------------------------------------- | -------- | -------- |
 | `query`         | `string` | Query string                              | yes      | `London` |
 | `suggestsCount` | `number` | Desired number of suggestions (default 6) | no       | `10`     |
 
 ### Response
+
 <a id="suggest-response"></a>
 
 ```js
-const suggestions = await sapiClient.suggest('London', 2)
+const suggestions = await sapiClient.suggest("London", 2);
 ```
+
 ```json
 [
   {
@@ -793,9 +843,11 @@ const suggestions = await sapiClient.suggest('London', 2)
   }
 ]
 ```
+
 ```js
-const suggestions = await sapiClient.suggest('London hotel', 2)
+const suggestions = await sapiClient.suggest("London hotel", 2);
 ```
+
 ```json
 [
   {
@@ -817,8 +869,8 @@ const suggestions = await sapiClient.suggest('London hotel', 2)
 ]
 ```
 
-
 ## `rooms()` method
+
 <a id="rooms-method"></a>
 
 Rooms is a method of **sapiClient** for retrieving rooms information and
@@ -826,18 +878,19 @@ offers for a particular itinerary:
 
 ```js
 const rooms = await sapiClient.rooms({
-  hotelId: '1714808',
-  checkIn: '2021-10-10',
-  checkOut: '2021-10-11',
-  rooms: '2'
-})
+  hotelId: "1714808",
+  checkIn: "2021-10-10",
+  checkOut: "2021-10-11",
+  rooms: "2",
+});
 ```
 
 ### Rooms parameters
+
 <a id="rooms-parameters"></a>
 
 | name                    | type                     | description                                                                    | required | example                                           |
-|-------------------------|--------------------------|--------------------------------------------------------------------------------|----------|---------------------------------------------------|
+| ----------------------- | ------------------------ | ------------------------------------------------------------------------------ | -------- | ------------------------------------------------- |
 | `hotelId`               | `string`                 | Hotel Id to retrieve rooms                                                     | yes      | `1714808`                                         |
 | `checkIn`               | `string`                 | Check in date (`YYYY-MM-DD`)                                                   | yes      | `2021-10-10`                                      |
 | `checkOut`              | `string`                 | Check out date (`YYYY-MM-DD`)                                                  | yes      | `2021-10-11`                                      |
@@ -856,8 +909,10 @@ const rooms = await sapiClient.rooms({
 | `deviceId`              | `string`                 | Device ID (the IDFV of an iOS device or the GAID of an Android device)         | no       |                                                   |
 | `searchId`              | `string`                 | SearchId override (SDK generates a new one if no provided)                     | no       | `08230dfcc5f0fb95caaa82ce559ea60c4a975d6f`        |
 | `metadata`              | `Record<string, string>` | Additional data to be passed to API                                            | no       | `{vclid: '21d2d152-de19-4f39-b40a-d4bc3002c6e8'}` |
+| `bundleId`              | `string`                 | Bundle Id clicked on SRP. Used to fetch bundle data from cache                 | no       | `13b5d152-de19-4f39-b40a-d4bc3002c3u9`            |
 
 ### Response
+
 <a id="rooms-response"></a>
 
 ```json
@@ -871,7 +926,7 @@ const rooms = await sapiClient.rooms({
       "bedTypes": [],
       "description": "20 sqm room Continental breakfast included Free WiFi LCD TV Spacious work desk Choice of pillows Coffee and tea facilities Large walk-in power shower",
       "id": "K0LnAe-G9WI",
-      "images": [{"url": "http://images.getaroom-cdn.com/image/...."}],
+      "images": [{ "url": "http://images.getaroom-cdn.com/image/...." }],
       "masterId": "9643931",
       "name": "1 Double Standard",
       "offers": [
@@ -881,17 +936,21 @@ const rooms = await sapiClient.rooms({
           "cancellationPenalties": [],
           "cug": ["signed_in"],
           "id": "o0KDe_mFPN4k",
-          "links": [{
-            "href": "https://secure.findhotel.net/checkout/?hotelID=1714808...",
-            "method": "GET",
-            "type": "checkout"
-          }],
-          "prices": [{
-            "chargeable": {"base": "1352.77", "taxes": "59.94"},
-            "currencyCode": "EUR",
-            "hotelFees": {"breakdown": [], "total": "0"},
-            "type": "chargeable_currency"
-          }],
+          "links": [
+            {
+              "href": "https://secure.findhotel.net/checkout/?hotelID=1714808...",
+              "method": "GET",
+              "type": "checkout"
+            }
+          ],
+          "prices": [
+            {
+              "chargeable": { "base": "1352.77", "taxes": "59.94" },
+              "currencyCode": "EUR",
+              "hotelFees": { "breakdown": [], "total": "0" },
+              "type": "chargeable_currency"
+            }
+          ],
           "providerCode": "GAR",
           "providerRateType": "public",
           "services": ["breakfast"]
@@ -902,24 +961,26 @@ const rooms = await sapiClient.rooms({
 }
 ```
 
-
 ## `hotel()` method
+
 <a id="hotel-method"></a>
 
 Hotel is a method of **sapiClient** for retrieving a single hotel by id
 
 ```js
-const hotel = await sapiClient.hotel('1196472')
+const hotel = await sapiClient.hotel("1196472");
 ```
 
 ### Hotel parameters
+
 <a id="hotel-parameters"></a>
 
 | name      | type     | description | required | example   |
-|-----------|----------|-------------|----------|-----------|
+| --------- | -------- | ----------- | -------- | --------- |
 | `hotelId` | `string` | Hotel Id    | yes      | `1196472` |
 
 ### Response
+
 <a id="hotel-response"></a>
 
 An example of the response for request with `hotelId` 1196472
@@ -963,7 +1024,8 @@ and \"pt-BR\" `language`
   "feesMnd": "<p>Você deverá pagar os seguintes encargos no estabelecimento:</p> <ul><li>Depósito: EUR 50 por noite</li><li>A cidade cobra um imposto de EUR 3.00 por pessoa, por noite até 21 noites. Esse imposto não se aplica a crianças de até 16 anos. </li><li>Será cobrado um imposto municipal/local de 6.422 %</li></ul> <p>Incluímos todas as cobranças que o estabelecimento nos forneceu. No entanto, as cobranças podem variar com base, por exemplo, na duração da estadia ou no tipo de quarto reservado. </p>",
   "reviewCountBkt": 9,
   "hotelName": "Movenpick Hotel Amsterdam City Centre",
-  "sentiments": [{
+  "sentiments": [
+    {
       "value": "Gostou do bar",
       "id": 46
     },
@@ -972,7 +1034,8 @@ and \"pt-BR\" `language`
       "id": 180
     }
   ],
-  "facilities": [{
+  "facilities": [
+    {
       "categoryID": 4,
       "importance": 2,
       "value": "Centro de Negócios",
@@ -993,7 +1056,8 @@ and \"pt-BR\" `language`
     "groups": 1121,
     "solo": 206
   },
-  "themes": [{
+  "themes": [
+    {
       "value": "Cidade",
       "id": 2
     },
@@ -1012,22 +1076,25 @@ and \"pt-BR\" `language`
 ```
 
 ## `hotels()` method
+
 <a id="hotels-method"></a>
 
 Hotel is a method of **sapiClient** for retrieving multiple hotels by hotel ids
 
 ```js
-const hotels = await sapiClient.hotels(['1714808','1380416','1710829'])
+const hotels = await sapiClient.hotels(["1714808", "1380416", "1710829"]);
 ```
 
 ### Hotels parameters
+
 <a id="hotels-parameters"></a>
 
 | name       | type       | description | required | example                           |
-|------------|------------|-------------|----------|-----------------------------------|
+| ---------- | ---------- | ----------- | -------- | --------------------------------- |
 | `hotelIds` | `string[]` | Hotel Ids   | yes      | `['1714808','1380416','1710829']` |
 
 ### Response
+
 <a id="hotel-response"></a>
 
 An example of the response for request with `hotelId` 1196472
@@ -1072,7 +1139,8 @@ and \"pt-BR\" `language`
     "feesMnd": "<p>Você deverá pagar os seguintes encargos no estabelecimento:</p> <ul><li>Depósito: EUR 50 por noite</li><li>A cidade cobra um imposto de EUR 3.00 por pessoa, por noite até 21 noites. Esse imposto não se aplica a crianças de até 16 anos. </li><li>Será cobrado um imposto municipal/local de 6.422 %</li></ul> <p>Incluímos todas as cobranças que o estabelecimento nos forneceu. No entanto, as cobranças podem variar com base, por exemplo, na duração da estadia ou no tipo de quarto reservado. </p>",
     "reviewCountBkt": 9,
     "hotelName": "Movenpick Hotel Amsterdam City Centre",
-    "sentiments": [{
+    "sentiments": [
+      {
         "value": "Gostou do bar",
         "id": 46
       },
@@ -1081,7 +1149,8 @@ and \"pt-BR\" `language`
         "id": 180
       }
     ],
-    "facilities": [{
+    "facilities": [
+      {
         "categoryID": 4,
         "importance": 2,
         "value": "Centro de Negócios",
@@ -1102,7 +1171,8 @@ and \"pt-BR\" `language`
       "groups": 1121,
       "solo": 206
     },
-    "themes": [{
+    "themes": [
+      {
         "value": "Cidade",
         "id": 2
       },
@@ -1122,38 +1192,40 @@ and \"pt-BR\" `language`
 ```
 
 ## `offers()` method
+
 <a id="offers-method"></a>
 
 Retrieves offers for a single hotel by provided parameters
 
 ```js
 const parameters = {
-  hotelId: '1196472',
-  checkIn: '2022-10-10',
-  checkOut: '2022-10-11',
-  rooms: '2'
-}
+  hotelId: "1196472",
+  checkIn: "2022-10-10",
+  checkOut: "2022-10-11",
+  rooms: "2",
+};
 
 const callbacks = {
-   onStart: (response) => {
-    log('Offers started', response)
+  onStart: (response) => {
+    log("Offers started", response);
   },
   onOffersReceived: (response) => {
-    log('Offers received', response)
+    log("Offers received", response);
   },
   onComplete: (response) => {
-    log('Offers completed', response)
-  }
-}
+    log("Offers completed", response);
+  },
+};
 
-const offers = await sapiClient.offers(parameters, callbacks)
+const offers = await sapiClient.offers(parameters, callbacks);
 ```
 
 ### Offers parameters
+
 <a id="offers-parameters"></a>
 
 | name                  | type                     | description                                                                                                                                                                      | required | example                                    |
-|-----------------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------------------------------------|
+| --------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------ |
 | `hotelId`             | `string`                 | Hotel Id                                                                                                                                                                         | yes      | `1196472`                                  |
 | `checkIn`             | `string`                 | Check in date (YYYY-MM-DD) (SDK generates default date if no provided)                                                                                                           | no       | `2022-10-10`                               |
 | `checkOut`            | `string`                 | Check out date (YYYY-MM-DD)) (SDK generates default date if no provided)                                                                                                         | no       | `2022-10-11`                               |
@@ -1177,6 +1249,7 @@ const offers = await sapiClient.offers(parameters, callbacks)
 
 <a id="sort-offers"></a>
 Offer sorting by one parameter for now. It is `price`, but there are different variants of sorting by price.:
+
 - **price:base_asc** - sort offers by base price ascending
 - **price:total_asc** - sort offers by total rate breakdown ascending
 - **price:with_tax_asc** - sort offers by base rate with tax ascending
@@ -1188,17 +1261,17 @@ It overwrites OSO sorting and sorting boost as well. If offersSort parameter is
 Object with callbacks:
 
 ```js
-const callbacks =  {
+const callbacks = {
   onStart: (response) => {
-    log('Offers started', response)
+    log("Offers started", response);
   },
   onOffersReceived: (response) => {
-    log('Offers received', response)
+    log("Offers received", response);
   },
   onComplete: (response) => {
-    log('Offers completed', response)
-  }
-}
+    log("Offers completed", response);
+  },
+};
 ```
 
 1.  ### onStart()
@@ -1217,56 +1290,58 @@ const callbacks =  {
     Returns hotel\'s offers (complete response).
 
 ### Response
+
 <a id="offers-response"></a>
 
 An example of the response for request parameters:
 
 ```js
 const parameters = {
-  hotelId: '1926746',
-  checkIn: '2022-07-10',
-  checkOut: '2022-07-11',
-  rooms: '2'
-}
+  hotelId: "1926746",
+  checkIn: "2022-07-10",
+  checkOut: "2022-07-11",
+  rooms: "2",
+};
 ```
 
 The response with the detailed description can be found in the [Offers Response](./docs/offers.md)
 
-
 ## `hotelAvailability()` method
+
 <a id="hotel-availability-method"></a>
 
 Returns availability of the provided hotels for different dates (aka price calendar)
 
 ```js
 const parameters = {
-  hotelIds: ['1380416','1359951'],
-  startDate: '2023-08-05',
-  endDate: '2023-08-12',
+  hotelIds: ["1380416", "1359951"],
+  startDate: "2023-08-05",
+  endDate: "2023-08-12",
   nights: 2,
-  rooms: '2',
-}
+  rooms: "2",
+};
 
 const callbacks = {
   onStart: (response) => {
-    log('Availability request started', response)
+    log("Availability request started", response);
   },
   onAvailabilityReceived: (response) => {
-    log('Availability received', response)
+    log("Availability received", response);
   },
   onComplete: (response) => {
-    log('Availability completed', response)
-  }
-}
+    log("Availability completed", response);
+  },
+};
 
-const response = await sapiClient.hotelAvailability(parameters, callbacks)
+const response = await sapiClient.hotelAvailability(parameters, callbacks);
 ```
 
 ### Hotel(s) availability search parameters
+
 <a id="availability-search-parameters"></a>
 
 | name        | type               | description                                                                                  | required | example                    |
-|-------------|--------------------|----------------------------------------------------------------------------------------------|----------|----------------------------|
+| ----------- | ------------------ | -------------------------------------------------------------------------------------------- | -------- | -------------------------- |
 | `hotelIds`  | `string, string[]` | Hotel id(s) to retrieve offers for                                                           | yes      | `['1380416','1359951']`    |
 | `startDate` | `string`           | Date of first check in (YYYY-MM-DD)                                                          | yes      | `'2023-10-10'`             |
 | `endDate`   | `string`           | Date of last check in (including). Can't be further than 61 days from StartDate (YYYY-MM-DD) | yes      | `'2023-10-11'`             |
@@ -1277,22 +1352,23 @@ const response = await sapiClient.hotelAvailability(parameters, callbacks)
 | `originId`  | `string`           | Identifier of origin where the request was originated                                        | no       | `'c3po6twr70'`             |
 
 ### Callbacks
+
 <a id="availability-callbacks"></a>
 
 Object with callbacks:
 
 ```js
-const callbacks =  {
+const callbacks = {
   onStart: (response) => {
-    log('Availability request started', response)
+    log("Availability request started", response);
   },
   onAvailabilityReceived: (response) => {
-    log('Availability received', response)
+    log("Availability received", response);
   },
   onComplete: (response) => {
-    log('Availability completed', response)
-  }
-}
+    log("Availability completed", response);
+  },
+};
 ```
 
 1.  ### onStart()
@@ -1311,6 +1387,7 @@ const callbacks =  {
     Returns availability with offers (complete response).
 
 ### Response
+
 <a id="availability-response"></a>
 
 An example of the response:
@@ -1340,9 +1417,7 @@ An example of the response:
           "providerCode": "WTM",
           "intermediaryProvider": "FHT",
           "package": {
-            "amenities": [
-              "breakfast"
-            ],
+            "amenities": ["breakfast"],
             "canPayLater": false
           },
           "cancellationPenalties": [
@@ -1353,16 +1428,13 @@ An example of the response:
               "currency": "EUR"
             }
           ],
-          "tags": [
-            "top_offer",
-            "exclusive_cheapest_offer"
-          ],
+          "tags": ["top_offer", "exclusive_cheapest_offer"],
           "metadata": {
             "providerRateType": "member",
             "feedID": ""
           },
           "roomName": "STANDARD DOUBLE/TWIN"
-        },
+        }
       ]
     },
     "2023-08-06": {
@@ -1382,21 +1454,16 @@ An example of the response:
             "base": 493.9438317757,
             "taxes": 32.2961682243,
             "hotelFees": 0
-        },
+          },
           "accessTier": "sensitive",
           "providerCode": "WTM",
           "intermediaryProvider": "FHT",
           "package": {
-            "amenities": [
-              "breakfast"
-            ],
+            "amenities": ["breakfast"],
             "canPayLater": false
           },
           "cancellationPenalties": [],
-          "tags": [
-            "top_offer",
-            "exclusive_cheapest_offer"
-          ],
+          "tags": ["top_offer", "exclusive_cheapest_offer"],
           "metadata": {
             "providerRateType": "member",
             "feedID": ""
@@ -1410,8 +1477,10 @@ An example of the response:
 ```
 
 ## Rooms configuration
+
 <a id="rooms-configuration"></a>
 `rooms` is a string that encodes the configuration of rooms requested by the user and follows the next rules:
+
 - Rooms are separated by pipe `|`
 - Adults and children are separated by colon `:`
 - Children ages are separated by comma `,`
@@ -1432,15 +1501,15 @@ SAPI SDK exposes a special method `generateSearchId` to generate `searchId` whic
 #### Example
 
 ```js
-import {generateSearchId} from '@findhotel/sapi'
+import { generateSearchId } from "@findhotel/sapi";
 
-const searchId = generateSearchId()
+const searchId = generateSearchId();
 
 const rooms = await sapiClient.rooms({
-  hotelId: '47319',
-  checkIn: '2023-10-10',
-  checkOut: '2023-10-11',
-  rooms: '2',
-  searchId
-})
+  hotelId: "47319",
+  checkIn: "2023-10-10",
+  checkOut: "2023-10-11",
+  rooms: "2",
+  searchId,
+});
 ```