stripe 8.220.0 → 8.221.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 8.221.0 - 2022-05-05
+* [#1413](https://github.com/stripe/stripe-node/pull/1413) API Updates
+  * Add support for new resources `FinancialConnections.AccountOwner`, `FinancialConnections.AccountOwnership`, `FinancialConnections.Account`, and `FinancialConnections.Session`
+  * Add support for `financial_connections` on `Checkout.Session.payment_method_options.us_bank_account`, `CheckoutSessionCreateParams.payment_method_options.us_bank_account`, `Invoice.payment_settings.payment_method_options.us_bank_account`, `InvoiceCreateParams.payment_settings.payment_method_options.us_bank_account`, `InvoiceUpdateParams.payment_settings.payment_method_options.us_bank_account`, `PaymentIntent.payment_method_options.us_bank_account`, `PaymentIntentConfirmParams.payment_method_options.us_bank_account`, `PaymentIntentCreateParams.payment_method_options.us_bank_account`, `PaymentIntentUpdateParams.payment_method_options.us_bank_account`, `SetupIntent.payment_method_options.us_bank_account`, `SetupIntentConfirmParams.payment_method_options.us_bank_account`, `SetupIntentCreateParams.payment_method_options.us_bank_account`, `SetupIntentUpdateParams.payment_method_options.us_bank_account`, `Subscription.payment_settings.payment_method_options.us_bank_account`, `SubscriptionCreateParams.payment_settings.payment_method_options.us_bank_account`, and `SubscriptionUpdateParams.payment_settings.payment_method_options.us_bank_account`
+  * Add support for `financial_connections_account` on `PaymentIntentConfirmParams.payment_method_data.us_bank_account`, `PaymentIntentCreateParams.payment_method_data.us_bank_account`, `PaymentIntentUpdateParams.payment_method_data.us_bank_account`, `PaymentMethod.us_bank_account`, `PaymentMethodCreateParams.us_bank_account`, `SetupIntentConfirmParams.payment_method_data.us_bank_account`, `SetupIntentCreateParams.payment_method_data.us_bank_account`, and `SetupIntentUpdateParams.payment_method_data.us_bank_account`
+  
+* [#1410](https://github.com/stripe/stripe-node/pull/1410) API Updates
+  * Add support for `registered_address` on `AccountCreateParams.individual`, `AccountUpdateParams.individual`, `PersonCreateParams`, `PersonUpdateParams`, `Person`, `TokenCreateParams.account.individual`, and `TokenCreateParams.person`
+  * Change type of `PaymentIntent.amount_details.tip.amount` from `nullable(integer)` to `integer`
+  * Change `PaymentIntent.amount_details.tip.amount` to be optional
+  * Add support for `payment_method_data` on `SetupIntentConfirmParams`, `SetupIntentCreateParams`, and `SetupIntentUpdateParams`
+* [#1409](https://github.com/stripe/stripe-node/pull/1409) Update autoPagination tests to be hermetic.
+* [#1411](https://github.com/stripe/stripe-node/pull/1411) Enable CI on beta branch
+
 ## 8.220.0 - 2022-05-03
 * [#1407](https://github.com/stripe/stripe-node/pull/1407) API Updates
   * Add support for new resource `CashBalance`

package/VERSION

@@ -1 +1 @@
-8.220.0
+8.221.0

package/lib/resources/FinancialConnections/Accounts.js

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec
+
+'use strict';
+
+const StripeResource = require('../../StripeResource');
+const stripeMethod = StripeResource.method;
+
+module.exports = StripeResource.extend({
+  path: 'financial_connections/accounts',
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{account}',
+  }),
+
+  disconnect: stripeMethod({
+    method: 'POST',
+    path: '/{account}/disconnect',
+  }),
+
+  refresh: stripeMethod({
+    method: 'POST',
+    path: '/{account}/refresh',
+  }),
+});

package/lib/resources/FinancialConnections/Sessions.js

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec
+
+'use strict';
+
+const StripeResource = require('../../StripeResource');
+const stripeMethod = StripeResource.method;
+
+module.exports = StripeResource.extend({
+  path: 'financial_connections/sessions',
+
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{session}',
+  }),
+});

package/lib/resources.js

@@ -63,6 +63,10 @@ module.exports = {
   Checkout: resourceNamespace('checkout', {
     Sessions: require('./resources/Checkout/Sessions'),
   }),
+  FinancialConnections: resourceNamespace('financialConnections', {
+    Accounts: require('./resources/FinancialConnections/Accounts'),
+    Sessions: require('./resources/FinancialConnections/Sessions'),
+  }),
   Identity: resourceNamespace('identity', {
     VerificationReports: require('./resources/Identity/VerificationReports'),
     VerificationSessions: require('./resources/Identity/VerificationSessions'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "8.220.0",
+  "version": "8.221.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

package/types/2020-08-27/Accounts.d.ts

@@ -1899,6 +1899,11 @@ declare module 'stripe' {
          */
         political_exposure?: Individual.PoliticalExposure;
 
+        /**
+         * The individual's registered address.
+         */
+        registered_address?: Individual.RegisteredAddress;
+
         /**
          * The last four digits of the individual's Social Security Number (U.S. only).
          */
@@ -1934,6 +1939,10 @@ declare module 'stripe' {
 
         type PoliticalExposure = 'existing' | 'none';
 
+        interface RegisteredAddress extends Omit<Stripe.AddressParam, 'line1'> {
+          line1?: string;
+        }
+
         interface Verification {
           /**
            * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
@@ -2980,6 +2989,11 @@ declare module 'stripe' {
          */
         political_exposure?: Individual.PoliticalExposure;
 
+        /**
+         * The individual's registered address.
+         */
+        registered_address?: Individual.RegisteredAddress;
+
         /**
          * The last four digits of the individual's Social Security Number (U.S. only).
          */
@@ -3015,6 +3029,10 @@ declare module 'stripe' {
 
         type PoliticalExposure = 'existing' | 'none';
 
+        interface RegisteredAddress extends Omit<Stripe.AddressParam, 'line1'> {
+          line1?: string;
+        }
+
         interface Verification {
           /**
            * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

package/types/2020-08-27/Checkout/Sessions.d.ts

@@ -535,6 +535,8 @@ declare module 'stripe' {
           }
 
           interface UsBankAccount {
+            financial_connections?: UsBankAccount.FinancialConnections;
+
             /**
              * Bank account verification method.
              */
@@ -542,6 +544,26 @@ declare module 'stripe' {
           }
 
           namespace UsBankAccount {
+            interface FinancialConnections {
+              /**
+               * The list of permissions to request. The `payment_method` permission must be included.
+               */
+              permissions?: Array<FinancialConnections.Permission>;
+
+              /**
+               * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
+               */
+              return_url?: string;
+            }
+
+            namespace FinancialConnections {
+              type Permission =
+                | 'balances'
+                | 'ownership'
+                | 'payment_method'
+                | 'transactions';
+            }
+
             type VerificationMethod = 'automatic' | 'instant';
           }
         }
@@ -1658,6 +1680,11 @@ declare module 'stripe' {
           }
 
           interface UsBankAccount {
+            /**
+             * Additional fields for Financial Connections Session creation
+             */
+            financial_connections?: UsBankAccount.FinancialConnections;
+
             /**
              * Verification method for the intent
              */
@@ -1665,6 +1692,21 @@ declare module 'stripe' {
           }
 
           namespace UsBankAccount {
+            interface FinancialConnections {
+              /**
+               * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `payment_method`, and `transactions`.
+               */
+              permissions?: Array<FinancialConnections.Permission>;
+            }
+
+            namespace FinancialConnections {
+              type Permission =
+                | 'balances'
+                | 'ownership'
+                | 'payment_method'
+                | 'transactions';
+            }
+
             type VerificationMethod = 'automatic' | 'instant';
           }
 

package/types/2020-08-27/FinancialConnections/AccountOwners.d.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * The AccountOwner object.
+       */
+      interface AccountOwner {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.account_owner';
+
+        /**
+         * The email address of the owner.
+         */
+        email: string | null;
+
+        /**
+         * The full name of the owner.
+         */
+        name: string;
+
+        /**
+         * The ownership object that this owner belongs to.
+         */
+        ownership: string;
+
+        /**
+         * The raw phone number of the owner.
+         */
+        phone: string | null;
+
+        /**
+         * The raw physical address of the owner.
+         */
+        raw_address: string | null;
+
+        /**
+         * The timestamp of the refresh that updated this owner.
+         */
+        refreshed_at: number | null;
+      }
+    }
+  }
+}

package/types/2020-08-27/FinancialConnections/AccountOwnerships.d.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * The AccountOwnership object.
+       */
+      interface AccountOwnership {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.account_ownership';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * A paginated list of owners for this account.
+         */
+        owners: ApiList<Stripe.FinancialConnections.AccountOwner>;
+      }
+    }
+  }
+}

package/types/2020-08-27/FinancialConnections/Accounts.d.ts

@@ -0,0 +1,311 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * The Account object.
+       */
+      interface Account {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.account';
+
+        /**
+         * The account holder that this account belongs to.
+         */
+        account_holder: Account.AccountHolder | null;
+
+        /**
+         * The most recent information about the account's balance.
+         */
+        balance: Account.Balance | null;
+
+        /**
+         * The state of the most recent attempt to refresh the account balance.
+         */
+        balance_refresh: Account.BalanceRefresh | null;
+
+        /**
+         * The type of the account. Account category is further divided in `subcategory`.
+         */
+        category: Account.Category;
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * A human-readable name that has been assigned to this account, either by the account holder or by the institution.
+         */
+        display_name: string | null;
+
+        /**
+         * The name of the institution that holds this account.
+         */
+        institution_name: string;
+
+        /**
+         * The last 4 digits of the account number. If present, this will be 4 numeric characters.
+         */
+        last4: string | 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;
+
+        /**
+         * The most recent information about the account's owners.
+         */
+        ownership: string | Stripe.FinancialConnections.AccountOwnership | null;
+
+        /**
+         * The state of the most recent attempt to refresh the account owners.
+         */
+        ownership_refresh: Account.OwnershipRefresh | null;
+
+        /**
+         * The list of permissions granted by this account.
+         */
+        permissions: Array<Account.Permission> | null;
+
+        /**
+         * The status of the link to the account.
+         */
+        status: Account.Status;
+
+        /**
+         * If `category` is `cash`, one of:
+         *
+         *  - `checking`
+         *  - `savings`
+         *  - `other`
+         *
+         * If `category` is `credit`, one of:
+         *
+         *  - `mortgage`
+         *  - `line_of_credit`
+         *  - `credit_card`
+         *  - `other`
+         *
+         * If `category` is `investment` or `other`, this will be `other`.
+         */
+        subcategory: Account.Subcategory;
+
+        /**
+         * The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
+         */
+        supported_payment_method_types: Array<
+          Account.SupportedPaymentMethodType
+        >;
+      }
+
+      namespace Account {
+        interface AccountHolder {
+          /**
+           * The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
+           */
+          account?: string | Stripe.Account;
+
+          /**
+           * ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
+           */
+          customer?: string | Stripe.Customer;
+
+          /**
+           * Type of account holder that this account belongs to.
+           */
+          type: AccountHolder.Type;
+        }
+
+        namespace AccountHolder {
+          type Type = 'account' | 'customer';
+        }
+
+        interface Balance {
+          /**
+           * The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.
+           */
+          as_of: number;
+
+          cash?: Balance.Cash;
+
+          credit?: Balance.Credit;
+
+          /**
+           * The balances owed to (or by) the account holder.
+           *
+           * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+           *
+           * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+           */
+          current: {
+            [key: string]: number;
+          };
+
+          /**
+           * The `type` of the balance. An additional hash is included on the balance with a name matching this value.
+           */
+          type: Balance.Type;
+        }
+
+        namespace Balance {
+          interface Cash {
+            /**
+             * The funds available to the account holder. Typically this is the current balance less any holds.
+             *
+             * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+             *
+             * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+             */
+            available: {
+              [key: string]: number;
+            } | null;
+          }
+
+          interface Credit {
+            /**
+             * The credit that has been used by the account holder.
+             *
+             * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+             *
+             * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+             */
+            used: {
+              [key: string]: number;
+            } | null;
+          }
+
+          type Type = 'cash' | 'credit';
+        }
+
+        interface BalanceRefresh {
+          /**
+           * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
+           */
+          last_attempted_at: number;
+
+          /**
+           * The status of the last refresh attempt.
+           */
+          status: BalanceRefresh.Status;
+        }
+
+        namespace BalanceRefresh {
+          type Status = 'failed' | 'pending' | 'succeeded';
+        }
+
+        type Category = 'cash' | 'credit' | 'investment' | 'other';
+
+        interface OwnershipRefresh {
+          /**
+           * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
+           */
+          last_attempted_at: number;
+
+          /**
+           * The status of the last refresh attempt.
+           */
+          status: OwnershipRefresh.Status;
+        }
+
+        namespace OwnershipRefresh {
+          type Status = 'failed' | 'pending' | 'succeeded';
+        }
+
+        type Permission =
+          | 'balances'
+          | 'ownership'
+          | 'payment_method'
+          | 'transactions';
+
+        type Status = 'active' | 'disconnected' | 'inactive';
+
+        type Subcategory =
+          | 'checking'
+          | 'credit_card'
+          | 'line_of_credit'
+          | 'mortgage'
+          | 'other'
+          | 'savings';
+
+        type SupportedPaymentMethodType = 'link' | 'us_bank_account';
+      }
+
+      interface AccountRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AccountDisconnectParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AccountRefreshParams {
+        /**
+         * The list of account features that you would like to refresh. Either: `balance` or `ownership`.
+         */
+        features: Array<AccountRefreshParams.Feature>;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace AccountRefreshParams {
+        type Feature = 'balance' | 'ownership';
+      }
+
+      class AccountsResource {
+        /**
+         * Retrieves the details of an Financial Connections Account.
+         */
+        retrieve(
+          id: string,
+          params?: AccountRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
+
+        /**
+         * Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
+         */
+        disconnect(
+          id: string,
+          params?: AccountDisconnectParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
+        disconnect(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
+
+        /**
+         * Refreshes the data associated with a Financial Connections Account.
+         */
+        refresh(
+          id: string,
+          params: AccountRefreshParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
+      }
+    }
+  }
+}