@findhotel/sapi 1.20.1 → 1.20.3

package/README.md

@@ -671,156 +671,123 @@ the state can be repeated between different callbacks.
 The complete SAPI search response is too big to be displayed on the page
 so there is a simplified example:
 
+```json
 ```json
 {
   "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,
+      "lat": -6.28067,
+      "lon": 39.53601,
       "precision": 5000,
       "radius": 20000
-    }
+    },
+    "objectID": "hotel:9660485",
+    "objectType": "hotel",
+    "pageSize": 25,
+    "priceBucketWidth": 16,
+    "admDivisionLevel1": "Tanzania",
+    "navPath": [
+      "3429",
+      "300878",
+      "235186"
+    ],
+    "navPathNames": {
+      "country": "Tanzania"
+    },
+    "navPathInfo": {
+      "adminDivision": {
+        "id": "12598",
+        "name": "Hokkaido Prefecture"
+      },
+      "city": {
+        "id": "43727",
+        "name": "Otaru"
+      },
+      "country": {
+        "id": "125948",
+        "name": "Japan"
+      }
+    },
+    "hotelName": "Zanzibar White Sand Luxury Villas & Spa - Relais & Chateaux",
+    "placeDisplayName": "Zanzibar"
   },
-  "anchorHotelId": "1714808",
   "anchorType": "hotel",
-  "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 }
-  },
+  "anchorHotelId": "9660485",
   "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],
+    "9660485": {
+      "_geoloc": {
+        "lat": -6.28067,
+        "lon": 39.53601
+      },
+      "checkInTime": "14:00",
+      "checkOutTime": "11:00",
+      "country": "TZ",
+      "facilities": [
+        2, 5, 6, 7, 9, 11, 13, 20, 21, 22, 23, 28, 29, 31, 34, 35, 66, 84, 85, 86, 98, 99, 100, 103, 104, 122, 127, 189, 191, 193, 195, 202, 222, 235, 238, 243, 244, 253, 255, 266, 270, 292, 299
+      ],
       "guestRating": {
-        "cleanliness": 7.94,
-        "dining": 7.51,
-        "facilities": 7.54,
-        "location": 8.09,
-        "overall": 7.83,
-        "service": 8.8
+        "cleanliness": 9.66,
+        "dining": 9.42,
+        "facilities": 9.9,
+        "location": 9.8,
+        "overall": 9.55,
+        "rooms": 9.72
       },
       "guestType": {
-        "business": 793,
-        "couples": 2558,
-        "families": 1145,
-        "groups": 1276,
-        "solo": 398
+        "business": 6,
+        "couples": 235,
+        "families": 110,
+        "groups": 68,
+        "solo": 13
       },
-      "hotelName": "ibis Amsterdam Centre",
       "imageURIs": [
-        "https://i.travelapi.com/hotels/1000000/30000/25600/25525/c2387aed_w.jpg"
+        "https://img.fih.io/image/raw/regular/provider_partition=eps/3xWl0k2P0Ofb7vxD4dr1NhFjOtdQaHXLe2p1tYLaOmw=.webp"
       ],
-      "isDeleted": false,
-      "lastBooked": 1658320362,
-      "objectID": "1041597",
-      "parentChainID": "10",
-      "placeDisplayName": "Burgwallen-Nieuwe Zijde, Amsterdam",
-      "pricing": {
-        "medianRateBkt": 12,
-        "medianRateMoFrBkt": 13,
-        "medianRateSaSuBkt": 11,
-        "minRate": 116,
-        "minRateInUserCurrency": 200,
-        "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": {
-      "anchorRate": {
-        "base": 244.6021305,
-        "hotelFees": 23.122149135,
-        "taxes": 20.4147
-      },
-      "availableOffersCount": 23,
-      "cheapestRate": {
-        "base": 222.55,
-        "taxes": 19.08,
-        "hotelFees": 16.17
-      },
-      "id": "1041597",
-      "offers": [
-        {
-          "id": "o5vFF4-wmvcc",
-          "currency": "EUR",
-          "availableRooms": 6,
-          "url": "https://r.vio.com?...",
-          "rate": {
-            "base": 197.17,
-            "taxes": 17.75,
-            "hotelFees": 31.8
-          },
-          "accessTier": "",
-          "providerCode": "BKS",
-          "intermediaryProvider": "BKS",
-          "roomName": "Standard Twin Room",
-          "package": {
-            "amenities": ["breakfast"],
-            "canPayLater": false
-          },
-          "cancellationPenalties": [],
-          "tags": ["top_offer"],
-          "metadata": {
-            "feedID": ""
-          }
-        }
+      "navPath": [
+        "3429",
+        "300878",
+        "235186"
       ],
-      "discount": {
-        "discountProvider": "FHT",
-        "hasDiscountProvider": true,
-        "hasParityProvider": true,
-        "modifier": "b"
+      "navPathInfo": {
+        "adminDivision": {
+          "id": "12598",
+          "name": "Hokkaido Prefecture"
+        },
+        "city": {
+          "id": "43727",
+          "name": "Otaru"
+        },
+        "country": {
+          "id": "125948",
+          "name": "Japan"
+        }
       }
     }
-  },
-  "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"
-  },
-  "status": {
-    "anchorComplete": true,
-    "nonAnchorComplete": true
   }
 }
 ```
 
+```
+#### navPathInfo 
+this structure holds all information about the hotel location(starting from country -> region -> city -> village)
+example:
+```json
+  "navPathInfo": {
+    "adminDivision": {
+      "id": "12598",
+      "name": "Hokkaido Prefecture"
+    },
+    "city": {
+      "id": "43727",
+      "name": "Otaru"
+    },
+    "country": {
+      "id": "125948",
+      "name": "Japan"
+    }
+  }
+```
+
 ### Load more results and load more offers for a hotel
 
 After the search is complete:

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

@@ -237,11 +237,13 @@ export interface NavPathNames {
     country?: string;
 }
 export interface NavPathInfo {
-    city?: string;
-    adminDivisions?: string[];
-    country?: string;
-    cityID?: string;
-    countryID?: string;
+    country?: PlaceInfo;
+    city?: PlaceInfo;
+    adminDivision?: PlaceInfo;
+}
+export interface PlaceInfo {
+    id: string;
+    name?: string;
 }
 export interface Hotel extends Omit<Hit, 'hotelName' | 'address' | 'placeDN' | 'placeADName'> {
     displayAddress: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findhotel/sapi",
-  "version": "1.20.1",
+  "version": "1.20.3",
   "description": "FindHotel Search API",
   "main": "dist/index.js",
   "types": "dist/types/packages/core/src",