@duffel/api 2.5.2 → 2.5.4

package/dist/DuffelPayments/PaymentIntents/PaymentIntents.d.ts

@@ -1,28 +1,28 @@
-import { DuffelResponse } from '../../types';
-import { Resource } from '../../Resource';
-import { CreatePaymentIntent, PaymentIntent } from './PaymentIntentsType';
-export declare class PaymentIntents extends Resource {
-    /**
-     * Endpoint path
-     */
-    path: string;
-    constructor(args: any);
-    /**
-     * You should use this API to get the complete, up-to-date information about a Payment Intent.
-     * @param {string} id - Duffel's unique identifier for the Payment Intent
-     * @link https://duffel.com/docs/api/payment-intents/get-payment-intent-by-id
-     */
-    get: (id: string) => Promise<DuffelResponse<PaymentIntent>>;
-    /**
-     * Once you've successfully collected the customer's card details, using the `client_token` from when you first created the Payment Intent, you then need to confirm it using this endpoint.
-     * Once confirmed, the amount charged to your customer's card will be added to your `Balance` (minus any Duffel Payment fees).
-     */
-    confirm: (id: string) => Promise<DuffelResponse<PaymentIntent>>;
-    /**
-     * To begin the process of collecting a card payment from your customer, you need to create a Payment Intent.
-     * The Payment Intent will contain a `client_token` that you use to collect the card payment in your application.
-     * If the Payment Intent is created in test mode you should use a [test card](https://duffel.com/docs/api/overview/test-mode/test-card-numbers).
-     * @param {Object.<CreatePaymentIntent>} params - Endpoint params (amount and string)
-     */
-    create: (params: CreatePaymentIntent) => Promise<DuffelResponse<PaymentIntent>>;
-}
+import { DuffelResponse } from '../../types';
+import { Resource } from '../../Resource';
+import { CreatePaymentIntent, PaymentIntent } from './PaymentIntentsType';
+export declare class PaymentIntents extends Resource {
+    /**
+     * Endpoint path
+     */
+    path: string;
+    constructor(args: any);
+    /**
+     * You should use this API to get the complete, up-to-date information about a Payment Intent.
+     * @param {string} id - Duffel's unique identifier for the Payment Intent
+     * @link https://duffel.com/docs/api/payment-intents/get-payment-intent-by-id
+     */
+    get: (id: string) => Promise<DuffelResponse<PaymentIntent>>;
+    /**
+     * Once you've successfully collected the customer's card details, using the `client_token` from when you first created the Payment Intent, you then need to confirm it using this endpoint.
+     * Once confirmed, the amount charged to your customer's card will be added to your `Balance` (minus any Duffel Payment fees).
+     */
+    confirm: (id: string) => Promise<DuffelResponse<PaymentIntent>>;
+    /**
+     * To begin the process of collecting a card payment from your customer, you need to create a Payment Intent.
+     * The Payment Intent will contain a `client_token` that you use to collect the card payment in your application.
+     * If the Payment Intent is created in test mode you should use a [test card](https://duffel.com/docs/api/overview/test-mode/test-card-numbers).
+     * @param {Object.<CreatePaymentIntent>} params - Endpoint params (amount and string)
+     */
+    create: (params: CreatePaymentIntent) => Promise<DuffelResponse<PaymentIntent>>;
+}

package/dist/DuffelPayments/PaymentIntents/PaymentIntents.spec.d.ts

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

package/dist/DuffelPayments/PaymentIntents/PaymentIntentsType.d.ts

@@ -1,112 +1,112 @@
-export interface PaymentIntent {
-    /**
-     * The amount of the Payment Intent that covers the cost of the flight being sold and any additional markup.
-     * The card payment will be charged this amount.
-     */
-    amount: string;
-    /**
-     * The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country that issued the card used to confirm the Payment Intent.
-     * It will be null until the Payment Intent is confirmed.
-     */
-    card_country_code: string | null;
-    /**
-     * The last four digits of the card used to confirm the Payment Intent.
-     * It will be null until the Payment Intent is confirmed.
-     */
-    card_last_four_digits: string | null;
-    /**
-     * The card network in which the Payment Intent was processed on.
-     * It will be null until the Payment Intent is confirmed.
-     */
-    card_network: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'visa' | 'unknown' | null;
-    /**
-     * This value is used when displaying the payment collection form to securely identify and transmit the values to Duffel.
-     */
-    client_token: string;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was confirmed
-     */
-    confirmed_at: string;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was created
-     */
-    created_at: string;
-    /**
-     * The currency of the `amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-     * The card payment will be charged in this currency.
-     * If it's different to your Balance currency, it will be converted to your Balance currency before the Balance is topped up.
-     */
-    currency: string;
-    /**
-     * The amount of the fees to process the Payment Intent.
-     * It will be `null` until the Payment Intent is confirmed.
-     */
-    fees_amount: string | null;
-    /**
-     * The currency of the fees_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-     * This currency will match your Balance currency.
-     * It will be null until the Payment Intent is confirmed.
-     */
-    fees_currency: string | null;
-    /**
-     * Duffel's unique identifier for the `Payment Intent`
-     */
-    id: string;
-    /**
-     * Whether the Payment Intent was created in live mode. This field will be set to `true` if the Payment Intent was created in live mode, or `false` if it was created in test mode.
-     */
-    live_mode: boolean;
-    /**
-     * The amount of the Payment Intent that was added to the Balance.
-     * It'll be `amount` (in the Balance currency) less the `fees_amount`.
-     * It will be `null` until the Payment Intent is confirmed.
-     */
-    net_amount: string | null;
-    /**
-     * The currency of the net_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-     * This currency will match your Balance currency.
-     * It will be null until the Payment Intent is confirmed.
-     */
-    net_currency: string | null;
-    /**
-     * The Refunds for this Payment Intent
-     * @link https://duffel.com/docs/api/payment-intents/schema#payment-intents-schema-refunds
-     */
-    refunds: {
-        amount: string;
-        arrival: string;
-        created_at: string;
-        currency: string;
-        destination: string;
-        id: string;
-        live_mode: boolean;
-        net_amount: string;
-        net_currency: string;
-        payment_intent_id: string;
-        status: 'succeeded' | 'pending' | 'failed';
-        updated_at: string;
-    }[];
-    /**
-     * The status of this Payment Intent
-     */
-    status: null | 'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'requires_capture' | 'cancelled' | 'succeeded';
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was updated
-     */
-    updated_at: string;
-}
-export interface CreatePaymentIntent {
-    /**
-     * This is the amount that the card payment being taken will be charged.
-     * It should be enough to cover the service(s) you want to sell (enough to book an Offer for example) and the processing fees.
-     * If the currency is different from your Balance currency you should also account for foreign exchange.
-     * It can be higher than that, in which case the remainder will be considered your markup.
-     * If it's higher than the maximum allowed for you organisation you will get a validation error. By default the maximum is 5,000.00 GBP (or equivalent in the same currency). If you need a maximum higher than the default please get in touch with us via help@duffel.com.
-     */
-    amount: string;
-    /**
-     * The currency of the amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-     * This is going to be the currency that the card payment being taken in will be charged in.
-     */
-    currency: string;
-}
+export interface PaymentIntent {
+    /**
+     * The amount of the Payment Intent that covers the cost of the flight being sold and any additional markup.
+     * The card payment will be charged this amount.
+     */
+    amount: string;
+    /**
+     * The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country that issued the card used to confirm the Payment Intent.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    card_country_code: string | null;
+    /**
+     * The last four digits of the card used to confirm the Payment Intent.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    card_last_four_digits: string | null;
+    /**
+     * The card network in which the Payment Intent was processed on.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    card_network: 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'interac' | 'jcb' | 'mastercard' | 'unionpay' | 'visa' | 'unknown' | null;
+    /**
+     * This value is used when displaying the payment collection form to securely identify and transmit the values to Duffel.
+     */
+    client_token: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was confirmed
+     */
+    confirmed_at: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was created
+     */
+    created_at: string;
+    /**
+     * The currency of the `amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * The card payment will be charged in this currency.
+     * If it's different to your Balance currency, it will be converted to your Balance currency before the Balance is topped up.
+     */
+    currency: string;
+    /**
+     * The amount of the fees to process the Payment Intent.
+     * It will be `null` until the Payment Intent is confirmed.
+     */
+    fees_amount: string | null;
+    /**
+     * The currency of the fees_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * This currency will match your Balance currency.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    fees_currency: string | null;
+    /**
+     * Duffel's unique identifier for the `Payment Intent`
+     */
+    id: string;
+    /**
+     * Whether the Payment Intent was created in live mode. This field will be set to `true` if the Payment Intent was created in live mode, or `false` if it was created in test mode.
+     */
+    live_mode: boolean;
+    /**
+     * The amount of the Payment Intent that was added to the Balance.
+     * It'll be `amount` (in the Balance currency) less the `fees_amount`.
+     * It will be `null` until the Payment Intent is confirmed.
+     */
+    net_amount: string | null;
+    /**
+     * The currency of the net_amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * This currency will match your Balance currency.
+     * It will be null until the Payment Intent is confirmed.
+     */
+    net_currency: string | null;
+    /**
+     * The Refunds for this Payment Intent
+     * @link https://duffel.com/docs/api/payment-intents/schema#payment-intents-schema-refunds
+     */
+    refunds: {
+        amount: string;
+        arrival: string;
+        created_at: string;
+        currency: string;
+        destination: string;
+        id: string;
+        live_mode: boolean;
+        net_amount: string;
+        net_currency: string;
+        payment_intent_id: string;
+        status: 'succeeded' | 'pending' | 'failed';
+        updated_at: string;
+    }[];
+    /**
+     * The status of this Payment Intent
+     */
+    status: null | 'requires_payment_method' | 'requires_confirmation' | 'requires_action' | 'processing' | 'requires_capture' | 'cancelled' | 'succeeded';
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the Payment Intent was updated
+     */
+    updated_at: string;
+}
+export interface CreatePaymentIntent {
+    /**
+     * This is the amount that the card payment being taken will be charged.
+     * It should be enough to cover the service(s) you want to sell (enough to book an Offer for example) and the processing fees.
+     * If the currency is different from your Balance currency you should also account for foreign exchange.
+     * It can be higher than that, in which case the remainder will be considered your markup.
+     * If it's higher than the maximum allowed for you organisation you will get a validation error. By default the maximum is 5,000.00 GBP (or equivalent in the same currency). If you need a maximum higher than the default please get in touch with us via help@duffel.com.
+     */
+    amount: string;
+    /**
+     * The currency of the amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     * This is going to be the currency that the card payment being taken in will be charged in.
+     */
+    currency: string;
+}

package/dist/DuffelPayments/PaymentIntents/index.d.ts

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

package/dist/DuffelPayments/Refunds/Refunds.d.ts

@@ -1,21 +1,21 @@
-import { Resource } from '../../Resource';
-import { DuffelResponse } from '../../types';
-import { CreateRefund, Refund } from './RefundsType';
-export declare class Refunds extends Resource {
-    /**
-     * Endpoint path
-     */
-    path: string;
-    constructor(args: any);
-    /**
-     * You should use this API to get the complete, up-to-date information about a Refund.
-     * @param {string} id - Duffel's unique identifier for the Refund
-     * @link https://duffel.com/docs/api/refunds/get-refund-by-id
-     */
-    get: (id: string) => Promise<DuffelResponse<Refund>>;
-    /**
-     * Create a Refund to refund some money to a customer that they paid using a Payment Intent. You must specify the amount and currency. The currency is currently limited to the currency in which the Payment Intent was made.
-     * @param {Object.<CreateFund>} params - Endpoint params (amount, currency and payment_intent_id)
-     */
-    create: (params: CreateRefund) => Promise<DuffelResponse<Refund>>;
-}
+import { Resource } from '../../Resource';
+import { DuffelResponse } from '../../types';
+import { CreateRefund, Refund } from './RefundsType';
+export declare class Refunds extends Resource {
+    /**
+     * Endpoint path
+     */
+    path: string;
+    constructor(args: any);
+    /**
+     * You should use this API to get the complete, up-to-date information about a Refund.
+     * @param {string} id - Duffel's unique identifier for the Refund
+     * @link https://duffel.com/docs/api/refunds/get-refund-by-id
+     */
+    get: (id: string) => Promise<DuffelResponse<Refund>>;
+    /**
+     * Create a Refund to refund some money to a customer that they paid using a Payment Intent. You must specify the amount and currency. The currency is currently limited to the currency in which the Payment Intent was made.
+     * @param {Object.<CreateFund>} params - Endpoint params (amount, currency and payment_intent_id)
+     */
+    create: (params: CreateRefund) => Promise<DuffelResponse<Refund>>;
+}

package/dist/DuffelPayments/Refunds/Refunds.spec.d.ts

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

package/dist/DuffelPayments/Refunds/RefundsType.d.ts

@@ -1,70 +1,70 @@
-export interface Refund {
-    /**
-     * The amount of the Payment Intent that will be refunded to the customer
-     */
-    amount: string;
-    /**
-     * When the refund is expected to arrive in the destination
-     */
-    arrival: string;
-    /**
-     * The ISO 8601 datetime at which the Refund was created
-     */
-    created_at: string;
-    /**
-     * The currency of the amount, as an ISO 4217 currency code.
-     * It will always match the currency of the Payment Intent.
-     */
-    currency: string;
-    /**
-     * Where the Refund amount will be sent to
-     */
-    destination: 'original_form_of_payment';
-    /**
-     * Duffel's unique identifier for the Refund
-     */
-    id: string;
-    /**
-     * Whether the Refund was created in live mode. This field will be set to true if the Refund was created in live mode, or false if it was created in test mode.
-     */
-    live_mode: boolean;
-    /**
-     * The amount deducted from your Balance to cover the Refund amount
-     */
-    net_amount: string;
-    /**
-     * The currency of the net_amount, as an ISO 4217 currency code.
-     * This currency will match your Balance currency.
-     */
-    net_currency: string;
-    /**
-     * Duffel's unique identifier for the Payment Intent that the Refund is for
-     */
-    payment_intent_id: string;
-    /**
-     * The status of the Refund.
-     * Succeeded: The refund is on its way to the destination.
-     * Pending: The Refund could not be processed immediately, and is pending processing.
-     * Failed: A refund can fail if the customer’s bank or card issuer has been unable to process it correctly (e.g., a closed bank account or a problem with the card). The bank returns the refunded amount to us and we add it back to your Balance. This process can take up to 30 days from the post date.
-     */
-    status: 'succeeded' | 'pending' | 'failed';
-    /**
-     * The ISO 8601 datetime at which the Refund was updated
-     */
-    updated_at: string;
-}
-export interface CreateRefund {
-    /**
-     * This amount that will be refunded to the customer's card.
-     */
-    amount: string;
-    /**
-     * The currency of the amount, as an ISO 4217 currency code.
-     * It must match the Payment Intent currency.
-     */
-    currency: string;
-    /**
-     * Duffel's unique identifier for the Payment Intent that the Refund is for
-     */
-    payment_intent_id: string;
-}
+export interface Refund {
+    /**
+     * The amount of the Payment Intent that will be refunded to the customer
+     */
+    amount: string;
+    /**
+     * When the refund is expected to arrive in the destination
+     */
+    arrival: string;
+    /**
+     * The ISO 8601 datetime at which the Refund was created
+     */
+    created_at: string;
+    /**
+     * The currency of the amount, as an ISO 4217 currency code.
+     * It will always match the currency of the Payment Intent.
+     */
+    currency: string;
+    /**
+     * Where the Refund amount will be sent to
+     */
+    destination: 'original_form_of_payment';
+    /**
+     * Duffel's unique identifier for the Refund
+     */
+    id: string;
+    /**
+     * Whether the Refund was created in live mode. This field will be set to true if the Refund was created in live mode, or false if it was created in test mode.
+     */
+    live_mode: boolean;
+    /**
+     * The amount deducted from your Balance to cover the Refund amount
+     */
+    net_amount: string;
+    /**
+     * The currency of the net_amount, as an ISO 4217 currency code.
+     * This currency will match your Balance currency.
+     */
+    net_currency: string;
+    /**
+     * Duffel's unique identifier for the Payment Intent that the Refund is for
+     */
+    payment_intent_id: string;
+    /**
+     * The status of the Refund.
+     * Succeeded: The refund is on its way to the destination.
+     * Pending: The Refund could not be processed immediately, and is pending processing.
+     * Failed: A refund can fail if the customer’s bank or card issuer has been unable to process it correctly (e.g., a closed bank account or a problem with the card). The bank returns the refunded amount to us and we add it back to your Balance. This process can take up to 30 days from the post date.
+     */
+    status: 'succeeded' | 'pending' | 'failed';
+    /**
+     * The ISO 8601 datetime at which the Refund was updated
+     */
+    updated_at: string;
+}
+export interface CreateRefund {
+    /**
+     * This amount that will be refunded to the customer's card.
+     */
+    amount: string;
+    /**
+     * The currency of the amount, as an ISO 4217 currency code.
+     * It must match the Payment Intent currency.
+     */
+    currency: string;
+    /**
+     * Duffel's unique identifier for the Payment Intent that the Refund is for
+     */
+    payment_intent_id: string;
+}

package/dist/DuffelPayments/Refunds/index.d.ts

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

package/dist/DuffelPayments/index.d.ts

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

package/dist/Links/Sessions/Sessions.d.ts

@@ -1,63 +1,63 @@
-import { Client } from 'Client';
-import { Resource } from '../../Resource';
-import { DuffelResponse } from '../../types';
-interface SessionParameters {
-    /**
-     * A tracking reference for the booking that may be created within this Duffel Links session
-     */
-    reference: string;
-    /**
-     * A url to return to when a flight is booked via Duffel Links
-     */
-    success_url: string;
-    /**
-     * A url to return to when there is an error within Duffel Links
-     */
-    failure_url: string;
-    /**
-     * A url to return to when the user exits Duffel Links before booking
-     */
-    abandonment_url: string;
-    /**
-     * A primary color to show within Duffel Links
-     */
-    primary_color?: string;
-    /**
-     * A url of the logo to show within Duffel Links
-     */
-    logo_url?: string;
-    /**
-     * A markup amount to be added to the flights shown within Duffel Links
-     */
-    markup_amount?: number;
-    /**
-     * A markup amount to be added to the flights shown within Duffel Links
-     */
-    markup_currency?: string;
-    /**
-     * A markup percentage to be added to the flights shown within Duffel Links
-     */
-    markup_rate?: number;
-    /**
-     * A text to be shown on the checkout page within Duffel Links
-     */
-    checkout_display_text?: string;
-}
-interface Session {
-    /**
-     * The Duffel Links url that contains the specified configuration
-     */
-    url: string;
-}
-export declare class Sessions extends Resource {
-    /**
-     * Endpoint path
-     */
-    path: string;
-    constructor(client: Client);
-    /**
-     * Create a Duffel Links Session per the configuration
-     */
-    create: (data: SessionParameters) => Promise<DuffelResponse<Session>>;
-}
-export {};
+import { Client } from '../../Client';
+import { Resource } from '../../Resource';
+import { DuffelResponse } from '../../types';
+interface SessionParameters {
+    /**
+     * A tracking reference for the booking that may be created within this Duffel Links session
+     */
+    reference: string;
+    /**
+     * A url to return to when a flight is booked via Duffel Links
+     */
+    success_url: string;
+    /**
+     * A url to return to when there is an error within Duffel Links
+     */
+    failure_url: string;
+    /**
+     * A url to return to when the user exits Duffel Links before booking
+     */
+    abandonment_url: string;
+    /**
+     * A primary color to show within Duffel Links
+     */
+    primary_color?: string;
+    /**
+     * A url of the logo to show within Duffel Links
+     */
+    logo_url?: string;
+    /**
+     * A markup amount to be added to the flights shown within Duffel Links
+     */
+    markup_amount?: number;
+    /**
+     * A markup amount to be added to the flights shown within Duffel Links
+     */
+    markup_currency?: string;
+    /**
+     * A markup percentage to be added to the flights shown within Duffel Links
+     */
+    markup_rate?: number;
+    /**
+     * A text to be shown on the checkout page within Duffel Links
+     */
+    checkout_display_text?: string;
+}
+interface Session {
+    /**
+     * The Duffel Links url that contains the specified configuration
+     */
+    url: string;
+}
+export declare class Sessions extends Resource {
+    /**
+     * Endpoint path
+     */
+    path: string;
+    constructor(client: Client);
+    /**
+     * Create a Duffel Links Session per the configuration
+     */
+    create: (data: SessionParameters) => Promise<DuffelResponse<Session>>;
+}
+export {};

package/dist/Links/Sessions/Sessions.spec.d.ts

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

package/dist/Links/Sessions/index.d.ts

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

package/dist/Links/index.d.ts

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