@findhotel/sapi 0.23.9 → 0.23.12

package/README.md

@@ -5,9 +5,10 @@
 2.  [Tutorials](#tutorials)
     1.  [Getting Started](#getting-started)
     2.  [Usage](#usage)
-        1.  [Hotels search](#tutorial-hotels-search)
-        2.  [Get rooms data](#tutorial-get-rooms)
+        1.  [Search](#tutorial-hotels-search)
+        2.  [Get hotel's rooms offers](#tutorial-get-rooms)
         3.  [Get hotel](#tutorial-get-hotel)
+        4.  [Get hotel offers](#tutorial-get-offers)
 3.  [API Reference](#api-reference)
     1.  [SAPI client](#sapi-client)
         1.  [Supported options](#client-options)
@@ -25,6 +26,10 @@
     5.  [`hotel()` method](#hotel-method)
         1.  [Hotel parameters](#hotel-parameters)
         2.  [Response](#hotel-response)
+    6.  [`offers()` method](#offers-method)
+        1.  [Offers parameters](#hotel-parameters)
+        2.  [Callbacks](#offers-callbacks)
+        3.  [Response](#offers-response)
 
 SDK provides a high level TypeScript/JavaScript API for searching
 hotels, hotels' offers and rooms.
@@ -80,7 +85,7 @@ For full documentation and supported options check [client api](#sapi-client).
 
 <a id="tutorial-hotels-search"></a>
 
-### Hotels search
+### Search
 
 Search for the hotels and hotels' offers:
 
@@ -93,19 +98,19 @@ Search for the hotels and hotels' offers:
     
     const callbacks =  {
       onStart: (response) => {
-        console.log('Search started', response)
+        log('Search started', response)
       },
       onAnchorReceived: (response) => {
-        console.log('Anchor received', response)
+        log('Anchor received', response)
       },
       onHotelsReceived: (response) => {
-        console.log('Hotels received', response)
+        log('Hotels received', response)
       },
       onOffersReceived: (response) => {
-        console.log('Offers received', response)
+        log('Offers received', response)
       },
       onComplete: (response) => {
-        console.log('Search completed', response)
+        log('Search completed', response)
       }
     }
     
@@ -116,9 +121,9 @@ For full documentation, check [search method api](#search-method).
 
 <a id="tutorial-get-rooms"></a>
 
-### Get rooms data
+### Get hotel's rooms offers
 
-Get rooms and rooms' offers:
+Get rooms data and rooms' offers:
 
     const rooms = await sapiClient.rooms({
       hotelId: '47319',
@@ -141,6 +146,33 @@ Get hotel by id:
 For full documentation, check [hotel method api](#hotel-method).
 
 
+<a id="tutorial-get-offers"></a>
+
+### Get hotel offers
+
+Get offers for a single hotel:
+
+    const parameters = {
+      hotelId: '1196472'
+    }
+    
+    const callbacks = {
+       onStart: (response) => {
+        log('Offers started', response)
+      },
+      onOffersReceived: (response) => {
+        log('Offers received', response)
+      },
+      onComplete: (response) => {
+        log('Offers completed', response)
+      }
+    }
+    
+    const offers = await sapiClient.offers(parameters, callbacks)
+
+For full documentation, check [offers method api](#offers-method).
+
+
 <a id="api-reference"></a>
 
 # API Reference
@@ -175,7 +207,7 @@ Create SAPI client:
       },
       callbacks: {
         onConfigReceived: (config) => {
-          console.log('Config received', config)
+          log('Config received', config)
         }
       }
     })
@@ -528,19 +560,19 @@ Search method receives callbacks object as the second argument:
 
     const callbacks =  {
       onStart: (response) => {
-        console.log('Search started', response)
+        log('Search started', response)
       },
       onAnchorReceived: (response) => {
-        console.log('Anchor received', response)
+        log('Anchor received', response)
       },
       onHotelsReceived: (response) => {
-        console.log('Hotels received', response)
+        log('Hotels received', response)
       },
       onOffersReceived: (response) => {
-        console.log('Offers received', response)
+        log('Offers received', response)
       },
       onComplete: (response) => {
-        console.log('Search completed', response)
+        log('Search completed', response)
       }
     }
 
@@ -649,20 +681,20 @@ Suggest provides autosuggestions for a given query
     
     [
       {
-        highlightValue: "<em>London</em>",
-        objectID: "158584",
-        objectType: "place",
-        placeDisplayName: "United Kingdom",
-        placeTypeName: "city",
-        value: "London"
+        "highlightValue": "<em>London</em>",
+        "objectID": "158584",
+        "objectType": "place",
+        "placeDisplayName": "United Kingdom",
+        "placeTypeName": "city",
+        "value": "London"
       },
       {
-        highlightValue: "<em>London</em> Heathrow Airport",
-        objectID: "167733",
-        objectType: "place",
-        placeDisplayName: "London, United Kingdom",
-        placeTypeName: "airport",
-        value: "London Heathrow Airport"
+        "highlightValue": "<em>London</em> Heathrow Airport",
+        "objectID": "167733",
+        "objectType": "place",
+        "placeDisplayName": "London, United Kingdom",
+        "placeTypeName": "airport",
+        "value": "London Heathrow Airport"
       }
     ]
     
@@ -670,20 +702,20 @@ Suggest provides autosuggestions for a given query
     
     [
       {
-        highlightValue: "Park Plaza Westminster Bridge <em>London</em>",
-        objectID: "1546646",
-        objectType: "hotel",
-        placeDisplayName: "London, United Kingdom",
-        placeTypeName: "property",
-        value: "Park Plaza Westminster Bridge London"
+        "highlightValue": "Park Plaza Westminster Bridge <em>London</em>",
+        "objectID": "1546646",
+        "objectType": "hotel",
+        "placeDisplayName": "London, United Kingdom",
+        "placeTypeName": "property",
+        "value": "Park Plaza Westminster Bridge London"
       },
       {
-        highlightValue: "Hampton by Hilton <em>London</em> Stansted Airport",
-        objectID: "3333916",
-        objectType: "hotel",
-        placeDisplayName: "United Kingdom",
-        placeTypeName: "property",
-        value: "Hampton by Hilton London Stansted Airport"
+        "highlightValue": "Hampton by Hilton <em>London</em> Stansted Airport",
+        "objectID": "3333916",
+        "objectType": "hotel",
+        "placeDisplayName": "United Kingdom",
+        "placeTypeName": "property",
+        "value": "Hampton by Hilton London Stansted Airport"
       }
     ]
 
@@ -937,3 +969,268 @@ An example of the response for request with `hotelId` 1196472 and "pt-BR" `langu
       "displayAddress": "Piet Heinkade 11, Oostelijk Havengebied, Amsterdã, Holanda"
     }
 
+
+<a id="offers-method"></a>
+
+## `offers()` method
+
+Retrieves offers for a single hotel by provided parameters
+
+    const parameters = {
+      hotelId: '1196472',
+      checkIn: '2022-10-10',
+      checkOut: '2022-10-11',
+      rooms: '2'
+    }
+    
+    const callbacks = {
+       onStart: (response) => {
+        log('Offers started', response)
+      },
+      onOffersReceived: (response) => {
+        log('Offers received', response)
+      },
+      onComplete: (response) => {
+        log('Offers completed', response)
+      }
+    }
+    
+    const offers = await sapiClient.offers(parameters, callbacks)
+
+
+<a id="hotel-parameters"></a>
+
+### Offers parameters
+
+<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
+
+
+<colgroup>
+<col  class="org-left" />
+
+<col  class="org-left" />
+
+<col  class="org-left" />
+
+<col  class="org-left" />
+
+<col  class="org-left" />
+</colgroup>
+<thead>
+<tr>
+<th scope="col" class="org-left">name</th>
+<th scope="col" class="org-left">type</th>
+<th scope="col" class="org-left">description</th>
+<th scope="col" class="org-left">required</th>
+<th scope="col" class="org-left">example</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td class="org-left">`hotelId`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Hotel Id</td>
+<td class="org-left">yes</td>
+<td class="org-left">`1196472`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`checkIn`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Check in date (YYYY-MM-DD) (SDK generates default date if no provided)</td>
+<td class="org-left">no</td>
+<td class="org-left">`2022-10-10`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`checkOut`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Check out date (YYYY-MM-DD)) (SDK generates default date if no provided)</td>
+<td class="org-left">no</td>
+<td class="org-left">`2022-10-11`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`rooms`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">[Rooms configuration](https://github.com/FindHotel/search-data-pipelines/wiki/Glossary#rooms-configuration)</td>
+<td class="org-left">no</td>
+<td class="org-left">`2`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`searchId`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">SearchId override (SDK generates a new one if no provided)</td>
+<td class="org-left">no</td>
+<td class="org-left">`08230dfcc5f0fb95caaa82ce559ea60c4a975d6f`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`cugDeals`</td>
+<td class="org-left">`string[]`</td>
+<td class="org-left">Codes of closed user group deals to retrieve offers</td>
+<td class="org-left">no</td>
+<td class="org-left">`['signed_in', 'offline']`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`freeCancellation`</td>
+<td class="org-left">`boolean`</td>
+<td class="org-left">Promote offers with free cancelation (default `false`)</td>
+<td class="org-left">no</td>
+<td class="org-left">`true`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`isAnchor`</td>
+<td class="org-left">`boolean`</td>
+<td class="org-left">Anchor/Non anchor hotel (default `false`)</td>
+<td class="org-left">no</td>
+<td class="org-left">`true`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`getAllOffers`</td>
+<td class="org-left">`boolean`</td>
+<td class="org-left">Get all/only top offers (default `false`)</td>
+<td class="org-left">no</td>
+<td class="org-left">`true`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`originId`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Identifier of origin where the request was originated</td>
+<td class="org-left">no</td>
+<td class="org-left">`c3po6twr70`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`trafficSource`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Visitor's traffic source. Opaque value that will be passed to tracking systems</td>
+<td class="org-left">no</td>
+<td class="org-left">`gha-vr`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`preferredRate`</td>
+<td class="org-left">`number`</td>
+<td class="org-left">Offer's price user saw on a CA (meta) platform</td>
+<td class="org-left">no</td>
+<td class="org-left">`196`</td>
+</tr>
+</tbody>
+</table>
+
+
+<a id="offers-callbacks"></a>
+
+### Callbacks
+
+Object with callbacks:
+
+    const callbacks =  {
+      onStart: (response) => {
+        log('Offers started', response)
+      },
+      onOffersReceived: (response) => {
+        log('Offers received', response)
+      },
+      onComplete: (response) => {
+        log('Offers completed', response)
+      }
+    }
+
+1.  onStart()
+
+    Runs at the beginning of the each new offers request.  
+    Returns adjusted and validated offers request parameters.
+
+2.  onOffersReceived()
+
+    Runs on every received batch of offers.  
+    Returns hotel's offers (incomplete response).
+
+3.  onComplete()
+
+    Runs after offers request complete.  
+    Returns hotel's offers (complete response).
+
+
+<a id="offers-response"></a>
+
+### Response
+
+An example of the response for request parameters:
+
+    const parameters = {
+      hotelId: '1926746',
+      checkIn: '2022-07-10',
+      checkOut: '2022-07-11',
+      rooms: '2'
+    }
+
+    {
+      "anchorPriceRateBreakdown": {
+        "baseRate": 113.21,
+        "localTaxes": 8.64,
+        "taxes": 10.19,
+        "calculatedTotalRate": 132.04,
+        "nightlyRate": 132.04
+      },
+      "availableOffersCount": 19,
+      "fetchedAllOffers": false,
+      "hasMoreOffers": true,
+      "id": "1926746",
+      "offers": [
+        {
+          "additionalProviderParams": {
+    	"feedId": "1524856"
+          },
+          "availableRooms": 10,
+          "bookURI": "https://r.findhotel.net?...",
+          "calculatedTotalRate": 110.72,
+          "canPayLater": true,
+          "cug": null,
+          "currency": "EUR",
+          "hasAnchorPrice": true,
+          "hasFreeCancellation": true,
+          "id": "oO8jdRHaO8y0",
+          "isAnchorPriceOffer": false,
+          "isCheapest": false,
+          "isTopOffer": true,
+          "meals": ["breakfast"],
+          "nightlyRate": 110.72,
+          "providerCode": "BKS",
+          "proxyProviderCode": "BKS",
+          "rateBreakdown": {
+    	"baseRate": 90.28,
+    	"localTaxes": 12.32,
+    	"taxes": 8.12
+          },
+          "roomID": "moc_08Ap8BcbIDg",
+          "roomName": "Standard Double Room",
+          "tags": ["top_offer"]
+        }
+      ],
+      "topOfferData": {
+        "anchorPrice": 132.04,
+        "anchorPriceNightly": 132.04,
+        "offerIndexes": [0, 1, 2, 3]
+      }
+    }
+