@stripe/stripe-js 1.20.2 → 1.21.2

package/types/stripe-js/setup-intents.d.ts

@@ -1,163 +1,177 @@
-declare module '@stripe/stripe-js' {
-  /**
-   * Data to be sent with a `stripe.confirmCardSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
-   */
-  interface ConfirmCardSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodCardData, 'type'>;
-  }
+import {SetupIntentConfirmParams} from '../api';
 
-  /**
-   * An options object to control the behavior of `stripe.confirmCardSetup`.
+import {
+  CreatePaymentMethodAcssDebitData,
+  CreatePaymentMethodAuBecsDebitData,
+  CreatePaymentMethodBancontactData,
+  CreatePaymentMethodCardData,
+  CreatePaymentMethodIdealData,
+  CreatePaymentMethodSepaDebitData,
+  CreatePaymentMethodSofortData,
+  CreatePaymentMethodPayPalData,
+  CreatePaymentMethodBacsDebitData,
+} from './payment-intents';
+
+import {Omit} from '../utils';
+
+/**
+ * Data to be sent with a `stripe.confirmCardSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmCardSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
    */
-  interface ConfirmCardSetupOptions {
-    /*
-     * Set this to `false` if you want to [handle next actions yourself](https://stripe.com/docs/payments/payment-intents/verifying-status#next-actions), or if you want to defer next action handling until later (e.g. for use in the [PaymentRequest API](https://stripe.com/docs/stripe-js/elements/payment-request-button#complete-payment-intents)).
-     * Default is `true`.
-     */
-    handleActions?: boolean;
-  }
+  payment_method?: string | Omit<CreatePaymentMethodCardData, 'type'>;
+}
 
-  /**
-   * Data to be sent with a `stripe.confirmIdealSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+/**
+ * An options object to control the behavior of `stripe.confirmCardSetup`.
+ */
+export interface ConfirmCardSetupOptions {
+  /*
+   * Set this to `false` if you want to [handle next actions yourself](https://stripe.com/docs/payments/payment-intents/verifying-status#next-actions), or if you want to defer next action handling until later (e.g. for use in the [PaymentRequest API](https://stripe.com/docs/stripe-js/elements/payment-request-button#complete-payment-intents)).
+   * Default is `true`.
    */
-  interface ConfirmIdealSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodIdealData, 'type'>;
-  }
+  handleActions?: boolean;
+}
 
-  /**
-   * Data to be sent with a `stripe.confirmIdealSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+/**
+ * Data to be sent with a `stripe.confirmIdealSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmIdealSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
    */
-  interface ConfirmPayPalSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodPayPalData, 'type'>;
+  payment_method?: string | Omit<CreatePaymentMethodIdealData, 'type'>;
+}
 
-    /**
-     * The required url your customer will be directed to after they complete authentication.
-     */
-    return_url: string;
-  }
+/**
+ * Data to be sent with a `stripe.confirmIdealSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmPayPalSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
+   */
+  payment_method?: string | Omit<CreatePaymentMethodPayPalData, 'type'>;
 
   /**
-   * Data to be sent with a `stripe.confirmSepaDebitSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+   * The required url your customer will be directed to after they complete authentication.
    */
-  interface ConfirmSepaDebitSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodSepaDebitData, 'type'>;
-  }
+  return_url: string;
+}
 
-  /**
-   * Data to be sent with a `stripe.confirmSofortSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+/**
+ * Data to be sent with a `stripe.confirmSepaDebitSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmSepaDebitSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
    */
-  interface ConfirmSofortSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodSofortData, 'type'>;
-  }
+  payment_method?: string | Omit<CreatePaymentMethodSepaDebitData, 'type'>;
+}
 
-  /**
-   * Data to be sent with a `stripe.confirmAuBecsDebitSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+/**
+ * Data to be sent with a `stripe.confirmSofortSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmSofortSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
    */
-  interface ConfirmAuBecsDebitSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodAuBecsDebitData, 'type'>;
-  }
+  payment_method?: string | Omit<CreatePaymentMethodSofortData, 'type'>;
+}
 
-  /**
-   * Data to be sent with a `stripe.confirmBacsDebitSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+/**
+ * Data to be sent with a `stripe.confirmAuBecsDebitSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmAuBecsDebitSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
    */
-  interface ConfirmBacsDebitSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodBacsDebitData, 'type'>;
-  }
+  payment_method?: string | Omit<CreatePaymentMethodAuBecsDebitData, 'type'>;
+}
 
-  /**
-   * Data to be sent with a `stripe.confirmBancontactSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+/**
+ * Data to be sent with a `stripe.confirmBacsDebitSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmBacsDebitSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
    */
-  interface ConfirmBancontactSetupData extends SetupIntentConfirmParams {
-    /*
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodBancontactData, 'type'>;
-  }
+  payment_method?: string | Omit<CreatePaymentMethodBacsDebitData, 'type'>;
+}
+
+/**
+ * Data to be sent with a `stripe.confirmBancontactSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmBancontactSetupData extends SetupIntentConfirmParams {
+  /*
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
+   */
+  payment_method?: string | Omit<CreatePaymentMethodBancontactData, 'type'>;
+}
 
+/**
+ * Data to be sent with a `stripe.confirmAcssDebitSetup` request.
+ * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmAcssDebitSetupData extends SetupIntentConfirmParams {
   /**
-   * Data to be sent with a `stripe.confirmAcssDebitSetup` request.
-   * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
+   *
+   * @recommended
    */
-  interface ConfirmAcssDebitSetupData extends SetupIntentConfirmParams {
-    /**
-     * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
-     * This field is optional if a `PaymentMethod` has already been attached to this `SetupIntent`.
-     *
-     * @recommended
-     */
-    payment_method?: string | Omit<CreatePaymentMethodAcssDebitData, 'type'>;
-  }
+  payment_method?: string | Omit<CreatePaymentMethodAcssDebitData, 'type'>;
+}
 
+/**
+ * An options object to control the behavior of `stripe.confirmAcssDebitSetup`.
+ */
+export interface ConfirmAcssDebitSetupOptions {
   /**
-   * An options object to control the behavior of `stripe.confirmAcssDebitSetup`.
+   * Set this to true if you want to skip displaying the mandate confirmation.
    */
-  interface ConfirmAcssDebitSetupOptions {
-    /**
-     * Set this to true if you want to skip displaying the mandate confirmation.
-     */
-    skipMandate?: boolean;
-  }
+  skipMandate?: boolean;
+}
 
+/**
+ * Data to be sent with a `stripe.verifyMicrodepositsForSetup` request.
+ */
+export interface VerifyMicrodepositsForSetupData {
   /**
-   * Data to be sent with a `stripe.verifyMicrodepositsForSetup` request.
+   * An array of two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
    */
-  interface VerifyMicrodepositsForSetupData {
-    /**
-     * An array of two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
-     */
-    amounts?: Array<number>;
-  }
+  amounts?: Array<number>;
 }