@duffel/api 4.21.5 → 4.22.0

package/dist/typings.d.ts

@@ -12,6 +12,7 @@ declare module '@duffel/api' {
     import { Sessions } from '@duffel/api/Links';
     import { Webhooks } from '@duffel/api/notifications';
     import { Stays } from '@duffel/api/Stays/Stays';
+    import { Cars } from '@duffel/api/Cars/Cars';
     import { Cards } from '@duffel/api/Payments/Cards';
     import { ThreeDSecureSessions } from '@duffel/api/Payments/ThreeDSecureSessions';
     import { Identity } from '@duffel/api/Identity/Identity';
@@ -55,6 +56,7 @@ declare module '@duffel/api' {
         refunds: Refunds;
         webhooks: Webhooks;
         stays: Stays;
+        cars: Cars;
         three_d_secure_sessions: ThreeDSecureSessions;
         identity: Identity;
         cards: Cards;
@@ -174,6 +176,29 @@ declare module '@duffel/api/Stays/Stays' {
     }
 }
 
+declare module '@duffel/api/Cars/Cars' {
+    import { Client } from '@duffel/api/Client';
+    import { CarsSearchParams, CarsSearch } from '@duffel/api/Cars/CarsTypes';
+    import { Resource } from '@duffel/api/Resource';
+    import { DuffelResponse } from '@duffel/api/types';
+    import { Bookings } from '@duffel/api/Cars/Bookings';
+    import { Quotes } from '@duffel/api/Cars/Quotes';
+    export class Cars extends Resource {
+            /**
+                * Endpoint path
+                */
+            path: string;
+            bookings: Bookings;
+            quotes: Quotes;
+            constructor(client: Client);
+            /**
+                * Search for available rental cars
+                * @param {object} params - The search parameters
+                */
+            search: (params: CarsSearchParams) => Promise<DuffelResponse<CarsSearch>>;
+    }
+}
+
 declare module '@duffel/api/Payments/Cards' {
     export * from '@duffel/api/Payments/Cards/Cards';
 }
@@ -270,6 +295,7 @@ declare module '@duffel/api/types' {
     export * from '@duffel/api/DuffelPayments/PaymentIntents/PaymentIntentsType';
     export * from '@duffel/api/Places/Suggestions/SuggestionsType';
     export * from '@duffel/api/Stays/StaysTypes';
+    export * from '@duffel/api/Cars/CarsTypes';
     export * from '@duffel/api/booking/AirlineInitiatedChanges/AirlineInitiatedChangesTypes';
     export * from '@duffel/api/booking/OfferRequests/OfferRequestsTypes';
     export * from '@duffel/api/booking/BatchOfferRequests/BatchOfferRequestsTypes';
@@ -1046,6 +1072,202 @@ declare module '@duffel/api/Stays/SearchResults' {
     export * from '@duffel/api/Stays/SearchResults/SearchResults';
 }
 
+declare module '@duffel/api/Cars/CarsTypes' {
+    export interface CarsGeographicCoordinates {
+        latitude: number;
+        longitude: number;
+    }
+    export interface CarsSearchLocation {
+        radius?: number;
+        geographic_coordinates: CarsGeographicCoordinates;
+    }
+    export interface CarsSearchDriver {
+        age: number;
+        residence_country_code: string;
+    }
+    export interface CarsSearchParams {
+        pickup_date: string;
+        pickup_time: string;
+        dropoff_date: string;
+        dropoff_time: string;
+        pickup_location: CarsSearchLocation;
+        dropoff_location: CarsSearchLocation;
+        driver: CarsSearchDriver;
+    }
+    export type CarsPaymentType = 'postpaid' | 'guarantee' | 'prepaid';
+    export type CarsMileageUnit = 'kilometres' | 'miles';
+    export type CarsMileage = {
+        type: 'unlimited';
+    } | {
+        type: 'limited';
+        unit: CarsMileageUnit;
+        limit: number;
+    };
+    export interface CarsSupplier {
+        name: string;
+        logo_url: string | null;
+    }
+    export type CarsCategory = 'mini' | 'mini_elite' | 'economy' | 'economy_elite' | 'compact' | 'compact_elite' | 'intermediate' | 'intermediate_elite' | 'standard' | 'standard_elite' | 'fullsize' | 'fullsize_elite' | 'premium' | 'premium_elite' | 'luxury' | 'luxury_elite' | 'special';
+    export type CarsVehicleType = 'two_door' | 'two_or_four_door' | 'four_door' | 'wagon_estate' | 'passenger_van' | 'limousine' | 'sport' | 'convertible' | 'suv' | 'open_air_all_terrain' | 'special' | 'pickup_regular_cab' | 'pickup_extended_cab' | 'special_offer_car' | 'coupe' | 'monospace' | 'recreational_vehicle' | 'two_wheel_vehicle';
+    export type CarsTransmission = 'manual' | 'automatic';
+    export type CarsFuel = 'unspecified_fuel' | 'diesel' | 'hybrid' | 'electric' | 'lpg' | 'hydrogen' | 'multi_fuel' | 'petrol';
+    export interface CarsBaggage {
+        large: number;
+        small: number;
+    }
+    export interface CarsImage {
+        url: string;
+    }
+    export interface Car {
+        name: string;
+        /**
+          * The ACRISS or SIPP code for this car. A four-letter code describing the car's attributes.
+          */
+        code: string;
+        category: CarsCategory;
+        type: CarsVehicleType;
+        transmission: CarsTransmission;
+        fuel: CarsFuel;
+        air_conditioning: boolean;
+        max_passengers: number | null;
+        baggage: CarsBaggage | null;
+        images: CarsImage[] | null;
+    }
+    export type CarsLocationAccess = 'in_terminal' | 'shuttle' | 'meet_and_greet' | 'call_for_pickup';
+    export interface CarsLocationAdditionalInformation {
+        title: string;
+        text: string;
+    }
+    export interface CarsLocationOpeningHours {
+        from: string;
+        to: string;
+    }
+    export interface CarsLocationAddress {
+        line_one: string | null;
+        city_name: string | null;
+        postal_code: string | null;
+        region: string | null;
+        country_code: string;
+    }
+    export interface CarsLocation {
+        name: string;
+        geographic_coordinates: CarsGeographicCoordinates;
+        address: CarsLocationAddress;
+        phone_number: string | null;
+        access: CarsLocationAccess | null;
+        additional_information: CarsLocationAdditionalInformation[];
+        opening_hours: CarsLocationOpeningHours[];
+    }
+    export interface CarsRate {
+        id: string;
+        base_amount: string | null;
+        base_currency: string | null;
+        total_amount: string;
+        total_currency: string;
+        payment_type: CarsPaymentType;
+        mileage: CarsMileage;
+        supplier: CarsSupplier;
+        car: Car;
+        pickup_location: CarsLocation;
+        dropoff_location: CarsLocation;
+    }
+    export interface CarsSearch {
+        id: string;
+        live_mode: boolean;
+        created_at: string;
+        pickup_date: string;
+        pickup_time: string;
+        dropoff_date: string;
+        dropoff_time: string;
+        pickup_location: CarsSearchLocation;
+        dropoff_location: CarsSearchLocation;
+        driver: CarsSearchDriver;
+        rates: CarsRate[];
+    }
+    export interface CarsCharge {
+        amount: string;
+        currency: string;
+        description: string | null;
+    }
+    export interface CarsCondition {
+        title: string;
+        text: string;
+    }
+    export interface CarsPrivacyPolicy {
+        title: string;
+        text: string;
+    }
+    export interface CarsQuote {
+        id: string;
+        live_mode: boolean;
+        rate_id: string;
+        search_id: string;
+        base_amount: string | null;
+        base_currency: string;
+        total_amount: string;
+        total_currency: string;
+        charges: CarsCharge[] | null;
+        payment_type: CarsPaymentType;
+        mileage: CarsMileage;
+        supplier: CarsSupplier;
+        car: Car;
+        conditions: CarsCondition[];
+        privacy_policies: CarsPrivacyPolicy[] | null;
+        pickup_location: CarsLocation;
+        dropoff_location: CarsLocation;
+        pickup_date: string;
+        pickup_time: string;
+        dropoff_date: string;
+        dropoff_time: string;
+    }
+    export type CarsBookingStatus = 'confirmed' | 'cancelled';
+    export interface CarsBookingDriver {
+        given_name: string;
+        family_name: string;
+        date_of_birth: string;
+        email: string;
+        phone_number: string;
+        user_id: string | null;
+    }
+    export interface CarsBooking {
+        id: string;
+        live_mode: boolean;
+        reference: string;
+        confirmed_at: string | null;
+        cancelled_at: string | null;
+        status: CarsBookingStatus;
+        driver: CarsBookingDriver;
+        quote_id: string;
+        base_amount: string | null;
+        base_currency: string;
+        total_amount: string;
+        total_currency: string;
+        charges: CarsCharge[] | null;
+        payment_type: CarsPaymentType;
+        mileage: CarsMileage;
+        supplier: CarsSupplier;
+        metadata: Record<string, string> | null;
+        users: string[];
+        car: Car;
+        conditions: CarsCondition[];
+        privacy_policies: CarsPrivacyPolicy[] | null;
+        pickup_location: CarsLocation;
+        dropoff_location: CarsLocation;
+        pickup_date: string;
+        pickup_time: string;
+        dropoff_date: string;
+        dropoff_time: string;
+    }
+}
+
+declare module '@duffel/api/Cars/Bookings' {
+    export * from '@duffel/api/Cars/Bookings/Bookings';
+}
+
+declare module '@duffel/api/Cars/Quotes' {
+    export * from '@duffel/api/Cars/Quotes/Quotes';
+}
+
 declare module '@duffel/api/Payments/Cards/Cards' {
     import { Client } from '@duffel/api/Client';
     import { Resource } from '@duffel/api/Resource';
@@ -3234,6 +3456,16 @@ declare module '@duffel/api/booking/OrderChangeOffers/OrderChangeOfferTypes' {
                 * The duration of the slice, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration
                 */
             duration?: string | null;
+            /**
+                * The name of the fare brand associated with this slice.
+                * A fare brand specifies the travel conditions you get on your slice made available
+                * by the airline. e.g. a British Airways Economy Basic fare will only include a hand baggage allowance.
+                * It is worth noting that the fare brand names are defined by the airlines themselves and therefore they
+                * are subject to change without any prior notice. We're in the process of adding support for fare_brand_name across
+                * all our airlines, so for now, this field may be null in some offers.
+                * This will become a non-nullable attribute in the near future.
+                */
+            fare_brand_name: string | null;
             /**
                 * Duffel's unique identifier for the slice. It identifies the slice of an order (i.e. the same slice across orders will have different `id`s.
                 */
@@ -5565,6 +5797,73 @@ declare module '@duffel/api/Stays/SearchResults/SearchResults' {
     }
 }
 
+declare module '@duffel/api/Cars/Bookings/Bookings' {
+    import { Client } from '@duffel/api/Client';
+    import { CarsBooking } from '@duffel/api/Cars/CarsTypes';
+    import { Resource } from '@duffel/api/Resource';
+    import { DuffelResponse } from '@duffel/api/types';
+    export interface CarsBookingPayload {
+            quote_id: string;
+            driver: {
+                    given_name: string;
+                    family_name: string;
+                    email: string;
+                    phone_number: string;
+                    date_of_birth: string;
+                    user_id?: string;
+            };
+            inbound_flight_number?: string;
+            supplier_loyalty_programme_account_number?: string;
+            payment?: {
+                    method: 'card';
+                    card_id: string;
+            };
+            metadata?: Record<string, string>;
+            users?: string[];
+    }
+    export class Bookings extends Resource {
+            /**
+                * Endpoint path
+                */
+            path: string;
+            constructor(client: Client);
+            /**
+                * Create a booking from a quote
+                * @param {object} payload - The booking payload, including quote id and driver information
+                */
+            create: (payload: CarsBookingPayload) => Promise<DuffelResponse<CarsBooking>>;
+            /**
+                * Get a booking by ID
+                * @param {string} bookingId - The ID of the booking
+                */
+            get: (bookingId: string) => Promise<DuffelResponse<CarsBooking>>;
+            /**
+                * Cancel a booking
+                * @param {string} bookingId - The ID of the booking to cancel
+                */
+            cancel: (bookingId: string) => Promise<DuffelResponse<CarsBooking>>;
+    }
+}
+
+declare module '@duffel/api/Cars/Quotes/Quotes' {
+    import { Client } from '@duffel/api/Client';
+    import { CarsQuote } from '@duffel/api/Cars/CarsTypes';
+    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<CarsQuote>>;
+    }
+}
+
 declare module '@duffel/api/booking/Identity/ComponentClientKey/ComponentClientKeys' {
     import { Resource } from '@duffel/api/Resource';
     import { type DuffelResponse } from '@duffel/api/types/ClientType';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duffel/api",
-  "version": "4.21.5",
+  "version": "4.22.0",
   "description": "Javascript client library for the Duffel API",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -64,14 +64,16 @@
     "node-fetch": "2.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.28.5",
-    "@babel/preset-env": "7.28.5",
+    "@babel/core": "7.29.0",
+    "@babel/preset-env": "7.29.0",
     "@babel/preset-typescript": "7.28.5",
     "@commitlint/cli": "17.8.1",
     "@commitlint/config-angular": "17.8.1",
     "@commitlint/cz-commitlint": "17.8.1",
     "@rollup/plugin-commonjs": "25.0.8",
     "@rollup/plugin-node-resolve": "15.3.1",
+    "@rollup/plugin-terser": "0.4.4",
+    "@rollup/plugin-typescript": "^12.3.0",
     "@types/jest": "29.5.14",
     "@typescript-eslint/eslint-plugin": "6.7.5",
     "@typescript-eslint/parser": "6.7.5",
@@ -86,12 +88,10 @@
     "lint-staged": "15.5.2",
     "nock": "13.5.6",
     "prettier": "3.5.3",
-    "rollup": "4.22.4",
+    "rollup": "3",
     "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": "0.4.4",
-    "rollup-plugin-typescript2": "0.36.0",
     "semantic-release": "22.0.12",
     "ts-jest": "29.4.6",
     "ts-node": "10.9.2",
@@ -120,5 +120,6 @@
     "branches": [
       "main"
     ]
-  }
+  },
+  "packageManager": "yarn@4.12.0+sha512.f45ab632439a67f8bc759bf32ead036a1f413287b9042726b7cc4818b7b49e14e9423ba49b18f9e06ea4941c1ad062385b1d8760a8d5091a1a31e5f6219afca8"
 }