@findhotel/sapi 0.24.2 → 0.24.5

package/README.md

@@ -14,20 +14,21 @@
     1.  [SAPI client](#sapi-client)
         1.  [Supported options](#client-options)
         2.  [Available client callbacks](#client-callbacks)
-    2.  [`search()` method](#search-method)
+    2.  [Response](#config-response)
+    3.  [`search()` method](#search-method)
         1.  [Search parameters](#search-parameters)
         2.  [Callbacks](#search-callbacks)
         3.  [Response](#search-response)
-    3.  [`suggest()` method](#suggest-method)
+    4.  [`suggest()` method](#suggest-method)
         1.  [Suggest parameters](#suggest-parameters)
         2.  [Response](#suggest-response)
-    4.  [`rooms()` method](#rooms-method)
+    5.  [`rooms()` method](#rooms-method)
         1.  [Rooms parameters](#rooms-parameters)
         2.  [Response](#rooms-response)
-    5.  [`hotel()` method](#hotel-method)
+    6.  [`hotel()` method](#hotel-method)
         1.  [Hotel parameters](#hotel-parameters)
         2.  [Response](#hotel-response)
-    6.  [`offers()` method](#offers-method)
+    7.  [`offers()` method](#offers-method)
         1.  [Offers parameters](#hotel-parameters)
         2.  [Callbacks](#offers-callbacks)
         3.  [Response](#offers-response)
@@ -386,7 +387,36 @@ Create SAPI client:
 
 1.  onConfigReceived(configs)
 
-    Returns configuration settings that are in use by sapiClient when received from remote endpoint.
+    Returns configuration settings that are used by sapiClient.
+
+
+<a id="config-response"></a>
+
+## Response
+
+    {
+      "exchangeRates": {
+        "EUR": 0.982994
+      },
+      "lov": [
+        {
+          "id": 9,
+          "categoryID": 19,
+          "objectID": "Facility:9",
+          "value": {
+    	"en": "Airport shuttle"
+          }
+        },
+        {
+          "categoryID": 2,
+          "id": 7,
+          "objectID": "Facility:7",
+          "value": {
+    	"en": "Swimming pool"
+          }
+        }
+      ]
+    }
 
 
 <a id="search-method"></a>
@@ -539,6 +569,14 @@ All parameters are optional.
 </tr>
 
 
+<tr>
+<td class="org-left">`tier`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">User tier</td>
+<td class="org-left">`member`</td>
+</tr>
+
+
 <tr>
 <td class="org-left">`originId`</td>
 <td class="org-left">`string`</td>
@@ -589,6 +627,10 @@ Search method receives callbacks object as the second argument:
       }
     }
 
+Each callback returns the full search state available inside SAPI at the time of callbacks executions.
+This means that each subsequent callback incrementally adds new properties and returns updated state.
+The data in the state can be repeated between different callbacks.
+
 1.  onStart()
 
     Runs at the beginning of the each new search.
@@ -602,30 +644,156 @@ Search method receives callbacks object as the second argument:
 
 2.  onAnchorReceived()
 
-    Runs when SAPI receives anchor (and?) anchor hotel  
-    `response` - *in progress&#x2026;*
+    Runs when SAPI receives anchor and(?) anchor hotel (in case of hotel search)  
+    
+    Returns static data about anchor `response.anchor`
+    and(?) anchor hotel inside `response.hotelEntities` object (in case of hotel search).
 
 3.  onHotelsReceived()
 
     Runs when SAPI receives static search results  
-    `response` - *in progress&#x2026;*
+    
+    Returns static data about hotels inside `response.hotelEntities` object
+    as well as appropriate hotel sort order in `response.hotelIds` array (sorted according HSO).
 
 4.  onOffersReceived()
 
     Runs when SAPI receives a bunch of offers  
-    `response` - *in progress&#x2026;*
+    
+    Returns hotel’s offers (incomplete response) in `response.hotelOfferEntities` object
+    as well as updated hotel sort order in `response.hotelIds` array (sorted according HSO and taking into account the real offers data)
 
 5.  onComplete()
 
     Runs when current search is complete and all offers are retrieved  
-    `response` - *in progress&#x2026;*
+    
+    Return complete SAPI seearch response.
 
 
 <a id="search-response"></a>
 
 ### Response
 
-*in progress&#x2026;*
+The complete SAPI search response is too big to be displayed on the page so there is a simplified example:
+
+    {
+      "anchor": {
+        "admDivisionLevel1": "The Netherlands",
+        "admDivisionLevel2": "Amsterdam",
+        "admDivisionLevel3": "Bedrijventerrein Sloterdijk",
+        "hotelName": "Holiday Inn Express Amsterdam - Sloterdijk Station, an IHG Hotel",
+        "objectID": "hotel:1714808",
+        "objectType": "hotel",
+        "pageSize": 26,
+        "placeDisplayName": "Bedrijventerrein Sloterdijk, Amsterdam",
+        "priceBucketWidth": 19,
+        "_geoloc": {"lat": 52.388326, "lon": 4.837264, "precision": 5000, "radius": 20000}
+      },
+      "anchorHotelId": "1714808",
+      "anchorType": "hotel",
+      "dealScores": {"1041597": 0.06, "1041618": 0.37, "1041632": 0.75},
+      "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},
+      },
+      "hotelEntities": {
+        "1041597": {
+          "chainID": "351",
+          "checkInTime": "15:00",
+          "checkOutTime": "12:00",
+          "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},
+          "hotelName": "ibis Amsterdam Centre",
+          "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},
+          "propertyTypeId": 0,
+          "regularPriceRange": [224, 243],
+          "reviewCount": 5766,
+          "sentiments": [177, 250, 300, 419],
+          "starRating": 3,
+          "tags": ["b220918-1"],
+          "themeIds": [2, 5, 12],
+          "_geoloc": {"lat": 52.37947, "lon": 4.89699}
+        }
+      },
+      "hotelIds": ["1840170", "2766940", "3310443", "3035769"],
+      "hotelOfferEntities": {
+        "1041597": {
+          "anchorPriceRateBreakdown": {
+    	"baseRate": 244.6021305,
+    	"calculatedTotalRate": 288.13897963499994,
+    	"localTaxes": 23.122149135,
+    	"nightlyRate": 288.13897963499994,
+    	"taxes": 20.4147
+          },
+          "availableOffersCount": 23,
+          "fetchedAllOffers": false,
+          "hasMoreOffers": true,
+          "id": "1041597",
+          "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": 288.13897963499994,
+    	"anchorPriceNightly": 288.13897963499994,
+    	"offerIndexes": [0, 1, 2, 3]
+          }
+        }
+      },
+      "hotelsHaveStaticPosition": true,
+      "offset": 0,
+      "resultsCount": 26,
+      "resultsCountTotal": 3401,
+      "searchId": "0f9642a0-eab7-4acb-8313-bc6d19c408f6",
+      "searchParameters": {
+        "hotelId": "1714808",
+        "checkIn": "2022-09-01",
+        "checkOut": "2022-09-02",
+        "rooms": "2"
+      }
+    }
 
 
 <a id="suggest-method"></a>
@@ -741,7 +909,7 @@ Rooms is a method of **sapiClient** for retrieving rooms information and
 offers for a particular itinerary:
 
     const rooms = await sapiClient.rooms({
-      hotelId: '47319',
+      hotelId: '1714808',
       checkIn: '2021-10-10',
       checkOut: '2021-10-11',
       rooms: '2'
@@ -782,7 +950,7 @@ offers for a particular itinerary:
 <td class="org-left">`string`</td>
 <td class="org-left">Hotel Id to retrieve rooms</td>
 <td class="org-left">yes</td>
-<td class="org-left">`1371626`</td>
+<td class="org-left">`1714808`</td>
 </tr>
 
 
@@ -831,6 +999,15 @@ offers for a particular itinerary:
 </tr>
 
 
+<tr>
+<td class="org-left">`tier`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">User tier</td>
+<td class="org-left">no</td>
+<td class="org-left">`plus`</td>
+</tr>
+
+
 <tr>
 <td class="org-left">`clickedOfferId`</td>
 <td class="org-left">`string`</td>
@@ -846,10 +1023,45 @@ offers for a particular itinerary:
 
 ### Response
 
-*in progress&#x2026;*
-
-SAPI `rooms()` method will have the similar response body as BoFH API
-`/rooms` endpoint. For now please refer to [BoFH documentation](https://github.com/FindHotel/bofh-api/blob/master/docs/consumers/default/endpoints/rooms.md#example-1).
+    {
+      "anonymousId": "fd9dbb5f-b337-4dd7-b640-1f177d1d3caa",
+      "hotelId": "1714808",
+      "rooms": [
+        {
+          "amenities": ["Non-Smoking Facility"],
+          "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/....}],
+          "masterId": "9643931",
+          "name": "1 Double Standard",
+          "offers": [
+    	{
+    	  "availableRooms": 0,
+    	  "canPayLater": false,
+    	  "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", "total": "1412.71"},
+    	    "currencyCode": "EUR",
+    	    "hotelFees": {"breakdown": [], "total": "0"},
+    	    "type": "chargeable_currency"
+    	  }],
+    	  "providerCode": "GAR",
+    	  "providerRateType": "public",
+    	  "refundable": false,
+    	  "services": ["breakfast"]
+    	}
+          ]
+        }
+      ]
+    }
 
 
 <a id="hotel-method"></a>
@@ -1103,6 +1315,15 @@ Retrieves offers for a single hotel by provided parameters
 </tr>
 
 
+<tr>
+<td class="org-left">`tier`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">User tier</td>
+<td class="org-left">no</td>
+<td class="org-left">`member`</td>
+</tr>
+
+
 <tr>
 <td class="org-left">`freeCancellation`</td>
 <td class="org-left">`boolean`</td>