@revolugo/common 6.9.6 → 6.9.7-beta.1

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

@@ -0,0 +1,192 @@
+import type { BreakfastOptionType } from '#constants'
+import type { CancellationPolicy } from './cancellation-policy.ts'
+import type { CurrencyType } from './currency.ts'
+import type { HotelRoomOfferPackageType } from './hotel-room-offer-package-type.ts'
+import type { HotelRoomOfferType } from './hotel-room-offer-type.ts'
+import type { HotelRoom } from './hotel-room.ts'
+import type { SourceMarket } from './source-market.ts'
+import type { Tag } from './tag.ts'
+import type { Tax } from './tax.ts'
+
+/**
+ * Description of the Hotel Room Offer.
+ * @export
+ * @interface HotelRoomOffer
+ */
+export interface HotelRoomOffer {
+  /**
+   * Quantity of breakfast per night included in the given **Hotel Room Offer**
+   * @type {number}
+   * @memberof HotelRoomOffer
+   */
+  breakfastCount?: number | null
+  /**
+   * This parameter describes the breakfast option for the given **Hotel Room Offer**:
+   * - **breakfast_option = "INCLUDED"**:
+   *   1. When **HotelRoomOffer.type = "PACKAGE"**:
+   *   the returned **Hotel Room Offer** includes breakfast for the requested **guest count (adult_count + children over 3)**, you cannot choose otherwise, and the returned **price** already includes it,
+   *   2. When **HotelRoomOffer.type = "HOTEL_ROOM"**:
+   *   the returned **Hotel Room Offer** includes breakfast for the **Hotel Room Offer** maximum occupancy, you cannot choose otherwise, and the returned **price** already includes it,
+   * -**breakfast_option = "OPTIONAL"**: the returned **Hotel Room Offer** does not include by default the breakfast and so does the returned **price**, but you'll be able to let your customers choose to add it to their booking. In that case, a **breakfast_price_per_guest_per_night** expressed in the requested **currency** will be available in the returned data, and you'll be to perform one of the two following actions:
+   *  - Call **[Create Hotel Room Offer endpoint](/v1/documentation#operation/postV1Hotel_room_offers)** and get a fresh **Hotel Room Offer** with updated price
+   *  - Compute and display the total price of the **Hotel Room Offer** related to the guest_count and night count requested including extra breafasts.,
+   * - **breakfast_option = "NOT_INCLUDED"**: the returned **Hotel Room Offer** does not include breakfast and you cannot choose otherwise through API. Guest may still be able to add extra breakfast option(s) at the time of check-in directly at the hotel's reception.
+   * @type {string}
+   * @memberof HotelRoomOffer
+   */
+  breakfastOption: BreakfastOptionType
+  /**
+   * Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.
+   *
+   *  <div style="background-color: #ffffef; padding: 20px; border: 1px solid lightgrey; border-radius: 5px;"><b style="color: red; margin-top: 10px;">🛑 DEPRECATED.</b>
+   *
+   *  <b style="color: orange;">Field renamed to "breakfast_unit_price"</div>
+   * @type {number}
+   * @memberof HotelRoomOffer
+   */
+  breakfastPricePerGuestPerNight?: number | null
+  /**
+   * Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.
+   * @type {number}
+   * @memberof HotelRoomOffer
+   */
+  breakfastUnitPrice?: number | null
+  /**
+   * The list of cancellation policies applied to the given **Hotel Room Offer**.
+   * @type {Array<CancellationPolicy>}
+   * @memberof HotelRoomOffer
+   */
+  cancellationPolicies: CancellationPolicy[]
+  /**
+   * When **type = HOTEL_ROOM**: this parameters represents the available quantity for the given **Hotel Room Offer**.
+   *   When **type = PACKAGE**: count = 1 always.
+   * @type {number}
+   * @memberof HotelRoomOffer
+   */
+  count?: number | null
+  /**
+   *
+   * @type {CurrencyBookingApiClient}
+   * @memberof HotelRoomOffer
+   */
+  currency: CurrencyType
+  /**
+   * id of the associated Hotel.
+   * @type {string}
+   * @memberof HotelRoomOffer
+   */
+  hotelId: string
+  /**
+   * List of Hotel Rooms included in the Hotel Room Offer.
+   * @type {Array<HotelRoom>}
+   * @memberof HotelRoomOffer
+   */
+  hotelRooms: HotelRoom[]
+  /**
+   * Hotel Room Offer id.
+   * @type {string}
+   * @memberof HotelRoomOffer
+   */
+  id?: string
+  /**
+   * An **Hotel Room Offer** of type **PACKAGE** can be of **4 types**, described by **package_type** parameter:
+   *
+   *  - **CHEAPEST** : The cheapest combination of hotel rooms that can accommodate the requested guest count. Note that it may not match the requested room count (e.g., 4 guests and 2 rooms requested may return an hotel room package including only 1 room with an occupancy of 4).
+   *
+   *  -**MATCHING_ROOM_COUNT** : the cheapest hotel room package that can accommodate the given guest count and that matches exactly the room count given.
+   *
+   *  -**BEST_MATCH** : The cheapest hotel room package that matches the given room and guest count with a balanced distribution of guests across the rooms (e.g.; 8 guests and 3 rooms requested may return an **Hotel Room Offer** package including 2 rooms with an occupancy of 3 on each one and 1 room with an occupancy of 2).
+   *
+   *  -**REGULAR** : any other available package.
+   * @type {string}
+   * @memberof HotelRoomOffer
+   */
+  packageType?: HotelRoomOfferPackageType
+  /**
+   * Price with taxes NOT INCLUDED of the given **Hotel Room Offer** including breakfast(s) when applicable, expressed in the requested **currency**.
+   * @type {number}
+   * @memberof HotelRoomOffer
+   */
+  price: number
+  /**
+   *
+   * @type {SourceMarket}
+   * @memberof HotelRoomOffer
+   */
+  sourceMarket: SourceMarket
+  /**
+   *
+   * @type {Array<Tag>}
+   * @memberof HotelRoomOffer
+   */
+  tags?: Tag[]
+  /**
+   * 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**.
+   *
+   * This data is not returned for a **Hotel Room Offer** of type **HOTEL_ROOM**, 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 = PACKAGE** based on a packaged list of **Hotel Room Offers** of type **HOTEL_ROOM**.
+   * @type {number}
+   * @memberof HotelRoomOffer
+   */
+  taxIncludedPrice: number
+  /**
+   *
+   * @type {Array<Tax>}
+   * @memberof HotelRoomOffer
+   */
+  taxes?: Tax[]
+  /**
+   * Hotel Room Offer type.
+   *
+   *  **Hotel Room Offers** with **type = "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)**.
+   *
+   *  Otherwise, you'll be able to create a new **Hotel Room Offer** with **type = "PACKAGE"** from multiple **Hotel Room Offers** with **type = "HOTEL_ROOM"**. See **[Create Hotel Room Offer endpoint](/v1/documentation#operation/postV1Hotel_room_offers)** for details.
+   * @type {string}
+   * @memberof HotelRoomOffer
+   */
+  type?: HotelRoomOfferType
+}
+
+export interface HotelRoomOfferResponse {
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   * @memberof HotelRoomOfferResponse
+   */
+  adultCount: number
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelRoomOfferResponse
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelRoomOfferResponse
+   */
+  checkOutDate: string
+  /**
+   * A comma-separated list of child ages (0 up to 17). e.g.: "3,7" represents 2 children respectively 3 and 7 years old.
+   * @type {string}
+   * @memberof HotelRoomOfferResponse
+   */
+  children?: string | null
+  /**
+   *
+   * @type {CurrencyBookingApiClient}
+   * @memberof HotelRoomOfferResponse
+   */
+  currency: CurrencyType
+  /**
+   * Hotel id
+   * @type {string}
+   * @memberof HotelRoomOfferResponse
+   */
+  hotelId: string
+  /**
+   *
+   * @type {HotelRoomOffer}
+   * @memberof HotelRoomOfferResponse
+   */
+  hotelRoomOffer: HotelRoomOffer
+}

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

@@ -0,0 +1,102 @@
+import type { Bed } from './bed.ts'
+
+export interface HotelRoom {
+  /**
+   * List of amenities in the room. May be subject to changes at the Hotel.
+   * @type {Array<string>}
+   * @memberof HotelRoom
+   */
+  amenities?: string[] | null
+  /**
+   * Beds list.
+   * Each nested array of beds represents a single combination of possible beds.
+   * e.g.: The following object represents **1 double bed or 1 sofa bed and 1 double bed or 1 single bed**:
+   * ```
+   * [
+   *   [
+   *     { count: 1, name: 'double', occupancy: 2 },
+   *     { count: 1, name: 'sofa', occupancy: 1 }
+   *   ],
+   *   [
+   *     { count: 1, name: 'double', occupancy: 2 },
+   *     { count: 1, name: 'single', occupancy: 1 }
+   *   ]
+   * ]
+   * ```
+   * @type {Array<Array<Bed>>}
+   * @memberof HotelRoom
+   */
+  beds: Bed[][]
+  /**
+   * Prettified and localized list of beds
+   * @type {string}
+   * @memberof HotelRoom
+   */
+  bedsPretty: string
+  /**
+   * Hotel Room count included in the Hotel Room Offer.
+   * @type {number}
+   * @memberof HotelRoom
+   */
+  count: number
+  /**
+   * Hotel Room description.
+   * @type {string}
+   * @memberof HotelRoom
+   */
+  description: string
+  /**
+   * Whether high resolution images are available.
+   * @type {boolean}
+   * @memberof HotelRoom
+   */
+  highresImages?: boolean | null
+  /**
+   * Hotel Room id, when applicable.
+   * @type {string}
+   * @memberof HotelRoom
+   */
+  id?: string
+  /**
+   * List of indexes corresponding to image names for the given Hotel Room among the related hotel images.
+   * @type {Array<number>}
+   * @memberof HotelRoom
+   */
+  imageIndexes?: number[] | null
+  /**
+   * Whether low resolution images are available.
+   * @type {boolean}
+   * @memberof HotelRoom
+   */
+  lowresImages?: boolean | null
+  /**
+   * Total occupancy of a single hotel room.
+   * @type {number}
+   * @memberof HotelRoom
+   */
+  occupancy: number
+  /**
+   * Rich Hotel Room description. May contain HTML tags markup.
+   * @type {string}
+   * @memberof HotelRoom
+   */
+  richDescription?: string | null
+  /**
+   * Room surface in square feet. May be subject to changes at the Hotel.
+   * @type {number}
+   * @memberof HotelRoom
+   */
+  roomSquareFeet?: number | null
+  /**
+   * Room surface in square meters. May be subject to changes at the Hotel.
+   * @type {number}
+   * @memberof HotelRoom
+   */
+  roomSquareMeters?: number | null
+  /**
+   * Whether thumb resolution images are available (in order to display them as image carousel navigation for instance).
+   * @type {boolean}
+   * @memberof HotelRoom
+   */
+  thumbImages?: boolean | null
+}

package/src/types/elements/hotel-rooming-list.ts

@@ -0,0 +1,49 @@
+import type { HotelRoom } from './index.ts'
+
+export interface HotelRoomingListGuest {
+  /**
+   *
+   * @type {string}
+   * @memberof HotelRoomingListGuest
+   */
+  fullname: string
+  /**
+   *
+   * @type {string}
+   * @memberof HotelRoomingListGuest
+   */
+  id: string
+}
+
+export interface HotelRoomingList {
+  /**
+   *
+   * @type {HotelRoom}
+   * @memberof HotelRoomingList
+   */
+  hotelRoom?: HotelRoom
+  /**
+   *
+   * @type {string}
+   * @memberof HotelRoomingList
+   */
+  hotelRoomId: string
+  /**
+   * Guests of a hotel rooming list
+   * @type {Array<HotelRoomingListGuest>}
+   * @memberof HotelRoomingList
+   */
+  hotelRoomingListGuests: HotelRoomingListGuest[]
+  /**
+   *
+   * @type {string}
+   * @memberof HotelRoomingList
+   */
+  id: string
+  /**
+   *
+   * @type {string}
+   * @memberof HotelRoomingList
+   */
+  limitDate?: string | null
+}

package/src/types/elements/hotel.ts

@@ -0,0 +1,184 @@
+import type { Amenities } from './amenity.ts'
+import type { CurrencyType } from './currency.ts'
+import type { HotelImage } from './hotel-image.ts'
+import type { HotelImages } from './hotel-images.ts'
+import type { HotelReviewRating } from './hotel-review-rating.ts'
+import type { TravelTimeItem } from './travel-times.ts'
+
+export interface Hotel {
+  /**
+   * Hotel address.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  address?: string | null
+  /**
+   * Second part of hotel address.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  address2?: string | null
+  /**
+   *
+   * @type {Amenities}
+   * @memberof HotelApi
+   */
+  amenities?: Amenities | null
+  /**
+   * Check in time of the hotel.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  checkInTime?: string | null
+  /**
+   * Check out time of the hotel.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  checkOutTime?: string | null
+  /**
+   * City
+   * @type {string}
+   * @memberof HotelApi
+   */
+  city?: string | null
+  /**
+   * Country
+   * @type {string}
+   * @memberof HotelApi
+   */
+  country?: string | null
+  /**
+   * Hotel country code in ISO2.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  countryCode?: string | null
+  /**
+   *
+   * @type {CurrencyBookingApiClient}
+   * @memberof HotelApi
+   */
+  currency?: CurrencyType
+  /**
+   * Hotel description.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  description?: string | null
+  /**
+   * Distance from a requested location, expressed in meters
+   * @type {number}
+   * @memberof HotelApi
+   */
+  distance?: number | null
+  /**
+   * Hotel email.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  email?: string | null
+  /**
+   * Hotel fax number.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  fax?: string | null
+  /**
+   * List of hotel images in various sizes featuring an indicator for the primary (hero) image
+   * @type {Array<HotelImage>}
+   * @memberof HotelApi
+   */
+  hotelImages?: HotelImage[] | null
+  /**
+   * 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.
+   * @type {Array<HotelReviewRating>}
+   * @memberof HotelApi
+   */
+  hotelReviewRatings?: HotelReviewRating[] | null
+  /**
+   * Hotel id.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  id: string
+  /**
+   *
+   * @type {HotelImages}
+   * @memberof HotelApi
+   */
+  images?: HotelImages | null
+  /**
+   * Hotel latitude.
+   * @type {number}
+   * @memberof HotelApi
+   */
+  latitude: number
+  /**
+   * Hotel longitude.
+   * @type {number}
+   * @memberof HotelApi
+   */
+  longitude: number
+  /**
+   * Hotel name.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  name: string
+  /**
+   * Hotel phone number.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  phone?: string | null
+  /**
+   * Internal policy of the hotel.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  policy?: string | null
+  /**
+   * Hotel address postal code.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  postalCode?: string | null
+  /**
+   * Hotel Star rating.
+   * @type {any}
+   * @memberof HotelApi
+   */
+  // oxlint-disable-next-line no-explicit-any
+  rating?: any | null
+  /**
+   * Hotel address state.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  state?: string | null
+  /**
+   * TripAdvisor property id. When applicable.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  taId?: string | null
+  /**
+   * Hotel timezone.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  timezone: string
+  /**
+   *
+   * @type {Array<TravelTimesApi>}
+   * @memberof HotelApi
+   */
+  venues?: TravelTimeItem[]
+  /**
+   * Hotel website url.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  website?: string | null
+}

package/src/types/elements/index.ts

@@ -0,0 +1,22 @@
+export type * from './bed.ts'
+export type * from './booking-policy.ts'
+export type * from './cancellation-policy.ts'
+export type * from './event-metadata.ts'
+export type * from './hotel-image.ts'
+export type * from './hotel-images.ts'
+export type * from './hotel-offer-request.ts'
+export type * from './hotel-room-offer.ts'
+export * from './hotel-room-offer-type.ts'
+export * from './hotel-room-offer-package-type.ts'
+export type * from './hotel-room-offer-request.ts'
+export type * from './hotel-room.ts'
+export { SourceMarketEnum } from './source-market.ts'
+export type * from './tag.ts'
+export * from './tax.ts'
+export * from './booking.ts'
+export * from './payment-method.ts'
+export * from './invoice.ts'
+export type * from './hotel.ts'
+export * from './hotel-offer.ts'
+export * from './contact-person.ts'
+export type * from './hotel-review-rating.ts'

package/src/types/elements/invoice.ts

@@ -0,0 +1,21 @@
+export interface InvoiceApi {
+  /**
+   *
+   * @type {string}
+   * @memberof InvoiceApi
+   */
+  type: InvoiceApiType
+  /**
+   *
+   * @type {string}
+   * @memberof InvoiceApi
+   */
+  url: string
+}
+
+export enum InvoiceApiTypeEnum {
+  CreditNote = 'credit_note',
+  Invoice = 'invoice',
+}
+
+type InvoiceApiType = `${InvoiceApiTypeEnum}`