Update generated code (#2237)

* Update generated code for v1399 * Update generated code for v1402 * Update generated code for v1409 * Update generated code for v1412 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Co-authored-by: jar-stripe <[email protected]>
stripe · Dec 18, 2024 · d727b3e · d727b3e
1 parent 69ac616
commit d727b3e
Show file tree

Hide file tree

Showing 63 changed files with 1,241 additions and 137 deletions.
diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION
@@ -1 +1 @@
-v1347
+v1412
diff --git a/src/apiVersion.ts b/src/apiVersion.ts
@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec
 
-export const ApiVersion = '2024-11-20.acacia';
+export const ApiVersion = '2024-12-18.acacia';
diff --git a/test/resources/generated_examples_test.spec.js b/test/resources/generated_examples_test.spec.js
diff --git a/types/AccountSessions.d.ts b/types/AccountSessions.d.ts
@@ -82,7 +82,7 @@ declare module 'stripe' {
         namespace AccountManagement {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication: boolean;
 
@@ -105,7 +105,7 @@ declare module 'stripe' {
         namespace AccountOnboarding {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication: boolean;
 
@@ -128,7 +128,7 @@ declare module 'stripe' {
         namespace Balances {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication: boolean;
 
@@ -179,7 +179,7 @@ declare module 'stripe' {
         namespace NotificationBanner {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication: boolean;
 
@@ -268,7 +268,7 @@ declare module 'stripe' {
         namespace Payouts {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication: boolean;
 

diff --git a/types/AccountSessionsResource.d.ts b/types/AccountSessionsResource.d.ts
@@ -93,7 +93,7 @@ declare module 'stripe' {
         namespace AccountManagement {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication?: boolean;
 
@@ -119,7 +119,7 @@ declare module 'stripe' {
         namespace AccountOnboarding {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication?: boolean;
 
@@ -145,7 +145,7 @@ declare module 'stripe' {
         namespace Balances {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication?: boolean;
 
@@ -202,7 +202,7 @@ declare module 'stripe' {
         namespace NotificationBanner {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication?: boolean;
 
@@ -300,7 +300,7 @@ declare module 'stripe' {
         namespace Payouts {
           interface Features {
             /**
-             * Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you're responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise.
+             * Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
              */
             disable_stripe_user_authentication?: boolean;
 

diff --git a/types/Accounts.d.ts b/types/Accounts.d.ts
@@ -129,12 +129,12 @@ declare module 'stripe' {
         /**
          * The applicant's gross annual revenue for its preceding fiscal year.
          */
-        annual_revenue: BusinessProfile.AnnualRevenue | null;
+        annual_revenue?: BusinessProfile.AnnualRevenue | null;
 
         /**
          * An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
          */
-        estimated_worker_count: number | null;
+        estimated_worker_count?: number | null;
 
         /**
          * [The merchant category code for the account](https://stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
@@ -899,7 +899,7 @@ declare module 'stripe' {
         alternatives: Array<FutureRequirements.Alternative> | null;
 
         /**
-         * Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.
+         * Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.
          */
         current_deadline: number | null;
 
@@ -919,7 +919,7 @@ declare module 'stripe' {
         errors: Array<FutureRequirements.Error> | null;
 
         /**
-         * Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well.
+         * Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
          */
         eventually_due: Array<string> | null;
 
@@ -1110,7 +1110,7 @@ declare module 'stripe' {
         errors: Array<Requirements.Error> | null;
 
         /**
-         * Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
+         * Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
          */
         eventually_due: Array<string> | null;
 

diff --git a/types/AccountsResource.d.ts b/types/AccountsResource.d.ts
@@ -73,7 +73,7 @@ declare module 'stripe' {
       external_account?: string | AccountCreateParams.ExternalAccount;
 
       /**
-       * A hash of account group type to tokens. These are account groups this account should be added to
+       * A hash of account group type to tokens. These are account groups this account should be added to.
        */
       groups?: AccountCreateParams.Groups;
 
@@ -1719,7 +1719,7 @@ declare module 'stripe' {
       >;
 
       /**
-       * A hash of account group type to tokens. These are account groups this account should be added to
+       * A hash of account group type to tokens. These are account groups this account should be added to.
        */
       groups?: AccountUpdateParams.Groups;
 

diff --git a/types/BalanceTransactions.d.ts b/types/BalanceTransactions.d.ts
@@ -80,7 +80,7 @@ declare module 'stripe' {
       status: string;
 
       /**
-       * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
+       * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
        */
       type: BalanceTransaction.Type;
     }
@@ -141,6 +141,8 @@ declare module 'stripe' {
         | 'payout'
         | 'payout_cancel'
         | 'payout_failure'
+        | 'payout_minimum_balance_hold'
+        | 'payout_minimum_balance_release'
         | 'refund'
         | 'refund_failure'
         | 'reserve_transaction'

diff --git a/types/BalanceTransactionsResource.d.ts b/types/BalanceTransactionsResource.d.ts
@@ -36,7 +36,7 @@ declare module 'stripe' {
       source?: string;
 
       /**
-       * Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
+       * Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
        */
       type?: string;
     }

diff --git a/types/Billing/CreditBalanceSummaryResource.d.ts b/types/Billing/CreditBalanceSummaryResource.d.ts
@@ -41,7 +41,7 @@ declare module 'stripe' {
         namespace Filter {
           interface ApplicabilityScope {
             /**
-             * The price type for which credit grants can apply. We currently only support the `metered` price type.
+             * The price type that credit grants can apply to. We currently only support the `metered` price type.
              */
             price_type: 'metered';
           }
@@ -52,7 +52,7 @@ declare module 'stripe' {
 
       class CreditBalanceSummaryResource {
         /**
-         * Retrieves the credit balance summary for a customer
+         * Retrieves the credit balance summary for a customer.
          */
         retrieve(
           params: CreditBalanceSummaryRetrieveParams,

diff --git a/types/Billing/CreditBalanceTransactions.d.ts b/types/Billing/CreditBalanceTransactions.d.ts
@@ -62,10 +62,15 @@ declare module 'stripe' {
         interface Credit {
           amount: Credit.Amount;
 
+          /**
+           * Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.
+           */
+          credits_application_invoice_voided?: Credit.CreditsApplicationInvoiceVoided | null;
+
           /**
            * The type of credit transaction.
            */
-          type: 'credits_granted';
+          type: Credit.Type;
         }
 
         namespace Credit {
@@ -94,6 +99,20 @@ declare module 'stripe' {
               value: number;
             }
           }
+
+          interface CreditsApplicationInvoiceVoided {
+            /**
+             * The invoice to which the reinstated billing credits were originally applied.
+             */
+            invoice: string | Stripe.Invoice;
+
+            /**
+             * The invoice line item to which the reinstated billing credits were originally applied.
+             */
+            invoice_line_item: string;
+          }
+
+          type Type = 'credits_application_invoice_voided' | 'credits_granted';
         }
 
         interface Debit {

diff --git a/types/Billing/CreditBalanceTransactionsResource.d.ts b/types/Billing/CreditBalanceTransactionsResource.d.ts
@@ -29,7 +29,7 @@ declare module 'stripe' {
 
       class CreditBalanceTransactionsResource {
         /**
-         * Retrieves a credit balance transaction
+         * Retrieves a credit balance transaction.
          */
         retrieve(
           id: string,
@@ -42,7 +42,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Billing.CreditBalanceTransaction>>;
 
         /**
-         * Retrieve a list of credit balance transactions
+         * Retrieve a list of credit balance transactions.
          */
         list(
           params: CreditBalanceTransactionListParams,