@revolugo/booking-api-client/dist/types/v1/models/HotelRoomOffersCreateApi.d.ts

Javascript Revolugo Booking API Client (browser + server)

import { CurrencyClient } from './CurrencyClient';
import { HotelRoomOffersDataCreateApi } from './HotelRoomOffersDataCreateApi';
import { Locale } from './Locale';
/**
 *
 * @export
 * @interface HotelRoomOffersCreateApi
 */
export interface HotelRoomOffersCreateApi {
    /**
     * 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 HotelRoomOffersCreateApi
     */
    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 HotelRoomOffersCreateApi
     */
    breakfastCount?: number;
    /**
     *
     * @type {CurrencyClient}
     * @memberof HotelRoomOffersCreateApi
     */
    currency: CurrencyClient;
    /**
     *
     * @type {Array<HotelRoomOffersDataCreateApi>}
     * @memberof HotelRoomOffersCreateApi
     */
    hotelRoomOffers: Array<HotelRoomOffersDataCreateApi>;
    /**
     *
     * @type {Locale}
     * @memberof HotelRoomOffersCreateApi
     */
    lang?: Locale | null;
}
/**
 * Check if a given object implements the HotelRoomOffersCreateApi interface.
 */
export declare function instanceOfHotelRoomOffersCreateApi(value: object): boolean;
export declare function HotelRoomOffersCreateApiFromJSON(json: any): HotelRoomOffersCreateApi;
export declare function HotelRoomOffersCreateApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelRoomOffersCreateApi;
export declare function HotelRoomOffersCreateApiToJSON(value?: HotelRoomOffersCreateApi | null): any;