@revolugo/common 6.9.6 → 6.9.7-beta.1

package/src/models/paginated-queries.ts

@@ -1,5 +1,6 @@
 import type { IPaginatedQueriesConfig } from '../types/index.ts'
 
+/* @__PURE__ */
 export const PAGINATED_QUERY_DEFAULT_CONFIG: IPaginatedQueriesConfig = {
   defaultScope: {
     limit: 20,

package/src/types/country.ts

@@ -1,5 +1,5 @@
-import type { ISO_COUNTRIES } from '../constants/countries.ts'
 import type { Currency } from '../constants/currencies.ts'
+import type { ISO_COUNTRIES } from '../countries/constants.ts'
 
 export type CountryIsoCode = (typeof ISO_COUNTRIES)[number]
 

package/src/types/elements/amenity.ts

@@ -0,0 +1,266 @@
+export interface Amenities {
+  /**
+   * Air conditioning.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  airConditioning?: boolean
+  /**
+   * Airport transportation service.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  airportTransportation?: boolean
+  /**
+   * Business center.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  businessCenter?: boolean
+  /**
+   * Car rental desk service.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  carRentDesk?: boolean
+  /**
+   * Children welcomed.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  childrenAllowed?: boolean
+  /**
+   * Clothing iron.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  clothingIron?: boolean
+  /**
+   * Coffea/tea maker.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  coffeeTeaMaker?: boolean
+  /**
+   * Combination.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  combination?: boolean
+  /**
+   * Continental Breakfast.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  continentalBreakfast?: boolean
+  /**
+   * Data ports in room.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  dataPorts?: boolean
+  /**
+   * Dry cleaning.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  dryCleaning?: boolean
+  /**
+   * Electornic room keys.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  electronicRoomKeys?: boolean
+  /**
+   * Exterior room entrance.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  exteriorRoomEntrance?: boolean
+  /**
+   * Family rooms.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  familyRooms?: boolean
+  /**
+   * Fitness facility.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  fitnessFacility?: boolean
+  /**
+   * Game room.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  gameRoom?: boolean
+  /**
+   * Golf course.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  golfCourse?: boolean
+  /**
+   * Hair dryer.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  hairDryer?: boolean
+  /**
+   * Handicap Accessible.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  handicapAccessible?: boolean
+  /**
+   * In house bar.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  inHouseBar?: boolean
+  /**
+   * In house dining.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  inHouseDining?: boolean
+  /**
+   * In room movies.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  inRoomMovies?: boolean
+  /**
+   * Indoor pool.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  indoorPool?: boolean
+  /**
+   * Interior room entrance.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  interiorRoomEntrance?: boolean
+  /**
+   * Kitchen.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  kitchen?: boolean
+  /**
+   * Map.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  map?: boolean
+  /**
+   * Meeting rooms.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  meetingRooms?: boolean
+  /**
+   * mini bar in room.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  miniBarInRoom?: boolean
+  /**
+   * Non smoking rooms.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  nonSmokingRooms?: boolean
+  /**
+   * Outdoor pool.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  outdoorPool?: boolean
+  /**
+   * Parking garage.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  parkingGarage?: boolean
+  /**
+   * Pets allowed.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  petsAllowed?: boolean
+  /**
+   * Restricted access.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  restrictedAccess?: boolean
+  /**
+   * Room service.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  roomService?: boolean
+  /**
+   * Safe in room.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  safe?: boolean
+  /**
+   * Sauna.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  sauna?: boolean
+  /**
+   * TV in room.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  tVInRoom?: boolean
+  /**
+   * Tennis court.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  tennisCourt?: boolean
+  /**
+   *  24/7 security.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  twentyFourHourSecurity?: boolean
+  /**
+   * Valet parking.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  valetParking?: boolean
+  /**
+   * Video check out.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  videoCheckOut?: boolean
+  /**
+   * Voice mail.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  voiceMail?: boolean
+  /**
+   * Wake up service.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  wakeUpService?: boolean
+  /**
+   * Whirpool.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  whirpool?: boolean
+}

package/src/types/elements/bed.ts

@@ -0,0 +1,20 @@
+export interface Bed {
+  /**
+   * Number of beds of the given type in the room.
+   * @type {number}
+   * @memberof BedApi
+   */
+  count: number
+  /**
+   * Bed name.
+   * @type {string}
+   * @memberof BedApi
+   */
+  name: string
+  /**
+   * Bed occupancy.
+   * @type {number}
+   * @memberof BedApi
+   */
+  occupancy: number
+}

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

@@ -0,0 +1,80 @@
+import type { CancellationPolicy } from './cancellation-policy.ts'
+import type { CurrencyType } from './currency.ts'
+import type { HotelRoomOffer } from './hotel-room-offer.ts'
+
+export interface BookingPolicies {
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   * @memberof BookingPolicies
+   */
+  adultCount: number
+  /**
+   * The list of cancellation policy date range with their corresponding penalty percentage.
+   * @type {Array<CancellationPolicy>}
+   * @memberof BookingPolicies
+   */
+  cancellationPolicies: CancellationPolicy[]
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof BookingPolicies
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof BookingPolicies
+   */
+  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 BookingPolicies
+   */
+  children?: string | null
+  /**
+   *
+   * @type {CurrencyBookingApiClient}
+   * @memberof BookingPolicies
+   */
+  currency: CurrencyType
+  /**
+   * Expiration date for this **Booking Policy**.
+   *
+   * The 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.
+   * @type {string}
+   * @memberof BookingPolicies
+   */
+  expiresAt: string | null
+  /**
+   * Hotel id
+   * @type {string}
+   * @memberof BookingPolicies
+   */
+  hotelId: string
+  /**
+   *
+   * @type {HotelRoomOffer}
+   * @memberof BookingPolicies
+   */
+  hotelRoomOffer: HotelRoomOffer
+  /**
+   * **Booking Policy** id
+   * @type {string}
+   * @memberof BookingPolicies
+   */
+  id: string
+  /**
+   * 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).
+   *
+   * In 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.
+   *
+   * If **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).
+   *
+   * ⚠️ It is strongly advised to clearly inform your customer of any price increase that may occur.
+   * @type {boolean}
+   * @memberof BookingPolicies
+   */
+  isPriceIncreased: boolean
+}

package/src/types/elements/booking.ts

@@ -0,0 +1,236 @@
+import type { CancellationPolicy } from './cancellation-policy.ts'
+import type { ContactPerson } from './contact-person.ts'
+import type { CurrencyType } from './currency.ts'
+import type { Event } from './event.ts'
+import type { HotelRoomOffer } from './hotel-room-offer.ts'
+import type { HotelRoomingList } from './hotel-rooming-list.ts'
+import type { InvoiceApi } from './invoice.ts'
+import type { PaymentMethodApi } from './payment-method.ts'
+import type { SourceMarket } from './source-market.ts'
+import type { Tax } from './tax.ts'
+
+export interface Booking {
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   * @memberof Booking
+   */
+  adultCount: number
+  /**
+   * Date of booking cancellation request, when applicable.
+   * @type {string}
+   * @memberof Booking
+   */
+  canceledAt?: string | null
+  /**
+   * The list of cancellation policy date range with their corresponding penalty percentage.
+   * @type {Array<CancellationPolicy>}
+   * @memberof Booking
+   */
+  cancellationPolicies: CancellationPolicy[]
+  /**
+   * Remarks about the cancellation policy.
+   * @type {string}
+   * @memberof Booking
+   */
+  cancellationPolicyRemarks?: string | null
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof Booking
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof Booking
+   */
+  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 Booking
+   */
+  children?: string | null
+  /**
+   * Date of booking confirmation request, when applicable.
+   * @type {string}
+   * @memberof Booking
+   */
+  confirmedAt?: string | null
+  /**
+   *
+   * @type {ContactPerson}
+   * @memberof Booking
+   */
+  contactPerson: ContactPerson
+  /**
+   * Creation date of the **Booking**.
+   * @type {string}
+   * @memberof Booking
+   */
+  createdAt: string
+  /**
+   *
+   * @type {CurrencyBookingApiClient}
+   * @memberof Booking
+   */
+  currency: CurrencyType
+  /**
+   * Customer Reference of the requested Booking (sometimes to present by the customer at hotel check-in).
+   * @type {string}
+   * @memberof Booking
+   */
+  customerReference?: string | null
+  /**
+   *
+   * @type {Event}
+   * @memberof Booking
+   */
+  event?: Event | null
+  /**
+   * Date of booking failure, when applicable.
+   * @type {string}
+   * @memberof Booking
+   */
+  failedAt?: string | null
+  /**
+   * Hotel Id of the requested Booking.
+   * @type {string}
+   * @memberof Booking
+   */
+  hotelId: string
+  /**
+   *
+   * @type {HotelRoomOffer}
+   * @memberof Booking
+   */
+  hotelRoomOffer: HotelRoomOffer
+  /**
+   * Hotel rooming lists of a hotel booking
+   * @type {Array<HotelRoomingList>}
+   * @memberof Booking
+   */
+  hotelRoomingLists?: HotelRoomingList[]
+  /**
+   * Booking Id
+   * @type {string}
+   * @memberof Booking
+   */
+  id?: string | null
+  /**
+   * The list of invoices and credit notes (when applicable) direct urls associated to the Booking.
+   * @type {Array<InvoiceApi>}
+   * @memberof Booking
+   */
+  invoices?: InvoiceApi[] | null
+  /**
+   * Date of the last booking status update.
+   * @type {string}
+   * @memberof Booking
+   */
+  lastStatusUpdatedAt: string
+  /**
+   * You can use this parameter to attach key-value data to bookings. Metadata is useful for storing additional, structured information on a booking. As an example, you could store your user's full name and corresponding unique identifier from your system on a booking. Metadata is not used internally by the Booking Engine and won't be seen by your users unless you choose to show it to them.
+   * @type {{ [key: string]: string; }}
+   * @memberof Booking
+   */
+  metadata?: {
+    [key: string]: string
+  } | null
+  /**
+   * Booking Pay Later Status
+   * @type {string}
+   * @memberof Booking
+   */
+  payLater?: BookingApiPayLater
+  /**
+   * List of preferred payment methods to be used along with their respective payload (when applicable) in order to fulfill the booking.
+   *
+   * ⚠️ This field is only returned when **booking.status = bkg-created**
+   * @type {Array<PaymentMethodApi>}
+   * @memberof Booking
+   */
+  paymentMethods?: PaymentMethodApi[]
+  /**
+   * Penalty percentage of the requested Booking.
+   *
+   *  When **booking.status = bkg-cx** this is the percentage of the **booking.tax_included_price** that have been charged on the canceled booking. Otherwise, this field won't be returned.
+   * @type {number}
+   * @memberof Booking
+   */
+  penaltyPercentage?: number | null
+  /**
+   * Booking Reference of the requested Booking.
+   * @type {string}
+   * @memberof Booking
+   */
+  reference: string
+  /**
+   *
+   * @type {SourceMarket}
+   * @memberof Booking
+   */
+  sourceMarket: SourceMarket
+  /**
+   * Booking status. Please, refer to [Booking Status](/v1/documentation#tag/Booking-Status) for details.
+   * @type {string}
+   * @memberof Booking
+   */
+  status: BookingStatus
+  /**
+   * Total tax amount expressed in the booking currency.
+   * @type {number}
+   * @memberof Booking
+   */
+  taxAmount: number
+  /**
+   * Price of the booking including taxes expressed in the booking currency.
+   * @type {number}
+   * @memberof Booking
+   */
+  taxIncludedPrice: number
+  /**
+   *
+   * @type {Array<Tax>}
+   * @memberof Booking
+   */
+  taxes?: Tax[] | null
+  /**
+   * Link to Revolugo terms and conditions under which the booking is made.
+   * @type {string}
+   * @memberof Booking
+   */
+  terms: string
+  /**
+   * This is the token to pass as URL params to [Cancel Booking endpoint](/v1/documentation#operation/deleteV1BookingsId) in order to perform a cancel request on the booking. If you want to cancel a booking, you should use this token instead of the booking id.
+   *
+   * ⚠️ For security reasons, this token is unique and once generated, it is valid during a period of 10 minutes.
+   *
+   * In order to get a fresh valid token you need to call **[Retrieve Booking endpoint](/v1/documentation#operation/getV1BookingsId)**.
+   * @type {string}
+   * @memberof Booking
+   */
+  token?: string | null
+}
+
+export enum BookingApiPayLaterEnum {
+  Disabled = 'DISABLED',
+  Enabled = 'ENABLED',
+  Forced = 'FORCED',
+}
+
+type BookingApiPayLater = `${BookingApiPayLaterEnum}`
+
+export enum BookingStatusEnum {
+  Cx = 'bkg-cx',
+  Cf = 'bkg-cf',
+  Created = 'bkg-created',
+  Af = 'bkg-af',
+  Ip = 'bkg-ip',
+  Pc = 'bkg-pc',
+  Pp = 'bkg-pp',
+  Qr = 'bkg-qr',
+}
+
+type BookingStatus = `${BookingStatusEnum}`

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

@@ -0,0 +1,20 @@
+export interface CancellationPolicy {
+  /**
+   * The start date and time of the cancellation policy, given in the hotel timezone.
+   * @type {string}
+   * @memberof CancellationPolicyApi
+   */
+  dateFrom: string
+  /**
+   * The end date and time of the cancellation policy, given in the hotel timezone.
+   * @type {string}
+   * @memberof CancellationPolicyApi
+   */
+  dateTo: string
+  /**
+   * The penalty percentage that is due in case of cancellation during the **date_from** to **date_to** period range.
+   * @type {number}
+   * @memberof CancellationPolicyApi
+   */
+  penaltyPercentage: number
+}