@revolugo/common 7.0.1 → 7.1.0-alpha.0

package/src/types/elements/amenity.ts

@@ -113,6 +113,12 @@ export interface Amenities {
    * @memberof Amenities
    */
   handicapAccessible?: boolean
+  /**
+   * Indoor pool.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  indoorPool?: boolean
   /**
    * In house bar.
    * @type {boolean}
@@ -131,12 +137,6 @@ export interface Amenities {
    * @memberof Amenities
    */
   inRoomMovies?: boolean
-  /**
-   * Indoor pool.
-   * @type {boolean}
-   * @memberof Amenities
-   */
-  indoorPool?: boolean
   /**
    * Interior room entrance.
    * @type {boolean}
@@ -216,17 +216,17 @@ export interface Amenities {
    */
   sauna?: boolean
   /**
-   * TV in room.
+   * Tennis court.
    * @type {boolean}
    * @memberof Amenities
    */
-  tVInRoom?: boolean
+  tennisCourt?: boolean
   /**
-   * Tennis court.
+   * TV in room.
    * @type {boolean}
    * @memberof Amenities
    */
-  tennisCourt?: boolean
+  tVInRoom?: boolean
   /**
    *  24/7 security.
    * @type {boolean}

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

@@ -3,6 +3,12 @@ import type { CurrencyType } from './currency.ts'
 import type { HotelRoomOffer } from './hotel-room-offer.ts'
 
 export interface BookingPolicies {
+  /**
+   * **Booking Policy** id
+   * @type {string}
+   * @memberof BookingPolicies
+   */
+  id: string
   /**
    * The total number of adults who will be staying in the property.
    * @type {number}
@@ -35,10 +41,11 @@ export interface BookingPolicies {
   children?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof BookingPolicies
    */
   currency: CurrencyType
+
   /**
    * Expiration date for this **Booking Policy**.
    *
@@ -47,7 +54,6 @@ export interface BookingPolicies {
    * @memberof BookingPolicies
    */
   expiresAt: string | null
-
   hasRoomingLists: boolean
   /**
    * Hotel id
@@ -61,12 +67,6 @@ export interface BookingPolicies {
    * @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).
    *

package/src/types/elements/booking.ts

@@ -10,6 +10,12 @@ import type { SourceMarket } from './source-market.ts'
 import type { Tax } from './tax.ts'
 
 export interface Booking {
+  /**
+   * Booking Id
+   * @type {string}
+   * @memberof Booking
+   */
+  id?: string | null
   /**
    * The total number of adults who will be staying in the property.
    * @type {number}
@@ -72,7 +78,7 @@ export interface Booking {
   createdAt: string
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof Booking
    */
   currency: CurrencyType
@@ -100,12 +106,6 @@ export interface Booking {
    * @memberof Booking
    */
   hotelId: string
-  /**
-   *
-   * @type {HotelRoomOffer}
-   * @memberof Booking
-   */
-  hotelRoomOffer: HotelRoomOffer
   /**
    * Hotel rooming lists of a hotel booking
    * @type {Array<HotelRoomingList>}
@@ -113,11 +113,11 @@ export interface Booking {
    */
   hotelRoomingLists?: HotelRoomingList[]
   /**
-   * Booking Id
-   * @type {string}
+   *
+   * @type {HotelRoomOffer}
    * @memberof Booking
    */
-  id?: string | null
+  hotelRoomOffer: HotelRoomOffer
   /**
    * The list of invoices and credit notes (when applicable) direct urls associated to the Booking.
    * @type {Array<InvoiceApi>}
@@ -184,18 +184,18 @@ export interface Booking {
    * @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
+  /**
+   * Price of the booking including taxes expressed in the booking currency.
+   * @type {number}
+   * @memberof Booking
+   */
+  taxIncludedPrice: number
   /**
    * Link to Revolugo terms and conditions under which the booking is made.
    * @type {string}

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

@@ -163,6 +163,13 @@ export interface PrebookFormValues {
   firstName: ContactPerson['firstName']
   lastName: ContactPerson['lastName']
   nationality: ContactPerson['nationality']
+  organizationAddress?: string
+  organizationCity?: string
+  organizationCountry?: string
+  organizationName?: string
+  organizationState?: string
+  organizationVatNumber?: string
+  organizationZipCode?: string
   phoneCountry: CountryIso2Code
   phoneNumber: string
   salutation: ContactPerson['salutation']

package/src/types/elements/elements-events.ts

@@ -35,6 +35,7 @@ export enum ElementsEvent {
   HotelOffersPollingStarted = 'hotel-offers:polling:started',
   HotelOffersRetrieved = 'hotel-offers:retrieved',
   HotelRetrieved = 'hotel:retrieved',
+  HotelRoomOfferItemVisible = 'hotel-room-offer:item:visible',
   HotelRoomOfferRequestCreated = 'hotel-room-offer-request:created',
   HotelRoomOfferRequestRetrieved = 'hotel-room-offer-request:retrieved',
   HotelRoomOffersBtnClick = 'hotel-room-offers:click:btn',
@@ -68,6 +69,7 @@ export interface ElementsEventCallbacks {
   [ElementsEvent.HotelOffersPollingStarted]: any
   [ElementsEvent.HotelOffersRetrieved]: HotelOffer[]
   [ElementsEvent.HotelRetrieved]: Hotel
+  [ElementsEvent.HotelRoomOfferItemVisible]: [HotelRoomOffer, number]
   [ElementsEvent.HotelRoomOfferRequestCreated]: HotelRoomOfferRequestResponse
   [ElementsEvent.HotelRoomOfferRequestRetrieved]: HotelRoomOfferRequestResponse
   [ElementsEvent.HotelRoomOffersBtnClick]: HotelRoomOffer

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

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

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

@@ -12,11 +12,11 @@ export type HotelOffersSortByOrderType = `${HotelOffersSortByOrderEnum}`
 
 export interface HotelOffersListPayload {
   currency: CurrencyType
-  hotelOfferRequestId: string
   endingBefore?: string | null
   filterByPrice?: string
   filterByReviewRating?: number
   filterByStar?: string
+  hotelOfferRequestId: string
   hotelRoomOffersLimit?: number
   includeHotelContentDetails?: boolean | null
   lang?: Locale

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

@@ -2,6 +2,11 @@ import type { EventMetadata } from './event-metadata.ts'
 import type { SourceMarket } from './source-market.ts'
 
 export interface HotelOfferRequest {
+  /**
+   * id of the **Hotel Offer Request**
+   * @type {string}
+   */
+  id: string
   /**
    * 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.
    *
@@ -29,6 +34,12 @@ export interface HotelOfferRequest {
    * @type {string}
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadata}
@@ -60,20 +71,15 @@ export interface HotelOfferRequest {
    * @type {SourceMarket}
    */
   sourceMarket: SourceMarket
-  /**
-   * Date of the **Hotel Room Offer Request** creation
-   * @type {string}
-   * @memberof HotelOfferRequestApiResponse
-   */
-  createdAt: string
+}
+
+export interface HotelOfferRequestResponse {
   /**
    * id of the **Hotel Offer Request**
    * @type {string}
+   * @memberof HotelOfferRequestApiResponse
    */
   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.
    *
@@ -106,6 +112,12 @@ export interface HotelOfferRequestResponse {
    * @memberof HotelOfferRequestApiResponse
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Offer Request** creation
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadataApi}
@@ -142,18 +154,6 @@ export interface HotelOfferRequestResponse {
    * @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
 }
 
 export interface HotelOfferRequestCreate {

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

@@ -9,6 +9,12 @@ import type { TravelTimeItem } from './travel-times.ts'
 import type { CurrencyCode } from '../../currencies/constants.ts'
 
 export interface HotelOffer {
+  /**
+   * Hotel id.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  id: string
   /**
    * Hotel address.
    * @type {string}
@@ -59,7 +65,7 @@ export interface HotelOffer {
   countryCode?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelOffer
    */
   currency?: CurrencyCode
@@ -102,11 +108,11 @@ export interface HotelOffer {
    */
   hotelReviewRatings?: HotelReviewRating[] | null
   /**
-   * Hotel id.
-   * @type {string}
+   *
+   * @type {Array<HotelRoomOffer>}
    * @memberof HotelOffer
    */
-  id: string
+  hotelRoomOffers: HotelRoomOffer[]
   /**
    *
    * @type {HotelImages}
@@ -162,6 +168,12 @@ export interface HotelOffer {
    * @memberof HotelOffer
    */
   state?: string | null
+  /**
+   *
+   * @type {Array<Tag>}
+   * @memberof HotelOffer
+   */
+  tags?: Tag[]
   /**
    * TripAdvisor property id. When applicable.
    * @type {string}
@@ -186,18 +198,6 @@ export interface HotelOffer {
    * @memberof HotelOffer
    */
   website?: string | null
-  /**
-   *
-   * @type {Array<HotelRoomOffer>}
-   * @memberof HotelOffer
-   */
-  hotelRoomOffers: HotelRoomOffer[]
-  /**
-   *
-   * @type {Array<Tag>}
-   * @memberof HotelOffer
-   */
-  tags?: Tag[]
 }
 
 export enum HotelOffersSortByEnum {

package/src/types/elements/hotel-offers-filters.ts

@@ -9,9 +9,9 @@ export enum FilterName {
 }
 
 export interface HotelOffersFilters {
+  [FilterName.Price]: [number, number]
   [FilterName.Rating]: string
   [FilterName.ReviewRating]?: number
-  [FilterName.Price]: [number, number]
   [FilterName.SortBy]: {
     direction: HotelOffersSortByOrderType
     value: HotelOffersSortByEnum

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

@@ -2,6 +2,12 @@ import type { EventMetadata } from './event-metadata.ts'
 import type { SourceMarket } from './source-market.ts'
 
 export interface HotelRoomOfferRequest {
+  /**
+   * id of the **Hotel Room Offer Request**
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  id: string
   /**
    * Requested number of adult(s) to be accommodated.
    * @type {number}
@@ -26,6 +32,12 @@ export interface HotelRoomOfferRequest {
    * @memberof HotelRoomOfferRequest
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadata}
@@ -50,21 +62,15 @@ export interface HotelRoomOfferRequest {
    * @memberof HotelRoomOfferRequest
    */
   sourceMarket: SourceMarket
-  /**
-   * Date of the **Hotel Room Offer Request** creation
-   * @type {string}
-   * @memberof HotelRoomOfferRequest
-   */
-  createdAt: string
+}
+
+export interface HotelRoomOfferRequestResponse {
   /**
    * id of the **Hotel Room Offer Request**
    * @type {string}
-   * @memberof HotelRoomOfferRequest
+   * @memberof HotelRoomOfferRequestApiResponse
    */
   id: string
-}
-
-export interface HotelRoomOfferRequestResponse {
   /**
    * Requested number of adult(s) to be accommodated.
    * @type {number}
@@ -89,6 +95,12 @@ export interface HotelRoomOfferRequestResponse {
    * @memberof HotelRoomOfferRequestApiResponse
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadataApi}
@@ -113,18 +125,6 @@ export interface HotelRoomOfferRequestResponse {
    * @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<

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

@@ -70,6 +70,12 @@ export interface HotelRoomOffersDataResponse {
  * @interface HotelRoomOffer
  */
 export interface HotelRoomOffer {
+  /**
+   * Hotel Room Offer id.
+   * @type {string}
+   * @memberof HotelRoomOffer
+   */
+  id?: string
   /**
    * Quantity of breakfast per night included in the given **Hotel Room Offer**
    * @type {number}
@@ -122,7 +128,7 @@ export interface HotelRoomOffer {
   count?: number | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelRoomOffer
    */
   currency: CurrencyType
@@ -138,12 +144,6 @@ export interface HotelRoomOffer {
    * @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:
    *
@@ -157,7 +157,7 @@ export interface HotelRoomOffer {
    * @type {string}
    * @memberof HotelRoomOffer
    */
-  packageType?: HotelRoomOfferPackageType
+  packageType?: HotelRoomOfferPackageType | null
   /**
    * Price with taxes NOT INCLUDED of the given **Hotel Room Offer** including breakfast(s) when applicable, expressed in the requested **currency**.
    * @type {number}
@@ -172,18 +172,16 @@ export interface HotelRoomOffer {
   sourceMarket: SourceMarket
   /**
    *
-   * @type {Array<Tag>}
+   * @type {StayTaxesInfo}
    * @memberof HotelRoomOffer
    */
-  tags?: Tag[]
+  stayTaxesInfo: StayTaxesInfo
   /**
-   * 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}
+   * @type {Array<Tag>}
    * @memberof HotelRoomOffer
    */
-  taxIncludedPrice: number
+  tags?: Tag[]
   /**
    *
    * @type {Array<Tax>}
@@ -192,11 +190,13 @@ export interface HotelRoomOffer {
   taxes?: Tax[]
 
   /**
+   * 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**.
    *
-   * @type {StayTaxesInfo}
+   * 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
    */
-  stayTaxesInfo: StayTaxesInfo
+  taxIncludedPrice: number
 
   /**
    * Hotel Room Offer type.
@@ -259,7 +259,7 @@ export interface HotelRoomOfferResponse {
   children?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelRoomOfferResponse
    */
   currency: CurrencyType

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

@@ -2,6 +2,12 @@ import type { Bed } from './bed.ts'
 import type { HotelImage } from './hotel-image.ts'
 
 export interface HotelRoom {
+  /**
+   * Hotel Room id, when applicable.
+   * @type {string}
+   * @memberof HotelRoom
+   */
+  id: string
   /**
    * List of amenities in the room. May be subject to changes at the Hotel.
    * @type {Array<string>}
@@ -52,12 +58,6 @@ export interface HotelRoom {
    * @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>}

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

@@ -6,16 +6,22 @@ export interface HotelRoomingListGuest {
    * @type {string}
    * @memberof HotelRoomingListGuest
    */
-  fullname: string
+  id: string
   /**
    *
    * @type {string}
    * @memberof HotelRoomingListGuest
    */
-  id: string
+  fullname: string
 }
 
 export interface HotelRoomingList {
+  /**
+   *
+   * @type {string}
+   * @memberof HotelRoomingList
+   */
+  id: string
   /**
    *
    * @type {HotelRoom}
@@ -34,12 +40,6 @@ export interface HotelRoomingList {
    * @memberof HotelRoomingList
    */
   hotelRoomingListGuests: HotelRoomingListGuest[]
-  /**
-   *
-   * @type {string}
-   * @memberof HotelRoomingList
-   */
-  id: string
   /**
    *
    * @type {string}

package/src/types/elements/hotel.ts

@@ -6,6 +6,12 @@ import type { HotelReviewRating } from './hotel-review-rating.ts'
 import type { TravelTimeItem } from './travel-times.ts'
 
 export interface Hotel {
+  /**
+   * Hotel id.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  id: string
   /**
    * Hotel address.
    * @type {string}
@@ -56,7 +62,7 @@ export interface Hotel {
   countryCode?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof HotelApi
    */
   currency?: CurrencyType
@@ -96,12 +102,6 @@ export interface Hotel {
    * @memberof HotelApi
    */
   hotelReviewRatings?: HotelReviewRating[] | null
-  /**
-   * Hotel id.
-   * @type {string}
-   * @memberof HotelApi
-   */
-  id: string
   /**
    *
    * @type {HotelImages}