@revolugo/common 7.1.0 → 7.1.1-alpha.1

package/package.json

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

package/src/cancellation-policies.ts

@@ -39,9 +39,9 @@ function initReleaseDateUTC({
   releaseDate,
   timezone,
 }: {
+  checkInDate: string
   releaseDate?: string
   timezone: string
-  checkInDate: string
 }): string | undefined {
   if (!releaseDate) {
     return undefined

package/src/constants/poller.ts

@@ -9,3 +9,9 @@ export enum PollerType {
   // eslint-disable-next-line @typescript-eslint/naming-convention
   HOTEL_SEARCH_POLLING = 'HOTEL_SEARCH_POLLING',
 }
+
+export enum Status {
+  Complete = 'COMPLETE',
+  Error = 'ERROR',
+  InProgress = 'IN_PROGRESS',
+}

package/src/schemas/booking-policy.ts

@@ -0,0 +1,51 @@
+/* eslint-disable camelcase */
+
+import { z } from 'zod'
+
+import { CANCELLATION_POLICY_SCHEMA } from './cancellation-policies.ts'
+import { CURRENCY_SCHEMA } from './currency.ts'
+import {
+  ADULT_COUNT_SCHEMA,
+  CHECK_IN_DATE_SCHEMA,
+  CHECK_OUT_DATE_SCHEMA,
+  CHILDREN_SCHEMA,
+  IS_PRICE_INCREASED,
+} from './global.ts'
+import { HOTEL_ROOM_OFFER_SCHEMA } from './hotel-room-offer.ts'
+
+export const BOOKING_POLICY_SCHEMA = z
+  .object({
+    adult_count: ADULT_COUNT_SCHEMA,
+    cancellation_policies: z.array(CANCELLATION_POLICY_SCHEMA).openapi({
+      description:
+        'The list of cancellation policy date range with their corresponding penalty percentage.',
+    }),
+    check_in_date: CHECK_IN_DATE_SCHEMA,
+    check_out_date: CHECK_OUT_DATE_SCHEMA,
+    children: CHILDREN_SCHEMA.optional().nullish(),
+    currency: CURRENCY_SCHEMA,
+    expires_at: z.coerce.date().openapi({
+      description:
+        'Expiration date for this **Booking Policy**.\n\nThe returned  **Booking Policy** (price and cancellation policies) is valid bookable policy up to this **expires_at** date, while it may be valid for a longer period in the case of some suppliers, this API call is equivalent to an availability check and it is important not to let long periods between retrieval of this policy and the booking confirmation call itself as this will often reduce the likelihood of a **Hotel Room Offer** being successfully booked.',
+    }),
+    has_rooming_lists: z.boolean().openapi({
+      description:
+        'Indicates whether the **Booking Policy** supports rooming lists, allowing individual guest details to be provided per room.',
+    }),
+    hotel_id: z.string().openapi({
+      description: 'Hotel id',
+    }),
+    hotel_room_offer: HOTEL_ROOM_OFFER_SCHEMA.openapi({
+      description:
+        'The **Hotel Room Offer** associated with this **Booking Policy**.',
+    }),
+    id: z.string().openapi({
+      description: '**Booking Policy** id',
+    }),
+    is_price_increased: IS_PRICE_INCREASED,
+  })
+  .openapi('bookingPoliciesApi', {
+    description:
+      'A **Booking Policy** represents a validated and bookable snapshot of a **Hotel Room Offer**, including its price, cancellation policies, and expiration date.',
+  })
+/* eslint-enable camelcase */

package/src/schemas/cancellation-policies.ts

@@ -1,18 +1,23 @@
 /* eslint-disable camelcase */
 import { z } from 'zod'
 
-export const CANCELLATION_POLICY_SCHEMA = z.object({
-  date_from: z.string().openapi({
+export const CANCELLATION_POLICY_SCHEMA = z
+  .object({
+    date_from: z.string().openapi({
+      description:
+        'The start date and time of the cancellation policy, given in the hotel timezone.',
+    }),
+    date_to: z.string().openapi({
+      description:
+        'The end date and time of the cancellation policy, given in the hotel timezone.',
+    }),
+    penalty_percentage: z.number().min(0).max(100).openapi({
+      description:
+        'The penalty percentage that is due in case of cancellation during the **date_from** to **date_to** period range.',
+    }),
+  })
+  .openapi('CancellationPolicyApi', {
     description:
-      'The start date and time of the cancellation policy, given in the hotel timezone.',
-  }),
-  date_to: z.string().openapi({
-    description:
-      'The end date and time of the cancellation policy, given in the hotel timezone.',
-  }),
-  penalty_percentage: z.number().min(0).max(100).openapi({
-    description:
-      'The penalty percentage that is due in case of cancellation during the **date_from** to **date_to** period range.',
-  }),
-})
+      'Defines the cancellation penalty that applies within a specific date and time range, expressed as a percentage of the booking cost.',
+  })
 /* eslint-enable camelcase */

package/src/schemas/currency.ts

@@ -4,4 +4,4 @@ import { STRIPE_CURRENCY_CODES } from '../currencies/index.ts'
 
 export const CURRENCY_SCHEMA = z
   .enum(STRIPE_CURRENCY_CODES)
-  .openapi({ description: 'ISO 4217 currency code.' })
+  .openapi('CurrencyClient', { description: 'ISO 4217 currency code.' })

package/src/schemas/global.ts

@@ -0,0 +1,139 @@
+/* eslint-disable camelcase */
+import { z } from 'zod'
+
+import {
+  BreakfastOption,
+  CountryIso2Code,
+  Locale,
+  Status,
+} from '../constants/index.ts'
+
+export const validStringDate = (): z.ZodString =>
+  z
+    .string()
+    .regex(/^(19|20)\d\d[- /.](0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])$/u)
+
+export const ADD_BREAKFAST_SCHEMA = z
+  .boolean()
+  .nullish()
+  .openapi('addBreakfast', {
+    description: `This parameter allows to add breakfast to the booking as long as every requested Hotel Room Offers **breakfast_option = ${BreakfastOption.Optional}** .\n\nThe final breakfast count that will be included in the Hotel Room Offer will be returned in the response and is calculated as follows: \n\n - If the returned Hotel Room Offer **total room count**  > **hotel_room_offer_request.adult_count** then **breakfast_count** will be equal to the **total room count** of the returned Hotel Room Offer, \n\n - Otherwise **breakfast_count** will be equal to the minimum value between related **hotel_room_offer_request.adult_count** and returned Hotel Room Offer **total occupancy**. \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;">If you already use this field, don't worry as we still support it with the following behaviour:</b>\n- <span style="color: orange;">When **add_breakfast = true** then **breakfast_count = MIN(guest count, total offer occupancy)** where **guest count** is the total number of adult and children over 3.</span>\n- <span style="color: orange;">Otherwise **breakfast_count = 0**.</span></div>`,
+  })
+
+export const ADULT_COUNT_SCHEMA = z
+  .number()
+  .int()
+  .min(1)
+  .max(200)
+  .openapi('adultCount', {
+    description:
+      'The total number of adults who will be staying in the property.',
+  })
+
+export const BREAKFAST_COUNT = z
+  .number()
+  .optional()
+  .openapi('breakfastCount', {
+    description: `This parameter describes the quantity of breakfast / night that should be included in the **Booking**. When **breakfast_option = ${BreakfastOption.Optional}**, valid **breakfast_count** lower bound is **room count** and upper bound is **guest count**, where **guest count** is the number of adult and children over 3.\n\n⚠️ The actual breakfast count that will be included in the **Booking** is the one that is returned in the response of this endpoint and might be different from this **breakfast_count** paramater in some cases. Please, make sure to check the actual breakfast count included in the **Hotel Room Offer** returned in the response of this endpoint.`,
+  })
+
+export const CHECK_IN_DATE_SCHEMA = validStringDate().openapi('checkInDate', {
+  description: 'Date of check-in formatted as YYYY-MM-DD.',
+})
+
+export const CHECK_OUT_DATE_SCHEMA = validStringDate().openapi('checkOutDate', {
+  description: 'Date of check-out formatted as YYYY-MM-DD.',
+})
+
+export const CHILDREN_SCHEMA = z
+  .string()
+  .regex(/^(([0-9]{1})|(1[0-7]){1})(,(([0-9]{1})|(1[0-7]){1}))*$|^$/u)
+  .openapi('children', {
+    description:
+      'A comma-separated list of child ages (0 up to 17). e.g.: "3,7" represents 2 children respectively 3 and 7 years old.',
+  })
+
+export const IMAGES_SCHEMA = z
+  .object({
+    count: z.number().openapi({ description: 'Number of images.' }).nullish(),
+    highres: z
+      .boolean()
+      .openapi({ description: 'Whether images exist in highres format.' })
+      .nullish(),
+
+    lowres: z
+      .boolean()
+      .openapi({ description: 'Whether images exist in lowres format.' })
+      .nullish(),
+    prefix: z
+      .string()
+      .openapi({ description: 'Base URL for the images.' })
+      .nullish(),
+    suffix: z
+      .string()
+      .openapi({
+        description:
+          'This parameter usually represents the extension of the image (e.g.: .jpg, .png)',
+      })
+      .nullish(),
+    thumb: z
+      .boolean()
+      .openapi({
+        description:
+          'Whether images exist in thumb format (for thumbnails preview).',
+      })
+      .nullish(),
+  })
+  .openapi({
+    description:
+      '🛑 DEPRECATED - Hotel images details.\n\nIn order to retrieve a specific image you need to construct the complete URL from the images parameters: **[images.prefix][highres|lowres|thumb]/[index]/[images.suffix]**. If **images.count = n**, then index is in [0...n-1] range.\n\ne.g.: https://s3.eu-west-3.amazonaws.com/revolugo/hotels/yhKY/images/highres/0.jpg',
+  })
+
+export const IS_PRICE_INCREASED = z.boolean().openapi({
+  description:
+    'Indicates whether the price of the **Hotel Room Offer** (without breakfast included) has increased compared to the price returned by [Retrieve Hotel Room Offers endpoint](/v1/documentation#operation/getV1Hotel_room_offers).\n\nIn some case, the returned price may increase for various reasons including: Currency rate change between the POST **Booking Policies** call and the GET **Hotel Room Offers** call, **Hotel Room Offer** price has increased since the GET **Hotel Room Offers** call.\n\nIf **is_price_increased** is **true**, it means that the actual/updated price of the **Hotel Room Offer** is greater than the price previously returned by [Retrieve Hotel Room Offers endpoint](/v1/documentation#operation/getV1Hotel_room_offers). If **is_price_increased** is **false**, the price of the **Hotel Room Offer** is equal to the price returned by [Retrieve Hotel Room Offers endpoint](/v1/documentation#operation/getV1Hotel_room_offers).\n\n⚠️ It is strongly advised to clearly inform your customer of any price increase that may occur.',
+})
+
+export const LANG_SCHEMA = z
+  .enum(Locale)
+  .openapi('Locale', {
+    description:
+      'Set the language for the returned content using a valid language code.',
+    enum: Object.values(Locale),
+  })
+  .default(Locale.en_US)
+
+export const META = z
+  .object({
+    status: z
+      .enum(Status)
+      .openapi('Status', { description: 'Status of the response.' }),
+  })
+  .openapi('Meta', { description: 'Meta data of the response' })
+
+export const ROOM_COUNT_SCHEMA = z
+  .number()
+  .min(1)
+  .max(200)
+  .openapi('RoomCount', {
+    description:
+      'The total number of rooms requested for the stay. Results may display offers matching a different room count than the requested one, however those results will always provide enough occupancy for the total guest count needed.\n\nConstraint: The **room_count** cannot be greater than the requested guest count (adult and children guests) and the minimum **room_count** cannot be less than the total guest count (adult and children guests) divided by 4, meaning that the maximum number of guest in a single room cannot be greeater than 4.',
+  })
+
+export const COUNTRY_ISO2_CODE_SCHEMA = z
+  .enum(CountryIso2Code)
+  .refine(check => Object.values(CountryIso2Code).includes(check), {
+    message: 'Invalid ISO Alpha-2 country code.',
+  })
+  .openapi('CountryIso2Code', {
+    description: 'ISO Alpha-2 country code.',
+  })
+
+export const SOURCE_MARKET_SCHEMA = COUNTRY_ISO2_CODE_SCHEMA.openapi(
+  'SourceMarket',
+  {
+    description:
+      'For sourcing availability within certain markets, a source market option may be used to get more accurate prices. You may use any valid ISO Alpha-2 country code, e.g. JP.',
+  },
+)
+/* eslint-enable camelcase */

package/src/schemas/hotel-offer.ts

@@ -7,7 +7,7 @@ import {
   CHECK_IN_DATE_SCHEMA,
   CHECK_OUT_DATE_SCHEMA,
   CHILDREN_SCHEMA,
-} from './hotel-offer-request.ts'
+} from './global.ts'
 import { HOTEL_ROOM_OFFER_SCHEMA } from './hotel-room-offer.ts'
 import { HOTEL_IMAGES, HOTEL_SCHEMA, VENUES_SCHEMA } from './hotel.ts'
 import { LIST_POLLING_META_SCHEMA } from './list-polling-meta.ts'
@@ -23,34 +23,46 @@ List of hotel images in various sizes featuring an indicator for the primary (he
   hotel_room_offers: z.array(HOTEL_ROOM_OFFER_SCHEMA),
   tags: TAGS_SCHEMA,
   venues: VENUES_SCHEMA,
-}).openapi('hotelOfferApi')
+}).openapi('hotelOfferApi', {
+  description:
+    'Hotel Offer combining hotel details with available Hotel Room Offers.',
+})
 
-export const HOTEL_OFFERS_SCHEMA = z.array(HOTEL_OFFER_SCHEMA)
+export const HOTEL_OFFERS_SCHEMA = z.array(HOTEL_OFFER_SCHEMA).openapi({
+  description: 'List of Hotel Offers.',
+})
 
-export const HOTEL_OFFERS_RESPONSE_SCHEMA = z.object({
-  data: z.object({
-    adult_count: ADULT_COUNT_SCHEMA,
-    check_in_date: CHECK_IN_DATE_SCHEMA,
-    check_out_date: CHECK_OUT_DATE_SCHEMA,
-    children: CHILDREN_SCHEMA.optional().nullish(),
-    currency: CURRENCY_SCHEMA,
-    hotel_offers: HOTEL_OFFERS_SCHEMA.openapi({
-      description: 'List of Hotel Offers',
-    }),
-    price_histogram: z
-      .array(z.number())
-      .openapi({
-        description:
-          '**Hotel Offers** price histogram dataset based on the price of the cheapest **Hotel Room Offer** included on each **Hotel Offer** returned. It represents the number of available **Hotel Offers** grouped by price sorted ascendingly. Each item of the list represents a price step based on returned **price_min**, **price_max** and requested **price_histogram_step_count**',
-      })
-      .nullish(),
-    price_max: z.number().nullish().openapi({
-      description: 'Maximum price of available returned **Hotel Offers**',
+export const HOTEL_OFFERS_RESPONSE_SCHEMA = z
+  .object({
+    data: z.object({
+      adult_count: ADULT_COUNT_SCHEMA,
+      check_in_date: CHECK_IN_DATE_SCHEMA,
+      check_out_date: CHECK_OUT_DATE_SCHEMA,
+      children: CHILDREN_SCHEMA.optional().nullish(),
+      currency: CURRENCY_SCHEMA,
+      hotel_offers: HOTEL_OFFERS_SCHEMA.openapi({
+        description: 'List of Hotel Offers',
+      }),
+      price_histogram: z
+        .array(z.number())
+        .openapi({
+          description:
+            '**Hotel Offers** price histogram dataset based on the price of the cheapest **Hotel Room Offer** included on each **Hotel Offer** returned. It represents the number of available **Hotel Offers** grouped by price sorted ascendingly. Each item of the list represents a price step based on returned **price_min**, **price_max** and requested **price_histogram_step_count**',
+        })
+        .nullish(),
+      price_max: z.number().nullish().openapi({
+        description: 'Maximum price of available returned **Hotel Offers**',
+      }),
+      price_min: z.number().nullish().openapi({
+        description: 'Minimum price of available returned **Hotel Offers**',
+      }),
     }),
-    price_min: z.number().nullish().openapi({
-      description: 'Minimum price of available returned **Hotel Offers**',
+    event: z.any().optional().openapi({
+      description:
+        'Event associated with the Hotel Offers response, when applicable.',
     }),
-  }),
-  event: z.any().optional(),
-  meta: LIST_POLLING_META_SCHEMA,
-})
+    meta: LIST_POLLING_META_SCHEMA,
+  })
+  .openapi({
+    description: 'Response envelope for the Hotel Offers polling endpoint.',
+  })

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

@@ -10,12 +10,17 @@ import {
 
 import { CANCELLATION_POLICY_SCHEMA } from './cancellation-policies.ts'
 import { CURRENCY_SCHEMA } from './currency.ts'
-import { SOURCE_MARKET_SCHEMA } from './hotel-offer-request.ts'
+import { SOURCE_MARKET_SCHEMA } from './global.ts'
 import { HOTEL_ROOMS_SCHEMA } from './hotel-room.ts'
+import { HOTEL_IMAGE } from './hotel.ts'
 import { LIST_POLLING_META_SCHEMA } from './list-polling-meta.ts'
 import { TAGS_SCHEMA } from './tag.ts'
 import { TAXES_SCHEMA } from './taxes.ts'
 
+export const HOTEL_ROOM_OFFERS_IMAGES = z.array(z.array(HOTEL_IMAGE)).openapi({
+  description:
+    'List of hotel room offer images in various sizes featuring an indicator for the primary (hero) image',
+})
 export const BREAKFAST_OPTION_DESCRIPTION = `This parameter describes the breakfast option for the given **Hotel Room Offer**:
 - **breakfast_option = "${BreakfastOption.Included}"**:
   1. When **HotelRoomOffer.type = "${HotelRoomOfferType.Package}"**:
@@ -95,10 +100,19 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
     description: 'Description of the Hotel Room Offer.',
   })
 
-export const HOTEL_ROOM_OFFERS_SCHEMA = z.array(HOTEL_ROOM_OFFER_SCHEMA)
+export const HOTEL_ROOM_OFFERS_SCHEMA = z
+  .array(HOTEL_ROOM_OFFER_SCHEMA)
+  .openapi({
+    description: 'List of Hotel Room Offers.',
+  })
 
-export const HOTEL_ROOM_OFFERS_RESPONSE_SCHEMA = z.object({
-  data: HOTEL_ROOM_OFFERS_SCHEMA,
-  meta: LIST_POLLING_META_SCHEMA,
-})
+export const HOTEL_ROOM_OFFERS_RESPONSE_SCHEMA = z
+  .object({
+    data: HOTEL_ROOM_OFFERS_SCHEMA,
+    meta: LIST_POLLING_META_SCHEMA,
+  })
+  .openapi({
+    description:
+      'Response envelope for the Hotel Room Offers polling endpoint.',
+  })
 /* eslint-enable camelcase */

package/src/schemas/hotel.ts

@@ -4,159 +4,185 @@ import { z } from 'zod'
 import { CountryIso2Code } from '../constants/index.ts'
 
 import { CURRENCY_SCHEMA } from './currency.ts'
+import { IMAGES_SCHEMA } from './global.ts'
 
-export const AMENITIES_SCHEMA = z.object({
-  air_conditioning: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Air conditioning.' }),
-  airport_transportation: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Airport transportation service.' }),
-  business_center: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Business center.' }),
-  car_rent_desk: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Car rental desk service.' }),
-  children_allowed: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Children welcomed.' }),
-  clothing_iron: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Clothing iron.' }),
-  coffee_tea_maker: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Coffea/tea maker.' }),
-  combination: z.boolean().optional().openapi({ description: 'Combination.' }),
-  continental_breakfast: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Continental Breakfast.' }),
-  data_ports: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Data ports in room.' }),
-  dry_cleaning: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Dry cleaning.' }),
-  electronic_room_keys: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Electornic room keys.' }),
-  exterior_room_entrance: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Exterior room entrance.' }),
-  family_rooms: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Family rooms.' }),
-  fitness_facility: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Fitness facility.' }),
-  game_room: z.boolean().optional().openapi({ description: 'Game room.' }),
-  golf_course: z.boolean().optional().openapi({ description: 'Golf course.' }),
-  hair_dryer: z.boolean().optional().openapi({ description: 'Hair dryer.' }),
-  handicap_accessible: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Handicap Accessible.' }),
-  in_house_bar: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'In house bar.' }),
-  in_house_dining: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'In house dining.' }),
-  in_room_movies: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'In room movies.' }),
-  indoor_pool: z.boolean().optional().openapi({ description: 'Indoor pool.' }),
-  interior_room_entrance: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Interior room entrance.' }),
-  kitchen: z.boolean().optional().openapi({ description: 'Kitchen.' }),
-  map: z.boolean().optional().openapi({ description: 'Map.' }),
-  meeting_rooms: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Meeting rooms.' }),
-  mini_bar_in_room: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'mini bar in room.' }),
-  non_smoking_rooms: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Non smoking rooms.' }),
-  outdoor_pool: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Outdoor pool.' }),
-  parking_garage: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Parking garage.' }),
-  pets_allowed: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Pets allowed.' }),
-  restricted_access: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Restricted access.' }),
-  room_service: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Room service.' }),
-  safe: z.boolean().optional().openapi({ description: 'Safe in room.' }),
-  sauna: z.boolean().optional().openapi({ description: 'Sauna.' }),
-  t_v_in_room: z.boolean().optional().openapi({ description: 'TV in room.' }),
-  tennis_court: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Tennis court.' }),
-  twenty_four_hour_security: z
-    .boolean()
-    .optional()
-    .openapi({ description: ' 24/7 security.' }),
-  valet_parking: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Valet parking.' }),
-  video_check_out: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Video check out.' }),
-  voice_mail: z.boolean().optional().openapi({ description: 'Voice mail.' }),
-  wake_up_service: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Wake up service.' }),
-  whirpool: z.boolean().optional().openapi({ description: 'Whirpool.' }),
-})
+export const AMENITIES_SCHEMA = z
+  .object({
+    air_conditioning: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Air conditioning.' }),
+    airport_transportation: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Airport transportation service.' }),
+    business_center: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Business center.' }),
+    car_rent_desk: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Car rental desk service.' }),
+    children_allowed: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Children welcomed.' }),
+    clothing_iron: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Clothing iron.' }),
+    coffee_tea_maker: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Coffea/tea maker.' }),
+    combination: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Combination.' }),
+    continental_breakfast: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Continental Breakfast.' }),
+    data_ports: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Data ports in room.' }),
+    dry_cleaning: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Dry cleaning.' }),
+    electronic_room_keys: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Electornic room keys.' }),
+    exterior_room_entrance: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Exterior room entrance.' }),
+    family_rooms: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Family rooms.' }),
+    fitness_facility: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Fitness facility.' }),
+    game_room: z.boolean().optional().openapi({ description: 'Game room.' }),
+    golf_course: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Golf course.' }),
+    hair_dryer: z.boolean().optional().openapi({ description: 'Hair dryer.' }),
+    handicap_accessible: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Handicap Accessible.' }),
+    in_house_bar: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'In house bar.' }),
+    in_house_dining: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'In house dining.' }),
+    in_room_movies: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'In room movies.' }),
+    indoor_pool: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Indoor pool.' }),
+    interior_room_entrance: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Interior room entrance.' }),
+    kitchen: z.boolean().optional().openapi({ description: 'Kitchen.' }),
+    map: z.boolean().optional().openapi({ description: 'Map.' }),
+    meeting_rooms: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Meeting rooms.' }),
+    mini_bar_in_room: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'mini bar in room.' }),
+    non_smoking_rooms: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Non smoking rooms.' }),
+    outdoor_pool: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Outdoor pool.' }),
+    parking_garage: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Parking garage.' }),
+    pets_allowed: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Pets allowed.' }),
+    restricted_access: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Restricted access.' }),
+    room_service: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Room service.' }),
+    safe: z.boolean().optional().openapi({ description: 'Safe in room.' }),
+    sauna: z.boolean().optional().openapi({ description: 'Sauna.' }),
+    t_v_in_room: z.boolean().optional().openapi({ description: 'TV in room.' }),
+    tennis_court: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Tennis court.' }),
+    twenty_four_hour_security: z
+      .boolean()
+      .optional()
+      .openapi({ description: ' 24/7 security.' }),
+    valet_parking: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Valet parking.' }),
+    video_check_out: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Video check out.' }),
+    voice_mail: z.boolean().optional().openapi({ description: 'Voice mail.' }),
+    wake_up_service: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Wake up service.' }),
+    whirpool: z.boolean().optional().openapi({ description: 'Whirpool.' }),
+  })
+  .openapi('hotelAmenitiesApi', {
+    description: 'Amenities available at the hotel.',
+  })
 
-export const HOTEL_IMAGE = z.object({
-  caption: z.string().nullish(),
-  is_hero_image: z.boolean(),
-  l: z.string(),
-  m: z.string(),
-  s: z.string(),
-  xl: z.string(),
-  xs: z.string(),
-})
+export const HOTEL_IMAGE = z
+  .object({
+    caption: z
+      .string()
+      .nullish()
+      .openapi({ description: 'Caption of the hotel image.' }),
+    is_hero_image: z.boolean().openapi({
+      description:
+        'Whether this image is the primary (hero) image of the hotel.',
+    }),
+    l: z.string().openapi({ description: 'URL of the large-size image.' }),
+    m: z.string().openapi({ description: 'URL of the medium-size image.' }),
+    s: z.string().openapi({ description: 'URL of the small-size image.' }),
+    xl: z
+      .string()
+      .openapi({ description: 'URL of the extra-large-size image.' }),
+    xs: z
+      .string()
+      .openapi({ description: 'URL of the extra-small-size image.' }),
+  })
+  .openapi('hotelImageApi', { description: 'Hotel image in various sizes.' })
 
 export const HOTEL_IMAGES = z.array(HOTEL_IMAGE).openapi({
   description:
@@ -170,8 +196,7 @@ export const HOTEL_REVIEW_RATING_SCHEMA = z
       .openapi({
         description: 'Category of the collected reviews for the Hotel.',
       })
-      .nullish()
-      .optional(),
+      .nullish(),
     rating: z.number().openapi({
       description: 'Rating of the collected review for the Hotel.',
     }),
@@ -187,174 +212,116 @@ export const HOTEL_REVIEW_RATINGS_SCHEMA = z
       'List of meta reviews (category and rating) that are summary of verified reviews collected across the web on the Hotel to help choose the best option.',
   })
 
-export const IMAGES_SCHEMA = z
-  .object({
-    count: z
-      .number()
-      .openapi({ description: 'Number of images.' })
-      .optional()
-      .nullish(),
-    highres: z
-      .boolean()
-      .openapi({ description: 'Whether images exist in highres format.' })
-      .optional()
-      .nullish(),
-
-    lowres: z
-      .boolean()
-      .openapi({ description: 'Whether images exist in lowres format.' })
-      .optional()
-      .nullish(),
-    prefix: z
-      .string()
-      .openapi({ description: 'Base URL for the images.' })
-      .optional()
-      .nullish(),
-    suffix: z
-      .string()
-      .openapi({
-        description:
-          'This parameter usually represents the extension of the image (e.g.: .jpg, .png)',
+export const VENUES_SCHEMA = z
+  .array(
+    z
+      .object({
+        description: z.string().nullish().openapi({
+          description: 'Description of the venue or point of interest.',
+        }),
+        name: z
+          .string()
+          .openapi({ description: 'Name of the venue or point of interest.' }),
+        travel_times: z
+          .object({
+            driving: z.number().optional().openapi({
+              description: 'Driving travel time to the venue in minutes.',
+            }),
+            transit: z.number().optional().openapi({
+              description: 'Transit travel time to the venue in minutes.',
+            }),
+            walking: z.number().optional().openapi({
+              description: 'Walking travel time to the venue in minutes.',
+            }),
+          })
+          .nullish()
+          .openapi({
+            description:
+              'Estimated travel times to the venue by transport mode.',
+          }),
       })
-      .optional()
-      .nullish(),
-    thumb: z
-      .boolean()
       .openapi({
-        description:
-          'Whether images exist in thumb format (for thumbnails preview).',
-      })
-      .optional()
-      .nullish(),
-  })
+        description: 'A venue or point of interest near the hotel.',
+      }),
+  )
+  .optional()
   .openapi({
     description:
-      '🛑 DEPRECATED - Hotel images details.\n\nIn order to retrieve a specific image you need to construct the complete URL from the images parameters: **[images.prefix][highres|lowres|thumb]/[index]/[images.suffix]**. If **images.count = n**, then index is in [0...n-1] range.\n\ne.g.: https://s3.eu-west-3.amazonaws.com/revolugo/hotels/yhKY/images/highres/0.jpg',
+      'List of nearby venues or points of interest (e.g. airports, stadiums) with estimated travel times.',
   })
 
-export const VENUES_SCHEMA = z
-  .array(
-    z.object({
-      description: z.string().optional().nullish(),
-      name: z.string(),
-      travel_times: z
-        .object({
-          driving: z.number().optional(),
-          transit: z.number().optional(),
-          walking: z.number().optional(),
-        })
-        .optional()
-        .nullish(),
-    }),
-  )
-  .optional()
 export const HOTEL_SCHEMA = z
   .object({
-    address: z
-      .string()
-      .openapi({ description: 'Hotel address.' })
-      .optional()
-      .nullish(),
+    address: z.string().openapi({ description: 'Hotel address.' }).nullish(),
     address2: z
       .string()
       .openapi({ description: 'Second part of hotel address.' })
-      .optional()
       .nullish(),
-    amenities: AMENITIES_SCHEMA.nullish(),
+    amenities: AMENITIES_SCHEMA.nullish().openapi({
+      description: 'Hotel amenities.',
+    }),
     check_in_time: z
       .string()
       .openapi({ description: 'Check in time of the hotel.' })
-      .optional()
       .nullish(),
     check_out_time: z
       .string()
       .openapi({ description: 'Check out time of the hotel.' })
-      .optional()
-      .nullish(),
-    city: z.string().openapi({ description: 'City' }).optional().nullish(),
-    country: z
-      .string()
-      .openapi({ description: 'Country' })
-      .optional()
       .nullish(),
+    city: z.string().openapi({ description: 'City' }).nullish(),
+    country: z.string().openapi({ description: 'Country' }).nullish(),
     country_code: z
       .string()
       .refine(check =>
         Object.values(CountryIso2Code).includes(check as CountryIso2Code),
       )
       .openapi({ description: 'Hotel country code in ISO2.' })
-      .optional()
-      .nullish(),
-    currency: CURRENCY_SCHEMA.openapi({ description: 'Hotel currency.' })
-      .optional()
       .nullish(),
+    currency: CURRENCY_SCHEMA.openapi({
+      description: 'Hotel currency.',
+    }).nullish(),
     description: z
       .string()
       .openapi({ description: 'Hotel description.' })
-      .optional()
       .nullish(),
     distance: z
       .number()
-      .optional()
       .openapi({
         description: 'Distance from a requested location, expressed in meters',
       })
-      .optional()
-      .nullish(),
-    email: z
-      .string()
-      .openapi({ description: 'Hotel email.' })
-      .optional()
-      .nullish(),
-    fax: z
-      .string()
-      .openapi({ description: 'Hotel fax number.' })
-      .optional()
       .nullish(),
+    email: z.string().openapi({ description: 'Hotel email.' }).nullish(),
+    fax: z.string().openapi({ description: 'Hotel fax number.' }).nullish(),
     hotel_images: HOTEL_IMAGES.nullish(),
-    hotel_review_ratings: HOTEL_REVIEW_RATINGS_SCHEMA.optional().nullish(),
+    hotel_review_ratings: HOTEL_REVIEW_RATINGS_SCHEMA.nullish(),
     id: z.string().openapi({ description: 'Hotel id.' }),
     images: IMAGES_SCHEMA.nullish(),
     latitude: z.number().openapi({ description: 'Hotel latitude.' }),
     longitude: z.number().openapi({ description: 'Hotel longitude.' }),
     name: z.string().openapi({ description: 'Hotel name.' }),
-    phone: z
-      .string()
-      .openapi({ description: 'Hotel phone number.' })
-      .optional()
-      .nullish(),
+    phone: z.string().openapi({ description: 'Hotel phone number.' }).nullish(),
     policy: z
       .string()
       .openapi({ description: 'Internal policy of the hotel.' })
-      .optional()
       .nullish(),
     postal_code: z
       .string()
       .openapi({ description: 'Hotel address postal code.' })
-      .optional()
       .nullish(),
-    rating: z
-      .number()
-      .optional()
-      .nullish()
-      .openapi({ description: 'Hotel Star rating.' }),
+    rating: z.number().nullish().openapi({ description: 'Hotel Star rating.' }),
     state: z
       .string()
       .openapi({ description: 'Hotel address state.' })
-      .optional()
       .nullish(),
     ta_id: z
       .string()
-      .optional()
       .openapi({ description: 'TripAdvisor property id. When applicable.' })
-      .optional()
       .nullish(),
     timezone: z.string().openapi({ description: 'Hotel timezone.' }),
     venues: VENUES_SCHEMA,
     website: z
       .string()
       .openapi({ description: 'Hotel website url.' })
-      .optional()
       .nullish(),
   })
-  .openapi('hotelApi')
+  .openapi('hotelApi', { description: 'Hotel details.' })

package/src/schemas/index.ts

@@ -1,6 +1,7 @@
+export * from './booking-policy.ts'
 export * from './cancellation-policies.ts'
 export * from './currency.ts'
-export * from './hotel-offer-request.ts'
+export * from './global.ts'
 export * from './hotel-offer.ts'
 export * from './hotel-room-offer.ts'
 export * from './hotel-room.ts'

package/src/schemas/list-polling-meta.ts

@@ -29,7 +29,9 @@ export const LIST_META_SCHEMA = z
     ending_before: ENDING_BEFORE_SCHEMA,
     limit: LIMIT_SCHEMA,
     starting_after: STARTING_AFTER_SCHEMA,
-    total_count: z.number().nullish(),
+    total_count: z.number().nullish().openapi({
+      description: 'Total count of items in the list.',
+    }),
   })
   .openapi('metaApiResponse')
   .openapi({
@@ -43,5 +45,8 @@ export const LIST_POLLING_META_SCHEMA = LIST_META_SCHEMA.extend({
     .number()
     .optional()
     .openapi({ description: 'Total count of the response list.' }),
-}).openapi('metaApiPollingResponse')
+}).openapi('metaApiPollingResponse', {
+  description:
+    'Meta information about the polling response list, including pagination cursors and the current polling status.',
+})
 /* eslint-enable camelcase */

package/src/schemas/tag.ts

@@ -1,13 +1,27 @@
 /* eslint-disable camelcase */
 import { z } from 'zod'
 
-export const TAG_SCHEMA = z.object({
-  bg: z.string().optional().nullish(),
-  color: z.string().optional().nullish(),
-  description: z.string().optional().nullish(),
-  fa_icon: z.string().optional().nullish(),
-  name: z.string(),
-})
+export const TAG_SCHEMA = z
+  .object({
+    bg: z.string().optional().nullish().openapi({
+      description: 'Background color of the tag.',
+    }),
+    color: z.string().optional().nullish().openapi({
+      description: 'Text color of the tag.',
+    }),
+    description: z.string().optional().nullish().openapi({
+      description: 'Description of the tag.',
+    }),
+    fa_icon: z.string().optional().nullish().openapi({
+      description: 'Font Awesome icon identifier for the tag.',
+    }),
+    name: z.string().openapi({ description: 'Name of the tag.' }),
+  })
+  .openapi('tagApi', {
+    description: 'Tag associated with a Hotel or Hotel Room Offer.',
+  })
 
-export const TAGS_SCHEMA = z.array(TAG_SCHEMA).optional().default([])
+export const TAGS_SCHEMA = z.array(TAG_SCHEMA).optional().default([]).openapi({
+  description: 'List of tags associated with a Hotel or Hotel Room Offer.',
+})
 /* eslint-enable camelcase */

package/src/schemas/taxes.ts

@@ -28,7 +28,9 @@ export const TAX_SCHEMA = z
         'Tax mode. Specifies if the tax applies per occupant, per booking or per room',
     }),
   })
-  .openapi('taxApi')
+  .openapi('taxApi', { description: 'Tax applied to the Hotel Room Offer.' })
 
-export const TAXES_SCHEMA = z.array(TAX_SCHEMA).optional()
+export const TAXES_SCHEMA = z.array(TAX_SCHEMA).optional().openapi({
+  description: 'List of taxes applied to the Hotel Room Offer.',
+})
 /* eslint-enable camelcase */

package/src/types/elements/booking-policy.ts

@@ -41,7 +41,7 @@ export interface BookingPolicies {
   children?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof BookingPolicies
    */
   currency: CurrencyType

package/src/types/elements/booking.ts

@@ -78,7 +78,7 @@ export interface Booking {
   createdAt: string
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof Booking
    */
   currency: CurrencyType

package/src/types/elements/contact-person.ts

@@ -163,10 +163,6 @@ export interface PrebookFormValues {
   firstName: ContactPerson['firstName']
   lastName: ContactPerson['lastName']
   nationality: ContactPerson['nationality']
-  phoneCountry: CountryIso2Code
-  phoneNumber: string
-  salutation: ContactPerson['salutation']
-  specialRequests: ContactPerson['remarks']
   organizationAddress?: string
   organizationCity?: string
   organizationCountry?: string
@@ -174,4 +170,8 @@ export interface PrebookFormValues {
   organizationState?: string
   organizationVatNumber?: string
   organizationZipCode?: string
+  phoneCountry: CountryIso2Code
+  phoneNumber: string
+  salutation: ContactPerson['salutation']
+  specialRequests: ContactPerson['remarks']
 }

package/src/types/elements/hotel-offer.ts

@@ -65,7 +65,7 @@ export interface HotelOffer {
   countryCode?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelOffer
    */
   currency?: CurrencyCode

package/src/types/elements/hotel-room-offer-request.ts

@@ -127,6 +127,7 @@ export interface HotelRoomOfferRequestResponse {
   sourceMarket: SourceMarket
 }
 
+// eslint-disable-next-line no-restricted-syntax
 export type HotelRoomOfferRequestCreate = Pick<
   HotelRoomOfferRequest,
   | 'adultCount'

package/src/types/elements/hotel-room-offer.ts

@@ -128,7 +128,7 @@ export interface HotelRoomOffer {
   count?: number | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelRoomOffer
    */
   currency: CurrencyType
@@ -259,7 +259,7 @@ export interface HotelRoomOfferResponse {
   children?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelRoomOfferResponse
    */
   currency: CurrencyType

package/src/types/elements/hotel.ts

@@ -62,7 +62,7 @@ export interface Hotel {
   countryCode?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelApi
    */
   currency?: CurrencyType

package/src/utils/omit.ts

@@ -6,6 +6,7 @@
 export function omit<T extends object, K extends keyof T>(
   object: T | null | undefined,
   keys: readonly K[] | K,
+  // eslint-disable-next-line no-restricted-syntax
 ): Omit<T, K> {
   if (object === null || object === undefined) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -35,5 +36,6 @@ export function omit<T extends object, K extends keyof T>(
     }
   }
 
+  // eslint-disable-next-line no-restricted-syntax
   return result as Omit<T, K>
 }

package/src/utils/pick.ts

@@ -1,7 +1,9 @@
 export function pick<T extends object, K extends keyof T>(
   obj: T,
   keys: readonly K[],
+  // eslint-disable-next-line no-restricted-syntax
 ): Pick<T, K> {
+  // eslint-disable-next-line no-restricted-syntax
   const result = {} as Pick<T, K>
   for (const key of keys) {
     if (Object.hasOwn(obj, key)) {

package/src/utils/shake.ts

@@ -7,6 +7,7 @@ export function shake<RemovedKeys extends string, T>(
   obj: T,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   filter: (value: any) => boolean = x => x === undefined,
+  // eslint-disable-next-line no-restricted-syntax
 ): Omit<T, RemovedKeys> {
   if (!obj) {
     return {} as T

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

@@ -1,43 +0,0 @@
-import { z } from 'zod'
-
-import { CountryIso2Code } from '../constants/index.ts'
-
-export const ADULT_COUNT_SCHEMA = z.number().int().min(1).max(200).openapi({
-  description:
-    'The total number of adults who will be staying in the property.',
-})
-
-export const CHECK_IN_DATE_SCHEMA = z
-  .string()
-  .regex(/^(19|20)\d\d[- /.](0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])$/u)
-  .openapi({ description: 'Date of check-in formatted as YYYY-MM-DD.' })
-
-export const CHECK_OUT_DATE_SCHEMA = z
-  .string()
-  .regex(/^(19|20)\d\d[- /.](0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])$/u)
-  .openapi({ description: 'Date of check-out formatted as YYYY-MM-DD.' })
-
-export const CHILDREN_SCHEMA = z
-  .string()
-  .regex(/^(([0-9]{1})|(1[0-7]){1})(,(([0-9]{1})|(1[0-7]){1}))*$|^$/u)
-  .openapi({
-    description:
-      'A comma-separated list of child ages (0 up to 17). e.g.: "3,7" represents 2 children respectively 3 and 7 years old.',
-  })
-
-export const COUNTRY_ISO2_CODE_SCHEMA = z
-  .enum(CountryIso2Code)
-  .refine(check => Object.values(CountryIso2Code).includes(check), {
-    message: 'Invalid ISO Alpha-2 country code.',
-  })
-  .openapi({
-    description: 'ISO Alpha-2 country code.',
-  })
-
-export const SOURCE_MARKET_SCHEMA = COUNTRY_ISO2_CODE_SCHEMA.openapi(
-  'sourceMarket',
-  {
-    description:
-      'For sourcing availability within certain markets, a source market option may be used to get more accurate prices. You may use any valid ISO Alpha-2 country code, e.g. JP.',
-  },
-)