@revolugo/booking-api-client 7.2.4-alpha.5 → 7.2.4-alpha.7

package/dist/types/v1/models/BookingApi.d.ts

@@ -0,0 +1,267 @@
+import { CancellationPolicyApi } from './CancellationPolicyApi';
+import { ContactPersonApi } from './ContactPersonApi';
+import { CurrencyClient } from './CurrencyClient';
+import { EventApi } from './EventApi';
+import { HotelRoomOfferApi } from './HotelRoomOfferApi';
+import { HotelRoomingListApi } from './HotelRoomingListApi';
+import { InvoiceApi } from './InvoiceApi';
+import { PaymentMethodApi } from './PaymentMethodApi';
+import { SourceMarket } from './SourceMarket';
+import { TaxApi } from './TaxApi';
+/**
+ * Booking record
+ * @export
+ * @interface BookingApi
+ */
+export interface BookingApi {
+    /**
+     * Additional instructions on how to check-in.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    additionalCheckInInstruction?: string | null;
+    /**
+     * Additional house policy, house manual, or condominium rules.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    additionalPolicies?: string | null;
+    /**
+     * The total number of adults who will be staying in the property.
+     * @type {number}
+     * @memberof BookingApi
+     */
+    adultCount: number;
+    /**
+     * Date of booking cancellation request, when applicable.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    canceledAt?: string | null;
+    /**
+     * The list of cancellation policy date range with their corresponding penalty percentage.
+     * @type {Array<CancellationPolicyApi>}
+     * @memberof BookingApi
+     */
+    cancellationPolicies: Array<CancellationPolicyApi>;
+    /**
+     * Remarks about the cancellation policy.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    cancellationPolicyRemarks?: string | null;
+    /**
+     * Date of check-in formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    checkInDate: string;
+    /**
+     * Date of check-out formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    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 BookingApi
+     */
+    children?: string | null;
+    /**
+     * Date of booking confirmation request, when applicable.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    confirmedAt?: string | null;
+    /**
+     *
+     * @type {ContactPersonApi}
+     * @memberof BookingApi
+     */
+    contactPerson: ContactPersonApi;
+    /**
+     * Creation date of the **Booking**.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {CurrencyClient}
+     * @memberof BookingApi
+     */
+    currency: CurrencyClient;
+    /**
+     * Customer Reference of the requested Booking (sometimes to present by the customer at hotel check-in).
+     * @type {string}
+     * @memberof BookingApi
+     */
+    customerReference?: string | null;
+    /**
+     *
+     * @type {EventApi}
+     * @memberof BookingApi
+     */
+    event?: EventApi | null;
+    /**
+     * Date of booking failure, when applicable.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    failedAt?: string | null;
+    /**
+     * Code your guest might need to show to the hotel during check-in. This number will only but available a few days prior to check-in and it’s subject to availability.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    hotelConfirmationId?: string | null;
+    /**
+     * Hotel Id of the requested Booking.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    hotelId: string;
+    /**
+     *
+     * @type {HotelRoomOfferApi}
+     * @memberof BookingApi
+     */
+    hotelRoomOffer: HotelRoomOfferApi;
+    /**
+     * Hotel rooming lists of a hotel booking
+     * @type {Array<HotelRoomingListApi>}
+     * @memberof BookingApi
+     */
+    hotelRoomingLists?: Array<HotelRoomingListApi>;
+    /**
+     * Booking Id
+     * @type {string}
+     * @memberof BookingApi
+     */
+    id?: string | null;
+    /**
+     * The list of invoices and credit notes (when applicable) direct urls associated to the Booking.
+     * @type {Array<InvoiceApi>}
+     * @memberof BookingApi
+     */
+    invoices?: Array<InvoiceApi> | null;
+    /**
+     * Date of the last booking status update.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    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 BookingApi
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Booking Pay Later Status
+     * @type {string}
+     * @memberof BookingApi
+     */
+    payLater?: BookingApiPayLaterEnum;
+    /**
+     * 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 BookingApi
+     */
+    paymentMethods?: Array<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 BookingApi
+     */
+    penaltyPercentage?: number | null;
+    /**
+     * Booking Reference of the requested Booking.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    reference: string;
+    /**
+     *
+     * @type {SourceMarket}
+     * @memberof BookingApi
+     */
+    sourceMarket: SourceMarket;
+    /**
+     * Booking status. Please, refer to [Booking Status](/v1/documentation#tag/Booking-Status) for details.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    status: BookingApiStatusEnum;
+    /**
+     * Total tax amount expressed in the booking currency.
+     * @type {number}
+     * @memberof BookingApi
+     */
+    taxAmount: number;
+    /**
+     * Price of the booking including taxes expressed in the booking currency.
+     * @type {number}
+     * @memberof BookingApi
+     */
+    taxIncludedPrice: number;
+    /**
+     *
+     * @type {Array<TaxApi>}
+     * @memberof BookingApi
+     */
+    taxes?: Array<TaxApi> | null;
+    /**
+     * Link to Revolugo terms and conditions under which the booking is made.
+     * @type {string}
+     * @memberof BookingApi
+     */
+    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 BookingApi
+     */
+    token?: string | null;
+}
+/**
+ * @export
+ */
+export declare const BookingApiPayLaterEnum: {
+    readonly Disabled: "DISABLED";
+    readonly Enabled: "ENABLED";
+    readonly Forced: "FORCED";
+};
+export type BookingApiPayLaterEnum = typeof BookingApiPayLaterEnum[keyof typeof BookingApiPayLaterEnum];
+/**
+ * @export
+ */
+export declare const BookingApiStatusEnum: {
+    readonly Cx: "bkg-cx";
+    readonly Cf: "bkg-cf";
+    readonly Created: "bkg-created";
+    readonly Af: "bkg-af";
+    readonly Ip: "bkg-ip";
+    readonly Pc: "bkg-pc";
+    readonly Pp: "bkg-pp";
+    readonly Qr: "bkg-qr";
+};
+export type BookingApiStatusEnum = typeof BookingApiStatusEnum[keyof typeof BookingApiStatusEnum];
+/**
+ * Check if a given object implements the BookingApi interface.
+ */
+export declare function instanceOfBookingApi(value: object): boolean;
+export declare function BookingApiFromJSON(json: any): BookingApi;
+export declare function BookingApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookingApi;
+export declare function BookingApiToJSON(value?: BookingApi | null): any;

package/dist/types/v1/models/BookingCreateApi.d.ts

@@ -0,0 +1,55 @@
+import { BookingCreateApiGuestsListInner } from './BookingCreateApiGuestsListInner';
+import { ContactPersonApi } from './ContactPersonApi';
+import { PaymentMethodRequestApi } from './PaymentMethodRequestApi';
+/**
+ *
+ * @export
+ * @interface BookingCreateApi
+ */
+export interface BookingCreateApi {
+    /**
+     * Booking policy id to book, returned from previous **[Create Booking Policies endpoint](/v1/documentation#operation/postV1Booking_policies)** call
+     * @type {string}
+     * @memberof BookingCreateApi
+     */
+    bookingPolicyId: string;
+    /**
+     *
+     * @type {ContactPersonApi}
+     * @memberof BookingCreateApi
+     */
+    contactPerson: ContactPersonApi;
+    /**
+     *
+     * @type {Array<BookingCreateApiGuestsListInner>}
+     * @memberof BookingCreateApi
+     */
+    guestsList?: Array<BookingCreateApiGuestsListInner>;
+    /**
+     * 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 BookingCreateApi
+     */
+    metadata?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * List of preferred payment methods to be used along with their respective payload (when applicable) in order to fulfill the booking.
+     * @type {Array<PaymentMethodRequestApi>}
+     * @memberof BookingCreateApi
+     */
+    paymentMethods?: Array<PaymentMethodRequestApi>;
+    /**
+     *
+     * @type {string}
+     * @memberof BookingCreateApi
+     */
+    trackingId?: string | null;
+}
+/**
+ * Check if a given object implements the BookingCreateApi interface.
+ */
+export declare function instanceOfBookingCreateApi(value: object): boolean;
+export declare function BookingCreateApiFromJSON(json: any): BookingCreateApi;
+export declare function BookingCreateApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookingCreateApi;
+export declare function BookingCreateApiToJSON(value?: BookingCreateApi | null): any;

package/dist/types/v1/models/BookingCreateApiGuestsListInner.d.ts

@@ -0,0 +1,27 @@
+import { BookingCreateApiGuestsListInnerGuestsInner } from './BookingCreateApiGuestsListInnerGuestsInner';
+/**
+ *
+ * @export
+ * @interface BookingCreateApiGuestsListInner
+ */
+export interface BookingCreateApiGuestsListInner {
+    /**
+     *
+     * @type {Array<BookingCreateApiGuestsListInnerGuestsInner>}
+     * @memberof BookingCreateApiGuestsListInner
+     */
+    guests: Array<BookingCreateApiGuestsListInnerGuestsInner>;
+    /**
+     *
+     * @type {string}
+     * @memberof BookingCreateApiGuestsListInner
+     */
+    hotelRoomId: string;
+}
+/**
+ * Check if a given object implements the BookingCreateApiGuestsListInner interface.
+ */
+export declare function instanceOfBookingCreateApiGuestsListInner(value: object): boolean;
+export declare function BookingCreateApiGuestsListInnerFromJSON(json: any): BookingCreateApiGuestsListInner;
+export declare function BookingCreateApiGuestsListInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookingCreateApiGuestsListInner;
+export declare function BookingCreateApiGuestsListInnerToJSON(value?: BookingCreateApiGuestsListInner | null): any;

package/dist/types/v1/models/BookingCreateApiGuestsListInnerGuestsInner.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Revolugo Booking API Reference
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface BookingCreateApiGuestsListInnerGuestsInner
+ */
+export interface BookingCreateApiGuestsListInnerGuestsInner {
+    /**
+     *
+     * @type {string}
+     * @memberof BookingCreateApiGuestsListInnerGuestsInner
+     */
+    fullname: string;
+}
+/**
+ * Check if a given object implements the BookingCreateApiGuestsListInnerGuestsInner interface.
+ */
+export declare function instanceOfBookingCreateApiGuestsListInnerGuestsInner(value: object): boolean;
+export declare function BookingCreateApiGuestsListInnerGuestsInnerFromJSON(json: any): BookingCreateApiGuestsListInnerGuestsInner;
+export declare function BookingCreateApiGuestsListInnerGuestsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookingCreateApiGuestsListInnerGuestsInner;
+export declare function BookingCreateApiGuestsListInnerGuestsInnerToJSON(value?: BookingCreateApiGuestsListInnerGuestsInner | null): any;

package/dist/types/v1/models/BookingPoliciesApi.d.ts

@@ -0,0 +1,97 @@
+import { CancellationPolicyApi } from './CancellationPolicyApi';
+import { CurrencyClient } from './CurrencyClient';
+import { HotelRoomOfferApi } from './HotelRoomOfferApi';
+/**
+ *
+ * @export
+ * @interface BookingPoliciesApi
+ */
+export interface BookingPoliciesApi {
+    /**
+     * The total number of adults who will be staying in the property.
+     * @type {number}
+     * @memberof BookingPoliciesApi
+     */
+    adultCount: number;
+    /**
+     * The list of cancellation policy date range with their corresponding penalty percentage.
+     * @type {Array<CancellationPolicyApi>}
+     * @memberof BookingPoliciesApi
+     */
+    cancellationPolicies: Array<CancellationPolicyApi>;
+    /**
+     * Date of check-in formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof BookingPoliciesApi
+     */
+    checkInDate: string;
+    /**
+     * Date of check-out formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof BookingPoliciesApi
+     */
+    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 BookingPoliciesApi
+     */
+    children?: string | null;
+    /**
+     *
+     * @type {CurrencyClient}
+     * @memberof BookingPoliciesApi
+     */
+    currency: CurrencyClient;
+    /**
+     * 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 {Date}
+     * @memberof BookingPoliciesApi
+     */
+    expiresAt: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BookingPoliciesApi
+     */
+    hasRoomingLists: boolean;
+    /**
+     * Hotel id
+     * @type {string}
+     * @memberof BookingPoliciesApi
+     */
+    hotelId: string;
+    /**
+     *
+     * @type {HotelRoomOfferApi}
+     * @memberof BookingPoliciesApi
+     */
+    hotelRoomOffer: HotelRoomOfferApi;
+    /**
+     * **Booking Policy** id
+     * @type {string}
+     * @memberof BookingPoliciesApi
+     */
+    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 BookingPoliciesApi
+     */
+    isPriceIncreased: boolean;
+}
+/**
+ * Check if a given object implements the BookingPoliciesApi interface.
+ */
+export declare function instanceOfBookingPoliciesApi(value: object): boolean;
+export declare function BookingPoliciesApiFromJSON(json: any): BookingPoliciesApi;
+export declare function BookingPoliciesApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookingPoliciesApi;
+export declare function BookingPoliciesApiToJSON(value?: BookingPoliciesApi | null): any;

package/dist/types/v1/models/BookingPoliciesCreateApi.d.ts

@@ -0,0 +1,53 @@
+import { Locale } from './Locale';
+/**
+ *
+ * @export
+ * @interface BookingPoliciesCreateApi
+ */
+export interface BookingPoliciesCreateApi {
+    /**
+     * This parameter allows to add breakfast to the booking as long as every requested Hotel Room Offers **breakfast_option = OPTIONAL** .
+     *
+     * The final breakfast count that will be included in the Hotel Room Offer will be returned in the response and is calculated as follows:
+     *
+     *  - If the returned Hotel Room Offer **total room count**  > **hotel_room_offer_request.adult_count** then **breakfast_count** will be equal to the **total room count** of the returned Hotel Room Offer,
+     *
+     *  - Otherwise **breakfast_count** will be equal to the minimum value between related **hotel_room_offer_request.adult_count** and returned Hotel Room Offer **total occupancy**.
+     *
+     *  <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;">If you already use this field, don't worry as we still support it with the following behaviour:</b>
+     * - <span style="color: orange;">When **add_breakfast = true** then **breakfast_count = MIN(guest count, total offer occupancy)** where **guest count** is the total number of adult and children over 3.</span>
+     * - <span style="color: orange;">Otherwise **breakfast_count = 0**.</span></div>
+     * @type {boolean}
+     * @memberof BookingPoliciesCreateApi
+     */
+    addBreakfast?: boolean | null;
+    /**
+     * This parameter describes the quantity of breakfast / night that should be included in the **Booking**. When **breakfast_option = OPTIONAL**, valid **breakfast_count** lower bound is **room count** and upper bound is **guest count**, where **guest count** is the number of adult and children over 3.
+     *
+     * ⚠️ The actual breakfast count that will be included in the **Booking** is the one that is returned in the response of this endpoint and might be different from this **breakfast_count** paramater in some cases. Please, make sure to check the actual breakfast count included in the **Hotel Room Offer** returned in the response of this endpoint.
+     * @type {number}
+     * @memberof BookingPoliciesCreateApi
+     */
+    breakfastCount?: number;
+    /**
+     * Id of requested **Hotel Room Offer** returned by [Retrieve Hotel Room Offers endpoint](/v1/documentation#operation/getV1Hotel_room_offers). Requested **Hotel Room Offer** must be of **type = PACKAGE**
+     * @type {string}
+     * @memberof BookingPoliciesCreateApi
+     */
+    hotelRoomOfferId: string;
+    /**
+     *
+     * @type {Locale}
+     * @memberof BookingPoliciesCreateApi
+     */
+    lang?: Locale | null;
+}
+/**
+ * Check if a given object implements the BookingPoliciesCreateApi interface.
+ */
+export declare function instanceOfBookingPoliciesCreateApi(value: object): boolean;
+export declare function BookingPoliciesCreateApiFromJSON(json: any): BookingPoliciesCreateApi;
+export declare function BookingPoliciesCreateApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookingPoliciesCreateApi;
+export declare function BookingPoliciesCreateApiToJSON(value?: BookingPoliciesCreateApi | null): any;

package/dist/types/v1/models/BookingsApiResponse.d.ts

@@ -0,0 +1,28 @@
+import { BookingApi } from './BookingApi';
+import { MetaResponseApi } from './MetaResponseApi';
+/**
+ *
+ * @export
+ * @interface BookingsApiResponse
+ */
+export interface BookingsApiResponse {
+    /**
+     * List of detailed Bookings
+     * @type {Array<BookingApi>}
+     * @memberof BookingsApiResponse
+     */
+    data: Array<BookingApi>;
+    /**
+     *
+     * @type {MetaResponseApi}
+     * @memberof BookingsApiResponse
+     */
+    meta: MetaResponseApi;
+}
+/**
+ * Check if a given object implements the BookingsApiResponse interface.
+ */
+export declare function instanceOfBookingsApiResponse(value: object): boolean;
+export declare function BookingsApiResponseFromJSON(json: any): BookingsApiResponse;
+export declare function BookingsApiResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookingsApiResponse;
+export declare function BookingsApiResponseToJSON(value?: BookingsApiResponse | null): any;

package/dist/types/v1/models/CancellationPolicyApi.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Revolugo Booking API Reference
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CancellationPolicyApi
+ */
+export interface CancellationPolicyApi {
+    /**
+     * 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;
+}
+/**
+ * Check if a given object implements the CancellationPolicyApi interface.
+ */
+export declare function instanceOfCancellationPolicyApi(value: object): boolean;
+export declare function CancellationPolicyApiFromJSON(json: any): CancellationPolicyApi;
+export declare function CancellationPolicyApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): CancellationPolicyApi;
+export declare function CancellationPolicyApiToJSON(value?: CancellationPolicyApi | null): any;