@revolugo/common 6.9.5 → 6.9.6-beta.1

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

@@ -0,0 +1,158 @@
+import type { CountryIso2Code } from '#constants'
+
+type CountryIso2CodeType = `${CountryIso2Code}`
+
+export interface ContactPerson {
+  /**
+   * Contact person's postal code of residence
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  address?: string | null
+  /**
+   * Contact person's city of residence
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  city?: string | null
+  /**
+   *
+   * @type {CountryIso2Code}
+   * @memberof ContactPerson
+   */
+  country?: CountryIso2CodeType | null
+  /**
+   * Contact person's email address
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  email: string
+  /**
+   * Contact person's first name
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  firstName: string
+  /**
+   * Set the prefered language to use when contacting the contact person for booking related communication(s).
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  lang?: ContactPersonLang
+  /**
+   * Contact person's last name
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  lastName: string
+  /**
+   *
+   * @type {CountryIso2Code}
+   * @memberof ContactPerson
+   */
+  nationality: CountryIso2CodeType
+  /**
+   *
+   * @type {ContactPersonOrganization}
+   * @memberof ContactPerson
+   */
+  organization?: ContactPersonOrganization | null
+  /**
+   * Contact person's phone number
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  phone: string
+  /**
+   * Contact person's remarks
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  remarks?: string
+  /**
+   * Title of the contact person
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  salutation?: ContactPersonSalutation
+  /**
+   * Contact person's state of residence
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  state?: string | null
+  /**
+   * Contact person's postal code of residence
+   * @type {string}
+   * @memberof ContactPerson
+   */
+  zipCode?: string | null
+}
+
+export enum ContactPersonLangEnum {
+  DeDe = 'de-DE',
+  EnUs = 'en-US',
+  EsEs = 'es-ES',
+  FrFr = 'fr-FR',
+  ItIt = 'it-IT',
+  NlNl = 'nl-NL',
+  PtPt = 'pt-PT',
+}
+
+type ContactPersonLang = `${ContactPersonLangEnum}`
+
+export enum ContactPersonSalutationEnum {
+  Dr = 'dr',
+  Mr = 'mr',
+  Mrs = 'mrs',
+  Ms = 'ms',
+  NotSpecified = 'notSpecified',
+  Prof = 'prof',
+}
+
+type ContactPersonSalutation = `${ContactPersonSalutationEnum}`
+
+export interface ContactPersonOrganization {
+  /**
+   * Address of the organization
+   * @type {string}
+   * @memberof ContactPersonOrganization
+   */
+  address: string
+  /**
+   * City of the organization
+   * @type {string}
+   * @memberof ContactPersonOrganization
+   */
+  city: string
+  /**
+   *
+   * @type {CountryIso2Code}
+   * @memberof ContactPersonOrganization
+   */
+  country: CountryIso2CodeType
+  /**
+   * Name of the organization
+   * @type {string}
+   * @memberof ContactPersonOrganization
+   */
+  name: string
+  /**
+   * State of the organization
+   * @type {string}
+   * @memberof ContactPersonOrganization
+   */
+  state?: string | null
+  /**
+   * VAT Number of the organization
+   * @type {string}
+   * @memberof ContactPersonOrganization
+   */
+  vatNumber?: string | null
+  /**
+   * ZIP Code of the organization
+   * @type {string}
+   * @memberof ContactPersonOrganization
+   */
+  zipCode: string
+}

package/src/types/elements/currency.ts

@@ -0,0 +1,3 @@
+import type { Currency } from '#constants'
+
+export type CurrencyType = `${Currency}`

package/src/types/elements/event-metadata.ts

@@ -0,0 +1,38 @@
+export interface EventMetadata {
+  /**
+   * End date of the event formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof EventMetadata
+   */
+  dateEnd?: string
+  /**
+   * Start date of the event formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof EventMetadata
+   */
+  dateStart?: string
+  /**
+   * Unique id of the event
+   * @type {string}
+   * @memberof EventMetadata
+   */
+  id?: string
+  /**
+   * Image URL of the event
+   * @type {string}
+   * @memberof EventMetadata
+   */
+  imageUrl?: string
+  /**
+   * Name of the event
+   * @type {string}
+   * @memberof EventMetadata
+   */
+  name?: string
+  /**
+   * Unique slug of the event
+   * @type {string}
+   * @memberof EventMetadata
+   */
+  slug?: string
+}

package/src/types/elements/event.ts

@@ -0,0 +1,14 @@
+export interface Event {
+  /**
+   * Unique name of the event
+   * @type {string}
+   * @memberof EventApi
+   */
+  name?: string | null
+  /**
+   * Unique slug of the event
+   * @type {string}
+   * @memberof EventApi
+   */
+  slug?: string | null
+}

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

@@ -0,0 +1,44 @@
+export interface HotelImage {
+  /**
+   *
+   * @type {string}
+   * @memberof HotelImage
+   */
+  caption?: string | null
+  /**
+   *
+   * @type {boolean}
+   * @memberof HotelImage
+   */
+  isHeroImage: boolean
+  /**
+   *
+   * @type {string}
+   * @memberof HotelImage
+   */
+  l: string
+  /**
+   *
+   * @type {string}
+   * @memberof HotelImage
+   */
+  m: string
+  /**
+   *
+   * @type {string}
+   * @memberof HotelImage
+   */
+  s: string
+  /**
+   *
+   * @type {string}
+   * @memberof HotelImage
+   */
+  xl: string
+  /**
+   *
+   * @type {string}
+   * @memberof HotelImage
+   */
+  xs: string
+}

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

@@ -0,0 +1,47 @@
+/**
+ * 🛑 DEPRECATED - Hotel images details.
+ *
+ * In 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.
+ *
+ * e.g.: https://s3.eu-west-3.amazonaws.com/revolugo/hotels/yhKY/images/highres/0.jpg
+ * @export
+ * @interface HotelImages
+ */
+export interface HotelImages {
+  /**
+   * Number of images.
+   * @type {number}
+   * @memberof HotelImages
+   */
+  count?: number | null
+  /**
+   * Whether images exist in highres format.
+   * @type {boolean}
+   * @memberof HotelImages
+   */
+  highres?: boolean | null
+  /**
+   * Whether images exist in lowres format.
+   * @type {boolean}
+   * @memberof HotelImages
+   */
+  lowres?: boolean | null
+  /**
+   * Base URL for the images.
+   * @type {string}
+   * @memberof HotelImages
+   */
+  prefix?: string | null
+  /**
+   * This parameter usually represents the extension of the image (e.g.: .jpg, .png)
+   * @type {string}
+   * @memberof HotelImages
+   */
+  suffix?: string | null
+  /**
+   * Whether images exist in thumb format (for thumbnails preview).
+   * @type {boolean}
+   * @memberof HotelImages
+   */
+  thumb?: boolean | null
+}

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

@@ -0,0 +1,82 @@
+import type { EventMetadata } from './event-metadata.ts'
+import type { SourceMarket } from './source-market.ts'
+
+export interface HotelOfferRequest {
+  /**
+   * This endpoint allows to find the geo-coordinates of a known address, place or locality via this free-text address query field. This address will eventually be geocoded into a latitude/longitude pair.
+   *
+   * <b style="color: red;">If address cannot be geocoded (transformed into a latitude/longitude pair) provided **latitude** and **longitude** parameters will be used as fallback.</b>
+   * @type {string}
+   */
+  address?: string | null
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   */
+  adultCount: number
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   */
+  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}
+   */
+  children?: string | null
+  /**
+   *
+   * @type {EventMetadata}
+   */
+  eventMetadata?: EventMetadata | null
+  /**
+   * Search location latitude.
+   *
+   * <b style="color: red;"> when no address parameter passed.</b>
+   * @type {number}
+   */
+  latitude?: number | null
+  /**
+   * Search location longitude.
+   *
+   * <b style="color: red;"> when no address parameter passed.</b>
+   * @type {number}
+   */
+  longitude?: number | null
+  /**
+   * 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.
+   *
+   * Constraint: 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.
+   * @type {number}
+   */
+  roomCount: number
+  /**
+   *
+   * @type {SourceMarket}
+   */
+  sourceMarket: SourceMarket
+  /**
+   * id of the **Hotel Offer Request**
+   * @type {string}
+   */
+  id: string
+}
+
+export type HotelOfferRequestCreate = Pick<
+  HotelOfferRequest,
+  | 'address'
+  | 'adultCount'
+  | 'checkInDate'
+  | 'checkOutDate'
+  | 'children'
+  | 'eventMetadata'
+  | 'latitude'
+  | 'longitude'
+  | 'roomCount'
+  | 'sourceMarket'
+>

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

@@ -0,0 +1,200 @@
+import type { Currency } from '#constants'
+import type { Amenities } from './amenity.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 { HotelRoomOffer } from './hotel-room-offer.ts'
+import type { Tag } from './tag.ts'
+import type { TravelTimeItem } from './travel-times.ts'
+
+export interface HotelOffer {
+  /**
+   * Hotel address.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  address?: string | null
+  /**
+   * Second part of hotel address.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  address2?: string | null
+  /**
+   *
+   * @type {Amenities}
+   * @memberof HotelOffer
+   */
+  amenities?: Amenities | null
+  /**
+   * Check in time of the hotel.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  checkInTime?: string | null
+  /**
+   * Check out time of the hotel.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  checkOutTime?: string | null
+  /**
+   * City
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  city?: string | null
+  /**
+   * Country
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  country?: string | null
+  /**
+   * Hotel country code in ISO2.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  countryCode?: string | null
+  /**
+   *
+   * @type {CurrencyBookingApiClient}
+   * @memberof HotelOffer
+   */
+  currency?: Currency
+  /**
+   * Hotel description.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  description?: string | null
+  /**
+   * Distance from a requested location, expressed in meters
+   * @type {number}
+   * @memberof HotelOffer
+   */
+  distance?: number | null
+  /**
+   * Hotel email.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  email?: string | null
+  /**
+   * Hotel fax number.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  fax?: string | null
+  /**
+   * ⚠️ Cached images of the hotel. May be empty, use the endpoint /hotels/{id}/images to get the latest images.
+   *
+   * List of hotel images in various sizes featuring an indicator for the primary (hero) image
+   * @type {Array<HotelImageApi>}
+   * @memberof HotelOffer
+   */
+  hotelImages: HotelImage[]
+  /**
+   * 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 HotelOffer
+   */
+  hotelReviewRatings?: HotelReviewRating[] | null
+  /**
+   * Hotel id.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  id: string
+  /**
+   *
+   * @type {HotelImages}
+   * @memberof HotelOffer
+   */
+  images?: HotelImages | null
+  /**
+   * Hotel latitude.
+   * @type {number}
+   * @memberof HotelOffer
+   */
+  latitude: number
+  /**
+   * Hotel longitude.
+   * @type {number}
+   * @memberof HotelOffer
+   */
+  longitude: number
+  /**
+   * Hotel name.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  name: string
+  /**
+   * Hotel phone number.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  phone?: string | null
+  /**
+   * Internal policy of the hotel.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  policy?: string | null
+  /**
+   * Hotel address postal code.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  postalCode?: string | null
+  /**
+   * Hotel Star rating.
+   * @type {any}
+   * @memberof HotelOffer
+   */
+  // oxlint-disable-next-line no-explicit-any
+  rating?: any | null
+  /**
+   * Hotel address state.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  state?: string | null
+  /**
+   * TripAdvisor property id. When applicable.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  taId?: string | null
+  /**
+   * Hotel timezone.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  timezone: string
+  /**
+   *
+   * @type {Array<TravelTimeItem>}
+   * @memberof HotelOffer
+   */
+  venues?: TravelTimeItem[]
+  /**
+   * Hotel website url.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  website?: string | null
+  /**
+   *
+   * @type {Array<HotelRoomOffer>}
+   * @memberof HotelOffer
+   */
+  hotelRoomOffers: HotelRoomOffer[]
+  /**
+   *
+   * @type {Array<Tag>}
+   * @memberof HotelOffer
+   */
+  tags?: Tag[]
+}

package/src/types/elements/hotel-review-rating.ts

@@ -0,0 +1,14 @@
+export interface HotelReviewRating {
+  /**
+   * Category of the collected reviews for the Hotel.
+   * @type {string}
+   * @memberof HotelReviewRating
+   */
+  category?: string | null
+  /**
+   * Rating of the collected review for the Hotel.
+   * @type {number}
+   * @memberof HotelReviewRating
+   */
+  rating: number
+}

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

@@ -0,0 +1,8 @@
+export enum HotelRoomOfferPackageTypeEnum {
+  BestMatch = 'BEST_MATCH',
+  Cheapest = 'CHEAPEST',
+  MatchingRoomCount = 'MATCHING_ROOM_COUNT',
+  Regular = 'REGULAR',
+}
+
+export type HotelRoomOfferPackageType = `${HotelRoomOfferPackageTypeEnum}`

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

@@ -0,0 +1,77 @@
+import type { EventMetadata } from './event-metadata.ts'
+import type { SourceMarket } from './source-market.ts'
+
+export interface HotelRoomOfferRequest {
+  /**
+   * Requested number of adult(s) to be accommodated.
+   * @type {number}
+   * @memberof HotelRoomOfferRequest
+   */
+  adultCount: number
+  /**
+   * Check-in date formatted as `YYYY-MM-DD`.
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  checkInDate: string
+  /**
+   * Check-out date formatted as `YYYY-MM-DD`.
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  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 HotelRoomOfferRequest
+   */
+  children?: string | null
+  /**
+   *
+   * @type {EventMetadata}
+   * @memberof HotelRoomOfferRequest
+   */
+  eventMetadata?: EventMetadata | null
+  /**
+   * id of requested hotel
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  hotelId: string
+  /**
+   * Number of room(s) requested. 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.
+   * @type {number}
+   * @memberof HotelRoomOfferRequest
+   */
+  roomCount: number
+  /**
+   *
+   * @type {SourceMarket}
+   * @memberof HotelRoomOfferRequest
+   */
+  sourceMarket: SourceMarket
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  createdAt: string
+  /**
+   * id of the **Hotel Room Offer Request**
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  id: string
+}
+
+export type HotelRoomOfferRequestCreate = Pick<
+  HotelRoomOfferRequest,
+  | 'adultCount'
+  | 'checkInDate'
+  | 'checkOutDate'
+  | 'children'
+  | 'eventMetadata'
+  | 'hotelId'
+  | 'roomCount'
+  | 'sourceMarket'
+>

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

@@ -0,0 +1,6 @@
+export enum HotelRoomOfferTypeEnum {
+  HotelRoom = 'HOTEL_ROOM',
+  Package = 'PACKAGE',
+}
+
+export type HotelRoomOfferType = `${HotelRoomOfferTypeEnum}`