stripe 8.203.0 → 8.206.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # CHANGELOG
 
+## 8.206.0 - 2022-03-01
+* [#1361](https://github.com/stripe/stripe-node/pull/1361) [#1362](https://github.com/stripe/stripe-node/pull/1362) API Updates
+  * Add support for new resource `TestHelpers.TestClock`
+  * Add support for `test_clock` on `CustomerCreateParams`, `Customer`, `Invoice`, `InvoiceItem`, `QuoteCreateParams`, `Quote`, `Subscription`, and `SubscriptionSchedule`
+  * Add support for `pending_invoice_items_behavior` on `InvoiceCreateParams`
+  * Change type of `ProductUpdateParams.url` from `string` to `emptyStringable(string)`
+  * Add support for `next_action` on `Refund`
+
+## 8.205.0 - 2022-02-25
+* [#1098](https://github.com/stripe/stripe-node/pull/1098) Typescript: add declaration for `onDone` on `autoPagingEach`
+* [#1357](https://github.com/stripe/stripe-node/pull/1357) Properly handle API errors with unknown error types
+* [#1359](https://github.com/stripe/stripe-node/pull/1359) API Updates
+  * Change `BillingPortalConfiguration` `.business_profile.privacy_policy_url` and `.business_profile.terms_of_service_url` to be optional on requests and responses
+
+  * Add support for `konbini_payments` on `AccountUpdateParams.capabilities`, `AccountCreateParams.capabilities`, and `Account.capabilities`
+  * Add support for `konbini` on `Charge.payment_method_details`, 
+  * Add support for `.payment_method_options.konbini` and `.payment_method_data.konbini` on the `PaymentIntent` API.
+  * Add support for `.payment_settings.payment_method_options.konbini` on the `Invoice` API.
+  * Add support for `.payment_method_options.konbini` on the `Subscription` API
+  * Add support for `.payment_method_options.konbini` on the `CheckoutSession` API
+  * Add support for `konbini` on the `PaymentMethod` API. 
+  * Add support for `konbini_display_details` on `PaymentIntent.next_action`
+* [#1311](https://github.com/stripe/stripe-node/pull/1311) update documentation to use appInfo
+
+## 8.204.0 - 2022-02-23
+* [#1354](https://github.com/stripe/stripe-node/pull/1354) API Updates
+  * Add support for `setup_future_usage` on `PaymentIntentCreateParams.payment_method_options.*`
+  * Add support for new values `bbpos_wisepad3` and `stripe_m2` on enums `TerminalReaderListParams.device_type` and `Terminal.Reader.device_type`
+  * Add support for `object` on `ExternalAccountListParams` (fixes #1351)
+
 ## 8.203.0 - 2022-02-15
 * [#1350](https://github.com/stripe/stripe-node/pull/1350) API Updates
   * Add support for `verify_microdeposits` method on resources `PaymentIntent` and `SetupIntent`

package/README.md

@@ -367,13 +367,27 @@ expect(event.id).to.equal(payload.id);
 
 ### Writing a Plugin
 
-If you're writing a plugin that uses the library, we'd appreciate it if you identified using `stripe.setAppInfo()`:
+If you're writing a plugin that uses the library, we'd appreciate it if you instantiated your stripe client with `appInfo`, eg;
 
 ```js
-stripe.setAppInfo({
-  name: 'MyAwesomePlugin',
-  version: '1.2.34', // Optional
-  url: 'https://myawesomeplugin.info', // Optional
+const stripe = require('stripe')('sk_test_...', {
+  appInfo: {
+    name: 'MyAwesomePlugin',
+    version: '1.2.34', // Optional
+    url: 'https://myawesomeplugin.info', // Optional
+  }
+});
+```
+
+Or using ES modules or TypeScript:
+
+```js
+const stripe = new Stripe(apiKey, {
+  appInfo: {
+    name: 'MyAwesomePlugin',
+    version: '1.2.34', // Optional
+    url: 'https://myawesomeplugin.info', // Optional
+  }
 });
 ```
 

package/VERSION

@@ -1 +1 @@
-8.203.0
+8.206.0

package/lib/Error.js

@@ -49,7 +49,7 @@ class StripeError extends Error {
       case 'invalid_grant':
         return new StripeInvalidGrantError(rawStripeError);
       default:
-        return new GenericError('Generic', 'Unknown Error');
+        return new StripeUnknownError(rawStripeError);
     }
   }
 }
@@ -122,6 +122,11 @@ class StripeIdempotencyError extends StripeError {}
  */
 class StripeInvalidGrantError extends StripeError {}
 
+/**
+ * Any other error from Stripe not specifically captured above
+ */
+class StripeUnknownError extends StripeError {}
+
 module.exports.generate = StripeError.generate;
 module.exports.StripeError = StripeError;
 module.exports.StripeCardError = StripeCardError;
@@ -134,3 +139,4 @@ module.exports.StripeConnectionError = StripeConnectionError;
 module.exports.StripeSignatureVerificationError = StripeSignatureVerificationError;
 module.exports.StripeIdempotencyError = StripeIdempotencyError;
 module.exports.StripeInvalidGrantError = StripeInvalidGrantError;
+module.exports.StripeUnknownError = StripeUnknownError;

package/lib/resources/TestHelpers/TestClocks.js

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec
+
+'use strict';
+
+const StripeResource = require('../../StripeResource');
+const stripeMethod = StripeResource.method;
+
+module.exports = StripeResource.extend({
+  path: 'test_helpers/test_clocks',
+
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{testClock}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
+
+  del: stripeMethod({
+    method: 'DELETE',
+    path: '/{testClock}',
+  }),
+
+  advance: stripeMethod({
+    method: 'POST',
+    path: '/{testClock}/advance',
+  }),
+});

package/lib/resources.js

@@ -91,4 +91,7 @@ module.exports = {
     Locations: require('./resources/Terminal/Locations'),
     Readers: require('./resources/Terminal/Readers'),
   }),
+  TestHelpers: resourceNamespace('testHelpers', {
+    TestClocks: require('./resources/TestHelpers/TestClocks'),
+  }),
 };

package/package.json

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

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

@@ -236,6 +236,11 @@ declare module 'stripe' {
          */
         klarna_payments?: Capabilities.KlarnaPayments;
 
+        /**
+         * The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
+         */
+        konbini_payments?: Capabilities.KonbiniPayments;
+
         /**
          * The status of the legacy payments capability of the account.
          */
@@ -310,6 +315,8 @@ declare module 'stripe' {
 
         type KlarnaPayments = 'active' | 'inactive' | 'pending';
 
+        type KonbiniPayments = 'active' | 'inactive' | 'pending';
+
         type LegacyPayments = 'active' | 'inactive' | 'pending';
 
         type OxxoPayments = 'active' | 'inactive' | 'pending';
@@ -1243,6 +1250,11 @@ declare module 'stripe' {
          */
         klarna_payments?: Capabilities.KlarnaPayments;
 
+        /**
+         * The konbini_payments capability.
+         */
+        konbini_payments?: Capabilities.KonbiniPayments;
+
         /**
          * The legacy_payments capability.
          */
@@ -1397,6 +1409,13 @@ declare module 'stripe' {
           requested?: boolean;
         }
 
+        interface KonbiniPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
         interface LegacyPayments {
           /**
            * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -2313,6 +2332,11 @@ declare module 'stripe' {
          */
         klarna_payments?: Capabilities.KlarnaPayments;
 
+        /**
+         * The konbini_payments capability.
+         */
+        konbini_payments?: Capabilities.KonbiniPayments;
+
         /**
          * The legacy_payments capability.
          */
@@ -2467,6 +2491,13 @@ declare module 'stripe' {
           requested?: boolean;
         }
 
+        interface KonbiniPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
         interface LegacyPayments {
           /**
            * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.

package/types/2020-08-27/BillingPortal/Configurations.d.ts

@@ -72,12 +72,12 @@ declare module 'stripe' {
           /**
            * A link to the business's publicly available privacy policy.
            */
-          privacy_policy_url: string;
+          privacy_policy_url: string | null;
 
           /**
            * A link to the business's publicly available terms of service.
            */
-          terms_of_service_url: string;
+          terms_of_service_url: string | null;
         }
 
         interface Features {
@@ -273,12 +273,12 @@ declare module 'stripe' {
           /**
            * A link to the business's publicly available privacy policy.
            */
-          privacy_policy_url: string;
+          privacy_policy_url?: string;
 
           /**
            * A link to the business's publicly available terms of service.
            */
-          terms_of_service_url: string;
+          terms_of_service_url?: string;
         }
 
         interface Features {
@@ -509,12 +509,12 @@ declare module 'stripe' {
           /**
            * A link to the business's publicly available privacy policy.
            */
-          privacy_policy_url?: string;
+          privacy_policy_url?: Stripe.Emptyable<string>;
 
           /**
            * A link to the business's publicly available terms of service.
            */
-          terms_of_service_url?: string;
+          terms_of_service_url?: Stripe.Emptyable<string>;
         }
 
         interface Features {

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

@@ -418,6 +418,8 @@ declare module 'stripe' {
 
         klarna?: PaymentMethodDetails.Klarna;
 
+        konbini?: PaymentMethodDetails.Konbini;
+
         multibanco?: PaymentMethodDetails.Multibanco;
 
         oxxo?: PaymentMethodDetails.Oxxo;
@@ -1424,6 +1426,26 @@ declare module 'stripe' {
           preferred_locale: string | null;
         }
 
+        interface Konbini {
+          /**
+           * If the payment succeeded, this contains the details of the convenience store where the payment was completed.
+           */
+          store: Konbini.Store | null;
+        }
+
+        namespace Konbini {
+          interface Store {
+            /**
+             * The name of the convenience store chain where the payment was completed.
+             */
+            chain: Store.Chain | null;
+          }
+
+          namespace Store {
+            type Chain = 'familymart' | 'lawson' | 'ministop' | 'seicomart';
+          }
+        }
+
         interface Multibanco {
           /**
            * Entity number associated with this Multibanco payment.

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

@@ -437,6 +437,8 @@ declare module 'stripe' {
 
           boleto?: PaymentMethodOptions.Boleto;
 
+          konbini?: PaymentMethodOptions.Konbini;
+
           oxxo?: PaymentMethodOptions.Oxxo;
         }
 
@@ -498,6 +500,13 @@ declare module 'stripe' {
             expires_after_days: number;
           }
 
+          interface Konbini {
+            /**
+             * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
+             */
+            expires_after_days: number | null;
+          }
+
           interface Oxxo {
             /**
              * The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
@@ -1172,9 +1181,7 @@ declare module 'stripe' {
           currency?: string;
 
           /**
-           * The description for the line item, to be displayed on the Checkout page.
-           *
-           * If using `price` or `price_data`, will default to the name of the associated product.
+           * [Deprecated] The description for the line item, to be displayed on the Checkout page.
            */
           description?: string;
 
@@ -1508,13 +1515,18 @@ declare module 'stripe' {
            */
           boleto?: PaymentMethodOptions.Boleto;
 
+          /**
+           * contains details about the Konbini payment method options.
+           */
+          konbini?: PaymentMethodOptions.Konbini;
+
           /**
            * contains details about the OXXO payment method options.
            */
           oxxo?: PaymentMethodOptions.Oxxo;
 
           /**
-           * contains details about the Wechat Pay payment method options.
+           * contains details about the WeChat Pay payment method options.
            */
           wechat_pay?: PaymentMethodOptions.WechatPay;
         }
@@ -1587,6 +1599,13 @@ declare module 'stripe' {
             expires_after_days?: number;
           }
 
+          interface Konbini {
+            /**
+             * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
+             */
+            expires_after_days?: Stripe.Emptyable<number>;
+          }
+
           interface Oxxo {
             /**
              * The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
@@ -1626,6 +1645,7 @@ declare module 'stripe' {
           | 'grabpay'
           | 'ideal'
           | 'klarna'
+          | 'konbini'
           | 'oxxo'
           | 'p24'
           | 'sepa_debit'

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

@@ -130,6 +130,11 @@ declare module 'stripe' {
        * The customer's tax IDs.
        */
       tax_ids?: ApiList<Stripe.TaxId>;
+
+      /**
+       * ID of the test clock this customer belongs to.
+       */
+      test_clock?: string | Stripe.TestHelpers.TestClock | null;
     }
 
     namespace Customer {
@@ -352,6 +357,11 @@ declare module 'stripe' {
        * The customer's tax IDs.
        */
       tax_id_data?: Array<CustomerCreateParams.TaxIdDatum>;
+
+      /**
+       * ID of the test clock to attach to the customer.
+       */
+      test_clock?: string;
     }
 
     namespace CustomerCreateParams {
@@ -696,6 +706,7 @@ declare module 'stripe' {
         | 'grabpay'
         | 'ideal'
         | 'klarna'
+        | 'konbini'
         | 'oxxo'
         | 'p24'
         | 'sepa_debit'

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

@@ -121,6 +121,12 @@ declare module 'stripe' {
        * Specifies which fields in the response should be expanded.
        */
       expand?: Array<string>;
+
+      object?: ExternalAccountListParams.Object;
+    }
+
+    namespace ExternalAccountListParams {
+      type Object = 'bank_account' | 'card';
     }
 
     interface ExternalAccountDeleteParams {}

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

@@ -105,6 +105,11 @@ declare module 'stripe' {
        */
       tax_rates: Array<Stripe.TaxRate> | null;
 
+      /**
+       * ID of the test clock this invoice item belongs to.
+       */
+      test_clock?: string | Stripe.TestHelpers.TestClock | null;
+
       /**
        * Unit amount (in the `currency` specified) of the invoice item.
        */

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

@@ -318,6 +318,11 @@ declare module 'stripe' {
        */
       tax: number | null;
 
+      /**
+       * ID of the test clock this invoice belongs to.
+       */
+      test_clock?: string | Stripe.TestHelpers.TestClock | null;
+
       threshold_reason?: Invoice.ThresholdReason;
 
       /**
@@ -603,6 +608,11 @@ declare module 'stripe' {
            * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
            */
           card: PaymentMethodOptions.Card | null;
+
+          /**
+           * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
+           */
+          konbini: PaymentMethodOptions.Konbini | null;
         }
 
         namespace PaymentMethodOptions {
@@ -651,6 +661,8 @@ declare module 'stripe' {
           namespace Card {
             type RequestThreeDSecure = 'any' | 'automatic';
           }
+
+          interface Konbini {}
         }
 
         type PaymentMethodType =
@@ -666,6 +678,7 @@ declare module 'stripe' {
           | 'giropay'
           | 'grabpay'
           | 'ideal'
+          | 'konbini'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
@@ -886,6 +899,11 @@ declare module 'stripe' {
        */
       payment_settings?: InvoiceCreateParams.PaymentSettings;
 
+      /**
+       * How to handle pending invoice items on invoice creation. One of `include`, `include_and_require`, or `exclude`. `include` will include any pending invoice items, and will create an empty draft invoice if no pending invoice items exist. `include_and_require` will include any pending invoice items, if no pending invoice items exist then the request will fail. `exclude` will always create an empty invoice draft regardless if there are pending invoice items or not. Defaults to `include_and_require` if the parameter is omitted.
+       */
+      pending_invoice_items_behavior?: InvoiceCreateParams.PendingInvoiceItemsBehavior;
+
       /**
        * Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.
        */
@@ -966,6 +984,11 @@ declare module 'stripe' {
            * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
            */
           card?: Stripe.Emptyable<PaymentMethodOptions.Card>;
+
+          /**
+           * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
+           */
+          konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
         }
 
         namespace PaymentMethodOptions {
@@ -1017,6 +1040,8 @@ declare module 'stripe' {
           namespace Card {
             type RequestThreeDSecure = 'any' | 'automatic';
           }
+
+          interface Konbini {}
         }
 
         type PaymentMethodType =
@@ -1032,12 +1057,18 @@ declare module 'stripe' {
           | 'giropay'
           | 'grabpay'
           | 'ideal'
+          | 'konbini'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
           | 'wechat_pay';
       }
 
+      type PendingInvoiceItemsBehavior =
+        | 'exclude'
+        | 'include'
+        | 'include_and_require';
+
       interface TransferData {
         /**
          * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
@@ -1224,6 +1255,11 @@ declare module 'stripe' {
            * If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
            */
           card?: Stripe.Emptyable<PaymentMethodOptions.Card>;
+
+          /**
+           * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
+           */
+          konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
         }
 
         namespace PaymentMethodOptions {
@@ -1275,6 +1311,8 @@ declare module 'stripe' {
           namespace Card {
             type RequestThreeDSecure = 'any' | 'automatic';
           }
+
+          interface Konbini {}
         }
 
         type PaymentMethodType =
@@ -1290,6 +1328,7 @@ declare module 'stripe' {
           | 'giropay'
           | 'grabpay'
           | 'ideal'
+          | 'konbini'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'