@findhotel/sapi 0.22.7 → 0.22.11

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## [0.22.11](https://github.com/FindHotel/sapi/compare/v0.22.10...v0.22.11) (2021-12-09)
+### Changed
+- SAF search replaced with SAPI backend search
+
+
+## [0.22.10](https://github.com/FindHotel/sapi/compare/v0.22.9...v0.22.10) (2021-11-30)
+### Added
+- boundingBox parameter to SAF-search request
+
+## [0.22.9](https://github.com/FindHotel/sapi/compare/v0.22.8...v0.22.9) (2021-11-24)
+### Added
+- Added missing field to suggest method
+
+
+## [0.22.8](https://github.com/FindHotel/sapi/compare/v0.22.7...v0.22.8) (2021-11-16)
+### Added
+- `roomLimit` parameter for RAA requests
+
+
 ## [0.22.7](https://github.com/FindHotel/sapi/compare/v0.22.6...v0.22.7) (2021-11-09)
 ### Added
 - clientRequestId for each individual WS request to RAA

package/README.md

@@ -15,7 +15,10 @@
         1.  [Search parameters](#search-parameters)
         2.  [Callbacks](#search-callbacks)
         3.  [Response](#search-response)
-    3.  [`rooms()` method](#rooms-method)
+    3.  [`suggest()` method](#suggest-method)
+        1.  [Suggest parameters](#suggest-parameters)
+        2.  [Response](#suggest-response)
+    4.  [`rooms()` method](#rooms-method)
         1.  [Rooms parameters](#rooms-parameters)
         2.  [Response](#rooms-response)
 
@@ -145,7 +148,6 @@ Create SAPI client:
       includeLocalTaxes: true,
       includeTaxes: false,
       pageSize: 20,
-      useSaf: false,
       initWithProfile: {
         features: ['search', 'configs'],
       },
@@ -486,6 +488,111 @@ Search method receives callbacks object as the second argument:
 *in progress…*
 
 
+<a id="suggest-method"></a>
+
+## `suggest()` method
+
+Suggest provides autosuggestions for a given query
+
+    const suggestions = await sapiClient.suggest('London', 6)
+
+
+<a id="suggest-parameters"></a>
+
+### Suggest 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">`query`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Query string</td>
+<td class="org-left">yes</td>
+<td class="org-left">`London`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`suggestsCount`</td>
+<td class="org-left">`number`</td>
+<td class="org-left">Desired number of suggestions (default 6)</td>
+<td class="org-left">no</td>
+<td class="org-left">`10`</td>
+</tr>
+</tbody>
+</table>
+
+
+<a id="suggest-response"></a>
+
+### Response
+
+    const suggestions = await sapiClient.suggest('London', 2)
+    
+    [
+      {
+        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"
+      }
+    ]
+    
+    const suggestions = await sapiClient.suggest('London hotel', 2)
+    
+    [
+      {
+        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"
+      }
+    ]
+
+
 <a id="rooms-method"></a>
 
 ## `rooms()` method