@revolugo/common 6.10.9-beta.20 → 6.10.9-beta.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "6.10.9-beta.20",
+  "version": "6.10.9-beta.22",
   "private": false,
   "description": "Revolugo common",
   "author": "Revolugo",

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

@@ -0,0 +1,29 @@
+import type { CurrencyType } from './currency.ts'
+import type { HotelOffersSortByType } from './hotel-offer.ts'
+// eslint-disable-next-line no-restricted-imports
+import type { Locale } from '../../constants/index.ts'
+
+export enum HotelOffersSortByOrderEnum {
+  Asc = 'asc',
+  Desc = 'desc',
+}
+
+export type HotelOffersSortByOrderType = `${HotelOffersSortByOrderEnum}`
+
+export interface HotelOffersListPayload {
+  currency: CurrencyType
+  hotelOfferRequestId: string
+  endingBefore?: string | null
+  filterByPrice?: string
+  filterByReviewRating?: number
+  filterByStar?: string
+  hotelRoomOffersLimit?: number
+  includeHotelContentDetails?: boolean | null
+  lang?: Locale
+  limit?: number
+  onlyRecommendedHotelOffers?: boolean | null
+  priceHistogramStepCount?: number
+  sortBy?: HotelOffersSortByType
+  sortByOrder?: HotelOffersSortByOrderType
+  startingAfter?: string | null
+}

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

@@ -60,9 +60,98 @@ export interface HotelOfferRequest {
    * @type {SourceMarket}
    */
   sourceMarket: SourceMarket
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  createdAt: string
+  /**
+   * id of the **Hotel Offer Request**
+   * @type {string}
+   */
+  id: string
+}
+
+export interface HotelOfferRequestResponse {
+  /**
+   * 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}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  address?: string | null
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  adultCount: number
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  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 HotelOfferRequestApiResponse
+   */
+  children?: string | null
+  /**
+   *
+   * @type {EventMetadataApi}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  eventMetadata?: EventMetadata | null
+  /**
+   * Search location latitude.
+   *
+   * <b style="color: red;"> when no address parameter passed.</b>
+   * @type {number}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  latitude?: number | null
+  /**
+   * Search location longitude.
+   *
+   * <b style="color: red;"> when no address parameter passed.</b>
+   * @type {number}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  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}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  roomCount: number
+  /**
+   *
+   * @type {SourceMarket}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  sourceMarket: SourceMarket
+  /**
+   * Date of the **Hotel Offer Request** creation
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  createdAt: string
   /**
    * id of the **Hotel Offer Request**
    * @type {string}
+   * @memberof HotelOfferRequestApiResponse
    */
   id: string
 }

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

@@ -207,3 +207,5 @@ export enum HotelOffersSortByEnum {
   ReviewRating = 'review_rating',
   TopPicks = 'top_picks',
 }
+
+export type HotelOffersSortByType = `${HotelOffersSortByEnum}`

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

@@ -64,6 +64,69 @@ export interface HotelRoomOfferRequest {
   id: string
 }
 
+export interface HotelRoomOfferRequestResponse {
+  /**
+   * Requested number of adult(s) to be accommodated.
+   * @type {number}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  adultCount: number
+  /**
+   * Check-in date formatted as `YYYY-MM-DD`.
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  checkInDate: string
+  /**
+   * Check-out date formatted as `YYYY-MM-DD`.
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  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 HotelRoomOfferRequestApiResponse
+   */
+  children?: string | null
+  /**
+   *
+   * @type {EventMetadataApi}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  eventMetadata?: EventMetadata | null
+  /**
+   * id of requested hotel
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  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 HotelRoomOfferRequestApiResponse
+   */
+  roomCount: number
+  /**
+   *
+   * @type {SourceMarket}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  sourceMarket: SourceMarket
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  createdAt: string
+  /**
+   * id of the **Hotel Room Offer Request**
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  id: string
+}
+
 export type HotelRoomOfferRequestCreate = Pick<
   HotelRoomOfferRequest,
   | 'adultCount'

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

@@ -3,12 +3,64 @@ 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 { MetaPollingResponse } from './meta-polling.ts'
 import type { SourceMarket } from './source-market.ts'
 import type { Tag } from './tag.ts'
 import type { Tax } from './tax.ts'
 // eslint-disable-next-line no-restricted-imports
 import type { BreakfastOptionType } from '../../constants/index.ts'
 
+export interface HotelRoomOffersDataResponse {
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  adultCount: number
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  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 HotelRoomOffersDataApiResponse
+   */
+  children?: string | null
+  /**
+   *
+   * @type {CurrencyType}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  currency: CurrencyType
+  /**
+   * Hotel id
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  hotelId: string
+  /**
+   * List of **Hotel Room Offers** sorted by price ascending.
+   * @type {HotelRoomOffer[]}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  hotelRoomOffers: HotelRoomOffer[]
+  /**
+   * Hotel timezone
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  hotelTimezone: string
+}
+
 /**
  * Description of the Hotel Room Offer.
  * @export
@@ -147,6 +199,28 @@ export interface HotelRoomOffer {
   type?: HotelRoomOfferType
 }
 
+export interface HotelRoomOffersResponse {
+  /**
+   *
+   * @type {HotelRoomOffersDataResponse}
+   * @memberof HotelRoomOffersApiResponse
+   */
+  data: HotelRoomOffersDataResponse
+  /**
+   *
+   * @type {any}
+   * @memberof HotelRoomOffersApiResponse
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  event?: any | null
+  /**
+   *
+   * @type {MetaApiPollingResponse}
+   * @memberof HotelRoomOffersApiResponse
+   */
+  meta: MetaPollingResponse
+}
+
 export interface HotelRoomOfferResponse {
   /**
    * The total number of adults who will be staying in the property.

package/src/types/elements/index.ts

@@ -21,3 +21,4 @@ export * from './hotel-offer.ts'
 export * from './contact-person.ts'
 export type * from './hotel-review-rating.ts'
 export type * from './travel-times.ts'
+export * from './hotel-offer-list.ts'

package/src/types/elements/meta-polling.ts

@@ -0,0 +1,31 @@
+// eslint-disable-next-line no-restricted-imports
+import type { PollerStatus } from '../../constants/poller.ts'
+
+type PollerType = `${PollerStatus}`
+
+export interface MetaPollingResponse {
+  /**
+   * A cursor to use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+   * @type {string}
+   * @memberof MetaApiPollingResponse
+   */
+  endingBefore?: string | null
+  /**
+   * A limit on the number of object to be returned.
+   * @type {number}
+   * @memberof MetaApiPollingResponse
+   */
+  limit?: number
+  /**
+   * A cursor to use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+   * @type {string}
+   * @memberof MetaApiPollingResponse
+   */
+  startingAfter?: string | null
+  /**
+   *
+   * @type {PollerType}
+   * @memberof MetaApiPollingResponse
+   */
+  status: PollerType
+}