@duffel/api 2.0.0 → 2.1.0

package/dist/typings.d.ts

@@ -13,6 +13,7 @@ declare module '@duffel/api' {
     import { Refunds } from '@duffel/api/DuffelPayments/Refunds';
     import { Sessions } from '@duffel/api/Links';
     import { Webhooks } from '@duffel/api/notifications';
+    import { Stays } from '@duffel/api/Stays/Stays';
     export interface DuffelAPIClient {
         aircraft: Aircraft;
         airlines: Airlines;
@@ -47,6 +48,7 @@ declare module '@duffel/api' {
         suggestions: Suggestions;
         refunds: Refunds;
         webhooks: Webhooks;
+        stays: Stays;
         constructor(config: Config);
     }
     export const DuffelError: typeof _DuffelError;
@@ -127,6 +129,31 @@ declare module '@duffel/api/notifications' {
     export * from '@duffel/api/notifications/Webhooks';
 }
 
+declare module '@duffel/api/Stays/Stays' {
+    import { Client } from '@duffel/api/Client';
+    import { StaysSearchParams, StaysSearchResult } from '@duffel/api/Stays/StaysTypes';
+    import { Resource } from '@duffel/api/Resource';
+    import { DuffelResponse } from '@duffel/api/types';
+    import { Bookings } from '@duffel/api/Stays/Bookings';
+    import { Quotes } from '@duffel/api/Stays/Quotes';
+    import { SearchResults } from '@duffel/api/Stays/SearchResults';
+    export class Stays extends Resource {
+            /**
+                * Endpoint path
+                */
+            path: string;
+            searchResults: SearchResults;
+            quotes: Quotes;
+            bookings: Bookings;
+            constructor(client: Client);
+            /**
+                * Search for accommodations
+                * @param {object} params - The search parameters
+                */
+            search: (params: StaysSearchParams) => Promise<DuffelResponse<StaysSearchResult>>;
+    }
+}
+
 declare module '@duffel/api/DuffelPayments/PaymentIntents' {
     export * from '@duffel/api/DuffelPayments/PaymentIntents/PaymentIntents';
 }
@@ -194,6 +221,7 @@ declare module '@duffel/api/types' {
     export * from '@duffel/api/types/shared';
     export * from '@duffel/api/types/ClientType';
     export * from '@duffel/api/notifications/Webhooks/WebhooksType';
+    export * from '@duffel/api/Stays/StaysTypes';
 }
 
 declare module '@duffel/api/supportingResources/Aircraft' {
@@ -270,6 +298,445 @@ declare module '@duffel/api/notifications/Webhooks' {
     export * from '@duffel/api/notifications/Webhooks/Webhooks';
 }
 
+declare module '@duffel/api/Stays/StaysTypes' {
+    export type StaysBedType = 'single' | 'double' | 'queen' | 'king' | 'sofabed';
+    export interface StaysBed {
+            /**
+                * The type of beds available in the room Available types: "single", "double", "queen", "king", "sofabed"
+                */
+            type: StaysBedType;
+            /**
+                * The number of beds of this type in the room.
+                */
+            count: number;
+    }
+    export interface StaysRating {
+            /**
+                * The source of this rating. Possible values: `"aaa"` (American Automobile Association Diamond Rating), `"northstar"` (Northstar Crown Rating), `"priceline"` (Priceline star rating)
+                */
+            source: 'aaa' | 'northstar' | 'priceline';
+            /**
+                * The rating value. This is an integer from 1 to 5 regardless of the `source`.
+                */
+            value: number;
+    }
+    export interface StaysRateCondition {
+            /**
+                * One or more paragraphs that outline the rate condition
+                */
+            description: string;
+            /**
+                * The condition title
+                */
+            title: string;
+    }
+    export interface StaysRateCancellationTimeline {
+            /**
+                * The amount refundable up until the specified before date
+                */
+            refund_amount: string;
+            /**
+                * The ISO 8601 datetime for the deadline of a refund.
+                */
+            before: string;
+            /**
+                * The currency of the amount, as an ISO 4217 currency code.
+                */
+            currency: string;
+    }
+    export interface StaysRate {
+            /**
+                * The currency of the base_amount, as an ISO 4217 currency code.
+                */
+            base_amount: string | null;
+            /**
+                * The currency of the base_amount, as an ISO 4217 currency code.
+                */
+            base_currency: string;
+            /**
+                * The type of boarding offered by this rate.
+                */
+            board_type: 'room_only' | 'breakfast' | 'all_inclusive';
+            /**
+                * A timeline that contains policies, such as possible refunds, once this rate has been booked. This is sorted in ascending chronological order.
+                */
+            cancellation_timeline: StaysRateCancellationTimeline[];
+            /**
+                * The conditions or policies that apply to the rate. The information provided should be treated as mandatory and displayed to the traveller during and after the booking process.
+                */
+            conditions: Array<StaysRateCondition>;
+            /**
+                * Fees are sometimes payable at time of check in. These fees are not collected during the booking process
+                */
+            due_at_accommodation_amount: string | null;
+            /**
+                * The currency of the due_at_accommodation_amount
+                */
+            due_at_accommodation_currency: string;
+            /**
+                * ID of a given rate for a accommodation
+                */
+            id: string;
+            /**
+                * The accepted payment method for this rate. Prepaid rates require payment at time of reservation. Accepted types: prepaid
+                */
+            payment_type: 'prepaid';
+            /**
+                * The supplier from which Duffel got this rate
+                */
+            supplier: 'priceline';
+            /**
+                * The fee amount, as an ISO 4217 currency code.
+                */
+            fee_amount: string | null;
+            /**
+                * The currency of the fee_amount, as an ISO 4217 currency code
+                */
+            fee_currency: string;
+            /**
+                * The tax amount, as an ISO 4217 currency code.
+                */
+            tax_amount: string | null;
+            /**
+                * The currency of the tax_amount, as an ISO 4217 currency code
+                */
+            tax_currency: string;
+            /**
+                * The total price for the room for all nights and for all occupants. Please note, the occupant may be required to pay fees on arrival at the hotel. These are not included in the total_amount, and are included in due_at_accommodation_amount
+                */
+            total_amount: string;
+            /**
+                * The currency of the total_amount, as an ISO 4217 currency code
+                */
+            total_currency: string;
+    }
+    export interface StaysPhoto {
+            url: string;
+    }
+    export interface StaysRoom {
+            /**
+                * The room name.
+                */
+            name: string;
+            /**
+                * Available beds in the room
+                */
+            beds?: StaysBed[];
+            /**
+                * Supplied photos for the room
+                */
+            photos?: StaysPhoto[];
+            /**
+                * The available rates for a specific room, including commission, distribution, payment and included services information.
+                */
+            rates: StaysRate[];
+    }
+    export interface StaysAmenity {
+            type: 'parking' | 'wi-fi' | 'gym';
+            description: string;
+    }
+    export interface StaysChain {
+            /**
+                * The hotel chain’s name
+                */
+            name: string;
+    }
+    export interface StaysAddress {
+            /**
+                * The name of the city or metropolitan area where the accommodation is located.
+                */
+            city_name: string;
+            /**
+                * The ISO 3166-1 alpha-2 code for the country where the hotel is located.
+                */
+            country_code: string;
+            /**
+                * The first line of the accommodation's address
+                */
+            line_one: string;
+            /**
+                * The accommodation's postal code (or zip code)
+                */
+            postal_code: string;
+            /**
+                * The setay's region or state
+                */
+            region: string;
+    }
+    export interface GeographicCoordinates {
+            /**
+                * The latitude position of the accommodation represented in Decimal degrees  with 6 decimal points with a range between -90° and 90°
+                */
+            latitude: number;
+            /**
+                * The longitude position of the accommodation represented in Decimal degrees with 6 decimal points with a range between -180° and 180°
+                */
+            longitude: number;
+    }
+    export interface StaysLocation {
+            /**
+                * Address information of the location
+                */
+            address: StaysAddress;
+            /**
+                * The exact latitude-longitude position of the accommodation. Useful for map views.
+                */
+            geographic_coordinates: GeographicCoordinates | null;
+    }
+    export interface StaysAccommodation {
+            /**
+                * The amenities available at the accommodation
+                */
+            amenities: StaysAmenity[] | null;
+            /**
+                * Information about the chain this accommodation belongs to
+                */
+            chain: StaysChain | null;
+            /**
+                * Check in and check out related information
+                */
+            check_in_information: {
+                    /**
+                        * The ISO 8601 format for the earliest time a traveller can check-in to their room.
+                        */
+                    check_out_before_time: string;
+                    /**
+                        * The ISO 8601 format for the earliest time a traveller can check-out to their room.
+                        */
+                    check_in_after_time: string;
+            } | null;
+            /**
+                * The total currency for the cheapest rate for this accommodation, as an ISO 4217 currency code. If rooms data is available, this is equivalent to the cheapest rate for the cheapest room.
+                */
+            cheapest_rate_currency: string;
+            /**
+                * The total amount for the cheapest rate for this accommodation. If rooms data is available, this is equivalent to the cheapest rate for the cheapest room.
+                */
+            cheapest_rate_total_amount: string;
+            /**
+                * The accommodation’s description
+                */
+            description?: string;
+            /**
+                * The accommodation’s email address. Note that this data may differ from the accommodation’s records if it was updated directly by the accommodation after the booking was created.
+                */
+            email: string | null;
+            /**
+                * Information on the accommodation's location
+                */
+            location: StaysLocation;
+            /**
+                * The accommodation's name
+                */
+            name: string;
+            /**
+                * The accommodation's phone number in E.164 (international) format. Note that this data may differ from the accommodation's records if it was updated directly by the accommodation after the booking was created.
+                */
+            phone_number: string | null;
+            /**
+                * Photos for the accommodation
+                */
+            photos?: StaysPhoto[];
+            /**
+                * Ratings of the accommodation
+                */
+            ratings: StaysRating[] | null;
+            /**
+                * Rooms for the accommodation
+                */
+            rooms: StaysRoom[];
+    }
+    /**
+        * Represents a quote for a stay.
+        */
+    export interface StaysQuote {
+            /**
+                * The id of the stay quote.
+                *
+                * Example: "quo_0000AS0NZdKjjnnHZmSUbI"
+                */
+            id: string;
+            /**
+                * The ISO 8601 date on which the guest wants to check in.
+                * This comes from the search request this quote originates from.
+                *
+                * Example: "2023-05-24"
+                */
+            check_in_date: string;
+            /**
+                * The ISO 8601 date on which the guest wants to check out.
+                * This comes from the search request this quote originates from.
+                *
+                * Example: "2023-05-28"
+                */
+            check_out_date: string;
+            /**
+                * The accommodation associated with this quote.
+                */
+            accommodation: StaysAccommodation;
+            /**
+                * The total price for the room for all nights and for all guests.
+                * Please note, the guest may be required to pay mandatory fees and taxes at the stay.
+                * These are not included in the total_amount, and are included in due_at_accommodation_amount.
+                *
+                * Example: "799.00"
+                */
+            total_amount: string;
+            /**
+                * The currency of the total_amount, as an ISO 4217 currency code.
+                *
+                * Example: "GBP"
+                */
+            total_currency: string;
+            /**
+                * The base amount for this quote, excluding taxes and fees.
+                * Will be null if the base amount is unknown.
+                *
+                * Example: "665.83"
+                */
+            base_amount: string | null;
+            /**
+                * The currency of the base_amount, as an ISO 4217 currency code.
+                *
+                * Example: "GBP"
+                */
+            base_currency: string;
+            /**
+                * The fee amount for this quote.
+                * Will be null if the fee amount is unknown.
+                *
+                * Example: "50.94"
+                */
+            fee_amount: string | null;
+            /**
+                * The currency of the fee_amount, as an ISO 4217 currency code.
+                *
+                * Example: "GBP"
+                */
+            fee_currency: string;
+            /**
+                * The tax amount for this quote.
+                * Will be null if the tax amount is unknown.
+                *
+                * Example: "133.17"
+                */
+            tax_amount: string | null;
+            /**
+                * The currency of the tax_amount, as an ISO 4217 currency code.
+                *
+                * Example: "GBP"
+                */
+            tax_currency: string;
+            /**
+                * Mandatory fees or taxes that are due by the guest at the accommodation.
+                * Depending on the accommodation, these may be payable on check-in or check-out.
+                * These fees are not collected during the booking process.
+                * Will be null if the amount due at accommodation is unknown.
+                *
+                * Example: "39.95"
+                */
+            due_at_accommodation_amount: string | null;
+            /**
+                * The currency of the due_at_accommodation_amount, as an ISO 4217 currency code.
+                *
+                * Example: "GBP"
+                */
+            due_at_accommodation_currency: string;
+    }
+    export type StaysBookingStatus = 'requested' | 'confirmed' | 'failed' | 'cancellation_confirmed';
+    export interface StaysBooking {
+            /**
+                * The ID of the booking
+                */
+            id: string;
+            /**
+                * The accommodation object for the booking
+                */
+            accommodation: StaysAccommodation;
+            /**
+                * The ISO 8601 date on which the guest wants to check in.
+                */
+            check_in_date: string;
+            /**
+                * The ISO 8601 date on which the guest wants to check out.
+                */
+            check_out_date: string;
+            /**
+                * A booking reference for the property you’ll be staying in. This is the reference you should use when contacting the accommodation.
+                */
+            reference: string | null;
+            /**
+                * The status of the booking. Possible values: requested, confirmed, failed,cancellation_requested,cancellation_confirmed.
+                */
+            status: StaysBookingStatus;
+            /**
+                * The ISO 8601 datetime at which the booking was confirmed by the accommodation.
+                */
+            confirmed_at: string | null;
+            /**
+                * The ISO 8601 datetime of the cancellation of this booking.
+                * This is null if the booking is not cancelled.
+                */
+            cancelled_at: string | null;
+            /**
+                * The guests for the booking
+                */
+            guests: Array<{
+                    given_name: string;
+                    family_name: string;
+            }>;
+    }
+    export interface StaysSearchParams {
+            check_in_date: string;
+            check_out_date: string;
+            adults: number;
+            rooms: number;
+            location: {
+                    radius: number;
+                    geographic_coordinates: {
+                            latitude: number;
+                            longitude: number;
+                    };
+            };
+    }
+    export interface StaysSearchResult {
+            id: string;
+            check_in_date: string;
+            check_out_date: string;
+            accommodation: StaysAccommodation;
+    }
+}
+
+declare module '@duffel/api/Resource' {
+    import { Client } from '@duffel/api/Client';
+    import { DuffelResponse } from '@duffel/api/types';
+    export class Resource {
+        constructor(client: Client);
+        protected request: <T_Data = any>({ method, path, data, params, }: {
+            method: string;
+            path: string;
+            data?: Record<string, any> | undefined;
+            params?: Record<string, any> | undefined;
+        }) => Promise<DuffelResponse<T_Data>>;
+        protected paginatedRequest: <T_Data = any>({ path, params, }: {
+            path: string;
+            params?: Record<string, any> | undefined;
+        }) => AsyncGenerator<DuffelResponse<T_Data>, void, unknown>;
+    }
+}
+
+declare module '@duffel/api/Stays/Bookings' {
+    export * from '@duffel/api/Stays/Bookings/Bookings';
+}
+
+declare module '@duffel/api/Stays/Quotes' {
+    export * from '@duffel/api/Stays/Quotes/Quotes';
+}
+
+declare module '@duffel/api/Stays/SearchResults' {
+    export * from '@duffel/api/Stays/SearchResults/SearchResults';
+}
+
 declare module '@duffel/api/DuffelPayments/PaymentIntents/PaymentIntents' {
     import { DuffelResponse } from '@duffel/api/types';
     import { Resource } from '@duffel/api/Resource';
@@ -3451,24 +3918,6 @@ declare module '@duffel/api/supportingResources/Airports/Airports' {
     }
 }
 
-declare module '@duffel/api/Resource' {
-    import { Client } from '@duffel/api/Client';
-    import { DuffelResponse } from '@duffel/api/types';
-    export class Resource {
-        constructor(client: Client);
-        protected request: <T_Data = any>({ method, path, data, params, }: {
-            method: string;
-            path: string;
-            data?: Record<string, any> | undefined;
-            params?: Record<string, any> | undefined;
-        }) => Promise<DuffelResponse<T_Data>>;
-        protected paginatedRequest: <T_Data = any>({ path, params, }: {
-            path: string;
-            params?: Record<string, any> | undefined;
-        }) => AsyncGenerator<DuffelResponse<T_Data>, void, unknown>;
-    }
-}
-
 declare module '@duffel/api/DuffelPayments/Refunds/RefundsType' {
     export interface Refund {
             /**
@@ -3662,6 +4111,83 @@ declare module '@duffel/api/notifications/Webhooks/Webhooks' {
     }
 }
 
+declare module '@duffel/api/Stays/Bookings/Bookings' {
+    import { Client } from '@duffel/api/Client';
+    import { StaysBooking } from '@duffel/api/Stays/StaysTypes';
+    import { Resource } from '@duffel/api/Resource';
+    import { DuffelResponse } from '@duffel/api/types';
+    export interface StaysBookingPayload {
+            quote_id: string;
+            guests: Array<{
+                    given_name: string;
+                    family_name: string;
+                    born_on: string;
+            }>;
+            email: string;
+            phone_number: string;
+            accommodation_special_requests?: string;
+    }
+    export class Bookings extends Resource {
+            /**
+                * Endpoint path
+                */
+            path: string;
+            constructor(client: Client);
+            /**
+                * Create a booking
+                * @param {object} payload - The booking payload, including quote id and guest information
+                */
+            create: (payload: StaysBookingPayload) => Promise<DuffelResponse<StaysBooking>>;
+            /**
+                * Get a booking
+                * @param {string} bookingId - The ID of the booking
+                */
+            get: (bookingId: string) => Promise<DuffelResponse<StaysBooking>>;
+            /**
+                * list bookings
+                */
+            list: () => Promise<DuffelResponse<StaysBooking>>;
+    }
+}
+
+declare module '@duffel/api/Stays/Quotes/Quotes' {
+    import { Client } from '@duffel/api/Client';
+    import { StaysQuote } from '@duffel/api/Stays/StaysTypes';
+    import { Resource } from '@duffel/api/Resource';
+    import { DuffelResponse } from '@duffel/api/types';
+    export class Quotes extends Resource {
+            /**
+                * Endpoint path
+                */
+            path: string;
+            constructor(client: Client);
+            /**
+                * Create a quote for the selected rate
+                * @param {string} rateId - The ID of the rate to create a quote for
+                */
+            create: (rateId: string) => Promise<DuffelResponse<StaysQuote>>;
+    }
+}
+
+declare module '@duffel/api/Stays/SearchResults/SearchResults' {
+    import { Client } from '@duffel/api/Client';
+    import { StaysSearchResult } from '@duffel/api/Stays/StaysTypes';
+    import { Resource } from '@duffel/api/Resource';
+    import { DuffelResponse } from '@duffel/api/types';
+    export class SearchResults extends Resource {
+            /**
+                * Endpoint path
+                */
+            path: string;
+            constructor(client: Client);
+            /**
+                * Fetch all rates for the given search result
+                * @param {string} searchResultId - The ID of the search result to fetch rates for
+                */
+            fetchAllRates: (searchResultId: string) => Promise<DuffelResponse<StaysSearchResult>>;
+    }
+}
+
 declare module '@duffel/api/booking/PartialOfferRequests/PartialOfferRequestTypes' {
     export interface SelectedPartialOffersParams {
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duffel/api",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Javascript client library for the Duffel API",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -22,7 +22,7 @@
     "start": "node ./dist/index.js",
     "dev": "ts-node ./src/index.ts",
     "lint": "eslint . --ext .ts,.tsx",
-    "test": "jest",
+    "test": "jest --runInBand",
     "pre-commit-check": "yarn lint-staged && yarn test && yarn build:test",
     "prepare": "husky install",
     "example": "ts-node ./examples/example.ts",
@@ -49,15 +49,16 @@
   },
   "resolutions": {
     "ansi-regex": "^5.0.1",
-    "set-value": "^4.0.1"
+    "set-value": "^4.0.1",
+    "minimist": "1.2.8"
   },
   "dependencies": {
     "@types/node": "^17.0.21",
     "@types/node-fetch": "^2.6.2",
-    "node-fetch": "2.6.9"
+    "node-fetch": "2.6.11"
   },
   "devDependencies": {
-    "@babel/core": "7.21.5",
+    "@babel/core": "7.21.8",
     "@babel/preset-env": "7.21.5",
     "@babel/preset-typescript": "7.21.5",
     "@commitlint/cli": "17.5.1",
@@ -79,13 +80,13 @@
     "lint-staged": "13.1.2",
     "nock": "13.2.9",
     "prettier": "2.8.8",
-    "rollup": "3.21.3",
+    "rollup": "3.21.8",
     "rollup-plugin-dts-bundle": "^1.0.0",
     "rollup-plugin-inject-process-env": "1.3.1",
     "rollup-plugin-peer-deps-external": "2.2.4",
     "rollup-plugin-terser": "7.0.2",
     "rollup-plugin-typescript2": "0.33.0",
-    "ts-jest": "28.0.8",
+    "ts-jest": "29.1.0",
     "ts-node": "10.9.1",
     "typescript": "4.9.5"
   },
@@ -101,7 +102,13 @@
         "@semantic-release/release-notes-generator"
       ],
       "@semantic-release/npm",
-      "@semantic-release/github"
+      [
+        "@semantic-release/github",
+        {
+          "successComment": false,
+          "failTitle": false
+        }
+      ]
     ],
     "branches": [
       "main"