@duffel/api 2.5.3 → 2.5.5

package/dist/booking/OrderChangeRequests/OrderChangeRequests.d.ts

@@ -1,29 +1,29 @@
-import { Resource } from '../../Resource';
-import { CreateOrderChangeRequest, DuffelResponse, OrderChangeRequestResponse } from '../../types';
-/**
- *
- * To change an order, you'll need to create an order change request.
- * This is still in PREVIEW mode
- * @export
- * @class OrderChangeRequests
- * @extends {Resource}
- */
-export declare class OrderChangeRequests extends Resource {
-    /**
-     * Endpoint path
-     */
-    path: string;
-    constructor(args: any);
-    /**
-     * Retrieves an order change request by its ID
-     * @param {string} id - The ID of your order change request
-     */
-    get: (id: string) => Promise<DuffelResponse<OrderChangeRequestResponse>>;
-    /**
-     *
-     * To change flights on an existing paid order, you'll need to create an order change request.
-     * @link https://duffel.com/docs/api/order-change-requests/create-order-change-request
-     * @memberof OrderChangeRequests
-     */
-    create: (options: CreateOrderChangeRequest) => Promise<DuffelResponse<OrderChangeRequestResponse>>;
-}
+import { Resource } from '../../Resource';
+import { CreateOrderChangeRequest, DuffelResponse, OrderChangeRequestResponse } from '../../types';
+/**
+ *
+ * To change an order, you'll need to create an order change request.
+ * This is still in PREVIEW mode
+ * @export
+ * @class OrderChangeRequests
+ * @extends {Resource}
+ */
+export declare class OrderChangeRequests extends Resource {
+    /**
+     * Endpoint path
+     */
+    path: string;
+    constructor(args: any);
+    /**
+     * Retrieves an order change request by its ID
+     * @param {string} id - The ID of your order change request
+     */
+    get: (id: string) => Promise<DuffelResponse<OrderChangeRequestResponse>>;
+    /**
+     *
+     * To change flights on an existing paid order, you'll need to create an order change request.
+     * @link https://duffel.com/docs/api/order-change-requests/create-order-change-request
+     * @memberof OrderChangeRequests
+     */
+    create: (options: CreateOrderChangeRequest) => Promise<DuffelResponse<OrderChangeRequestResponse>>;
+}

package/dist/booking/OrderChangeRequests/OrderChangeRequestsTypes.d.ts

@@ -1,141 +1,141 @@
-import { CabinClass, Place } from '../../types';
-import { OrderChangeOfferSlices } from '../OrderChangeOffers/OrderChangeOfferTypes';
-export interface OrderChangeSliceResponse {
-    remove: {
-        slice_id: string;
-    };
-    add: {
-        /**
-         * 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 where this slice ends
-         */
-        destination: Place;
-        /**
-         * The city or airport where this slice begins
-         */
-        origin: Place;
-        /**
-         * The cabin that the passengers want to travel in
-         */
-        cabin_class: CabinClass;
-    };
-}
-export interface OrderChangeOffers {
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was last updated
-     */
-    updated_at: string;
-    /**
-     * The price of this offer as a change to your existing order, excluding taxes
-     */
-    change_total_amount: string | null;
-    /**
-     * The currency of the `change_total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-     * It will match your organisation's billing currency unless you're using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered).
-     */
-    change_total_currency: string | null;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was created
-     */
-    created_at: string;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer will expire and no longer be usable to create an order
-     */
-    expires_at: string;
-    /**
-     * Duffel's unique identifier for the order change offer
-     */
-    id: string;
-    /**
-     * The price of this offer if it was newly purchased, excluding taxes
-     */
-    new_total_amount: string | null;
-    /**
-     * The currency of the `new_total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you're using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered).
-     */
-    new_total_currency: string;
-    /**
-     * The ID for an `order change` if one has already been created from this `order change offer`
-     */
-    order_change_id: string;
-    /**
-     * The penalty price imposed by the airline for making this change
-     */
-    penalty_amount: string | null;
-    /**
-     * The currency of the `penalty_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-     * It will match your organisation's billing currency unless you're using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered).
-     */
-    penalty_currency: string | null;
-    /**
-     * Where the refund, once confirmed, will be sent. `card` is currently a restricted feature. `awaiting_payment` is for pay later orders where no payment has been made yet.
-     */
-    refund_to: 'arc_bsp_cash' | 'balance' | 'card' | 'voucher' | 'awaiting_payment';
-    /**
-     * The slices within an order change that are being added to and/or removed from the order
-     */
-    slices: OrderChangeOfferSlices;
-}
-export interface OrderChangeRequestResponse {
-    /**
-     * The ID of your order change request
-     */
-    id: string;
-    /**
-     * Whether the order was created in live mode. This field will be set to `true` if the order was created in live mode, or `false` if it was created in test mode.
-     */
-    live_mode: boolean;
-    /**
-     * The list of the offers available to perform change on the order.
-     */
-    order_change_offers: OrderChangeOffers[];
-    /**
-     * The order ID that you want to change
-     */
-    order_id: string;
-    /**
-     * The slices to be added and/or removed
-     */
-    slices: OrderChangeSliceResponse;
-}
-export interface CreateOrderChangeRequest {
-    /**
-     * 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: {
-        /**
-         * The search criteria for slices which you wish to add to your order
-         */
-        add: {
-            /**
-             * The cabin that the passengers want to travel in
-             */
-            cabin_class: CabinClass;
-            /**
-             * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the passengers want to depart
-             */
-            departure_date: string;
-            /**
-             * The 3-letter IATA code for the city or airport where this slice ends
-             */
-            destination: string;
-            /**
-             * The 3-letter IATA code for the city or airport where this slice starts
-             */
-            origin: string;
-        }[];
-        /**
-         * The slices that you wish to remove from your order
-         */
-        remove: {
-            slice_id: string;
-        }[];
-    };
-    /**
-     * The order ID you wish to change
-     */
-    order_id: string;
-}
+import { CabinClass, Place } from '../../types';
+import { OrderChangeOfferSlices } from '../OrderChangeOffers/OrderChangeOfferTypes';
+export interface OrderChangeSliceResponse {
+    remove: {
+        slice_id: string;
+    };
+    add: {
+        /**
+         * 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 where this slice ends
+         */
+        destination: Place;
+        /**
+         * The city or airport where this slice begins
+         */
+        origin: Place;
+        /**
+         * The cabin that the passengers want to travel in
+         */
+        cabin_class: CabinClass;
+    };
+}
+export interface OrderChangeOffers {
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was last updated
+     */
+    updated_at: string;
+    /**
+     * The price of this offer as a change to your existing order, excluding taxes
+     */
+    change_total_amount: string | null;
+    /**
+     * The currency of the `change_total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * It will match your organisation's billing currency unless you're using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered).
+     */
+    change_total_currency: string | null;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was created
+     */
+    created_at: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer will expire and no longer be usable to create an order
+     */
+    expires_at: string;
+    /**
+     * Duffel's unique identifier for the order change offer
+     */
+    id: string;
+    /**
+     * The price of this offer if it was newly purchased, excluding taxes
+     */
+    new_total_amount: string | null;
+    /**
+     * The currency of the `new_total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you're using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered).
+     */
+    new_total_currency: string;
+    /**
+     * The ID for an `order change` if one has already been created from this `order change offer`
+     */
+    order_change_id: string;
+    /**
+     * The penalty price imposed by the airline for making this change
+     */
+    penalty_amount: string | null;
+    /**
+     * The currency of the `penalty_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * It will match your organisation's billing currency unless you're using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered).
+     */
+    penalty_currency: string | null;
+    /**
+     * Where the refund, once confirmed, will be sent. `card` is currently a restricted feature. `awaiting_payment` is for pay later orders where no payment has been made yet.
+     */
+    refund_to: 'arc_bsp_cash' | 'balance' | 'card' | 'voucher' | 'awaiting_payment';
+    /**
+     * The slices within an order change that are being added to and/or removed from the order
+     */
+    slices: OrderChangeOfferSlices;
+}
+export interface OrderChangeRequestResponse {
+    /**
+     * The ID of your order change request
+     */
+    id: string;
+    /**
+     * Whether the order was created in live mode. This field will be set to `true` if the order was created in live mode, or `false` if it was created in test mode.
+     */
+    live_mode: boolean;
+    /**
+     * The list of the offers available to perform change on the order.
+     */
+    order_change_offers: OrderChangeOffers[];
+    /**
+     * The order ID that you want to change
+     */
+    order_id: string;
+    /**
+     * The slices to be added and/or removed
+     */
+    slices: OrderChangeSliceResponse;
+}
+export interface CreateOrderChangeRequest {
+    /**
+     * 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: {
+        /**
+         * The search criteria for slices which you wish to add to your order
+         */
+        add: {
+            /**
+             * The cabin that the passengers want to travel in
+             */
+            cabin_class: CabinClass;
+            /**
+             * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the passengers want to depart
+             */
+            departure_date: string;
+            /**
+             * The 3-letter IATA code for the city or airport where this slice ends
+             */
+            destination: string;
+            /**
+             * The 3-letter IATA code for the city or airport where this slice starts
+             */
+            origin: string;
+        }[];
+        /**
+         * The slices that you wish to remove from your order
+         */
+        remove: {
+            slice_id: string;
+        }[];
+    };
+    /**
+     * The order ID you wish to change
+     */
+    order_id: string;
+}

package/dist/booking/OrderChangeRequests/OrderRequestChanges.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

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

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

package/dist/booking/OrderChanges/OrderChanges.d.ts

@@ -1,31 +1,31 @@
-import { Resource } from '../../Resource';
-import { ConfirmOrderChangePayment, CreateOrderChangeParameters, DuffelResponse, OrderChangeOfferSlice } from '../../types';
-/**
- * Once you've created an order change request, and you've chosen which slices to add and remove, you'll then want to create an order change.
- */
-export declare class OrderChanges extends Resource {
-    /**
-     * Endpoint path
-     */
-    path: string;
-    constructor(args: any);
-    /**
-     * To begin the process of changing an order you need to create an order change.
-     * The OrderChange will contain the `selected_order_change_offer` reference of the change you wish to make to your order.
-     * @link https://duffel.com/docs/api/order-changes/create-order-change
-     */
-    create: (options: CreateOrderChangeParameters) => Promise<DuffelResponse<OrderChangeOfferSlice>>;
-    /**
-     * Retrieves an order change by its ID
-     * @param {string} id - Duffel's unique identifier for the order change
-     * @link https://duffel.com/docs/api/order-changes/get-order-change-by-id
-     */
-    get: (id: string) => Promise<DuffelResponse<OrderChangeOfferSlice>>;
-    /**
-     * Once you've created a pending order change, you'll know the change_total_amount due for the change.
-     * @param {string} id - Duffel's unique identifier for the order change
-     * @param {payment} Object - The payment details to use to pay for the order change, if there is an amount to be paid. Some order changes may not need this if they instead refund an amount. In those cases, you can pass any empty object.
-     * @link https://duffel.com/docs/api/order-changes/confirm-order-change
-     */
-    confirm: (id: string, options: Partial<ConfirmOrderChangePayment>) => Promise<DuffelResponse<OrderChangeOfferSlice>>;
-}
+import { Resource } from '../../Resource';
+import { ConfirmOrderChangePayment, CreateOrderChangeParameters, DuffelResponse, OrderChangeOfferSlice } from '../../types';
+/**
+ * Once you've created an order change request, and you've chosen which slices to add and remove, you'll then want to create an order change.
+ */
+export declare class OrderChanges extends Resource {
+    /**
+     * Endpoint path
+     */
+    path: string;
+    constructor(args: any);
+    /**
+     * To begin the process of changing an order you need to create an order change.
+     * The OrderChange will contain the `selected_order_change_offer` reference of the change you wish to make to your order.
+     * @link https://duffel.com/docs/api/order-changes/create-order-change
+     */
+    create: (options: CreateOrderChangeParameters) => Promise<DuffelResponse<OrderChangeOfferSlice>>;
+    /**
+     * Retrieves an order change by its ID
+     * @param {string} id - Duffel's unique identifier for the order change
+     * @link https://duffel.com/docs/api/order-changes/get-order-change-by-id
+     */
+    get: (id: string) => Promise<DuffelResponse<OrderChangeOfferSlice>>;
+    /**
+     * Once you've created a pending order change, you'll know the change_total_amount due for the change.
+     * @param {string} id - Duffel's unique identifier for the order change
+     * @param {payment} Object - The payment details to use to pay for the order change, if there is an amount to be paid. Some order changes may not need this if they instead refund an amount. In those cases, you can pass any empty object.
+     * @link https://duffel.com/docs/api/order-changes/confirm-order-change
+     */
+    confirm: (id: string, options: Partial<ConfirmOrderChangePayment>) => Promise<DuffelResponse<OrderChangeOfferSlice>>;
+}

package/dist/booking/OrderChanges/OrderChanges.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/booking/OrderChanges/OrderChangesTypes.d.ts

@@ -1,102 +1,102 @@
-import { OrderChangeOfferSlices, PaymentType } from '../../types';
-export interface OrderChange {
-    /**
-     * The price of this offer as a change to your existing order, excluding taxes
-     */
-    change_total_amount: string | null;
-    /**
-     * The currency of the change_total_amount, as an ISO 4217 currency code.
-     * It will match your organisation's billing currency unless you're using Duffel
-     * as an accredited IATA agent, in which case it will be in the currency provided
-     * by the airline (which will usually be based on the country where your
-     * IATA agency is registered).
-     */
-    change_total_currency: string | null;
-    /**
-     * Whether the order was created in live mode. This field will be set to `true`
-     * if the order was created in live mode, or `false` if it was created in test mode.
-     */
-    live_mode: boolean;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was created
-     */
-    created_at: string;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime that indicates when the order change was confirmed
-     */
-    confirmed_at: string;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer will expire
-     * and no longer be usable to create an order
-     */
-    expires_at: string;
-    /**
-     * Duffel's unique identifier for the order change offer
-     */
-    id: string;
-    /**
-     * The price of this offer if it was newly purchased, excluding taxes
-     */
-    new_total_amount: string | null;
-    /**
-     * The currency of the new_total_amount, as an ISO 4217 currency code.
-     * It will match your organisation's billing currency unless you're using
-     * Duffel as an accredited IATA agent, in which case it will be in the
-     * currency provided by the airline (which will usually be based on the
-     * country where your IATA agency is registered).
-     */
-    new_total_currency: string;
-    /**
-     * Duffel's unique identifier for the order which is being changed
-     */
-    order_id: string;
-    /**
-     * The penalty price imposed by the airline for making this change
-     */
-    penalty_amount: string | null;
-    /**
-     * The currency of the penalty_amount, as an ISO 4217 currency code.
-     * It will match your organisation's billing currency unless you're using
-     * Duffel as an accredited IATA agent, in which case it will be in the
-     * currency provided by the airline (which will usually be based on
-     * the country where your IATA agency is registered).
-     */
-    penalty_currency: string | null;
-    /**
-     * Where the refund, once confirmed, will be sent. card is currently a restricted feature.
-     * `awaiting_payment` is for pay later orders where no payment has been made yet.
-     */
-    refund_to: 'arc_bsp_cash' | 'balance' | 'card' | 'voucher' | 'awaiting_payment' | 'original_form_of_payment';
-    /**
-     * The slices to be added and/or removed
-     */
-    slices: OrderChangeOfferSlices;
-    /**
-     * The available payment types to complete the order change.
-     */
-    available_payment_types?: PaymentType[] | null;
-}
-export interface CreateOrderChangeParameters {
-    /**
-     * Duffel's unique identifier for the order change offer
-     */
-    selected_order_change_offer: string;
-}
-export interface ConfirmOrderChangePayment {
-    /**
-     * The amount of the payment. This should be the same as the change_total_amount of the order change.
-     */
-    amount: string;
-    /**
-     * The currency of the change_total_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-     */
-    currency: string;
-    /**
-     * The type of payment you want to use for the Order Change.
-     * If you are an IATA agent with your own agreements with airlines, in some cases, you can pay using ARC/BSP cash by specifying arc_bsp_cash.
-     * Otherwise, you must pay using your Duffel account's balance by specifying balance.
-     * In test mode, your balance is unlimited.
-     * If you're not sure which of these options applies to you, get in touch with the Duffel support team at [help@duffel.com](mailto:help@duffel.com).
-     */
-    type: PaymentType;
-}
+import { OrderChangeOfferSlices, PaymentType } from '../../types';
+export interface OrderChange {
+    /**
+     * The price of this offer as a change to your existing order, excluding taxes
+     */
+    change_total_amount: string | null;
+    /**
+     * The currency of the change_total_amount, as an ISO 4217 currency code.
+     * It will match your organisation's billing currency unless you're using Duffel
+     * as an accredited IATA agent, in which case it will be in the currency provided
+     * by the airline (which will usually be based on the country where your
+     * IATA agency is registered).
+     */
+    change_total_currency: string | null;
+    /**
+     * Whether the order was created in live mode. This field will be set to `true`
+     * if the order was created in live mode, or `false` if it was created in test mode.
+     */
+    live_mode: boolean;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was created
+     */
+    created_at: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime that indicates when the order change was confirmed
+     */
+    confirmed_at: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer will expire
+     * and no longer be usable to create an order
+     */
+    expires_at: string;
+    /**
+     * Duffel's unique identifier for the order change offer
+     */
+    id: string;
+    /**
+     * The price of this offer if it was newly purchased, excluding taxes
+     */
+    new_total_amount: string | null;
+    /**
+     * The currency of the new_total_amount, as an ISO 4217 currency code.
+     * It will match your organisation's billing currency unless you're using
+     * Duffel as an accredited IATA agent, in which case it will be in the
+     * currency provided by the airline (which will usually be based on the
+     * country where your IATA agency is registered).
+     */
+    new_total_currency: string;
+    /**
+     * Duffel's unique identifier for the order which is being changed
+     */
+    order_id: string;
+    /**
+     * The penalty price imposed by the airline for making this change
+     */
+    penalty_amount: string | null;
+    /**
+     * The currency of the penalty_amount, as an ISO 4217 currency code.
+     * It will match your organisation's billing currency unless you're using
+     * Duffel as an accredited IATA agent, in which case it will be in the
+     * currency provided by the airline (which will usually be based on
+     * the country where your IATA agency is registered).
+     */
+    penalty_currency: string | null;
+    /**
+     * Where the refund, once confirmed, will be sent. card is currently a restricted feature.
+     * `awaiting_payment` is for pay later orders where no payment has been made yet.
+     */
+    refund_to: 'arc_bsp_cash' | 'balance' | 'card' | 'voucher' | 'awaiting_payment' | 'original_form_of_payment';
+    /**
+     * The slices to be added and/or removed
+     */
+    slices: OrderChangeOfferSlices;
+    /**
+     * The available payment types to complete the order change.
+     */
+    available_payment_types?: PaymentType[] | null;
+}
+export interface CreateOrderChangeParameters {
+    /**
+     * Duffel's unique identifier for the order change offer
+     */
+    selected_order_change_offer: string;
+}
+export interface ConfirmOrderChangePayment {
+    /**
+     * The amount of the payment. This should be the same as the change_total_amount of the order change.
+     */
+    amount: string;
+    /**
+     * The currency of the change_total_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     */
+    currency: string;
+    /**
+     * The type of payment you want to use for the Order Change.
+     * If you are an IATA agent with your own agreements with airlines, in some cases, you can pay using ARC/BSP cash by specifying arc_bsp_cash.
+     * Otherwise, you must pay using your Duffel account's balance by specifying balance.
+     * In test mode, your balance is unlimited.
+     * If you're not sure which of these options applies to you, get in touch with the Duffel support team at [help@duffel.com](mailto:help@duffel.com).
+     */
+    type: PaymentType;
+}

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

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