@duffel/api 2.5.3 → 2.5.5

package/dist/booking/OfferRequests/OfferRequestsTypes.d.ts

@@ -1,240 +1,240 @@
-import { Airline, CabinClass, DuffelPassengerType, Place, PlaceType } from '../../types';
-import { Offer } from '../Offers/OfferTypes';
-export interface OfferRequestSlice {
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the passengers want to depart
-     */
-    departure_date: string;
-    /**
-     * The city or airport the passengers want to travel to
-     */
-    destination: Place | string;
-    /**
-     * The city or airport the passengers want to depart from
-     */
-    origin: Place | string;
-    /**
-     * The type of the origin
-     */
-    origin_type: PlaceType;
-    /**
-     * The type of the destination
-     */
-    destination_type: PlaceType;
-}
-interface CreateOfferRequestPassengerCommon {
-    /**
-     * The passenger's family name. Only `space`, `-`, `'`, and letters from the
-     * `ASCII`, `Latin-1 Supplement` and `Latin Extended-A` (with the exceptions
-     * of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, and `ð`) Unicode charts are accepted.
-     * All other characters will result in a validation error. The minimum length
-     * is 1 character, and the maximum is 20 characters.
-     *
-     * This is only required if you're also including
-     * **Loyalty Programme Accounts**.
-     */
-    family_name?: string;
-    /**
-     * The passenger's given name. Only `space`, `-`, `'`, and letters from the
-     * `ASCII`, `Latin-1 Supplement` and `Latin Extended-A` (with the exceptions
-     * of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, and `ð`) Unicode charts are accepted.
-     * All other characters will result in a validation error. The minimum length
-     * is 1 character, and the maximum is 20 characters.
-     *
-     * This is only required if you're also including
-     * **Loyalty Programme Accounts**.
-     */
-    given_name?: string;
-    /**
-     * The **Loyalty Programme Accounts** for this passenger.
-     */
-    loyalty_programme_accounts?: LoyaltyProgrammeAccount[];
-}
-interface CreateOfferRequestAdultPassenger extends CreateOfferRequestPassengerCommon {
-    age?: never;
-    fare_type?: never;
-    /**
-     * The type of the passenger. If the passenger is aged 18 or over, you should
-     * specify a `type` of `adult`. If a passenger is aged under 18, you should
-     * specify their `age` instead of a `type`. A passenger can have only a type
-     * or an age, but not both.
-     */
-    type: Extract<DuffelPassengerType, 'adult'>;
-}
-interface CreateOfferRequestNonAdultPassenger extends CreateOfferRequestPassengerCommon {
-    /**
-     * The age of the passenger on the `departure_date` of the final slice. e.g.
-     * if you a searching for a round trip and the passenger is 15 years old at
-     * the time of the outbound flight, but they then have their birthday and are
-     * 16 years old for the inbound flight, you must set the age to 16. You should
-     * specify an `age` for passengers who are under 18 years old. A passenger can
-     * have only a type or an age, but not both. You can optionally pass age with
-     * `fare_type` though.
-     */
-    age: number;
-    fare_type?: never;
-    type?: never;
-}
-export type CreateOfferRequestPassengerFareType = 'accompanying_adult' | 'contract_bulk' | 'contract_bulk_child' | 'contract_bulk_infant_with_seat' | 'contract_bulk_infant_without_seat' | 'frequent_flyer' | 'group_inclusive_tour' | 'group_inclusive_tour_child' | 'humanitarian' | 'individual_inclusive_tour_child' | 'marine' | 'seat_only' | 'student' | 'teacher' | 'tour_operator_inclusive' | 'tour_operator_inclusive_infant' | 'unaccompanied_child' | 'visiting_friends_and_family';
-interface CreateOfferRequestPassengerWithFareType extends CreateOfferRequestPassengerCommon {
-    /**
-     * The age of the passenger on the `departure_date` of the final slice. e.g.
-     * if you a searching for a round trip and the passenger is 15 years old at
-     * the time of the outbound flight, but they then have their birthday and are
-     * 16 years old for the inbound flight, you must set the age to 16. You should
-     * specify an `age` for passengers who are under 18 years old. A passenger can
-     * have only a type or an age, but not both. You can optionally pass age with
-     * `fare_type` though.
-     */
-    age?: number;
-    /**
-     * The fare type of the passenger. If the passenger is aged less than 18, you
-     * should pass in age as well.
-     */
-    fare_type: CreateOfferRequestPassengerFareType;
-    type?: never;
-}
-export type CreateOfferRequestPassenger = CreateOfferRequestAdultPassenger | CreateOfferRequestNonAdultPassenger | CreateOfferRequestPassengerWithFareType;
-export interface CreateOfferRequestPrivateFare {
-    corporate_code: string;
-    tracking_reference: string;
-}
-/**
- * The passengers who want to travel. A passenger will have only a type or an age.
- */
-export interface OfferRequestPassenger {
-    /**
-     * The age of the passenger on the `departure_date` of the final slice.
-     */
-    age?: number;
-    /**
-     * The type of the passenger.
-     */
-    type?: DuffelPassengerType;
-    /**
-     * The passenger's family name. Only `space`, `-`, `'`, and letters from the `ASCII`, `Latin-1 Supplement` and `Latin
-     * Extended-A` (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, , and `ð`) Unicode charts are accepted. All
-     * other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20
-     * characters.
-     *
-     * This is only required if you're also including **Loyalty Programme Accounts**.
-     */
-    family_name?: string;
-    /**
-     * The passenger's given name. Only `space`, `-`, `'`, and letters from the `ASCII`, `Latin-1 Supplement` and `Latin
-     * Extended-A` (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, , and `ð`) Unicode charts are accepted. All
-     * other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20
-     * characters.
-     *
-     * This is only required if you're also including **Loyalty Programme Accounts**.
-     */
-    given_name?: string;
-    /**
-     * The **Loyalty Programme Accounts** for this passenger.
-     */
-    loyalty_programme_accounts?: LoyaltyProgrammeAccount[];
-    /**
-     * The identifier for the passenger, unique within this Offer Request and across all Offer Requests.
-     * This ID will be generated by Duffel unless you had optionally provided one.
-     * Optionally providing one has been deprecated.
-     */
-    id: string;
-}
-/**
- * The **Loyalty Programme Account** details.
- */
-export interface LoyaltyProgrammeAccount {
-    /**
-     * The passenger's account number for this **Loyalty Programme Account**.
-     */
-    account_number: string;
-    /**
-     * The IATA code for the airline that this **Loyalty Programme Account** belongs to.
-     */
-    airline_iata_code: Airline['iata_code'];
-}
-/**
- * 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).
- * @link https://duffel.com/docs/api/offer-requests/schema
- */
-export interface OfferRequest {
-    /**
-     * The slices that make up this offer request.
-     * One-way journeys can be expressed using one slice, whereas return trips will need two.
-     * @link https://duffel.com/docs/api/overview/key-principles
-     */
-    slices: OfferRequestSlice[];
-    /**
-     * The cabin that the passengers want to travel in
-     */
-    cabin_class?: CabinClass;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer request was created
-     */
-    created_at: string;
-    /**
-     * Duffel's unique identifier for the offer request
-     */
-    id: string;
-    /**
-     * Whether the offer request was created in live mode. This field will be set to true if the offer request was created in live mode, or false if it was created in test mode.
-     */
-    live_mode: boolean;
-    /**
-     * The offers returned by the airlines
-     */
-    offers: Omit<Offer, 'available_services'>[];
-    /**
-     * The passengers who want to travel. A passenger will have only a type or an age.
-     */
-    passengers: OfferRequestPassenger[];
-}
-export interface CreateOfferRequest {
-    /**
-     * The cabin that the passengers want to travel in.
-     */
-    cabin_class?: CabinClass;
-    /**
-     * The maximum number of connections within any slice of the offer. For
-     * example 0 means a direct flight which will have a single segment within
-     * each slice and 1 means a maximum of two segments within each slice of the
-     * offer.
-     */
-    max_connections?: 0 | 1 | 2;
-    /**
-     * The passengers who want to travel. If you specify an `age` for a passenger,
-     * the `type` may differ for the same passenger in different offers due to
-     * airline's different rules. E.g. one airline may treat a 14 year old as an
-     * adult, and another as a young adult. You may only specify an `age` or a
-     * `type` – not both.
-     */
-    passengers: CreateOfferRequestPassenger[];
-    /**
-     * The private fare codes for this Offer Request. You can pass in multiple
-     * airlines with their specific private fare codes. The key is the airline's
-     * IATA code that provided the private fare code. The `corporate_code` is
-     * provided to you by the airline and the `tracking_reference` is to identify
-     * your business by the airlines.
-     */
-    private_fares?: {
-        [iataCode: string]: CreateOfferRequestPrivateFare[];
-    };
-    /**
-     * The [slices](https://duffel.com/docs/api/overview/key-principles) that make
-     * up this offer request. One-way journeys can be expressed using one slice,
-     * whereas return trips will need two.
-     */
-    slices: Omit<OfferRequestSlice, 'origin_type' | 'destination_type'>[];
-}
-export interface CreateOfferRequestQueryParameters {
-    /**
-     * When 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](https://duffel.com/docs/api/offers/get-offers) endpoint, specifying the `offer_request_id`.
-     * 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;
-}
-export {};
+import { Airline, CabinClass, DuffelPassengerType, Place, PlaceType } from '../../types';
+import { Offer } from '../Offers/OfferTypes';
+export interface OfferRequestSlice {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the passengers want to depart
+     */
+    departure_date: string;
+    /**
+     * The city or airport the passengers want to travel to
+     */
+    destination: Place | string;
+    /**
+     * The city or airport the passengers want to depart from
+     */
+    origin: Place | string;
+    /**
+     * The type of the origin
+     */
+    origin_type: PlaceType;
+    /**
+     * The type of the destination
+     */
+    destination_type: PlaceType;
+}
+interface CreateOfferRequestPassengerCommon {
+    /**
+     * The passenger's family name. Only `space`, `-`, `'`, and letters from the
+     * `ASCII`, `Latin-1 Supplement` and `Latin Extended-A` (with the exceptions
+     * of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, and `ð`) Unicode charts are accepted.
+     * All other characters will result in a validation error. The minimum length
+     * is 1 character, and the maximum is 20 characters.
+     *
+     * This is only required if you're also including
+     * **Loyalty Programme Accounts**.
+     */
+    family_name?: string;
+    /**
+     * The passenger's given name. Only `space`, `-`, `'`, and letters from the
+     * `ASCII`, `Latin-1 Supplement` and `Latin Extended-A` (with the exceptions
+     * of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, and `ð`) Unicode charts are accepted.
+     * All other characters will result in a validation error. The minimum length
+     * is 1 character, and the maximum is 20 characters.
+     *
+     * This is only required if you're also including
+     * **Loyalty Programme Accounts**.
+     */
+    given_name?: string;
+    /**
+     * The **Loyalty Programme Accounts** for this passenger.
+     */
+    loyalty_programme_accounts?: LoyaltyProgrammeAccount[];
+}
+interface CreateOfferRequestAdultPassenger extends CreateOfferRequestPassengerCommon {
+    age?: never;
+    fare_type?: never;
+    /**
+     * The type of the passenger. If the passenger is aged 18 or over, you should
+     * specify a `type` of `adult`. If a passenger is aged under 18, you should
+     * specify their `age` instead of a `type`. A passenger can have only a type
+     * or an age, but not both.
+     */
+    type: Extract<DuffelPassengerType, 'adult'>;
+}
+interface CreateOfferRequestNonAdultPassenger extends CreateOfferRequestPassengerCommon {
+    /**
+     * The age of the passenger on the `departure_date` of the final slice. e.g.
+     * if you a searching for a round trip and the passenger is 15 years old at
+     * the time of the outbound flight, but they then have their birthday and are
+     * 16 years old for the inbound flight, you must set the age to 16. You should
+     * specify an `age` for passengers who are under 18 years old. A passenger can
+     * have only a type or an age, but not both. You can optionally pass age with
+     * `fare_type` though.
+     */
+    age: number;
+    fare_type?: never;
+    type?: never;
+}
+export type CreateOfferRequestPassengerFareType = 'accompanying_adult' | 'contract_bulk' | 'contract_bulk_child' | 'contract_bulk_infant_with_seat' | 'contract_bulk_infant_without_seat' | 'frequent_flyer' | 'group_inclusive_tour' | 'group_inclusive_tour_child' | 'humanitarian' | 'individual_inclusive_tour_child' | 'marine' | 'seat_only' | 'student' | 'teacher' | 'tour_operator_inclusive' | 'tour_operator_inclusive_infant' | 'unaccompanied_child' | 'visiting_friends_and_family';
+interface CreateOfferRequestPassengerWithFareType extends CreateOfferRequestPassengerCommon {
+    /**
+     * The age of the passenger on the `departure_date` of the final slice. e.g.
+     * if you a searching for a round trip and the passenger is 15 years old at
+     * the time of the outbound flight, but they then have their birthday and are
+     * 16 years old for the inbound flight, you must set the age to 16. You should
+     * specify an `age` for passengers who are under 18 years old. A passenger can
+     * have only a type or an age, but not both. You can optionally pass age with
+     * `fare_type` though.
+     */
+    age?: number;
+    /**
+     * The fare type of the passenger. If the passenger is aged less than 18, you
+     * should pass in age as well.
+     */
+    fare_type: CreateOfferRequestPassengerFareType;
+    type?: never;
+}
+export type CreateOfferRequestPassenger = CreateOfferRequestAdultPassenger | CreateOfferRequestNonAdultPassenger | CreateOfferRequestPassengerWithFareType;
+export interface CreateOfferRequestPrivateFare {
+    corporate_code: string;
+    tracking_reference: string;
+}
+/**
+ * The passengers who want to travel. A passenger will have only a type or an age.
+ */
+export interface OfferRequestPassenger {
+    /**
+     * The age of the passenger on the `departure_date` of the final slice.
+     */
+    age?: number;
+    /**
+     * The type of the passenger.
+     */
+    type?: DuffelPassengerType;
+    /**
+     * The passenger's family name. Only `space`, `-`, `'`, and letters from the `ASCII`, `Latin-1 Supplement` and `Latin
+     * Extended-A` (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, , and `ð`) Unicode charts are accepted. All
+     * other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20
+     * characters.
+     *
+     * This is only required if you're also including **Loyalty Programme Accounts**.
+     */
+    family_name?: string;
+    /**
+     * The passenger's given name. Only `space`, `-`, `'`, and letters from the `ASCII`, `Latin-1 Supplement` and `Latin
+     * Extended-A` (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, , and `ð`) Unicode charts are accepted. All
+     * other characters will result in a validation error. The minimum length is 1 character, and the maximum is 20
+     * characters.
+     *
+     * This is only required if you're also including **Loyalty Programme Accounts**.
+     */
+    given_name?: string;
+    /**
+     * The **Loyalty Programme Accounts** for this passenger.
+     */
+    loyalty_programme_accounts?: LoyaltyProgrammeAccount[];
+    /**
+     * The identifier for the passenger, unique within this Offer Request and across all Offer Requests.
+     * This ID will be generated by Duffel unless you had optionally provided one.
+     * Optionally providing one has been deprecated.
+     */
+    id: string;
+}
+/**
+ * The **Loyalty Programme Account** details.
+ */
+export interface LoyaltyProgrammeAccount {
+    /**
+     * The passenger's account number for this **Loyalty Programme Account**.
+     */
+    account_number: string;
+    /**
+     * The IATA code for the airline that this **Loyalty Programme Account** belongs to.
+     */
+    airline_iata_code: Airline['iata_code'];
+}
+/**
+ * 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).
+ * @link https://duffel.com/docs/api/offer-requests/schema
+ */
+export interface OfferRequest {
+    /**
+     * The slices that make up this offer request.
+     * One-way journeys can be expressed using one slice, whereas return trips will need two.
+     * @link https://duffel.com/docs/api/overview/key-principles
+     */
+    slices: OfferRequestSlice[];
+    /**
+     * The cabin that the passengers want to travel in
+     */
+    cabin_class?: CabinClass;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer request was created
+     */
+    created_at: string;
+    /**
+     * Duffel's unique identifier for the offer request
+     */
+    id: string;
+    /**
+     * Whether the offer request was created in live mode. This field will be set to true if the offer request was created in live mode, or false if it was created in test mode.
+     */
+    live_mode: boolean;
+    /**
+     * The offers returned by the airlines
+     */
+    offers: Omit<Offer, 'available_services'>[];
+    /**
+     * The passengers who want to travel. A passenger will have only a type or an age.
+     */
+    passengers: OfferRequestPassenger[];
+}
+export interface CreateOfferRequest {
+    /**
+     * The cabin that the passengers want to travel in.
+     */
+    cabin_class?: CabinClass;
+    /**
+     * The maximum number of connections within any slice of the offer. For
+     * example 0 means a direct flight which will have a single segment within
+     * each slice and 1 means a maximum of two segments within each slice of the
+     * offer.
+     */
+    max_connections?: 0 | 1 | 2;
+    /**
+     * The passengers who want to travel. If you specify an `age` for a passenger,
+     * the `type` may differ for the same passenger in different offers due to
+     * airline's different rules. E.g. one airline may treat a 14 year old as an
+     * adult, and another as a young adult. You may only specify an `age` or a
+     * `type` – not both.
+     */
+    passengers: CreateOfferRequestPassenger[];
+    /**
+     * The private fare codes for this Offer Request. You can pass in multiple
+     * airlines with their specific private fare codes. The key is the airline's
+     * IATA code that provided the private fare code. The `corporate_code` is
+     * provided to you by the airline and the `tracking_reference` is to identify
+     * your business by the airlines.
+     */
+    private_fares?: {
+        [iataCode: string]: CreateOfferRequestPrivateFare[];
+    };
+    /**
+     * The [slices](https://duffel.com/docs/api/overview/key-principles) that make
+     * up this offer request. One-way journeys can be expressed using one slice,
+     * whereas return trips will need two.
+     */
+    slices: Omit<OfferRequestSlice, 'origin_type' | 'destination_type'>[];
+}
+export interface CreateOfferRequestQueryParameters {
+    /**
+     * When 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](https://duffel.com/docs/api/offers/get-offers) endpoint, specifying the `offer_request_id`.
+     * 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;
+}
+export {};

package/dist/booking/OfferRequests/index.d.ts

@@ -1 +1 @@
-export * from './OfferRequests';
+export * from './OfferRequests';