@findhotel/sapi 0.22.16 → 0.23.1

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [0.23.1](https://github.com/FindHotel/sapi/compare/v0.23.0...v0.23.1) (2022-02-09)
+### Added
+- SAPI backend offers support.
+
+
+## [0.23.0](https://github.com/FindHotel/sapi/compare/v0.22.16...v0.23.0) (2022-02-09)
+### Changed
+- Skipped
+
+
 ## [0.22.16](https://github.com/FindHotel/sapi/compare/v0.22.15...v0.22.16) (2022-01-04)
 ### Added
 - Added missing fields to Offer type

package/README.md

@@ -61,7 +61,7 @@ Create SAPI client:
       anonymousId: 'fd9dbb5f-b337-4dd7-b640-1f177d1d3caa',
       language: 'en',
       currency: 'USD',
-      userCountry: 'US'
+      countryCode: 'US'
     })
 
 Now SAPI client is ready to be used in your application.
@@ -143,12 +143,12 @@ Create SAPI client:
       anonymousId: 'fd9dbb5f-b337-4dd7-b640-1f177d1d3caa',
       language: 'en',
       currency: 'USD',
-      userCountry: 'US',
-      deviceCategory: 'mobile',
+      countryCode: 'US',
+      deviceType: 'mobile',
       includeLocalTaxes: true,
       includeTaxes: false,
       pageSize: 20,
-      initWithProfile: {
+      initWithAppConfig: {
         features: ['search', 'configs'],
       },
       algoliaClientOptions: {
@@ -229,7 +229,7 @@ Create SAPI client:
 
 
 <tr>
-<td class="org-left">`userCountry`</td>
+<td class="org-left">`countryCode`</td>
 <td class="org-left">no</td>
 <td class="org-left">`string`</td>
 <td class="org-left">`US`</td>
@@ -239,7 +239,7 @@ Create SAPI client:
 
 
 <tr>
-<td class="org-left">`deviceCategory`</td>
+<td class="org-left">`deviceType`</td>
 <td class="org-left">yes</td>
 <td class="org-left">`string`</td>
 <td class="org-left">&#xa0;</td>
@@ -279,11 +279,11 @@ Create SAPI client:
 
 
 <tr>
-<td class="org-left">`initWithProfile`</td>
+<td class="org-left">`initWithAppConfig`</td>
 <td class="org-left">no</td>
-<td class="org-left">`Record<string, any>`</td>
+<td class="org-left">`AppConfig`</td>
 <td class="org-left">&#xa0;</td>
-<td class="org-left">External profile to override internal client profile</td>
+<td class="org-left">External app config to override internal one</td>
 <td class="org-left">&#xa0;</td>
 </tr>
 
@@ -399,6 +399,14 @@ All parameters are optional.
 </tr>
 
 
+<tr>
+<td class="org-left">`boundingBox`</td>
+<td class="org-left">`[p1Lat, p1Lng, p2Lat, p2Lng]`</td>
+<td class="org-left">`topLeft` and `bottomRight` coordinates of bounding box to perform search inside it</td>
+<td class="org-left">`[46.650828100116044, 7.123046875, 45.17210966999772, 1.009765625]`</td>
+</tr>
+
+
 <tr>
 <td class="org-left">`checkIn`</td>
 <td class="org-left">`string`</td>
@@ -421,6 +429,78 @@ All parameters are optional.
 <td class="org-left">[Rooms configuration](https://github.com/FindHotel/search-data-pipelines/wiki/Glossary#rooms-configuration)</td>
 <td class="org-left">`2`</td>
 </tr>
+
+
+<tr>
+<td class="org-left">`dayDistance`</td>
+<td class="org-left">`number`</td>
+<td class="org-left">Amount of full days from now to desired check in date (works in combination with `nights` parameter)</td>
+<td class="org-left">`15`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`nights`</td>
+<td class="org-left">`number`</td>
+<td class="org-left">Number of nights of stay</td>
+<td class="org-left">`3`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`sortField`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Defines the sort by criteria</td>
+<td class="org-left">`popularity, price`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`sortOrder`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Defines the sort order</td>
+<td class="org-left">`ascending, descending`</td>
+</tr>
+
+
+<tr>
+<td class="org-left">`filters`</td>
+<td class="org-left">`Object`</td>
+<td class="org-left">Object with filters</td>
+<td class="org-left">`{starRatings: 5}`</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">`['signed_in', 'offline']`</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">`c3po6twr70`</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">`196`</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">`gha-vr`</td>
+</tr>
 </tbody>
 </table>