@revolugo/common 7.0.1 → 7.1.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "7.0.1",
+  "version": "7.1.0-alpha.0",
   "private": false,
   "description": "Revolugo common",
   "author": "Revolugo",
@@ -34,7 +34,7 @@
     "dayjs": "1.11.19",
     "ky": "1.14.3",
     "slugify": "1.6.6",
-    "type-fest": "5.4.3",
+    "type-fest": "5.4.4",
     "uuid": "13.0.0",
     "zod": "4.3.6"
   },

package/src/cancellation-policies.test.ts

@@ -238,7 +238,10 @@ describe('sanitizeCancellationPolicies', () => {
 
     describe('when Booking Date < Release Date < Check In Date', () => {
       const releaseDate = '2021-01-05'
-      const releaseDatetime = getFormattedUTCLocalTime(releaseDate, timezone)
+      const releaseDateCP = dayjs(releaseDate)
+        .add(1, 'day')
+        .format('YYYY-MM-DD')
+      const releaseDatetime = getFormattedUTCLocalTime(releaseDateCP, timezone)
       const bookingDatetime = getFormattedUTCLocalTime(
         '2021-01-01T10:00:00',
         timezone,
@@ -404,7 +407,10 @@ describe('sanitizeCancellationPolicies', () => {
 
     describe('when Booking Date < Release Date < DF_0', () => {
       const releaseDate = '2020-12-30'
-      const releaseDatetime = getFormattedUTCLocalTime(releaseDate, timezone)
+      const releaseDateCP = dayjs(releaseDate)
+        .add(1, 'day')
+        .format('YYYY-MM-DD')
+      const releaseDatetime = getFormattedUTCLocalTime(releaseDateCP, timezone)
       const bookingDatetime = getFormattedUTCLocalTime(
         '2020-12-20T10:00:00',
         timezone,

package/src/cancellation-policies.ts

@@ -34,6 +34,31 @@ export interface SanitizeCancellationPolicies {
   timezone?: string
 }
 
+function initReleaseDateUTC({
+  checkInDate,
+  releaseDate,
+  timezone,
+}: {
+  checkInDate: string
+  releaseDate?: string
+  timezone: string
+}): string | undefined {
+  if (!releaseDate) {
+    return undefined
+  }
+
+  if (dayjs(releaseDate).isSameOrAfter(dayjs(checkInDate))) {
+    return dayjs.tz(releaseDate, timezone).startOf('day').utc().format()
+  }
+
+  return dayjs
+    .tz(releaseDate, timezone)
+    .add(1, 'day')
+    .startOf('day')
+    .utc()
+    .format()
+}
+
 // eslint-disable-next-line complexity, max-statements, max-lines-per-function
 export function sanitizeCancellationPolicies({
   bookingDatetime,
@@ -62,8 +87,11 @@ export function sanitizeCancellationPolicies({
 
   const nextDayCheckInDateUTC = nextDay(checkInDatetimeUTC)
 
-  const releaseDatetimeUTC =
-    releaseDate && dayjs.tz(releaseDate, timezone).startOf('day').utc().format()
+  const releaseDatetimeUTC = initReleaseDateUTC({
+    checkInDate,
+    releaseDate,
+    timezone,
+  })
 
   if (dayjs(bookingDatetimeUTC).isAfter(nextDayCheckInDateUTC)) {
     return sanitizeCancellationPolicies({
@@ -452,10 +480,10 @@ export function getSanitizedCancellationPolicies({
   initialDate,
   timezone,
 }: {
-  checkInDate: string
   cancellationPolicies: ICancellationPolicy[]
-  timezone?: string
+  checkInDate: string
   initialDate?: string
+  timezone?: string
 }): ICancellationPolicy[] {
   if (!cancellationPolicies.length) {
     return []
@@ -511,3 +539,28 @@ export function isFreeCancellable(cps: ICancellationPolicy[]): boolean {
       dayjs().isBetween(dayjs(freeCp.dateFrom), dayjs(freeCp.dateTo)))
   )
 }
+
+export function filterForCustomers(
+  cps: ICancellationPolicy[],
+): ICancellationPolicy[] {
+  const now = dayjs()
+  const nowPlus2Hours = now.add(2, 'hours')
+
+  return cps.reduce<ICancellationPolicy[]>((result, cp) => {
+    if (
+      dayjs(cp.dateFrom).isSameOrBefore(nowPlus2Hours) &&
+      dayjs(cp.dateTo).isAfter(nowPlus2Hours)
+    ) {
+      result.push({
+        ...cp,
+        dateFrom: now.format(),
+      })
+    }
+
+    if (dayjs(cp.dateFrom).isAfter(nowPlus2Hours)) {
+      result.push(cp)
+    }
+
+    return result
+  }, [])
+}

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/currencies/types.ts

@@ -3,11 +3,11 @@ import type { CurrencyCode } from './constants.ts'
 export interface ICurrency {
   code: CurrencyCode
   decimalDigits: number
+  deprecated?: boolean
   name: string
   namePlural: string
   rounding: number
   symbol: string
   symbolNative: string
   zeroDecimal: boolean
-  deprecated?: boolean
 }

package/src/currencies/utils.ts

@@ -98,49 +98,50 @@ export class MoneyCalculator {
     this.isNormalized = isNormalized
   }
 
-  public denormalize(): this {
-    if (!this.isNormalized) {
+  public ceil(): this {
+    this.amount = Math.ceil(this.amount)
+
+    return this
+  }
+
+  public convert({
+    currency,
+    exchangeRate,
+  }: {
+    currency: CurrencyCode
+    exchangeRate: number
+  }): this {
+    if (this.currency === currency || this.amount === 0) {
       return this
     }
 
-    this.amount = denormalizeAmount({
-      amount: this.amount,
-      currency: this.currency,
-    })
+    const startingIsNormalized = this.isNormalized
 
-    this.isNormalized = false
+    if (startingIsNormalized) {
+      this.denormalize()
+    }
 
-    return this
-  }
+    this.amount *= exchangeRate
+    this.currency = currency
 
-  public markup(percentage: number): this {
-    this.amount /= 1 - percentage
+    if (startingIsNormalized) {
+      this.normalize()
+    }
 
     return this
   }
 
-  public normalize(): this {
-    if (this.isNormalized) {
+  public denormalize(): this {
+    if (!this.isNormalized) {
       return this
     }
 
-    this.amount = Number(
-      normalizeAmount({
-        // Making sure we only have 2 decimals after comma
-        amount: Number(this.amount.toFixed(2)),
-        currency: this.currency,
-        // Making sure Javascript doesnt give us back a float number
-        // 1172.64 * 100 = 117264.00000000001 💩
-      }).toFixed(0),
-    )
-
-    this.isNormalized = true
-
-    return this
-  }
+    this.amount = denormalizeAmount({
+      amount: this.amount,
+      currency: this.currency,
+    })
 
-  public ceil(): this {
-    this.amount = Math.ceil(this.amount)
+    this.isNormalized = false
 
     return this
   }
@@ -151,12 +152,6 @@ export class MoneyCalculator {
     return this
   }
 
-  public round(): this {
-    this.amount = Math.round(this.amount)
-
-    return this
-  }
-
   public format(locale?: string, space?: string): string {
     return formatAmount({
       amount: this.amount,
@@ -170,29 +165,34 @@ export class MoneyCalculator {
     return this.amount
   }
 
-  public convert({
-    currency,
-    exchangeRate,
-  }: {
-    exchangeRate: number
-    currency: CurrencyCode
-  }): this {
-    if (this.currency === currency || this.amount === 0) {
+  public markup(percentage: number): this {
+    this.amount /= 1 - percentage
+
+    return this
+  }
+
+  public normalize(): this {
+    if (this.isNormalized) {
       return this
     }
 
-    const startingIsNormalized = this.isNormalized
+    this.amount = Number(
+      normalizeAmount({
+        // Making sure we only have 2 decimals after comma
+        amount: Number(this.amount.toFixed(2)),
+        currency: this.currency,
+        // Making sure Javascript doesnt give us back a float number
+        // 1172.64 * 100 = 117264.00000000001 💩
+      }).toFixed(0),
+    )
 
-    if (startingIsNormalized) {
-      this.denormalize()
-    }
+    this.isNormalized = true
 
-    this.amount *= exchangeRate
-    this.currency = currency
+    return this
+  }
 
-    if (startingIsNormalized) {
-      this.normalize()
-    }
+  public round(): this {
+    this.amount = Math.round(this.amount)
 
     return this
   }

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.',
+  })