Merge branch 'master' into sdk-release/next-major

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 12.17.0 - 2023-08-03
+* [#1863](https://github.com/stripe/stripe-node/pull/1863) Update generated code
+  * Change type of `AccountCreateParams.settings.card_issuing.tos_acceptance.user_agent`, `AccountCreateParams.settings.treasury.tos_acceptance.user_agent`, `AccountUpdateParams.settings.card_issuing.tos_acceptance.user_agent`, `AccountUpdateParams.settings.treasury.tos_acceptance.user_agent`, `BillingPortal.ConfigurationCreateParams.business_profile.headline`, `BillingPortal.ConfigurationUpdateParams.business_profile.headline`, `InvoiceCreateParams.payment_settings.default_mandate`, `InvoiceCreateParams.shipping_details.phone`, `InvoicePayParams.mandate`, `InvoiceUpdateParams.default_source`, `InvoiceUpdateParams.payment_settings.default_mandate`, `InvoiceUpdateParams.shipping_details.phone`, `Issuing.CardholderCreateParams.individual.card_issuing.user_terms_acceptance.user_agent`, `Issuing.CardholderUpdateParams.individual.card_issuing.user_terms_acceptance.user_agent`, `Issuing.DisputeCreateParams.evidence.canceled.cancellation_reason`, `Issuing.DisputeCreateParams.evidence.canceled.explanation`, `Issuing.DisputeCreateParams.evidence.canceled.product_description`, `Issuing.DisputeCreateParams.evidence.duplicate.explanation`, `Issuing.DisputeCreateParams.evidence.fraudulent.explanation`, `Issuing.DisputeCreateParams.evidence.merchandise_not_as_described.explanation`, `Issuing.DisputeCreateParams.evidence.merchandise_not_as_described.return_description`, `Issuing.DisputeCreateParams.evidence.not_received.explanation`, `Issuing.DisputeCreateParams.evidence.not_received.product_description`, `Issuing.DisputeCreateParams.evidence.other.explanation`, `Issuing.DisputeCreateParams.evidence.other.product_description`, `Issuing.DisputeCreateParams.evidence.service_not_as_described.cancellation_reason`, `Issuing.DisputeCreateParams.evidence.service_not_as_described.explanation`, `Issuing.DisputeUpdateParams.evidence.canceled.cancellation_reason`, `Issuing.DisputeUpdateParams.evidence.canceled.explanation`, `Issuing.DisputeUpdateParams.evidence.canceled.product_description`, `Issuing.DisputeUpdateParams.evidence.duplicate.explanation`, `Issuing.DisputeUpdateParams.evidence.fraudulent.explanation`, `Issuing.DisputeUpdateParams.evidence.merchandise_not_as_described.explanation`, `Issuing.DisputeUpdateParams.evidence.merchandise_not_as_described.return_description`, `Issuing.DisputeUpdateParams.evidence.not_received.explanation`, `Issuing.DisputeUpdateParams.evidence.not_received.product_description`, `Issuing.DisputeUpdateParams.evidence.other.explanation`, `Issuing.DisputeUpdateParams.evidence.other.product_description`, `Issuing.DisputeUpdateParams.evidence.service_not_as_described.cancellation_reason`, `Issuing.DisputeUpdateParams.evidence.service_not_as_described.explanation`, `PaymentIntentConfirmParams.payment_method_data.billing_details.name`, `PaymentIntentConfirmParams.payment_method_data.billing_details.phone`, `PaymentIntentConfirmParams.payment_method_options.konbini.confirmation_number`, `PaymentIntentConfirmParams.payment_method_options.konbini.product_description`, `PaymentIntentCreateParams.payment_method_data.billing_details.name`, `PaymentIntentCreateParams.payment_method_data.billing_details.phone`, `PaymentIntentCreateParams.payment_method_options.konbini.confirmation_number`, `PaymentIntentCreateParams.payment_method_options.konbini.product_description`, `PaymentIntentUpdateParams.payment_method_data.billing_details.name`, `PaymentIntentUpdateParams.payment_method_data.billing_details.phone`, `PaymentIntentUpdateParams.payment_method_options.konbini.confirmation_number`, `PaymentIntentUpdateParams.payment_method_options.konbini.product_description`, `PaymentMethodCreateParams.billing_details.name`, `PaymentMethodCreateParams.billing_details.phone`, `PaymentMethodUpdateParams.billing_details.name`, `PaymentMethodUpdateParams.billing_details.phone`, `ProductUpdateParams.caption`, `ProductUpdateParams.description`, `ProductUpdateParams.unit_label`, `QuoteCreateParams.description`, `QuoteCreateParams.footer`, `QuoteCreateParams.header`, `QuoteUpdateParams.description`, `QuoteUpdateParams.footer`, `QuoteUpdateParams.header`, `QuoteUpdateParams.subscription_data.description`, `SetupIntentConfirmParams.payment_method_data.billing_details.name`, `SetupIntentConfirmParams.payment_method_data.billing_details.phone`, `SetupIntentCreateParams.payment_method_data.billing_details.name`, `SetupIntentCreateParams.payment_method_data.billing_details.phone`, `SetupIntentUpdateParams.payment_method_data.billing_details.name`, `SetupIntentUpdateParams.payment_method_data.billing_details.phone`, `SubscriptionCancelParams.cancellation_details.comment`, `SubscriptionScheduleCreateParams.default_settings.description`, `SubscriptionScheduleCreateParams.phases[].description`, `SubscriptionScheduleUpdateParams.default_settings.description`, `SubscriptionScheduleUpdateParams.phases[].description`, `SubscriptionUpdateParams.cancellation_details.comment`, `SubscriptionUpdateParams.default_source`, `SubscriptionUpdateParams.description`, `Tax.CalculationCreateParams.customer_details.address.city`, `Tax.CalculationCreateParams.customer_details.address.line1`, `Tax.CalculationCreateParams.customer_details.address.line2`, `Tax.CalculationCreateParams.customer_details.address.postal_code`, `Tax.CalculationCreateParams.customer_details.address.state`, `Terminal.LocationUpdateParams.configuration_overrides`, `Terminal.ReaderUpdateParams.label`, `TokenCreateParams.person.documents.company_authorization.files[]`, `TokenCreateParams.person.documents.passport.files[]`, `TokenCreateParams.person.documents.visa.files[]`, `Treasury.OutboundPaymentCreateParams.destination_payment_method_data.billing_details.name`, `Treasury.OutboundPaymentCreateParams.destination_payment_method_data.billing_details.phone`, `WebhookEndpointCreateParams.description`, and `WebhookEndpointUpdateParams.description` from `string` to `emptyStringable(string)`
+  * Add support for `subscription_details` on `Invoice`
+  * Add support for `preferred_settlement_speed` on `PaymentIntent.payment_method_options.us_bank_account`, `PaymentIntentConfirmParams.payment_method_options.us_bank_account`, `PaymentIntentCreateParams.payment_method_options.us_bank_account`, and `PaymentIntentUpdateParams.payment_method_options.us_bank_account`
+  * Add support for new values `sepa_debit_fingerprint` and `us_bank_account_fingerprint` on enums `Radar.ValueList.item_type` and `Radar.ValueListCreateParams.item_type`
+* [#1866](https://github.com/stripe/stripe-node/pull/1866) Allow monkey patching http / https
+
 ## 12.16.0 - 2023-07-27
 * [#1853](https://github.com/stripe/stripe-node/pull/1853) Update generated code
   * Add support for `monthly_estimated_revenue` on `Account.business_profile`, `AccountCreateParams.business_profile`, and `AccountUpdateParams.business_profile`

OPENAPI_VERSION

@@ -1 +1 @@
-v433
+v446

VERSION

@@ -1 +1 @@
-12.16.0
+12.17.0

package.json

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

src/net/NodeHttpClient.ts

@@ -1,12 +1,22 @@
-import * as http from 'http';
-import * as https from 'https';
+import * as http_ from 'http';
+import * as https_ from 'https';
 import {RequestHeaders, RequestData} from '../Types.js';
 import {
   HttpClient,
   HttpClientResponse,
   HttpClientResponseInterface,
 } from './HttpClient.js';
 
+// `import * as http_ from 'http'` creates a "Module Namespace Exotic Object"
+// which is immune to monkey-patching, whereas http_.default (in an ES Module context)
+// will resolve to the same thing as require('http'), which is
+// monkey-patchable. We care about this because users in their test
+// suites might be using a library like "nock" which relies on the ability
+// to monkey-patch and intercept calls to http.request.
+const http = ((http_ as unknown) as {default: typeof http_}).default || http_;
+const https =
+  ((https_ as unknown) as {default: typeof https_}).default || https_;
+
 const defaultHttpAgent = new http.Agent({keepAlive: true});
 const defaultHttpsAgent = new https.Agent({keepAlive: true});
 
@@ -15,9 +25,9 @@ const defaultHttpsAgent = new https.Agent({keepAlive: true});
  * requests.`
  */
 export class NodeHttpClient extends HttpClient {
-  _agent?: http.Agent | https.Agent | undefined;
+  _agent?: http_.Agent | https_.Agent | undefined;
 
-  constructor(agent?: http.Agent | https.Agent) {
+  constructor(agent?: http_.Agent | https_.Agent) {
     super();
     this._agent = agent;
   }
@@ -93,19 +103,19 @@ export class NodeHttpClient extends HttpClient {
 
 export class NodeHttpClientResponse extends HttpClientResponse
   implements HttpClientResponseInterface {
-  _res: http.IncomingMessage;
+  _res: http_.IncomingMessage;
 
-  constructor(res: http.IncomingMessage) {
+  constructor(res: http_.IncomingMessage) {
     // @ts-ignore
     super(res.statusCode, res.headers || {});
     this._res = res;
   }
 
-  getRawResponse(): http.IncomingMessage {
+  getRawResponse(): http_.IncomingMessage {
     return this._res;
   }
 
-  toStream(streamCompleteCallback: () => void): http.IncomingMessage {
+  toStream(streamCompleteCallback: () => void): http_.IncomingMessage {
     // The raw response is itself the stream, so we just return that. To be
     // backwards compatible, we should invoke the streamCompleteCallback only
     // once the stream has been fully consumed.

src/stripe.core.ts

@@ -49,7 +49,7 @@ export function createStripe(
   platformFunctions: PlatformFunctions,
   requestSender: RequestSenderFactory = defaultRequestSenderFactory
 ): typeof Stripe {
-  Stripe.PACKAGE_VERSION = '12.16.0';
+  Stripe.PACKAGE_VERSION = '12.17.0';
   Stripe.USER_AGENT = {
     bindings_version: Stripe.PACKAGE_VERSION,
     lang: 'node',

testProjects/mjs/index.js

@@ -1,5 +1,6 @@
 import DefaultStripe, {Stripe} from 'stripe';
 import assert from 'assert';
+import * as http from 'http';
 
 assert(Stripe.PACKAGE_VERSION);
 assert(Stripe.USER_AGENT);
@@ -90,9 +91,43 @@ async function exampleFunction(args) {
   }
 }
 
+
+// Test that http is monkey-patchable (motivation: https://github.com/stripe/stripe-node/issues/1844)
+async function exampleMonkeyPatchFunction() {
+  http.default.request = () => {
+    throw new Error('foo');
+  };
+
+  try {
+    await stripe.paymentIntents.create({
+      currency: 'usd',
+      amount: 2000,
+      confirm: true,
+      payment_method: 'pm_card_visa',
+    });
+  } catch (e) {
+    assert (e instanceof stripe.errors.StripeConnectionError);
+    if (e.detail.message === 'foo') {
+      return;
+    } else {
+      throw e;
+    }
+  }
+
+  throw new Error('Expected an error');
+}
+
 exampleFunction({
   // The required parameter currency is missing
   amount: 2000,
   confirm: true,
   payment_method: 'pm_card_visa',
-});
+}).then(() => {
+  return exampleMonkeyPatchFunction()
+}).then(() => {
+  process.exit(0);
+}).catch((e) => {
+  console.error(e);
+  process.exit(1);
+}
+);

tsconfig.cjs.json

@@ -9,7 +9,8 @@
     "noImplicitThis": true,
     "strict": true,
     "strictFunctionTypes": true,
-    "types": [ "node" ]
+    "types": [ "node" ],
+    "esModuleInterop": false // This is a viral option, do not enable https://www.semver-ts.org/#module-interop
   },
   "include": ["./src/**/*"],
   "exclude": ["./src/stripe.esm.node.ts", "./src/stripe.esm.worker.ts"],

types/AccountsResource.d.ts

@@ -1122,7 +1122,7 @@ declare module 'stripe' {
             /**
              * The user agent of the browser from which the account representative accepted the service agreement.
              */
-            user_agent?: string;
+            user_agent?: Stripe.Emptyable<string>;
           }
         }
 
@@ -1255,7 +1255,7 @@ declare module 'stripe' {
             /**
              * The user agent of the browser from which the account representative accepted the service agreement.
              */
-            user_agent?: string;
+            user_agent?: Stripe.Emptyable<string>;
           }
         }
       }
@@ -2365,7 +2365,7 @@ declare module 'stripe' {
             /**
              * The user agent of the browser from which the account representative accepted the service agreement.
              */
-            user_agent?: string;
+            user_agent?: Stripe.Emptyable<string>;
           }
         }
 
@@ -2498,7 +2498,7 @@ declare module 'stripe' {
             /**
              * The user agent of the browser from which the account representative accepted the service agreement.
              */
-            user_agent?: string;
+            user_agent?: Stripe.Emptyable<string>;
           }
         }
       }

types/ApplicationFees.d.ts

@@ -22,12 +22,12 @@ declare module 'stripe' {
       account: string | Stripe.Account;
 
       /**
-       * Amount earned, in %s.
+       * Amount earned, in cents (or local equivalent).
        */
       amount: number;
 
       /**
-       * Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)
+       * Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)
        */
       amount_refunded: number;
 

types/BalanceTransactions.d.ts

@@ -20,7 +20,7 @@ declare module 'stripe' {
       object: 'balance_transaction';
 
       /**
-       * Gross amount of the transaction, in %s.
+       * Gross amount of the transaction, in cents (or local equivalent).
        */
       amount: number;
 
@@ -50,17 +50,17 @@ declare module 'stripe' {
       exchange_rate: number | null;
 
       /**
-       * Fees (in %s) paid for this transaction.
+       * Fees (in cents (or local equivalent)) paid for this transaction.
        */
       fee: number;
 
       /**
-       * Detailed breakdown of fees (in %s) paid for this transaction.
+       * Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
        */
       fee_details: Array<BalanceTransaction.FeeDetail>;
 
       /**
-       * Net amount of the transaction, in %s.
+       * Net amount of the transaction, in cents (or local equivalent).
        */
       net: number;
 

types/BillingPortal/ConfigurationsResource.d.ts

@@ -40,7 +40,7 @@ declare module 'stripe' {
           /**
            * The messaging shown to customers in the portal.
            */
-          headline?: string;
+          headline?: Stripe.Emptyable<string>;
 
           /**
            * A link to the business's publicly available privacy policy.
@@ -289,7 +289,7 @@ declare module 'stripe' {
           /**
            * The messaging shown to customers in the portal.
            */
-          headline?: string;
+          headline?: Stripe.Emptyable<string>;
 
           /**
            * A link to the business's publicly available privacy policy.

types/Charges.d.ts

@@ -27,12 +27,12 @@ declare module 'stripe' {
       amount: number;
 
       /**
-       * Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).
+       * Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
        */
       amount_captured: number;
 
       /**
-       * Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).
+       * Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
        */
       amount_refunded: number;
 

types/Checkout/Sessions.d.ts

@@ -1600,7 +1600,7 @@ declare module 'stripe' {
             taxability_reason: Tax.TaxabilityReason | null;
 
             /**
-             * The amount on which tax is calculated, in %s.
+             * The amount on which tax is calculated, in cents (or local equivalent).
              */
             taxable_amount: number | null;
           }
@@ -1742,7 +1742,7 @@ declare module 'stripe' {
               taxability_reason: Tax.TaxabilityReason | null;
 
               /**
-               * The amount on which tax is calculated, in %s.
+               * The amount on which tax is calculated, in cents (or local equivalent).
                */
               taxable_amount: number | null;
             }

types/Checkout/SessionsResource.d.ts

@@ -2018,7 +2018,7 @@ declare module 'stripe' {
 
         interface SubscriptionData {
           /**
-           * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
+           * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
            */
           application_fee_percent?: number;
 
@@ -2042,7 +2042,7 @@ declare module 'stripe' {
           /**
            * The subscription's description, meant to be displayable to the customer.
            * Use this field to optionally store an explanation of the subscription
-           * for rendering in Stripe hosted surfaces.
+           * for rendering in the [customer portal](https://stripe.com/docs/customer-management).
            */
           description?: string;
 
@@ -2095,7 +2095,7 @@ declare module 'stripe' {
 
           interface TransferData {
             /**
-             * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
+             * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
              */
             amount_percent?: number;
 

types/ConnectCollectionTransfers.d.ts

@@ -17,7 +17,7 @@ declare module 'stripe' {
       object: 'connect_collection_transfer';
 
       /**
-       * Amount transferred, in %s.
+       * Amount transferred, in cents (or local equivalent).
        */
       amount: number;
 

types/Coupons.d.ts

@@ -75,7 +75,7 @@ declare module 'stripe' {
       name: string | null;
 
       /**
-       * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.
+       * Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
        */
       percent_off: number | null;