stripe 8.183.0 → 8.186.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # CHANGELOG
 
+## 8.186.1 - 2021-11-04
+* [#1284](https://github.com/stripe/stripe-node/pull/1284) API Updates
+  * Remove support for `ownership_declaration_shown_and_signed` on `TokenCreateParams.account`. This API was unused.
+  * Add support for `ownership_declaration_shown_and_signed` on `TokenCreateParams.account.company`
+  
+
+## 8.186.0 - 2021-11-01
+* [#1283](https://github.com/stripe/stripe-node/pull/1283) API Updates
+  * Add support for `ownership_declaration` on `AccountUpdateParams.company`, `AccountCreateParams.company`, `Account.company`, and `TokenCreateParams.account.company`
+  * Add support for `proof_of_registration` on `AccountUpdateParams.documents` and `AccountCreateParams.documents`
+  * Add support for `ownership_declaration_shown_and_signed` on `TokenCreateParams.account`
+
+## 8.185.0 - 2021-11-01
+* [#1282](https://github.com/stripe/stripe-node/pull/1282) API Updates
+  * Change type of `AccountUpdateParams.individual.full_name_aliases`, `AccountCreateParams.individual.full_name_aliases`, `PersonCreateParams.full_name_aliases`, `PersonUpdateParams.full_name_aliases`, `TokenCreateParams.account.individual.full_name_aliases`, and `TokenCreateParams.person.full_name_aliases` from `array(string)` to `emptyStringable(array(string))`
+  * Add support for new values `en-BE`, `en-ES`, and `en-IT` on enums `PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale`, `PaymentIntentUpdateParams.payment_method_options.klarna.preferred_locale`, and `PaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale`
+
+## 8.184.0 - 2021-10-20
+* [#1276](https://github.com/stripe/stripe-node/pull/1276) API Updates
+  * Change `Account.controller.type` to be required
+  * Add support for `buyer_id` on `Charge.payment_method_details.alipay`
+* [#1273](https://github.com/stripe/stripe-node/pull/1273) Add typed createFetchHttpClient function.
+
 ## 8.183.0 - 2021-10-15
 * [#1272](https://github.com/stripe/stripe-node/pull/1272) API Updates
   * Change type of `UsageRecordCreateParams.timestamp` from `integer` to `literal('now') | integer`

package/VERSION

@@ -1 +1 @@
-8.183.0
+8.186.1

package/lib/stripe.js

@@ -142,6 +142,18 @@ Stripe.createNodeHttpClient = (agent) => {
   return new NodeHttpClient(agent);
 };
 
+/**
+ * Creates an HTTP client for issuing Stripe API requests which uses the Web
+ * Fetch API.
+ *
+ * A fetch function can optionally be passed in as a parameter. If none is
+ * passed, will default to the default `fetch` function in the global scope.
+ */
+Stripe.createFetchHttpClient = (fetchFn) => {
+  const {FetchHttpClient} = require('./net/FetchHttpClient');
+  return new FetchHttpClient(fetchFn);
+};
+
 Stripe.prototype = {
   /**
    * @deprecated will be removed in a future major version. Use the config object instead:

package/package.json

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

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

@@ -370,6 +370,11 @@ declare module 'stripe' {
          */
         owners_provided?: boolean;
 
+        /**
+         * This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
+         */
+        ownership_declaration?: Company.OwnershipDeclaration | null;
+
         /**
          * The company's phone number (used for verification).
          */
@@ -476,6 +481,23 @@ declare module 'stripe' {
           town: string | null;
         }
 
+        interface OwnershipDeclaration {
+          /**
+           * The Unix timestamp marking when the beneficial owner attestation was made.
+           */
+          date: number | null;
+
+          /**
+           * The IP address from which the beneficial owner attestation was made.
+           */
+          ip: string | null;
+
+          /**
+           * The user-agent string from the browser where the beneficial owner attestation was made.
+           */
+          user_agent: string | null;
+        }
+
         type Structure =
           | 'free_zone_establishment'
           | 'free_zone_llc'
@@ -536,7 +558,7 @@ declare module 'stripe' {
         /**
          * The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.
          */
-        type?: Controller.Type;
+        type: Controller.Type;
       }
 
       namespace Controller {
@@ -1478,6 +1500,11 @@ declare module 'stripe' {
          */
         owners_provided?: boolean;
 
+        /**
+         * This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
+         */
+        ownership_declaration?: Company.OwnershipDeclaration;
+
         /**
          * The company's phone number (used for verification).
          */
@@ -1519,6 +1546,23 @@ declare module 'stripe' {
           line1?: string;
         }
 
+        interface OwnershipDeclaration {
+          /**
+           * The Unix timestamp marking when the beneficial owner attestation was made.
+           */
+          date?: number;
+
+          /**
+           * The IP address from which the beneficial owner attestation was made.
+           */
+          ip?: string;
+
+          /**
+           * The user agent of the browser from which the beneficial owner attestation was made.
+           */
+          user_agent?: string;
+        }
+
         type Structure =
           | 'free_zone_establishment'
           | 'free_zone_llc'
@@ -1593,6 +1637,11 @@ declare module 'stripe' {
          * One or more documents that demonstrate proof of a company's tax ID.
          */
         company_tax_id_verification?: Documents.CompanyTaxIdVerification;
+
+        /**
+         * One or more documents showing the company's proof of registration with the national business registry.
+         */
+        proof_of_registration?: Documents.ProofOfRegistration;
       }
 
       namespace Documents {
@@ -1637,6 +1686,13 @@ declare module 'stripe' {
            */
           files?: Array<string>;
         }
+
+        interface ProofOfRegistration {
+          /**
+           * One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
+           */
+          files?: Array<string>;
+        }
       }
 
       interface ExternalAccount {
@@ -1720,7 +1776,7 @@ declare module 'stripe' {
         /**
          * A list of alternate names or aliases that the individual is known by.
          */
-        full_name_aliases?: Array<string>;
+        full_name_aliases?: Stripe.Emptyable<Array<string>>;
 
         /**
          * The individual's gender (International regulations require either "male" or "female").
@@ -2514,6 +2570,11 @@ declare module 'stripe' {
          */
         owners_provided?: boolean;
 
+        /**
+         * This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
+         */
+        ownership_declaration?: Company.OwnershipDeclaration;
+
         /**
          * The company's phone number (used for verification).
          */
@@ -2555,6 +2616,23 @@ declare module 'stripe' {
           line1?: string;
         }
 
+        interface OwnershipDeclaration {
+          /**
+           * The Unix timestamp marking when the beneficial owner attestation was made.
+           */
+          date?: number;
+
+          /**
+           * The IP address from which the beneficial owner attestation was made.
+           */
+          ip?: string;
+
+          /**
+           * The user agent of the browser from which the beneficial owner attestation was made.
+           */
+          user_agent?: string;
+        }
+
         type Structure =
           | 'free_zone_establishment'
           | 'free_zone_llc'
@@ -2629,6 +2707,11 @@ declare module 'stripe' {
          * One or more documents that demonstrate proof of a company's tax ID.
          */
         company_tax_id_verification?: Documents.CompanyTaxIdVerification;
+
+        /**
+         * One or more documents showing the company's proof of registration with the national business registry.
+         */
+        proof_of_registration?: Documents.ProofOfRegistration;
       }
 
       namespace Documents {
@@ -2673,6 +2756,13 @@ declare module 'stripe' {
            */
           files?: Array<string>;
         }
+
+        interface ProofOfRegistration {
+          /**
+           * One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
+           */
+          files?: Array<string>;
+        }
       }
 
       interface Individual {
@@ -2719,7 +2809,7 @@ declare module 'stripe' {
         /**
          * A list of alternate names or aliases that the individual is known by.
          */
-        full_name_aliases?: Array<string>;
+        full_name_aliases?: Stripe.Emptyable<Array<string>>;
 
         /**
          * The individual's gender (International regulations require either "male" or "female").

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

@@ -543,6 +543,11 @@ declare module 'stripe' {
         }
 
         interface Alipay {
+          /**
+           * Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
+           */
+          buyer_id?: string;
+
           /**
            * Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.
            */
@@ -648,7 +653,7 @@ declare module 'stripe' {
 
         interface Boleto {
           /**
-           * Uniquely identifies this customer tax_id (CNPJ or CPF)
+           * The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
            */
           tax_id: string;
         }
@@ -1413,7 +1418,7 @@ declare module 'stripe' {
 
           /**
            * Preferred language of the Klarna authorization page that the customer is redirected to.
-           * Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `it-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `fr-FR`, or `en-FR`
+           * Can be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `fr-FR`, or `en-FR`
            */
           preferred_locale: string | null;
         }

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

@@ -842,8 +842,8 @@ declare module 'stripe' {
         /**
          * The URL to which Stripe should send customers when payment or setup
          * is complete.
-         * If you'd like access to the Checkout Session for the successful
-         * payment, read more about it in the guide on [fulfilling orders](https://stripe.com/docs/payments/checkout/fulfill-orders).
+         * If you'd like to use information from the successful Checkout Session on your page,
+         * read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
          */
         success_url: string;
 
@@ -1158,7 +1158,7 @@ declare module 'stripe' {
             enabled: boolean;
 
             /**
-             * The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99.
+             * The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999.
              */
             maximum?: number;
 

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

@@ -1193,7 +1193,7 @@ declare module 'stripe' {
 
         interface Boleto {
           /**
-           * Uniquely identifies this customer tax_id (CNPJ or CPF)
+           * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
            */
           tax_id: string;
         }
@@ -1657,10 +1657,13 @@ declare module 'stripe' {
             | 'de-AT'
             | 'de-DE'
             | 'en-AT'
+            | 'en-BE'
             | 'en-DE'
             | 'en-DK'
+            | 'en-ES'
             | 'en-FI'
             | 'en-GB'
+            | 'en-IT'
             | 'en-NL'
             | 'en-NO'
             | 'en-SE'
@@ -2102,7 +2105,7 @@ declare module 'stripe' {
 
         interface Boleto {
           /**
-           * Uniquely identifies this customer tax_id (CNPJ or CPF)
+           * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
            */
           tax_id: string;
         }
@@ -2566,10 +2569,13 @@ declare module 'stripe' {
             | 'de-AT'
             | 'de-DE'
             | 'en-AT'
+            | 'en-BE'
             | 'en-DE'
             | 'en-DK'
+            | 'en-ES'
             | 'en-FI'
             | 'en-GB'
+            | 'en-IT'
             | 'en-NL'
             | 'en-NO'
             | 'en-SE'
@@ -3125,7 +3131,7 @@ declare module 'stripe' {
 
         interface Boleto {
           /**
-           * Uniquely identifies this customer tax_id (CNPJ or CPF)
+           * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
            */
           tax_id: string;
         }
@@ -3589,10 +3595,13 @@ declare module 'stripe' {
             | 'de-AT'
             | 'de-DE'
             | 'en-AT'
+            | 'en-BE'
             | 'en-DE'
             | 'en-DK'
+            | 'en-ES'
             | 'en-FI'
             | 'en-GB'
+            | 'en-IT'
             | 'en-NL'
             | 'en-NO'
             | 'en-SE'

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

@@ -862,7 +862,7 @@ declare module 'stripe' {
 
       interface Boleto {
         /**
-         * Uniquely identifies this customer tax_id (CNPJ or CPF)
+         * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
          */
         tax_id: string;
       }
@@ -1301,7 +1301,7 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.PaymentMethod>>;
 
       /**
-       * Returns a list of PaymentMethods for a given Customer
+       * Returns a list of PaymentMethods. For listing a customer's payment methods, you should use [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list)
        */
       list(
         params: PaymentMethodListParams,

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

@@ -632,7 +632,7 @@ declare module 'stripe' {
       /**
        * A list of alternate names or aliases that the person is known by.
        */
-      full_name_aliases?: Array<string>;
+      full_name_aliases?: Stripe.Emptyable<Array<string>>;
 
       /**
        * The person's gender (International regulations require either "male" or "female").
@@ -899,7 +899,7 @@ declare module 'stripe' {
       /**
        * A list of alternate names or aliases that the person is known by.
        */
-      full_name_aliases?: Array<string>;
+      full_name_aliases?: Stripe.Emptyable<Array<string>>;
 
       /**
        * The person's gender (International regulations require either "male" or "female").

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

@@ -44,7 +44,7 @@ declare module 'stripe' {
       livemode: boolean;
 
       /**
-       * A lookup key used to retrieve prices dynamically from a static string.
+       * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
        */
       lookup_key: string | null;
 
@@ -238,7 +238,7 @@ declare module 'stripe' {
       expand?: Array<string>;
 
       /**
-       * A lookup key used to retrieve prices dynamically from a static string.
+       * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
        */
       lookup_key?: string;
 
@@ -451,7 +451,7 @@ declare module 'stripe' {
       expand?: Array<string>;
 
       /**
-       * A lookup key used to retrieve prices dynamically from a static string.
+       * A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
        */
       lookup_key?: string;
 

package/types/2020-08-27/Terminal/ConnectionTokens.d.ts

@@ -13,7 +13,7 @@ declare module 'stripe' {
         object: 'terminal.connection_token';
 
         /**
-         * The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/readers/fleet-management#connection-tokens).
+         * The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens).
          */
         location?: string;
 
@@ -30,7 +30,7 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/readers/fleet-management#connection-tokens).
+         * The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://stripe.com/docs/terminal/fleet/locations#connection-tokens).
          */
         location?: string;
       }

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

@@ -177,6 +177,16 @@ declare module 'stripe' {
            */
           owners_provided?: boolean;
 
+          /**
+           * This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
+           */
+          ownership_declaration?: Company.OwnershipDeclaration;
+
+          /**
+           * Whether the user described by the data in the token has been shown the Ownership Declaration and indicated that it is correct.
+           */
+          ownership_declaration_shown_and_signed?: boolean;
+
           /**
            * The company's phone number (used for verification).
            */
@@ -218,6 +228,23 @@ declare module 'stripe' {
             line1?: string;
           }
 
+          interface OwnershipDeclaration {
+            /**
+             * The Unix timestamp marking when the beneficial owner attestation was made.
+             */
+            date?: number;
+
+            /**
+             * The IP address from which the beneficial owner attestation was made.
+             */
+            ip?: string;
+
+            /**
+             * The user agent of the browser from which the beneficial owner attestation was made.
+             */
+            user_agent?: string;
+          }
+
           type Structure =
             | 'free_zone_establishment'
             | 'free_zone_llc'
@@ -306,7 +333,7 @@ declare module 'stripe' {
           /**
            * A list of alternate names or aliases that the individual is known by.
            */
-          full_name_aliases?: Array<string>;
+          full_name_aliases?: Stripe.Emptyable<Array<string>>;
 
           /**
            * The individual's gender (International regulations require either "male" or "female").
@@ -553,7 +580,7 @@ declare module 'stripe' {
         /**
          * A list of alternate names or aliases that the person is known by.
          */
-        full_name_aliases?: Array<string>;
+        full_name_aliases?: Stripe.Emptyable<Array<string>>;
 
         /**
          * The person's gender (International regulations require either "male" or "female").

package/types/net/net.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference lib="dom" />
 
 import {IncomingMessage} from 'http';
 declare module 'stripe' {
@@ -61,5 +62,21 @@ declare module 'stripe' {
     ) => HttpClient<
       HttpClientResponse<IncomingMessage, Stripe.StripeStreamResponse>
     >;
+
+    /**
+     * Creates an HTTP client for issuing Stripe API requests which uses the Web
+     * Fetch API.
+     *
+     * A fetch function can optionally be passed in as a parameter. If none is
+     * passed, will default to the default `fetch` function in the global scope.
+     */
+    export const createFetchHttpClient: (
+      fetchFn?: WindowOrWorkerGlobalScope['fetch']
+    ) => HttpClient<
+      HttpClientResponse<
+        ReturnType<WindowOrWorkerGlobalScope['fetch']>,
+        ReadableStream<Uint8Array>
+      >
+    >;
   }
 }

package/types/test/typescriptTest.ts

@@ -222,3 +222,30 @@ async (): Promise<void> => {
 
   const jsonResponse: object = await response.toJSON();
 };
+
+// Test FetchHttpClient request processing.
+async (): Promise<void> => {
+  const client = Stripe.createFetchHttpClient(window.fetch);
+
+  const response = await client.makeRequest(
+    'api.stripe.com',
+    '443',
+    '/test',
+    'POST',
+    {
+      'Stripe-Account': 'account',
+      'Content-Length': 123,
+    },
+    'requestdata',
+    'https',
+    80000
+  );
+
+  const stream: ReadableStream = response.toStream(() => {
+    return;
+  });
+
+  const results = await stream.getReader().read();
+
+  const jsonResponse: object = await response.toJSON();
+};