@stripe/stripe-js 3.0.2 → 3.0.4

package/types/api/payment-methods.d.ts

@@ -1,452 +0,0 @@
-import {StripeElement, StripeElements} from '../stripe-js';
-import {Metadata, MetadataParam, Address} from './shared';
-
-/**
- * The PaymentMethod object.
- */
-export interface PaymentMethod {
-  /**
-   * Unique identifier for the object.
-   */
-  id: string;
-
-  /**
-   * String representing the object's type. Objects of the same type share the same value.
-   */
-  object: 'payment_method';
-
-  billing_details: PaymentMethod.BillingDetails;
-
-  card?: PaymentMethod.Card;
-
-  card_present?: PaymentMethod.CardPresent;
-
-  /**
-   * Time at which the object was created. Measured in seconds since the Unix epoch.
-   */
-  created: number;
-
-  /**
-   * The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
-   */
-  customer: string | null;
-
-  eps?: PaymentMethod.Eps;
-
-  fpx?: PaymentMethod.Fpx;
-
-  grabpay?: PaymentMethod.GrabPay;
-
-  ideal?: PaymentMethod.Ideal;
-
-  p24?: PaymentMethod.P24;
-
-  /**
-   * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-   */
-  livemode: boolean;
-
-  /**
-   * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-   */
-  metadata: Metadata;
-
-  sepa_debit?: PaymentMethod.SepaDebit;
-
-  /**
-   * The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
-   */
-  type: string;
-
-  affirm?: PaymentMethod.Affirm;
-
-  afterpay_clearpay?: PaymentMethod.AfterpayClearpay;
-
-  acss_debit?: PaymentMethod.AcssDebit;
-
-  au_becs_debit?: PaymentMethod.AuBecsDebit;
-
-  us_bank_account?: PaymentMethod.UsBankAccount;
-}
-
-export namespace PaymentMethod {
-  export interface AuBecsDebit {
-    /**
-     * Bank State Branch
-     */
-    bsb_number: string | null;
-
-    /**
-     * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
-     */
-    fingerprint: string | null;
-
-    /**
-     * Last four characters of the account number.
-     */
-    last4: string | null;
-  }
-
-  export interface BillingDetails {
-    /**
-     * Billing address.
-     */
-    address: Address | null;
-
-    /**
-     * Email address.
-     */
-    email: string | null;
-
-    /**
-     * Full name.
-     */
-    name: string | null;
-
-    /**
-     * Billing phone number (including extension).
-     */
-    phone: string | null;
-  }
-
-  export interface Card {
-    /**
-     * Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
-     */
-    brand: string;
-
-    /**
-     * Checks on Card address and CVC if provided.
-     */
-    checks: Card.Checks | null;
-
-    /**
-     * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
-     */
-    country: string | null;
-
-    /**
-     * Two-digit number representing the card's expiration month.
-     */
-    exp_month: number;
-
-    /**
-     * Four-digit number representing the card's expiration year.
-     */
-    exp_year: number;
-
-    /**
-     * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number.
-     */
-    fingerprint?: string | null;
-
-    /**
-     * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
-     */
-    funding: string;
-
-    /**
-     * The last four digits of the card.
-     */
-    last4: string;
-
-    /**
-     * Contains details on how this Card maybe be used for 3D Secure authentication.
-     */
-    three_d_secure_usage: Card.ThreeDSecureUsage | null;
-
-    /**
-     * If this Card is part of a card wallet, this contains the details of the card wallet.
-     */
-    wallet: null | {[k: string]: any};
-  }
-
-  export namespace Card {
-    export interface Checks {
-      /**
-       * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
-       */
-      address_line1_check: string | null;
-
-      /**
-       * If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
-       */
-      address_postal_code_check: string | null;
-
-      /**
-       * If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
-       */
-      cvc_check: string | null;
-    }
-
-    export interface ThreeDSecureUsage {
-      /**
-       * Whether 3D Secure is supported on this card.
-       */
-      supported: boolean;
-    }
-  }
-
-  export interface CardPresent {}
-
-  export interface Eps {
-    /**
-     * The customer's bank.
-     */
-    bank: string;
-  }
-
-  export interface Fpx {
-    /**
-     * The customer's bank.
-     */
-    bank: string;
-  }
-
-  export interface GrabPay {}
-
-  export interface Ideal {
-    /**
-     * The customer's bank, if provided.
-     */
-    bank: string | null;
-
-    /**
-     * The Bank Identifier Code of the customer's bank, if the bank was provided.
-     */
-    bic: string | null;
-  }
-
-  export interface P24 {
-    /**
-     * The customer's bank.
-     */
-    bank: string;
-  }
-
-  export interface SepaDebit {
-    /**
-     * Bank code of bank associated with the bank account.
-     */
-    bank_code: string | null;
-
-    /**
-     * Branch code of bank associated with the bank account.
-     */
-    branch_code: string | null;
-
-    /**
-     * Two-letter ISO code representing the country the bank account is located in.
-     */
-    country: string | null;
-
-    /**
-     * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
-     */
-    fingerprint: string | null;
-
-    /**
-     * Last four characters of the IBAN.
-     */
-    last4: string | null;
-  }
-
-  export interface Affirm {}
-
-  export interface AfterpayClearpay {}
-
-  export interface AcssDebit {
-    /**
-     * Customer’s bank account number.
-     */
-    account_number: string;
-
-    /**
-     * Institution number of the customer’s bank.
-     */
-    institution_number: string;
-
-    /**
-     * Transit number of the customer’s bank.
-     */
-    transit_number: string;
-  }
-
-  export interface UsBankAccount {
-    /**
-     * Customer’s bank account number.
-     */
-    account_number: string;
-
-    /**
-     * The routing transit number for the bank account.
-     */
-    routing_number: string;
-
-    /**
-     * The type of entity that holds the account. This can be either `individual` or `company`.
-     */
-    account_holder_type: string;
-
-    /**
-     * Account type: checkings or savings. Defaults to checking if omitted.
-     */
-    account_type: string;
-
-    /**
-     * The name of the bank.
-     */
-    bank_name: string;
-
-    /**
-     * The ID of the Financial Connections Account used to create the payment method.
-     */
-    financial_connections_account: string;
-
-    /**
-     * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
-     */
-    fingerprint: string;
-
-    /**
-     * Last four digits of the bank account number.
-     */
-    last4: string;
-
-    /**
-     * Contains information about US bank account networks that can be used.
-     */
-    networks: {
-      /**
-       * The preferred network.
-       */
-      preferred: string;
-
-      /**
-       * All supported networks.
-       */
-      supported: string[];
-    };
-  }
-}
-
-export interface PaymentMethodCreateParams {
-  /**
-   * Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
-   */
-  billing_details?: PaymentMethodCreateParams.BillingDetails;
-
-  /**
-   * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-   */
-  metadata?: MetadataParam;
-
-  /**
-   * The PaymentMethod to share.
-   */
-  payment_method?: string;
-
-  /**
-   * The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. Required unless `payment_method` is specified (see the [Cloning PaymentMethods](https://stripe.com/docs/payments/payment-methods/connect#cloning-payment-methods) guide)
-   */
-  type?: string;
-}
-
-export interface CreatePaymentMethodFromElements {
-  /**
-   * The Elements instance
-   *
-   * @docs https://stripe.com/docs/js/elements_object
-   */
-  elements: StripeElements;
-
-  /**
-   * Parameters that will be passed on to the PaymentMethod API
-   *
-   * @docs https://stripe.com/docs/api/payment_methods/create
-   */
-  params?: PaymentMethodCreateParams;
-
-  /**
-   * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-   */
-  metadata?: MetadataParam;
-}
-export interface CreatePaymentMethodFromElement {
-  /**
-   * The specific Element used to collect payment details
-   *
-   * @docs https://stripe.com/docs/js/element
-   */
-  element: StripeElement;
-
-  /**
-   * Parameters that will be passed on to the PaymentMethod API
-   *
-   * @docs https://stripe.com/docs/api/payment_methods/create
-   */
-  params?: PaymentMethodCreateParams;
-
-  /**
-   * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-   */
-  metadata?: MetadataParam;
-}
-
-export namespace PaymentMethodCreateParams {
-  export interface BillingDetails {
-    /**
-     * Billing address.
-     */
-    address?: BillingDetails.Address;
-
-    /**
-     * Email address.
-     */
-    email?: string;
-
-    /**
-     * Full name.
-     */
-    name?: string;
-
-    /**
-     * Billing phone number (including extension).
-     */
-    phone?: string;
-  }
-
-  export namespace BillingDetails {
-    export interface Address {
-      /**
-       * City, district, suburb, town, or village.
-       */
-      city?: string;
-
-      /**
-       * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
-       */
-      country?: string;
-
-      /**
-       * Address line 1 (e.g., street, PO Box, or company name).
-       */
-      line1?: string;
-
-      /**
-       * Address line 2 (e.g., apartment, suite, unit, or building).
-       */
-      line2?: string;
-
-      /**
-       * ZIP or postal code.
-       */
-      postal_code?: string;
-
-      /**
-       * State, county, province, or region.
-       */
-      state?: string;
-    }
-  }
-}

package/types/api/setup-intents.d.ts

@@ -1,184 +0,0 @@
-import {PaymentMethod} from './payment-methods';
-
-/**
- * The SetupIntent object.
- */
-export interface SetupIntent {
-  /**
-   * Unique identifier for the object.
-   */
-  id: string;
-
-  /**
-   * String representing the object's type. Objects of the same type share the same value.
-   */
-  object: 'setup_intent';
-
-  /**
-   * Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
-   */
-  cancellation_reason: SetupIntent.CancellationReason | null;
-
-  /**
-   * The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
-   *
-   * The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
-   */
-  client_secret: string | null;
-
-  /**
-   * Time at which the object was created. Measured in seconds since the Unix epoch.
-   */
-  created: number;
-
-  /**
-   * An arbitrary string attached to the object. Often useful for displaying to users.
-   */
-  description: string | null;
-
-  /**
-   * The error encountered in the previous SetupIntent confirmation.
-   */
-  last_setup_error: SetupIntent.LastSetupError | null;
-
-  /**
-   * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-   */
-  livemode: boolean;
-
-  /**
-   * If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
-   */
-  next_action: SetupIntent.NextAction | null;
-
-  /**
-   * ID of the payment method used with this SetupIntent, or the PaymentMethod itself if this field is expanded.
-   */
-  payment_method: string | null | PaymentMethod;
-
-  /**
-   * The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
-   */
-  payment_method_types: Array<string>;
-
-  /**
-   * [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
-   */
-  status: SetupIntent.Status;
-
-  /**
-   * Indicates how the payment method is intended to be used in the future.
-   *
-   * Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.
-   */
-  usage: string;
-}
-
-export namespace SetupIntent {
-  export type CancellationReason =
-    | 'abandoned'
-    | 'duplicate'
-    | 'requested_by_customer';
-
-  export interface LastSetupError {
-    /**
-     * For card errors, the ID of the failed charge.
-     */
-    charge?: string;
-
-    /**
-     * For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
-     */
-    code?: string;
-
-    /**
-     * For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
-     */
-    decline_code?: string;
-
-    /**
-     * A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
-     */
-    doc_url?: string;
-
-    /**
-     * A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
-     */
-    message?: string;
-
-    /**
-     * If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
-     */
-    param?: string;
-
-    payment_method?: PaymentMethod;
-
-    /**
-     * The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`
-     */
-    type: LastSetupError.Type;
-  }
-
-  export namespace LastSetupError {
-    export type Type =
-      | 'api_connection_error'
-      | 'api_error'
-      | 'authentication_error'
-      | 'card_error'
-      | 'idempotency_error'
-      | 'invalid_request_error'
-      | 'rate_limit_error';
-  }
-
-  export interface NextAction {
-    redirect_to_url?: NextAction.RedirectToUrl;
-
-    /**
-     * Type of the next action to perform, one of `redirect_to_url` or `use_stripe_sdk`.
-     */
-    type: string;
-
-    /**
-     * When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
-     */
-    use_stripe_sdk?: NextAction.UseStripeSdk;
-  }
-
-  export namespace NextAction {
-    export interface RedirectToUrl {
-      /**
-       * If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
-       */
-      return_url: string | null;
-
-      /**
-       * The URL you must redirect your customer to in order to authenticate.
-       */
-      url: string | null;
-    }
-
-    export interface UseStripeSdk {}
-  }
-
-  export type Status =
-    | 'canceled'
-    | 'processing'
-    | 'requires_action'
-    | 'requires_confirmation'
-    | 'requires_payment_method'
-    | 'succeeded';
-}
-
-export interface SetupIntentConfirmParams {
-  /**
-   * This hash contains details about the Mandate to create
-   */
-  mandate_data?: {[k: string]: any};
-
-  /**
-   * The URL to redirect your customer back to after they authenticate on the payment method's app or site.
-   * If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
-   * This parameter is only used for cards and other redirect-based payment methods.
-   */
-  return_url?: string;
-}