@revolugo/booking-api-client 7.1.0-alpha.1 → 7.1.0

package/dist/types/v1/apis/ResourceHotelRoomOffersApi.d.ts

@@ -1,4 +1,4 @@
-import { CurrencyClient, HotelRoomOfferApiResponse, HotelRoomOffersApiResponse, HotelRoomOffersCreateApi } from '../models';
+import { CurrencyBookingApiClient, HotelRoomOfferApiResponse, HotelRoomOffersApiResponse, HotelRoomOffersCreateApi } from '../models';
 import { TPollerCallback } from '@revolugo/common/utils';
 /**
  * Revolugo Booking API Reference
@@ -13,7 +13,7 @@ import { TPollerCallback } from '@revolugo/common/utils';
  */
 import * as runtime from '../runtime';
 export interface HotelRoomOffersListPayload {
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     hotelRoomOfferRequestId: string;
     lang?: HotelRoomOffersLangEnum;
     limit?: number | null;
@@ -31,7 +31,7 @@ export interface HotelRoomOffersInterface {
     /**
      * You\'ll make a call to the **Hotel Room Offers** endpoint in order to get a list of **Hotel Room Offers** resulting from your **Hotel Room Offer Request** parameters. We\'ll send your rate check request to the specific hotel matching the hotel ID you provided previously and the **Hotel Room Offers** endpoint will return the available rates at this specific hotel. An **Hotel Room Offer** describes hotel rooms: prices, remaining count available (when applicable), details about the room itself (e.g., beds, etc) and other information you\'ll find below.   ⚠️ **Cancellation Policies** attached to each **Hotel Room Offer** returned by this endpoint will most likely be **<span style=\"color:red\">cached data</span>** and should not be considered as accurate, although in most case they will reflect the actual/live ones.  In order to retrieve accurate and live **Cancellation Policies** for a specific **Hotel Room Offer** you need to make a call to the **[Create Booking Policies endpoint](/v1/documentation#operation/postV1Booking_policies)**. However, we do not recommend to systematically call **[Create Booking Policies endpoint](/v1/documentation#operation/postV1Booking_policies)** for each **Hotel Room Offer** retrieved as it will most likely trigger rate limiting on your API calls. Rather we recommend to do this as an explicit two-step process: first you check **Hotel Room Offers**, then, once your customer shows interest in a specific **Hotel Room Offer**, you make the call to the **[Create Booking Policies endpoint](/v1/documentation#operation/postV1Booking_policies)** on behalf of your customer.    This endpoint requires ⚛️ **[Polling](/v1/documentation#tag/Polling)**.
      * @summary ⚛️ Retrieve Hotel Room Offers
-     * @param {CurrencyClient} currency ISO 4217 currency code.
+     * @param {CurrencyBookingApiClient} currency ISO 4217 currency code.
      * @param {string} hotelRoomOfferRequestId id of the **Hotel Room Offer Request** previously created via [Create Hotel Room Offer Request](/v1/documentation#operation/postV1Hotel_room_offer_requests).
      * @param {'de-DE' | 'en-US' | 'es-ES' | 'fr-FR' | 'it-IT' | 'nl-NL' | 'pt-PT'} [lang] Set the language for the returned content using a valid language code.
      * @param {number} [limit] Limit the number of **Hotel Room Offers** returned, sorted by increasing price.

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

@@ -488,10 +488,10 @@ export interface BookingApi {
     createdAt: string;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof BookingApi
      */
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     /**
      * Customer Reference of the requested Booking (sometimes to present by the customer at hotel check-in).
      * @type {string}
@@ -773,10 +773,10 @@ export interface BookingPoliciesApi {
     children?: string | null;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof BookingPoliciesApi
      */
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     /**
      * Expiration date for this **Booking Policy**.
      *
@@ -861,12 +861,25 @@ export interface BookingPoliciesCreateApi {
      */
     hotelRoomOfferId: string;
     /**
-     *
-     * @type {Locale}
+     * Set the language for the returned content using a valid language code.
+     * @type {string}
      * @memberof BookingPoliciesCreateApi
      */
-    lang?: Locale | null;
+    lang?: BookingPoliciesCreateApiLangEnum;
 }
+/**
+ * @export
+ */
+export declare const BookingPoliciesCreateApiLangEnum: {
+    readonly DeDe: "de-DE";
+    readonly EnUs: "en-US";
+    readonly EsEs: "es-ES";
+    readonly FrFr: "fr-FR";
+    readonly ItIt: "it-IT";
+    readonly NlNl: "nl-NL";
+    readonly PtPt: "pt-PT";
+};
+export type BookingPoliciesCreateApiLangEnum = typeof BookingPoliciesCreateApiLangEnum[keyof typeof BookingPoliciesCreateApiLangEnum];
 /**
  *
  * @export
@@ -948,11 +961,11 @@ export interface ContactPersonApi {
      */
     firstName: string;
     /**
-     *
-     * @type {Locale}
+     * Set the prefered language to use when contacting the contact person for booking related communication(s).
+     * @type {string}
      * @memberof ContactPersonApi
      */
-    lang?: Locale;
+    lang?: ContactPersonApiLangEnum;
     /**
      * Contact person's last name
      * @type {string}
@@ -1002,6 +1015,19 @@ export interface ContactPersonApi {
      */
     zipCode?: string | null;
 }
+/**
+ * @export
+ */
+export declare const ContactPersonApiLangEnum: {
+    readonly DeDe: "de-DE";
+    readonly EnUs: "en-US";
+    readonly EsEs: "es-ES";
+    readonly FrFr: "fr-FR";
+    readonly ItIt: "it-IT";
+    readonly NlNl: "nl-NL";
+    readonly PtPt: "pt-PT";
+};
+export type ContactPersonApiLangEnum = typeof ContactPersonApiLangEnum[keyof typeof ContactPersonApiLangEnum];
 /**
  * @export
  */
@@ -1317,7 +1343,7 @@ export type CountryIso2Code = typeof CountryIso2Code[keyof typeof CountryIso2Cod
  * ISO 4217 currency code.
  * @export
  */
-export declare const CurrencyClient: {
+export declare const CurrencyBookingApiClient: {
     readonly Aed: "AED";
     readonly Afn: "AFN";
     readonly All: "ALL";
@@ -1457,7 +1483,7 @@ export declare const CurrencyClient: {
     readonly Zar: "ZAR";
     readonly Zmw: "ZMW";
 };
-export type CurrencyClient = typeof CurrencyClient[keyof typeof CurrencyClient];
+export type CurrencyBookingApiClient = typeof CurrencyBookingApiClient[keyof typeof CurrencyBookingApiClient];
 /**
  *
  * @export
@@ -1628,10 +1654,10 @@ export interface HotelApi {
     countryCode?: string | null;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof HotelApi
      */
-    currency?: CurrencyClient;
+    currency?: CurrencyBookingApiClient;
     /**
      * Hotel description.
      * @type {string}
@@ -1807,49 +1833,49 @@ export interface HotelApiImages {
     thumb?: boolean | null;
 }
 /**
- * Hotel image in various sizes.
+ *
  * @export
  * @interface HotelImageApi
  */
 export interface HotelImageApi {
     /**
-     * Caption of the hotel image.
+     *
      * @type {string}
      * @memberof HotelImageApi
      */
     caption?: string | null;
     /**
-     * Whether this image is the primary (hero) image of the hotel.
+     *
      * @type {boolean}
      * @memberof HotelImageApi
      */
     isHeroImage: boolean;
     /**
-     * URL of the large-size image.
+     *
      * @type {string}
      * @memberof HotelImageApi
      */
     l: string;
     /**
-     * URL of the medium-size image.
+     *
      * @type {string}
      * @memberof HotelImageApi
      */
     m: string;
     /**
-     * URL of the small-size image.
+     *
      * @type {string}
      * @memberof HotelImageApi
      */
     s: string;
     /**
-     * URL of the extra-large-size image.
+     *
      * @type {string}
      * @memberof HotelImageApi
      */
     xl: string;
     /**
-     * URL of the extra-small-size image.
+     *
      * @type {string}
      * @memberof HotelImageApi
      */
@@ -1911,10 +1937,10 @@ export interface HotelOfferApi {
     countryCode?: string | null;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof HotelOfferApi
      */
-    currency?: CurrencyClient;
+    currency?: CurrencyBookingApiClient;
     /**
      * Hotel description.
      * @type {string}
@@ -2350,10 +2376,10 @@ export interface HotelOffersDataApiResponse {
     children?: string | null;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof HotelOffersDataApiResponse
      */
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     /**
      * List of Hotel Offers
      * @type {Array<HotelOfferApi>}
@@ -2567,10 +2593,10 @@ export interface HotelRoomOfferApi {
     count?: number | null;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof HotelRoomOfferApi
      */
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     /**
      * id of the associated Hotel.
      * @type {string}
@@ -2720,10 +2746,10 @@ export interface HotelRoomOfferApiResponse {
     children?: string | null;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof HotelRoomOfferApiResponse
      */
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     /**
      * Hotel id
      * @type {string}
@@ -2992,10 +3018,10 @@ export interface HotelRoomOffersCreateApi {
     breakfastCount?: number;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof HotelRoomOffersCreateApi
      */
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     /**
      *
      * @type {Array<HotelRoomOffersDataCreateApi>}
@@ -3003,12 +3029,25 @@ export interface HotelRoomOffersCreateApi {
      */
     hotelRoomOffers: Array<HotelRoomOffersDataCreateApi>;
     /**
-     *
-     * @type {Locale}
+     * Set the language for the returned content using a valid language code.
+     * @type {string}
      * @memberof HotelRoomOffersCreateApi
      */
-    lang?: Locale | null;
+    lang?: HotelRoomOffersCreateApiLangEnum;
 }
+/**
+ * @export
+ */
+export declare const HotelRoomOffersCreateApiLangEnum: {
+    readonly DeDe: "de-DE";
+    readonly EnUs: "en-US";
+    readonly EsEs: "es-ES";
+    readonly FrFr: "fr-FR";
+    readonly ItIt: "it-IT";
+    readonly NlNl: "nl-NL";
+    readonly PtPt: "pt-PT";
+};
+export type HotelRoomOffersCreateApiLangEnum = typeof HotelRoomOffersCreateApiLangEnum[keyof typeof HotelRoomOffersCreateApiLangEnum];
 /**
  *
  * @export
@@ -3041,10 +3080,10 @@ export interface HotelRoomOffersDataApiResponse {
     children?: string | null;
     /**
      *
-     * @type {CurrencyClient}
+     * @type {CurrencyBookingApiClient}
      * @memberof HotelRoomOffersDataApiResponse
      */
-    currency: CurrencyClient;
+    currency: CurrencyBookingApiClient;
     /**
      * Hotel id
      * @type {string}
@@ -3315,20 +3354,6 @@ export declare const InvoiceApiTypeEnum: {
     readonly Invoice: "invoice";
 };
 export type InvoiceApiTypeEnum = typeof InvoiceApiTypeEnum[keyof typeof InvoiceApiTypeEnum];
-/**
- * Set the language for the returned content using a valid language code.
- * @export
- */
-export declare const Locale: {
-    readonly DeDe: "de-DE";
-    readonly EnUs: "en-US";
-    readonly EsEs: "es-ES";
-    readonly FrFr: "fr-FR";
-    readonly ItIt: "it-IT";
-    readonly NlNl: "nl-NL";
-    readonly PtPt: "pt-PT";
-};
-export type Locale = typeof Locale[keyof typeof Locale];
 /**
  * Meta information about the response list, such as pagination cursors or status.
  * @export

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/booking-api-client",
-  "version": "7.1.0-alpha.1",
+  "version": "7.1.0",
   "private": false,
   "description": "Javascript Revolugo Booking API Client (browser + server)",
   "keywords": [
@@ -42,18 +42,18 @@
   "devDependencies": {
     "@hono/node-server": "1.19.9",
     "hono": "4.11.9",
-    "@revolugo/booking-api": "7.1.0",
     "@revolugo/engines": "7.1.0",
+    "@revolugo/node": "7.1.0",
     "@revolugo/env": "7.1.0",
-    "@revolugo/models": "7.1.0",
+    "@revolugo/booking-api": "7.1.0",
     "@revolugo/root": "7.1.0",
-    "@revolugo/node": "7.1.0"
+    "@revolugo/models": "7.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "openapi-generator-cli generate -i ../../../apps/back/booking-api/src/swagger.json -g typescript-fetch -o ./tmp --skip-validate-spec -c ./config.yaml && bun ./scripts/delete-client-extra-classes.ts && cp -r ./tmp/* ./tmp/.openapi* ./src/v1 && rm -rf dist tmp && vite build",
+    "build": "openapi-generator-cli generate -i ../../../apps/back/booking-api/src/swagger.json -g typescript-fetch -o ./tmp --skip-validate-spec -c ./config.yaml --skip-overwrite && bun ./scripts/delete-client-extra-classes.ts && cp -r ./tmp/* ./tmp/.openapi* ./src/v1 && rm -rf dist tmp && vite build",
     "test": "pnpm run test:e2e && pnpm run test:poller",
     "test:client-package:e2e": "bun --inspect ./client/examples/e2e-client.ts",
     "test:e2e": "NODE_OPTIONS='--experimental-vm-modules' vitest ./tests/e2e-*.test.ts",