@revolugo/common 7.0.0-alpha.8 → 7.0.0-alpha.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "7.0.0-alpha.8",
+  "version": "7.0.0-alpha.9",
   "private": false,
   "description": "Revolugo common",
   "author": "Revolugo",

package/src/schemas/hotel-room-offer.ts

@@ -5,12 +5,14 @@ import {
   BreakfastOption,
   HotelRoomOfferType,
   PackageType,
+  StayTaxesInfoEnum,
 } from '../constants/index.ts'
 
 import { CANCELLATION_POLICY_SCHEMA } from './cancellation-policies.ts'
 import { CURRENCY_SCHEMA } from './currency.ts'
 import { SOURCE_MARKET_SCHEMA } from './hotel-offer-request.ts'
 import { HOTEL_ROOMS_SCHEMA } from './hotel-room.ts'
+import { LIST_POLLING_META_SCHEMA } from './list-polling-meta.ts'
 import { TAGS_SCHEMA } from './tag.ts'
 import { TAXES_SCHEMA } from './taxes.ts'
 
@@ -27,21 +29,17 @@ export const PACKAGE_TYPES_DESCRIPTION = `An **Hotel Room Offer** of type **${Ho
 
 export const HOTEL_ROOM_OFFER_SCHEMA = z
   .object({
-    breakfast_count: z.number().min(0).optional().nullish().openapi({
+    breakfast_count: z.number().min(0).nullish().openapi({
       description:
         'Quantity of breakfast per night included in the given **Hotel Room Offer**',
     }),
     breakfast_option: z.enum(BreakfastOption).openapi({
       description: BREAKFAST_OPTION_DESCRIPTION,
     }),
-    breakfast_price_per_guest_per_night: z
-      .number()
-      .optional()
-      .nullish()
-      .openapi({
-        description:
-          'Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.\n\n <div style="background-color: #ffffef; padding: 20px; border: 1px solid lightgrey; border-radius: 5px;"><b style="color: red; margin-top: 10px;">🛑 DEPRECATED.</b>\n\n <b style="color: orange;">Field renamed to "breakfast_unit_price"</div>',
-      }),
+    breakfast_price_per_guest_per_night: z.number().nullish().openapi({
+      description:
+        'Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.\n\n <div style="background-color: #ffffef; padding: 20px; border: 1px solid lightgrey; border-radius: 5px;"><b style="color: red; margin-top: 10px;">🛑 DEPRECATED.</b>\n\n <b style="color: orange;">Field renamed to "breakfast_unit_price"</div>',
+    }),
     breakfast_unit_price: z.number().optional().nullish().openapi({
       description:
         'Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.',
@@ -54,7 +52,6 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
       }),
     count: z
       .number()
-      .optional()
       .nullish()
       .openapi({
         description: `When **type = ${HotelRoomOfferType.HotelRoom}**: this parameters represents the available quantity for the given **Hotel Room Offer**.
@@ -73,13 +70,15 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
       .openapi({
         description: PACKAGE_TYPES_DESCRIPTION,
       })
-      .nullish()
-      .optional(),
+      .nullish(),
     price: z.number().openapi({
       description:
         'Price with taxes NOT INCLUDED of the given **Hotel Room Offer** including breakfast(s) when applicable, expressed in the requested **currency**.',
     }),
     source_market: SOURCE_MARKET_SCHEMA,
+    stay_taxes_info: z
+      .enum(StayTaxesInfoEnum)
+      .openapi({ description: 'Either INCLUDED, NOT_INCLUDED or UNKNOWN' }),
     tags: TAGS_SCHEMA,
     tax_included_price: z.number().openapi({
       description: `Price of the given **Hotel Room Offer** including breakfast(s) when applicable, and including all taxes from returned **taxes** list parameter expressed in the requested **currency**.\n\nThis data is not returned for a **Hotel Room Offer** of type **${HotelRoomOfferType.HotelRoom}**, you'll need to compute and display the actual tax included price of the final **Hotel Room** package corresponding to the guest count and night count requested, or make a call to the **[Create Hotel Room Offer](/v1/documentation#operation/postV1Hotel_room_offers)** endpoint in order to get a valid and bookable **Hotel Room Offer** where **type = ${HotelRoomOfferType.Package}** based on a packaged list of **Hotel Room Offers** of type **${HotelRoomOfferType.HotelRoom}**.`,
@@ -90,10 +89,16 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
       .openapi({
         description: `Hotel Room Offer type.\n\n **Hotel Room Offers** with **type = "${HotelRoomOfferType.Package}"** are **Hotel Room Offers** that are already bookable and you'll be able to follow the next step of the **Booking Flow** calling **[Create Booking Policies endpoint](/v1/documentation#operation/postV1Booking_policies)**. \n\n Otherwise, you'll be able to create a new **Hotel Room Offer** with **type = "${HotelRoomOfferType.Package}"** from multiple **Hotel Room Offers** with **type = "${HotelRoomOfferType.HotelRoom}"**. See **[Create Hotel Room Offer endpoint](/v1/documentation#operation/postV1Hotel_room_offers)** for details.`,
       })
-      .nullish()
       .optional(),
   })
   .openapi('hotelRoomOfferApi', {
     description: 'Description of the Hotel Room Offer.',
   })
+
+export const HOTEL_ROOM_OFFERS_SCHEMA = z.array(HOTEL_ROOM_OFFER_SCHEMA)
+
+export const HOTEL_ROOM_OFFERS_RESPONSE_SCHEMA = z.object({
+  data: HOTEL_ROOM_OFFERS_SCHEMA,
+  meta: LIST_POLLING_META_SCHEMA,
+})
 /* eslint-enable camelcase */

package/src/schemas/hotel-room.ts

@@ -57,10 +57,7 @@ export const HOTEL_ROOM_SCHEMA = z
       .openapi({ description: 'Whether high resolution images are available.' })
       .optional()
       .nullish(),
-    id: z
-      .string()
-      .optional()
-      .openapi({ description: 'Hotel Room id, when applicable.' }),
+    id: z.string().openapi({ description: 'Hotel Room id, when applicable.' }),
     image_indexes: z.array(z.number()).optional().nullish().openapi({
       description:
         'List of indexes corresponding to image names for the given Hotel Room among the related hotel images.',