@duffel/api 4.25.0 → 4.27.0

package/dist/typings.d.ts

@@ -154,6 +154,7 @@ declare module '@duffel/api/Stays/Stays' {
     import { Brands } from '@duffel/api/Stays/Brands';
     import { LoyaltyProgrammes } from '@duffel/api/Stays/LoyaltyProgrammes';
     import { Bookings } from '@duffel/api/Stays/Bookings';
+    import { NegotiatedRates } from '@duffel/api/Stays/NegotiatedRates';
     import { Quotes } from '@duffel/api/Stays/Quotes';
     import { SearchResults } from '@duffel/api/Stays/SearchResults';
     export class Stays extends Resource {
@@ -164,6 +165,7 @@ declare module '@duffel/api/Stays/Stays' {
             accommodation: Accommodation;
             loyaltyProgrammes: LoyaltyProgrammes;
             brands: Brands;
+            negotiatedRates: NegotiatedRates;
             searchResults: SearchResults;
             quotes: Quotes;
             bookings: Bookings;
@@ -617,7 +619,11 @@ declare module '@duffel/api/Stays/StaysTypes' {
     }
     export interface StaysChain {
             /**
-                * The hotel chain’s name
+                * Duffel ID for this chain
+                */
+            id: string;
+            /**
+                * The hotel chain's name
                 */
             name: string;
     }
@@ -1040,6 +1046,130 @@ declare module '@duffel/api/Stays/StaysTypes' {
                 */
             user_id?: string;
     };
+    /**
+        * A negotiated rate that enables passing rate access codes for stays accommodation.
+        * Can be associated with either a chain or specific accommodations, but not both.
+        */
+    export interface StaysNegotiatedRate {
+            /**
+                * The ID of the Negotiated Rate
+                *
+                * Example: "nre_0000AvtkNoC81yBytDM9PE"
+                */
+            id: string;
+            /**
+                * The rate access code to be utilised when using this negotiated rate
+                *
+                * Example: "DUFFEL"
+                */
+            rate_access_code: string;
+            /**
+                * The display name of the negotiated rate
+                *
+                * Example: "2025 Negotiated Rate"
+                */
+            display_name: string;
+            /**
+                * Whether this negotiated rate is for live mode. When false, it is for test mode
+                *
+                * Example: false
+                */
+            live_mode: boolean;
+            /**
+                * The ID of the hotel chain this negotiated rate is valid for.
+                * Mutually exclusive with accommodation_ids.
+                *
+                * Example: "chn_0000B6QFxO9EOY5cqw5kYK"
+                */
+            chain_id: string | null;
+            /**
+                * The accommodation ids this negotiated rate is valid for use with.
+                * Mutually exclusive with chain_id.
+                *
+                * Example: ["acc_0000AWr2VsUNIF1Vl91xg0"]
+                */
+            accommodation_ids: string[] | null;
+    }
+    /**
+        * Payload for creating a negotiated rate associated with a chain.
+        * You must provide either chain_id or accommodation_ids, but not both.
+        */
+    export interface StaysNegotiatedRateCreatePayloadWithChain {
+            /**
+                * The rate access code to be utilised when using this negotiated rate
+                *
+                * Example: "DUFFEL"
+                */
+            rate_access_code: string;
+            /**
+                * The display name of the negotiated rate
+                *
+                * Example: "2025 Negotiated Rate"
+                */
+            display_name: string;
+            /**
+                * The ID of the hotel chain this negotiated rate is valid for
+                *
+                * Example: "chn_0000B6QFxO9EOY5cqw5kYK"
+                */
+            chain_id: string;
+    }
+    /**
+        * Payload for creating a negotiated rate associated with accommodations.
+        * You must provide either chain_id or accommodation_ids, but not both.
+        */
+    export interface StaysNegotiatedRateCreatePayloadWithAccommodations {
+            /**
+                * The rate access code to be utilised when using this negotiated rate
+                *
+                * Example: "DUFFEL"
+                */
+            rate_access_code: string;
+            /**
+                * The display name of the negotiated rate
+                *
+                * Example: "2025 Negotiated Rate"
+                */
+            display_name: string;
+            /**
+                * The accommodation ids this negotiated rate is valid for use with
+                *
+                * Example: ["acc_0000AWr2VsUNIF1Vl91xg0"]
+                */
+            accommodation_ids: string[];
+    }
+    /**
+        * Payload for creating a negotiated rate.
+        * You must provide either chain_id or accommodation_ids, but not both.
+        */
+    export type StaysNegotiatedRateCreatePayload = StaysNegotiatedRateCreatePayloadWithChain | StaysNegotiatedRateCreatePayloadWithAccommodations;
+    /**
+        * Payload for updating a negotiated rate.
+        * You can update the display_name and change the association to chain_id or accommodation_ids.
+        * If updating the association, you must provide only one of chain_id or accommodation_ids.
+        */
+    export interface StaysNegotiatedRateUpdatePayload {
+            /**
+                * The display name of the negotiated rate
+                *
+                * Example: "2025 Negotiated Rate"
+                */
+            display_name?: string;
+            /**
+                * The ID of the hotel chain this negotiated rate is valid for.
+                * Setting this will remove any existing accommodation_ids association.
+                *
+                * Example: "chn_0000B6QFxO9EOY5cqw5kYK"
+                */
+            chain_id?: string;
+            /**
+                * The accommodation ids this negotiated rate is valid for use with.
+                * Setting this will remove any existing chain_id association.
+                *
+                * Example: ["acc_0000AWr2VsUNIF1Vl91xg0"]
+                */
+            accommodation_ids?: string[];
+    }
     export {};
 }
 
@@ -1077,6 +1207,10 @@ declare module '@duffel/api/Stays/Bookings' {
     export * from '@duffel/api/Stays/Bookings/Bookings';
 }
 
+declare module '@duffel/api/Stays/NegotiatedRates' {
+    export * from '@duffel/api/Stays/NegotiatedRates/NegotiatedRates';
+}
+
 declare module '@duffel/api/Stays/Quotes' {
     export * from '@duffel/api/Stays/Quotes/Quotes';
 }
@@ -1635,7 +1769,7 @@ declare module '@duffel/api/booking/BatchOfferRequests/BatchOfferRequests' {
 declare module '@duffel/api/booking/OfferRequests/OfferRequests' {
     import { Client } from '@duffel/api/Client';
     import { Resource } from '@duffel/api/Resource';
-    import { CreateOfferRequest, CreateOfferRequestQueryParameters, DuffelResponse, OfferRequest, PaginationMeta } from '@duffel/api/types';
+    import { CreateOfferRequest, CreateOfferRequestQueryParameters, DuffelResponse, OfferRequest, OfferRequestItinerariesView, PaginationMeta } from '@duffel/api/types';
     /**
         * To search for flights, you'll need to create an `offer request`.
         * An offer request describes the passengers and where and when they want to travel (in the form of a list of `slices`).
@@ -1670,12 +1804,17 @@ declare module '@duffel/api/booking/OfferRequests/OfferRequests' {
                 * To search for flights, you'll need to create an `offer request`.
                 * An offer request describes the passengers and where and when they want to travel (in the form of a list of `slices`).
                 * It may also include additional filters (e.g. a particular cabin to travel in).
-                * @param {Object} [options] - the parameters for making an offer requests (required: slices, passengers; optional: cabin_class, return_offers)
+                * @param {Object} [options] - the parameters for making an offer requests (required: slices, passengers; optional: cabin_class, return_offers, view, include_split_ticket)
                 * When `return_offers` is set to `true`, the offer request resource returned will include all the `offers` returned by the airlines.
                 * If set to false, the offer request resource won't include any `offers`. To retrieve the associated offers later, use the List Offers endpoint, specifying the `offer_request_id`.
+                * When `view` is set to `'itineraries'`, offers are grouped per slice into a hierarchy of itineraries and fare brands.
+                * Combine `view: 'itineraries'` with `include_split_ticket: true` to surface split-ticket candidates.
                 * @link https://duffel.com/docs/api/offer-requests/create-offer-request
+                * @link https://duffel.com/docs/guides/selling-split-ticket-itineraries
                 */
             create: <QueryParams extends CreateOfferRequestQueryParameters>(options: CreateOfferRequest & QueryParams) => Promise<DuffelResponse<QueryParams extends {
+                    view: "itineraries";
+            } ? OfferRequestItinerariesView : QueryParams extends {
                     return_offers: false;
             } ? Omit<OfferRequest, "offers"> : OfferRequest>>;
     }
@@ -2278,7 +2417,7 @@ declare module '@duffel/api/booking/AirlineInitiatedChanges/AirlineInitiatedChan
 
 declare module '@duffel/api/booking/OfferRequests/OfferRequestsTypes' {
     import { Airline, CabinClass, PassengerType, Place, PlaceType } from '@duffel/api/types';
-    import { Offer } from '@duffel/api/booking/Offers/OfferTypes';
+    import { Offer, OfferSliceSegment } from '@duffel/api/booking/Offers/OfferTypes';
     export interface OfferRequestSlice {
             /**
                 * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the passengers want to depart
@@ -2506,6 +2645,16 @@ declare module '@duffel/api/booking/OfferRequests/OfferRequestsTypes' {
                 * whereas return trips will need two.
                 */
             slices: CreateOfferRequestSlice[];
+            /**
+                * When set to `true` and the offer request contains more than one slice,
+                * Duffel will fire additional one-way searches per slice to find
+                * split-ticket itinerary candidates. Split-ticket offers are only returned
+                * when combined with the `view=itineraries` query parameter.
+                *
+                * Requires this capability to be enabled on your Duffel account.
+                * @link https://duffel.com/docs/guides/selling-split-ticket-itineraries
+                */
+            include_split_ticket?: boolean;
     }
     export type TimeRangeFilter = {
             from: string;
@@ -2536,6 +2685,18 @@ declare module '@duffel/api/booking/OfferRequests/OfferRequestsTypes' {
                 */
             departure_time: TimeRangeFilter | null;
     }
+    /**
+        * The shape of the offer request response.
+        *
+        * - `offers` (default) — a flat list of offers under `data.offers`.
+        * - `itineraries` — offers are grouped per slice into a hierarchy of
+        *   itineraries and fare brands under `data.slices[].itineraries[]`. This is
+        *   the view required to surface split-ticket candidates created with
+        *   `include_split_ticket: true`.
+        *
+        * @link https://duffel.com/docs/guides/selling-split-ticket-itineraries
+        */
+    export type OfferRequestView = 'offers' | 'itineraries';
     export interface CreateOfferRequestQueryParameters {
             /**
                 * When set to `true`, the offer request resource returned will include all the offers returned by the airlines.
@@ -2544,6 +2705,14 @@ declare module '@duffel/api/booking/OfferRequests/OfferRequestsTypes' {
                 * You should use this option if you want to take advantage of the pagination, sorting and filtering that the [List Offers](https://duffel.com/docs/api/offers/get-offers) endpoint provides.
                 */
             return_offers?: boolean;
+            /**
+                * Controls the shape of the response. Defaults to `offers`, which returns a
+                * flat list of offers. Set to `itineraries` to receive offers grouped by
+                * slice, itinerary and fare brand — required to retrieve split-ticket
+                * candidates produced by `include_split_ticket: true`.
+                * @link https://duffel.com/docs/guides/selling-split-ticket-itineraries
+                */
+            view?: OfferRequestView;
             /**
                 * The maximum amount of time in milliseconds to wait for each airline search to complete.
                 * This timeout applies to the response time of the call to the airline and includes
@@ -2558,6 +2727,101 @@ declare module '@duffel/api/booking/OfferRequests/OfferRequestsTypes' {
                 */
             supplier_timeout?: number;
     }
+    /**
+        * Discriminator for offers returned under the `itineraries` view.
+        *
+        * - `single_ticket` — a single offer from one airline that covers every slice
+        *   in the original offer request.
+        * - `split_ticket` — an offer that covers a single slice, intended to be
+        *   combined with offers for the remaining slices (potentially from a
+        *   different airline) to fulfil the journey.
+        *
+        * @link https://duffel.com/docs/guides/selling-split-ticket-itineraries
+        */
+    export type ItineraryOfferType = 'single_ticket' | 'split_ticket';
+    /**
+        * An offer returned under the `itineraries` view.
+        *
+        * It is structurally the same as a regular {@link Offer} (minus
+        * `available_services`, which is only populated by the Get single offer
+        * endpoint) but carries a `type` discriminator describing whether the offer
+        * covers the full journey or a single slice that needs to be combined with
+        * other offers.
+        */
+    export interface ItineraryOffer extends Omit<Offer, 'available_services'> {
+            /**
+                * Whether the offer covers every slice from a single airline
+                * (`single_ticket`) or only the slice it is nested under and needs to be
+                * combined with other offers to complete the journey (`split_ticket`).
+                */
+            type: ItineraryOfferType;
+    }
+    /**
+        * A fare brand grouping offers that share the same itinerary segments.
+        */
+    export interface ItineraryBrand {
+            /**
+                * The airline's marketing name for the fare brand, e.g. "Economy Basic".
+                */
+            fare_brand_name: string;
+            /**
+                * The offers available for this fare brand on this itinerary.
+                */
+            offers: ItineraryOffer[];
+    }
+    /**
+        * One way the airline can fly a passenger from the slice's origin to its
+        * destination. A single itinerary is a fixed list of segments which may be
+        * sold under one or more fare brands.
+        */
+    export interface Itinerary {
+            /**
+                * The segments that make up this itinerary, in the order they are flown.
+                */
+            segments: OfferSliceSegment[];
+            /**
+                * The fare brands available for this itinerary, each carrying one or more
+                * bookable offers.
+                */
+            brands: ItineraryBrand[];
+    }
+    /**
+        * A slice as represented in the `itineraries` view of an offer request.
+        *
+        * Unlike {@link OfferRequestSlice}, it does not include the `departure_date`
+        * or origin/destination type fields directly — the per-segment scheduling
+        * lives inside `itineraries[].segments[]`.
+        */
+    export interface OfferRequestItinerariesViewSlice {
+            /**
+                * The city or airport the passengers want to depart from.
+                */
+            origin: Place;
+            /**
+                * The city or airport the passengers want to travel to.
+                */
+            destination: Place;
+            /**
+                * The itineraries available for this slice, each grouping offers by fare
+                * brand.
+                */
+            itineraries: Itinerary[];
+    }
+    /**
+        * The response payload returned when an offer request is created with the
+        * `view=itineraries` query parameter. Offers are grouped per slice rather than
+        * returned as a flat list, which is required to surface split-ticket
+        * candidates produced by `include_split_ticket: true`.
+        *
+        * @link https://duffel.com/docs/guides/selling-split-ticket-itineraries
+        */
+    export interface OfferRequestItinerariesView extends Omit<OfferRequest, 'slices' | 'offers'> {
+            /**
+                * The slices that make up this offer request, each carrying the itineraries
+                * and offers available for that slice.
+                */
+            slices: OfferRequestItinerariesViewSlice[];
+    }
     export {};
 }
 
@@ -5772,6 +6036,51 @@ declare module '@duffel/api/Stays/Bookings/Bookings' {
     }
 }
 
+declare module '@duffel/api/Stays/NegotiatedRates/NegotiatedRates' {
+    import { Client } from '@duffel/api/Client';
+    import { StaysNegotiatedRate, StaysNegotiatedRateCreatePayload, StaysNegotiatedRateUpdatePayload } from '@duffel/api/Stays/StaysTypes';
+    import { Resource } from '@duffel/api/Resource';
+    import { DuffelResponse, PaginationMeta } from '@duffel/api/types';
+    export class NegotiatedRates extends Resource {
+            /**
+                * Endpoint path
+                */
+            path: string;
+            constructor(client: Client);
+            /**
+                * Create a negotiated rate.
+                * You must provide either chain_id or accommodation_id, but not both.
+                * @param {object} payload - The negotiated rate payload
+                */
+            create: (payload: StaysNegotiatedRateCreatePayload) => Promise<DuffelResponse<StaysNegotiatedRate>>;
+            /**
+                * Get a negotiated rate by ID
+                * @param {string} id - The ID of the negotiated rate
+                */
+            get: (id: string) => Promise<DuffelResponse<StaysNegotiatedRate>>;
+            /**
+                * Update a negotiated rate
+                * @param {string} id - The ID of the negotiated rate
+                * @param {object} payload - The update payload
+                */
+            update: (id: string, payload: StaysNegotiatedRateUpdatePayload) => Promise<DuffelResponse<StaysNegotiatedRate>>;
+            /**
+                * List negotiated rates
+                * @param {Object} [options] - Pagination options (optional: limit, after, before)
+                */
+            list: (options?: PaginationMeta) => Promise<DuffelResponse<StaysNegotiatedRate[]>>;
+            /**
+                * Retrieves a generator of all negotiated rates. The results may be returned in any order.
+                */
+            listWithGenerator: () => AsyncGenerator<DuffelResponse<StaysNegotiatedRate>, void, unknown>;
+            /**
+                * Delete a negotiated rate
+                * @param {string} id - The ID of the negotiated rate
+                */
+            delete: (id: string) => Promise<DuffelResponse<StaysNegotiatedRate>>;
+    }
+}
+
 declare module '@duffel/api/Stays/Quotes/Quotes' {
     import { Client } from '@duffel/api/Client';
     import { StaysQuote } from '@duffel/api/Stays/StaysTypes';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duffel/api",
-  "version": "4.25.0",
+  "version": "4.27.0",
   "description": "Javascript client library for the Duffel API",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -50,23 +50,25 @@
     "set-value": "4.0.1",
     "minimist": "1.2.8",
     "semver": "7.5.3",
-    "@aashutoshrathi/word-wrap": "npm:word-wrap"
+    "@aashutoshrathi/word-wrap": "npm:word-wrap",
+    "@semantic-release/npm": "13.1.5"
   },
   "dependencies": {
     "@types/node": "18.0.0",
-    "@types/node-fetch": "2.6.2",
+    "@types/node-fetch": "2.6.13",
     "node-fetch": "2.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.29.0",
-    "@babel/preset-env": "7.29.2",
-    "@babel/preset-typescript": "7.28.5",
+    "@babel/core": "7.29.7",
+    "@babel/preset-env": "7.29.7",
+    "@babel/preset-typescript": "7.29.7",
     "@commitlint/cli": "17.8.1",
     "@commitlint/config-angular": "17.8.1",
     "@rollup/plugin-commonjs": "25.0.8",
     "@rollup/plugin-node-resolve": "15.3.1",
     "@rollup/plugin-terser": "1.0.0",
     "@rollup/plugin-typescript": "12.3.0",
+    "@semantic-release/npm": "13.1.5",
     "@types/jest": "29.5.14",
     "@typescript-eslint/eslint-plugin": "6.7.5",
     "@typescript-eslint/parser": "6.7.5",
@@ -80,12 +82,12 @@
     "lint-staged": "15.5.2",
     "nock": "13.5.6",
     "prettier": "3.5.3",
-    "rollup": "4.60.1",
+    "rollup": "4.61.1",
     "rollup-plugin-dts-bundle": "1.0.0",
     "rollup-plugin-inject-process-env": "1.3.1",
     "rollup-plugin-peer-deps-external": "2.2.4",
-    "semantic-release": "22.0.12",
-    "ts-jest": "29.4.6",
+    "semantic-release": "24.2.9",
+    "ts-jest": "29.4.11",
     "ts-node": "10.9.2",
     "tslib": "2.8.1",
     "typescript": "5.9.3"