@revolugo/booking-api-client 7.2.4-alpha.2 → 7.2.4-alpha.21

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

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

package/dist/types/v1/models/BedApi.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 BedApi
+ */
+export interface BedApi {
+    /**
+     * 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;
+}
+/**
+ * Check if a given object implements the BedApi interface.
+ */
+export declare function instanceOfBedApi(value: object): boolean;
+export declare function BedApiFromJSON(json: any): BedApi;
+export declare function BedApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): BedApi;
+export declare function BedApiToJSON(value?: BedApi | null): any;

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;