@findhotel/sapi - npm Package Compare versions

Comparing version 0.22.8 to 0.22.9

CHANGELOG.md

@@ -0,1 +1,6 @@
+## [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)
@@ -2,0 +7,0 @@ ### Added

dist/types/packages/core/src/__fixtures__/suggest.d.ts

@@ -46,2 +46,3 @@ export declare const placeSuggestHit: {
     objectID: string;
+    objectType: string;
     placeDisplayName: string;
@@ -81,2 +82,3 @@ placeTypeName: string;
     objectID: string;
+    objectType: string;
     placeDisplayName: string;
@@ -83,0 +85,0 @@ placeTypeName: string;

dist/types/packages/core/src/types/types.d.ts

@@ -188,2 +188,3 @@ /**
     objectID: string;
+    objectType: string;
     placeDisplayName: string;
@@ -190,0 +191,0 @@ placeTypeName: PlaceTypeName;

package.json

 {
   "name": "@findhotel/sapi",
-  "version": "0.22.8",
+  "version": "0.22.9",
   "description": "FindHotel Search API",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -18,3 +18,6 @@
         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)
@@ -490,2 +493,107 @@ 2.  [Response](#rooms-response)
 
+<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>
@@ -492,0 +600,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

263565

increased by1.08%

Lines of code

2221

increased by0.18%

Number of lines in readme file

706

increased by18.06%

No dependency changes