@stripe/stripe-js 1.20.3 → 1.21.0

package/types/stripe-js/token-and-sources.d.ts

@@ -1,110 +1,110 @@
-declare module '@stripe/stripe-js' {
+import {SourceCreateParams} from '../api';
+
+/**
+ * An object containing the unique ID and client secret for a `Source`.
+ *
+ * You can use a `Source` object created with `stripe.createSource` as the argument to `stripe.retrieveSource`, as every `Source` object has both `id` and `client_secret` keys.
+ */
+export interface RetrieveSourceParam {
   /**
-   * An object containing the unique ID and client secret for a `Source`.
-   *
-   * You can use a `Source` object created with `stripe.createSource` as the argument to `stripe.retrieveSource`, as every `Source` object has both `id` and `client_secret` keys.
+   * Unique identifier of the `Source`.
    */
-  interface RetrieveSourceParam {
-    /**
-     * Unique identifier of the `Source`.
-     */
-    id: string;
-
-    /**
-     * A secret available to the web client that created the `Source`, for purposes of retrieving the `Source` later from that same client.
-     */
-    client_secret: string;
-  }
+  id: string;
 
   /**
-   * An object containing additional payment information you might have collected.
-   *
-   * Although these fields are optional, we highly recommend collecting name and address.
-   * This information can be used to perform a number of verifications, such as CVC, ZIP, and address verification.
-   * Radar includes built-in rules that can block payments where the ZIP or CVC verifications with the cardholder’s bank failed.
+   * A secret available to the web client that created the `Source`, for purposes of retrieving the `Source` later from that same client.
    */
-  interface CreateTokenCardData {
-    /**
-     * @recommended
-     */
-    name?: string;
+  client_secret: string;
+}
 
-    address_line1?: string;
+/**
+ * An object containing additional payment information you might have collected.
+ *
+ * Although these fields are optional, we highly recommend collecting name and address.
+ * This information can be used to perform a number of verifications, such as CVC, ZIP, and address verification.
+ * Radar includes built-in rules that can block payments where the ZIP or CVC verifications with the cardholder’s bank failed.
+ */
+export interface CreateTokenCardData {
+  /**
+   * @recommended
+   */
+  name?: string;
 
-    address_line2?: string;
+  address_line1?: string;
 
-    address_city?: string;
+  address_line2?: string;
 
-    address_state?: string;
+  address_city?: string;
 
-    address_zip?: string;
+  address_state?: string;
 
-    /**
-     * A two character country code (for example, `US`).
-     *
-     * @recommended
-     */
-    address_country?: string;
+  address_zip?: string;
 
-    /**
-     * Required in order to [add the card to a Connect account](https://stripe.com/docs/connect/payouts#bank-accounts) (in all other cases, this parameter is not used).
-     * Currently, the only supported currency for debit card payouts is `usd`.
-     */
-    currency?: string;
-  }
+  /**
+   * A two character country code (for example, `US`).
+   *
+   * @recommended
+   */
+  address_country?: string;
 
-  interface CreateTokenIbanData {
-    /**
-     * Three character currency code (e.g., `eur`).
-     */
-    currency: string;
+  /**
+   * Required in order to [add the card to a Connect account](https://stripe.com/docs/connect/payouts#bank-accounts) (in all other cases, this parameter is not used).
+   * Currently, the only supported currency for debit card payouts is `usd`.
+   */
+  currency?: string;
+}
 
-    account_holder_name: string;
+export interface CreateTokenIbanData {
+  /**
+   * Three character currency code (e.g., `eur`).
+   */
+  currency: string;
 
-    account_holder_type: string;
-  }
+  account_holder_name: string;
 
-  interface CreateTokenPiiData {
-    personal_id_number: string;
-  }
+  account_holder_type: string;
+}
 
-  interface CreateTokenBankAccountData {
-    country: string;
+export interface CreateTokenPiiData {
+  personal_id_number: string;
+}
 
-    currency: string;
+export interface CreateTokenBankAccountData {
+  country: string;
 
-    routing_number?: string;
+  currency: string;
 
-    account_number: string;
+  routing_number?: string;
 
-    account_holder_name?: string;
+  account_number: string;
 
-    account_holder_type: string;
+  account_holder_name?: string;
 
-    account_type?: string;
-  }
+  account_holder_type: string;
 
-  /**
-   * A required object containing the `type` of `Source` you want to create, and any additional payment information that you have collected.
-   * See the [Sources API](https://stripe.com/docs/api#create_source) reference for details.
-   *
-   * You cannot pass raw card information to `stripe.createSource(sourceData)`.
-   * Instead, you must gather card information in an `Element` and use `stripe.createSource(element, sourceData)`.
-   * You can also pass an existing card token to convert it into a `Source` object.
-   */
-  interface CreateSourceData extends SourceCreateParams {
-    bancontact?: CreateSourceData.DeprecatedMethodData;
+  account_type?: string;
+}
 
-    ideal?: CreateSourceData.DeprecatedMethodData;
+/**
+ * A required object containing the `type` of `Source` you want to create, and any additional payment information that you have collected.
+ * See the [Sources API](https://stripe.com/docs/api#create_source) reference for details.
+ *
+ * You cannot pass raw card information to `stripe.createSource(sourceData)`.
+ * Instead, you must gather card information in an `Element` and use `stripe.createSource(element, sourceData)`.
+ * You can also pass an existing card token to convert it into a `Source` object.
+ */
+export interface CreateSourceData extends SourceCreateParams {
+  bancontact?: CreateSourceData.DeprecatedMethodData;
 
-    klarna?: CreateSourceData.DeprecatedMethodData;
+  ideal?: CreateSourceData.DeprecatedMethodData;
 
-    sepa_debit?: CreateSourceData.DeprecatedMethodData;
+  klarna?: CreateSourceData.DeprecatedMethodData;
 
-    sofort?: CreateSourceData.DeprecatedMethodData;
-  }
+  sepa_debit?: CreateSourceData.DeprecatedMethodData;
+
+  sofort?: CreateSourceData.DeprecatedMethodData;
+}
 
-  namespace CreateSourceData {
-    type DeprecatedMethodData = Record<string, unknown>;
-  }
+export namespace CreateSourceData {
+  export type DeprecatedMethodData = Record<string, unknown>;
 }

package/types/utils.d.ts

@@ -0,0 +1,2 @@
+// Polyfill for TypeScript < 3.5 compatibility
+export type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;

package/types/api/BankAccounts.d.ts

@@ -1,63 +0,0 @@
-declare module '@stripe/stripe-js' {
-  /**
-   * The BankAccount object.
-   */
-  interface BankAccount {
-    /**
-     * Unique identifier for the object.
-     */
-    id: string;
-
-    /**
-     * String representing the object's type. Objects of the same type share the same value.
-     */
-    object: 'bank_account';
-
-    /**
-     * The name of the person or business that owns the bank account.
-     */
-    account_holder_name: string | null;
-
-    /**
-     * The type of entity that holds the account. This can be either `individual` or `company`.
-     */
-    account_holder_type: string | null;
-
-    /**
-     * Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
-     */
-    bank_name: string | null;
-
-    /**
-     * Two-letter ISO code representing the country the bank account is located in.
-     */
-    country: string;
-
-    /**
-     * Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
-     */
-    currency: string;
-
-    /**
-     * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
-     */
-    fingerprint: string | null;
-
-    /**
-     * The last four digits of the bank account number.
-     */
-    last4: string;
-
-    /**
-     * The routing transit number for the bank account.
-     */
-    routing_number: string | null;
-
-    /**
-     * For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn't enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.
-     *
-     * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.
-     */
-    status: string;
-  }
-}

package/types/api/Cards.d.ts

@@ -1,130 +0,0 @@
-declare module '@stripe/stripe-js' {
-  /**
-   * The Card object.
-   */
-  interface Card {
-    /**
-     * Unique identifier for the object.
-     */
-    id: string;
-
-    /**
-     * String representing the object's type. Objects of the same type share the same value.
-     */
-    object: 'card';
-
-    /**
-     * City/District/Suburb/Town/Village.
-     */
-    address_city: string | null;
-
-    /**
-     * Billing address country, if provided when creating card.
-     */
-    address_country: string | null;
-
-    /**
-     * Address line 1 (Street address/PO Box/Company name).
-     */
-    address_line1: string | null;
-
-    /**
-     * If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
-     */
-    address_line1_check: string | null;
-
-    /**
-     * Address line 2 (Apartment/Suite/Unit/Building).
-     */
-    address_line2: string | null;
-
-    /**
-     * State/County/Province/Region.
-     */
-    address_state: string | null;
-
-    /**
-     * ZIP or postal code.
-     */
-    address_zip: string | null;
-
-    /**
-     * If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
-     */
-    address_zip_check: string | null;
-
-    /**
-     * Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
-     */
-    brand: string;
-
-    /**
-     * 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;
-
-    /**
-     * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-     */
-    currency?: string | null;
-
-    /**
-     * The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
-     */
-    customer?: string | null;
-
-    /**
-     * If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
-     */
-    cvc_check: string | null;
-
-    /**
-     * (For tokenized numbers only.) The last four digits of the device account number.
-     */
-    dynamic_last4: 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, for example.
-     */
-    fingerprint?: string | null;
-
-    /**
-     * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
-     */
-    funding: string;
-
-    /**
-     * The last four digits of the card.
-     */
-    last4: string;
-
-    /**
-     * 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;
-
-    /**
-     * Cardholder name.
-     */
-    name: string | null;
-
-    /**
-     * If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
-     */
-    tokenization_method: string | null;
-  }
-
-  namespace Card {
-    type AvailablePayoutMethod = 'instant' | 'standard';
-  }
-}