@revolugo/booking-api-client
Version:
Javascript Revolugo Booking API Client (browser + server)
85 lines (84 loc) • 3.34 kB
TypeScript
import { EventMetadataApi } from './EventMetadataApi';
import { SourceMarket } from './SourceMarket';
/**
*
* @export
* @interface HotelOfferRequestCreateApi
*/
export interface HotelOfferRequestCreateApi {
/**
* 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 HotelOfferRequestCreateApi
*/
address?: string | null;
/**
* The total number of adults who will be staying in the property.
* @type {number}
* @memberof HotelOfferRequestCreateApi
*/
adultCount: number;
/**
* Date of check-in formatted as YYYY-MM-DD.
* @type {string}
* @memberof HotelOfferRequestCreateApi
*/
checkInDate: string;
/**
* Date of check-out formatted as YYYY-MM-DD.
* @type {string}
* @memberof HotelOfferRequestCreateApi
*/
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 HotelOfferRequestCreateApi
*/
children?: string | null;
/**
*
* @type {EventMetadataApi}
* @memberof HotelOfferRequestCreateApi
*/
eventMetadata?: EventMetadataApi | null;
/**
* Search location latitude.
*
* <b style="color: red;"> when no address parameter passed.</b>
* @type {number}
* @memberof HotelOfferRequestCreateApi
*/
latitude?: number | null;
/**
* Search location longitude.
*
* <b style="color: red;"> when no address parameter passed.</b>
* @type {number}
* @memberof HotelOfferRequestCreateApi
*/
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 HotelOfferRequestCreateApi
*/
roomCount: number;
/**
*
* @type {SourceMarket}
* @memberof HotelOfferRequestCreateApi
*/
sourceMarket: SourceMarket;
}
/**
* Check if a given object implements the HotelOfferRequestCreateApi interface.
*/
export declare function instanceOfHotelOfferRequestCreateApi(value: object): boolean;
export declare function HotelOfferRequestCreateApiFromJSON(json: any): HotelOfferRequestCreateApi;
export declare function HotelOfferRequestCreateApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOfferRequestCreateApi;
export declare function HotelOfferRequestCreateApiToJSON(value?: HotelOfferRequestCreateApi | null): any;