@findhotel/sapi 0.23.3 → 0.23.6

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [0.23.6](https://github.com/FindHotel/sapi/compare/v0.23.5...v0.23.6) (2022-03-21)
+### Added
+- `hotel()` method to get complete hotel information by hotelId
+- `sapiOverride` parameter
+
+
+## [0.23.5](https://github.com/FindHotel/sapi/compare/v0.23.4...v0.23.5) (2022-03-04)
+### Added
+- SAF domain for STG environment
+
+
+## [0.23.4](https://github.com/FindHotel/sapi/compare/v0.23.3...v0.23.4) (2022-02-28)
+### Changed
+- SAF domain for E2E environment
+
+
 ## [0.23.3](https://github.com/FindHotel/sapi/compare/v0.23.2...v0.23.3) (2022-02-22)
 ### Added
 - Log WS errors and re-connects

package/README.md

@@ -6,7 +6,8 @@
     1.  [Getting Started](#getting-started)
     2.  [Usage](#usage)
         1.  [Hotels search](#tutorial-hotels-search)
-        2.  [Get rooms](#tutorial-get-rooms)
+        2.  [Get rooms data](#tutorial-get-rooms)
+        3.  [Get hotel](#tutorial-get-hotel)
 3.  [API Reference](#api-reference)
     1.  [SAPI client](#sapi-client)
         1.  [Supported options](#client-options)
@@ -21,6 +22,9 @@
     4.  [`rooms()` method](#rooms-method)
         1.  [Rooms parameters](#rooms-parameters)
         2.  [Response](#rooms-response)
+    5.  [`hotel()` method](#hotel-method)
+        1.  [Hotel parameters](#hotel-parameters)
+        2.  [Response](#hotel-response)
 
 SDK provides a high level TypeScript/JavaScript API for searching
 hotels, hotels' offers and rooms.
@@ -112,7 +116,7 @@ For full documentation, check [search method api](#search-method).
 
 <a id="tutorial-get-rooms"></a>
 
-### Get rooms
+### Get rooms data
 
 Get rooms and rooms' offers:
 
@@ -126,6 +130,17 @@ Get rooms and rooms' offers:
 For full documentation, check [rooms method api](#rooms-method).
 
 
+<a id="tutorial-get-hotel"></a>
+
+### Get hotel
+
+Get hotel by id:
+
+    const hotel = await sapiClient.hotel('1196472')
+
+For full documentation, check [hotel method api](#hotel-method).
+
+
 <a id="api-reference"></a>
 
 # API Reference
@@ -680,7 +695,7 @@ Suggest provides autosuggestions for a given query
 Rooms is a method of **sapiClient** for retrieving rooms information and
 offers for a particular itinerary:
 
-    const rooms = sapiClient.rooms({
+    const rooms = await sapiClient.rooms({
       hotelId: '47319',
       checkIn: '2021-10-10',
       checkOut: '2021-10-11',
@@ -782,3 +797,143 @@ offers for a particular itinerary:
 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).
 
+
+<a id="hotel-method"></a>
+
+## `hotel()` method
+
+Hotel is a method of **sapiClient** for retrieving a single hotel by id
+
+    const hotel = await sapiClient.hotel('1196472')
+
+
+<a id="hotel-parameters"></a>
+
+### Hotel 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">`hotelId`</td>
+<td class="org-left">`string`</td>
+<td class="org-left">Hotel Id</td>
+<td class="org-left">yes</td>
+<td class="org-left">`1196472`</td>
+</tr>
+</tbody>
+</table>
+
+
+<a id="hotel-response"></a>
+
+### Response
+
+An example of the response for request with `hotelId` 1196472 and "pt-BR" `language`
+
+    {
+      "objectID": "1196472",
+      "guestRating": {
+        "cleanliness": 8.82,
+        "dining": 8.73,
+        "facilities": 8.73,
+        "location": 8.8,
+        "overall": 8.54,
+        "pricing": 4.49,
+        "rooms": 8.82,
+        "service": 8.67
+      },
+      "isDeleted": false,
+      "starRating": 4,
+      "_geoloc": {
+        "lat": 52.377805,
+        "lon": 4.914172
+      },
+      "feesOpt": "<p>Os seguintes depósitos e taxas são cobrados pelo hotel no momento do serviço prestado, durante o check-in ou check-out. </p> <ul> <li>Taxa para café da manhã em estilo buffet: EUR 25.00 por pessoa (aproximadamente)</li>  <li>Taxa para o acesso à internet com fio no quarto: EUR 15 por dia (as tarifas podem variar)</li>  <li>Taxa para o acesso à internet com fio em áreas comuns: EUR 15 por dia (as tarifas podem variar)</li>   <li>Taxa para estacionamento coberto sem manobrista: EUR 38.00 por dia</li>   <li>Estacionamento pago nos arredores: EUR 15 por dia (aberto 24 horas)</li>                    </ul> <p>A lista acima pode estar incompleta. As taxas e os depósitos podem não incluir impostos e estão sujeitos a mudanças. </p>",
+      "checkInSpInst": "O funcionário da recepção receberá os hóspedes na chegada. Para mais informações, entre em contato com o estabelecimento usando os dados que estão na confirmação da reserva. Os hóspedes que forem usar o traslado da Estação Central de Amsterdã devem entrar em contato com o estabelecimento com antecedência. Devido à COVID-19, as opções de comida e bebida deste estabelecimento podem estar limitadas de acordo com os regulamentos locais.",
+      "policies": "<ul>  <li>Este estabelecimento oferece transporte da estação de trem. Os hóspedes devem entrar em contato com o estabelecimento antes da viagem com os detalhes da chegada usando as informações para contato presentes na confirmação da reserva. </li> <li>É necessário reservar os seguintes serviços: serviços de massagem. As reservas podem ser feitas contatando este hotel antes da viagem usando as informações para contato fornecidas na confirmação da reserva. </li> <li>Somente hóspedes registrados podem ter acesso aos quartos. </li><li>O estabelecimento possui quartos conectados ou adjacentes, que podem ser solicitados entrando-se em contato diretamente com o estabelecimento, através do número fornecido na confirmação da reserva. </li><li>Não há necessidade de carro para o transporte de/para o estabelecimento. </li><p>Há restrições de altura no estacionamento. </p><li>Medidas de limpeza aprimorada e segurança dos hóspedes estão atualmente em vigor nesta acomodação.</li><li>A limpeza do estabelecimento é feita com desinfetante, as superfícies tocadas regularmente são desinfetadas entre as estadias e os lençóis e as toalhas são lavados a uma temperatura mínima de 60 °C.</li><li>Equipamentos de proteção individuais , como máscaras, vão estar disponíveis para os hóspedes.</li><li>Medidas de distanciamento social estão em vigor; os funcionários utilizam equipamento de proteção individual no estabelecimento; há um painel protetor de acrílico entre funcionários e hóspedes nas principais áreas de contato; os hóspedes recebem álcool em gel.</li><li>Há possibilidade de check-in sem contato e check-out sem contato.</li><li>Cada quarto permanece vazio por um mínimo de 24 horas entre as estadias.</li><li> Este estabelecimento recebe hóspedes de todas as orientações sexuais e identidades de gênero (LGBTQ friendly). </li> </ul>",
+      "phone": "+31205191200",
+      "imageURIs": [
+        "https://i.travelapi.com/hotels/2000000/1460000/1452100/1452083/a39e2fc8_w.jpg",
+        "https://i.travelapi.com/hotels/2000000/1460000/1452100/1452083/3892e861_w.jpg",
+        "https://i.travelapi.com/hotels/2000000/1460000/1452100/1452083/aed25438_w.jpg"
+      ],
+      "checkInTime": "15:00",
+      "checkInInst": "<ul>  <li>Pessoas extras podem incorrer em taxas adicionais que variam dependendo da política do estabelecimento</li><li>Documento de identificação oficial com foto e cartão de crédito, cartão de débito ou depósito em dinheiro podem ser exigidos no momento do check-in para despesas extras.</li><li>Solicitações especiais estão sujeitas à disponibilidade no momento do check-in e podem incorrer em taxas adicionais. Essas solicitações não estão garantidas</li><li>Políticas de cancelamento ou cobranças especiais podem se aplicar a reservas de grupos (mais de 8 quartos para o mesmo estabelecimento/mesmas datas)</li><li>Este estabelecimento aceita cartões de crédito – não são aceitos pagamentos em dinheiro.</li><li>Os recursos de segurança disponíveis no estabelecimento incluem itens como detector de fumaça</li><li>As normas culturais e políticas de hóspedes podem variar conforme o país e o estabelecimento. As políticas listadas são fornecidas pelo estabelecimento</li>  </ul>",
+      "reviewCount": 17538,
+      "chainID": "2101",
+      "checkInEnd": "01:00",
+      "lastBooked": 1608030831,
+      "checkOutTime": "12:00",
+      "feesMnd": "<p>Você deverá pagar os seguintes encargos no estabelecimento:</p> <ul><li>Depósito: EUR 50 por noite</li><li>A cidade cobra um imposto de EUR 3.00 por pessoa, por noite até 21 noites. Esse imposto não se aplica a crianças de até 16 anos. </li><li>Será cobrado um imposto municipal/local de 6.422 %</li></ul> <p>Incluímos todas as cobranças que o estabelecimento nos forneceu. No entanto, as cobranças podem variar com base, por exemplo, na duração da estadia ou no tipo de quarto reservado. </p>",
+      "reviewCountBkt": 9,
+      "hotelName": "Movenpick Hotel Amsterdam City Centre",
+      "sentiments": [{
+          "value": "Gostou do bar",
+          "id": 46
+        },
+        {
+          "value": "Processo rápido de check-in/check-out",
+          "id": 180
+        }
+      ],
+      "facilities": [{
+          "categoryID": 4,
+          "importance": 2,
+          "value": "Centro de Negócios",
+          "id": 1
+        },
+        {
+          "categoryID": 17,
+          "importance": 2,
+          "value": "Serviço de quarto",
+          "id": 2
+        }
+      ],
+      "placeID": "311007",
+      "guestType": {
+        "business": 1333,
+        "couples": 3125,
+        "families": 1484,
+        "groups": 1121,
+        "solo": 206
+      },
+      "themes": [{
+          "value": "Cidade",
+          "id": 2
+        },
+        {
+          "value": "Empresarial",
+          "id": 12
+        }
+      ],
+      "propertyType": {
+        "value": "Hotel",
+        "id": 0
+      },
+      "placeDisplayName": "Oostelijk Havengebied, Amsterdã",
+      "displayAddress": "Piet Heinkade 11, Oostelijk Havengebied, Amsterdã, Holanda"
+    }
+