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

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

@@ -0,0 +1,216 @@
+import { AmenitiesApi } from './AmenitiesApi';
+import { CurrencyClient } from './CurrencyClient';
+import { HotelApiImages } from './HotelApiImages';
+import { HotelImageApi } from './HotelImageApi';
+import { HotelReviewRatingApi } from './HotelReviewRatingApi';
+import { HotelRoomOfferApi } from './HotelRoomOfferApi';
+import { TagApi } from './TagApi';
+import { TravelTimesApi } from './TravelTimesApi';
+/**
+ *
+ * @export
+ * @interface HotelOfferApi
+ */
+export interface HotelOfferApi {
+    /**
+     * Hotel address.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    address?: string | null;
+    /**
+     * Second part of hotel address.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    address2?: string | null;
+    /**
+     *
+     * @type {AmenitiesApi}
+     * @memberof HotelOfferApi
+     */
+    amenities?: AmenitiesApi | null;
+    /**
+     * Check in time of the hotel.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    checkInTime?: string | null;
+    /**
+     * Check out time of the hotel.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    checkOutTime?: string | null;
+    /**
+     * City
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    city?: string | null;
+    /**
+     * Country
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    country?: string | null;
+    /**
+     * Hotel country code in ISO2.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    countryCode?: string | null;
+    /**
+     *
+     * @type {CurrencyClient}
+     * @memberof HotelOfferApi
+     */
+    currency?: CurrencyClient;
+    /**
+     * Hotel description.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    description?: string | null;
+    /**
+     * Distance from a requested location, expressed in meters
+     * @type {number}
+     * @memberof HotelOfferApi
+     */
+    distance?: number | null;
+    /**
+     * Hotel email.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    email?: string | null;
+    /**
+     * Hotel fax number.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    fax?: string | null;
+    /**
+     * ⚠️ Cached images of the hotel. May be empty, use the endpoint /hotels/{id}/images to get the latest images.
+     *
+     * List of hotel images in various sizes featuring an indicator for the primary (hero) image
+     * @type {Array<HotelImageApi>}
+     * @memberof HotelOfferApi
+     */
+    hotelImages: Array<HotelImageApi>;
+    /**
+     * List of meta reviews (category and rating) that are summary of verified reviews collected across the web on the Hotel to help choose the best option.
+     * @type {Array<HotelReviewRatingApi>}
+     * @memberof HotelOfferApi
+     */
+    hotelReviewRatings?: Array<HotelReviewRatingApi> | null;
+    /**
+     * Hotel id.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    id: string;
+    /**
+     *
+     * @type {HotelApiImages}
+     * @memberof HotelOfferApi
+     */
+    images?: HotelApiImages | null;
+    /**
+     * Hotel latitude.
+     * @type {number}
+     * @memberof HotelOfferApi
+     */
+    latitude: number;
+    /**
+     * Hotel longitude.
+     * @type {number}
+     * @memberof HotelOfferApi
+     */
+    longitude: number;
+    /**
+     * Hotel name.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    name: string;
+    /**
+     * Hotel phone number.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    phone?: string | null;
+    /**
+     * Internal policy of the hotel.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    policy?: string | null;
+    /**
+     * Hotel address postal code.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    postalCode?: string | null;
+    /**
+     * Hotel Star rating.
+     * @type {number}
+     * @memberof HotelOfferApi
+     */
+    rating?: number | null;
+    /**
+     * Hotel review count
+     * @type {number}
+     * @memberof HotelOfferApi
+     */
+    reviewCount?: number | null;
+    /**
+     * Hotel address state.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    state?: string | null;
+    /**
+     * TripAdvisor property id. When applicable.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    taId?: string | null;
+    /**
+     * Hotel timezone.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    timezone: string;
+    /**
+     *
+     * @type {Array<TravelTimesApi>}
+     * @memberof HotelOfferApi
+     */
+    venues?: Array<TravelTimesApi>;
+    /**
+     * Hotel website url.
+     * @type {string}
+     * @memberof HotelOfferApi
+     */
+    website?: string | null;
+    /**
+     *
+     * @type {Array<HotelRoomOfferApi>}
+     * @memberof HotelOfferApi
+     */
+    hotelRoomOffers: Array<HotelRoomOfferApi>;
+    /**
+     *
+     * @type {Array<TagApi>}
+     * @memberof HotelOfferApi
+     */
+    tags?: Array<TagApi>;
+}
+/**
+ * Check if a given object implements the HotelOfferApi interface.
+ */
+export declare function instanceOfHotelOfferApi(value: object): boolean;
+export declare function HotelOfferApiFromJSON(json: any): HotelOfferApi;
+export declare function HotelOfferApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOfferApi;
+export declare function HotelOfferApiToJSON(value?: HotelOfferApi | null): any;

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

@@ -0,0 +1,37 @@
+import { HotelImageApi } from './HotelImageApi';
+import { HotelRoomOfferApi } from './HotelRoomOfferApi';
+import { TagApi } from './TagApi';
+/**
+ *
+ * @export
+ * @interface HotelOfferApiAllOf
+ */
+export interface HotelOfferApiAllOf {
+    /**
+     * ⚠️ Cached images of the hotel. May be empty, use the endpoint /hotels/{id}/images to get the latest images.
+     *
+     * List of hotel images in various sizes featuring an indicator for the primary (hero) image
+     * @type {Array<HotelImageApi>}
+     * @memberof HotelOfferApiAllOf
+     */
+    hotelImages: Array<HotelImageApi>;
+    /**
+     *
+     * @type {Array<HotelRoomOfferApi>}
+     * @memberof HotelOfferApiAllOf
+     */
+    hotelRoomOffers: Array<HotelRoomOfferApi>;
+    /**
+     *
+     * @type {Array<TagApi>}
+     * @memberof HotelOfferApiAllOf
+     */
+    tags?: Array<TagApi>;
+}
+/**
+ * Check if a given object implements the HotelOfferApiAllOf interface.
+ */
+export declare function instanceOfHotelOfferApiAllOf(value: object): boolean;
+export declare function HotelOfferApiAllOfFromJSON(json: any): HotelOfferApiAllOf;
+export declare function HotelOfferApiAllOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOfferApiAllOf;
+export declare function HotelOfferApiAllOfToJSON(value?: HotelOfferApiAllOf | null): any;

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

@@ -0,0 +1,94 @@
+import { EventMetadataApi } from './EventMetadataApi';
+import { SourceMarket } from './SourceMarket';
+/**
+ *
+ * @export
+ * @interface HotelOfferRequestApiResponse
+ */
+export interface HotelOfferRequestApiResponse {
+    /**
+     * Formatted address in the case of an hotel offer request created with an address that has been successfully geocoded.
+     * @type {string}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    address?: string | null;
+    /**
+     * The total number of adults who will be staying in the property.
+     * @type {number}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    adultCount: number;
+    /**
+     * Date of check-in formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    checkInDate: string;
+    /**
+     * Date of check-out formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    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 HotelOfferRequestApiResponse
+     */
+    children?: string | null;
+    /**
+     * Date of the **Hotel Room Offer Request** creation
+     * @type {string}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    createdAt: string;
+    /**
+     *
+     * @type {EventMetadataApi}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    eventMetadata?: EventMetadataApi | null;
+    /**
+     * id of the **Hotel Offer Request**
+     * @type {string}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    id: string;
+    /**
+     * Search location latitude.
+     *
+     * <b style="color: red;"> when no address parameter passed.</b>
+     * @type {number}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    latitude: number;
+    /**
+     * Search location longitude.
+     *
+     * <b style="color: red;"> when no address parameter passed.</b>
+     * @type {number}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    longitude: number;
+    /**
+     * 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 HotelOfferRequestApiResponse
+     */
+    roomCount: number;
+    /**
+     *
+     * @type {SourceMarket}
+     * @memberof HotelOfferRequestApiResponse
+     */
+    sourceMarket: SourceMarket;
+}
+/**
+ * Check if a given object implements the HotelOfferRequestApiResponse interface.
+ */
+export declare function instanceOfHotelOfferRequestApiResponse(value: object): boolean;
+export declare function HotelOfferRequestApiResponseFromJSON(json: any): HotelOfferRequestApiResponse;
+export declare function HotelOfferRequestApiResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOfferRequestApiResponse;
+export declare function HotelOfferRequestApiResponseToJSON(value?: HotelOfferRequestApiResponse | null): any;

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

@@ -0,0 +1,84 @@
+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;

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

@@ -0,0 +1,34 @@
+import { HotelOffersApiResponseMeta } from './HotelOffersApiResponseMeta';
+import { HotelOffersDataApiResponse } from './HotelOffersDataApiResponse';
+/**
+ *
+ * @export
+ * @interface HotelOffersApiResponse
+ */
+export interface HotelOffersApiResponse {
+    /**
+     *
+     * @type {HotelOffersDataApiResponse}
+     * @memberof HotelOffersApiResponse
+     */
+    data: HotelOffersDataApiResponse;
+    /**
+     *
+     * @type {any}
+     * @memberof HotelOffersApiResponse
+     */
+    event?: any | null;
+    /**
+     *
+     * @type {HotelOffersApiResponseMeta}
+     * @memberof HotelOffersApiResponse
+     */
+    meta: HotelOffersApiResponseMeta;
+}
+/**
+ * Check if a given object implements the HotelOffersApiResponse interface.
+ */
+export declare function instanceOfHotelOffersApiResponse(value: object): boolean;
+export declare function HotelOffersApiResponseFromJSON(json: any): HotelOffersApiResponse;
+export declare function HotelOffersApiResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOffersApiResponse;
+export declare function HotelOffersApiResponseToJSON(value?: HotelOffersApiResponse | null): any;

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

@@ -0,0 +1,45 @@
+import { PollerStatus } from './PollerStatus';
+/**
+ * Meta information about the response list, such as pagination cursors or status.
+ * @export
+ * @interface HotelOffersApiResponseMeta
+ */
+export interface HotelOffersApiResponseMeta {
+    /**
+     * A cursor to use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+     * @type {string}
+     * @memberof HotelOffersApiResponseMeta
+     */
+    endingBefore?: string | null;
+    /**
+     * A limit on the number of object to be returned.
+     * @type {number}
+     * @memberof HotelOffersApiResponseMeta
+     */
+    limit?: number;
+    /**
+     * A cursor to use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof HotelOffersApiResponseMeta
+     */
+    startingAfter?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof HotelOffersApiResponseMeta
+     */
+    totalCount: number;
+    /**
+     *
+     * @type {PollerStatus}
+     * @memberof HotelOffersApiResponseMeta
+     */
+    status: PollerStatus;
+}
+/**
+ * Check if a given object implements the HotelOffersApiResponseMeta interface.
+ */
+export declare function instanceOfHotelOffersApiResponseMeta(value: object): boolean;
+export declare function HotelOffersApiResponseMetaFromJSON(json: any): HotelOffersApiResponseMeta;
+export declare function HotelOffersApiResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOffersApiResponseMeta;
+export declare function HotelOffersApiResponseMetaToJSON(value?: HotelOffersApiResponseMeta | null): any;

package/dist/types/v1/models/HotelOffersApiResponseMetaAllOf.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 HotelOffersApiResponseMetaAllOf
+ */
+export interface HotelOffersApiResponseMetaAllOf {
+    /**
+     *
+     * @type {number}
+     * @memberof HotelOffersApiResponseMetaAllOf
+     */
+    totalCount: number;
+}
+/**
+ * Check if a given object implements the HotelOffersApiResponseMetaAllOf interface.
+ */
+export declare function instanceOfHotelOffersApiResponseMetaAllOf(value: object): boolean;
+export declare function HotelOffersApiResponseMetaAllOfFromJSON(json: any): HotelOffersApiResponseMetaAllOf;
+export declare function HotelOffersApiResponseMetaAllOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOffersApiResponseMetaAllOf;
+export declare function HotelOffersApiResponseMetaAllOfToJSON(value?: HotelOffersApiResponseMetaAllOf | null): any;

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

@@ -0,0 +1,70 @@
+import { CurrencyClient } from './CurrencyClient';
+import { HotelOfferApi } from './HotelOfferApi';
+/**
+ *
+ * @export
+ * @interface HotelOffersDataApiResponse
+ */
+export interface HotelOffersDataApiResponse {
+    /**
+     * The total number of adults who will be staying in the property.
+     * @type {number}
+     * @memberof HotelOffersDataApiResponse
+     */
+    adultCount: number;
+    /**
+     * Date of check-in formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof HotelOffersDataApiResponse
+     */
+    checkInDate: string;
+    /**
+     * Date of check-out formatted as YYYY-MM-DD.
+     * @type {string}
+     * @memberof HotelOffersDataApiResponse
+     */
+    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 HotelOffersDataApiResponse
+     */
+    children?: string | null;
+    /**
+     *
+     * @type {CurrencyClient}
+     * @memberof HotelOffersDataApiResponse
+     */
+    currency: CurrencyClient;
+    /**
+     * List of Hotel Offers
+     * @type {Array<HotelOfferApi>}
+     * @memberof HotelOffersDataApiResponse
+     */
+    hotelOffers: Array<HotelOfferApi>;
+    /**
+     * **Hotel Offers** price histogram dataset based on the price of the cheapest **Hotel Room Offer** included on each **Hotel Offer** returned. It represents the number of available **Hotel Offers** grouped by price sorted ascendingly. Each item of the list represents a price step based on returned **price_min**, **price_max** and requested **price_histogram_step_count**
+     * @type {Array<number>}
+     * @memberof HotelOffersDataApiResponse
+     */
+    priceHistogram?: Array<number> | null;
+    /**
+     * Maximum price of available returned **Hotel Offers**
+     * @type {number}
+     * @memberof HotelOffersDataApiResponse
+     */
+    priceMax?: number | null;
+    /**
+     * Minimum price of available returned **Hotel Offers**
+     * @type {number}
+     * @memberof HotelOffersDataApiResponse
+     */
+    priceMin?: number | null;
+}
+/**
+ * Check if a given object implements the HotelOffersDataApiResponse interface.
+ */
+export declare function instanceOfHotelOffersDataApiResponse(value: object): boolean;
+export declare function HotelOffersDataApiResponseFromJSON(json: any): HotelOffersDataApiResponse;
+export declare function HotelOffersDataApiResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelOffersDataApiResponse;
+export declare function HotelOffersDataApiResponseToJSON(value?: HotelOffersDataApiResponse | null): any;

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

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+/**
+ * Review rating with category collected for the Hotel.
+ * @export
+ * @interface HotelReviewRatingApi
+ */
+export interface HotelReviewRatingApi {
+    /**
+     * Category of the collected reviews for the Hotel.
+     * @type {string}
+     * @memberof HotelReviewRatingApi
+     */
+    category?: string | null;
+    /**
+     * Rating of the collected review for the Hotel.
+     * @type {number}
+     * @memberof HotelReviewRatingApi
+     */
+    rating: number;
+}
+/**
+ * Check if a given object implements the HotelReviewRatingApi interface.
+ */
+export declare function instanceOfHotelReviewRatingApi(value: object): boolean;
+export declare function HotelReviewRatingApiFromJSON(json: any): HotelReviewRatingApi;
+export declare function HotelReviewRatingApiFromJSONTyped(json: any, ignoreDiscriminator: boolean): HotelReviewRatingApi;
+export declare function HotelReviewRatingApiToJSON(value?: HotelReviewRatingApi | null): any;