Update generated code (stripe#2147)

* Update generated code for v1170 * Update generated code for v1171 * Update generated code for v1172 * Update generated code for v1173 * Update generated code for v1174 * Update generated code for v1175 * Update generated code for v1176 * Update generated code for v1177 * Update generated code for v1179 * Update generated code for v1180 * Update generated code for v1182 * Update generated code for v1183 * Update generated code for v1184 * Update generated code for v1186 * Update generated code for v1187 * Update generated code for v1188 * Update generated code for v1189 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
gurus00 · Aug 8, 2024 · 9f148ec · 9f148ec
1 parent 92e32dc
commit 9f148ec
Show file tree

Hide file tree

Showing 36 changed files with 1,137 additions and 824 deletions.
diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION
@@ -1 +1 @@
-v1169
+v1189
diff --git a/src/resources.ts b/src/resources.ts
@@ -3,6 +3,7 @@
 import {resourceNamespace} from './ResourceNamespace.js';
 import {Accounts as FinancialConnectionsAccounts} from './resources/FinancialConnections/Accounts.js';
 import {ActiveEntitlements as EntitlementsActiveEntitlements} from './resources/Entitlements/ActiveEntitlements.js';
+import {Alerts as BillingAlerts} from './resources/Billing/Alerts.js';
 import {Authorizations as TestHelpersIssuingAuthorizations} from './resources/TestHelpers/Issuing/Authorizations.js';
 import {Authorizations as IssuingAuthorizations} from './resources/Issuing/Authorizations.js';
 import {Calculations as TaxCalculations} from './resources/Tax/Calculations.js';
@@ -119,6 +120,7 @@ export {Transfers} from './resources/Transfers.js';
 export {WebhookEndpoints} from './resources/WebhookEndpoints.js';
 export const Apps = resourceNamespace('apps', {Secrets: AppsSecrets});
 export const Billing = resourceNamespace('billing', {
+  Alerts: BillingAlerts,
   MeterEventAdjustments: BillingMeterEventAdjustments,
   MeterEvents: BillingMeterEvents,
   Meters: BillingMeters,

diff --git a/src/resources/Billing/Alerts.ts b/src/resources/Billing/Alerts.ts
@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec
+
+import {StripeResource} from '../../StripeResource.js';
+const stripeMethod = StripeResource.method;
+export const Alerts = StripeResource.extend({
+  create: stripeMethod({method: 'POST', fullPath: '/v1/billing/alerts'}),
+  retrieve: stripeMethod({method: 'GET', fullPath: '/v1/billing/alerts/{id}'}),
+  list: stripeMethod({
+    method: 'GET',
+    fullPath: '/v1/billing/alerts',
+    methodType: 'list',
+  }),
+  activate: stripeMethod({
+    method: 'POST',
+    fullPath: '/v1/billing/alerts/{id}/activate',
+  }),
+  archive: stripeMethod({
+    method: 'POST',
+    fullPath: '/v1/billing/alerts/{id}/archive',
+  }),
+  deactivate: stripeMethod({
+    method: 'POST',
+    fullPath: '/v1/billing/alerts/{id}/deactivate',
+  }),
+});
diff --git a/src/resources/Tax/Calculations.ts b/src/resources/Tax/Calculations.ts
@@ -4,6 +4,10 @@ import {StripeResource} from '../../StripeResource.js';
 const stripeMethod = StripeResource.method;
 export const Calculations = StripeResource.extend({
   create: stripeMethod({method: 'POST', fullPath: '/v1/tax/calculations'}),
+  retrieve: stripeMethod({
+    method: 'GET',
+    fullPath: '/v1/tax/calculations/{calculation}',
+  }),
   listLineItems: stripeMethod({
     method: 'GET',
     fullPath: '/v1/tax/calculations/{calculation}/line_items',

diff --git a/test/resources/generated_examples_test.spec.js b/test/resources/generated_examples_test.spec.js
diff --git a/types/Accounts.d.ts b/types/Accounts.d.ts
@@ -1316,22 +1316,22 @@ declare module 'stripe' {
           statement_descriptor: string | null;
 
           /**
-           * The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only)
+           * The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_kana: string | null;
 
           /**
-           * The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only)
+           * The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_kanji: string | null;
 
           /**
-           * The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.
+           * The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_prefix_kana: string | null;
 
           /**
-           * The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.
+           * The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_prefix_kanji: string | null;
         }

diff --git a/types/AccountsResource.d.ts b/types/AccountsResource.d.ts
@@ -1441,17 +1441,17 @@ declare module 'stripe' {
 
         interface Payments {
           /**
-           * The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.
+           * The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).
            */
           statement_descriptor?: string;
 
           /**
-           * The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).
+           * The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_kana?: string;
 
           /**
-           * The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).
+           * The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_kanji?: string;
         }
@@ -2995,17 +2995,17 @@ declare module 'stripe' {
 
         interface Payments {
           /**
-           * The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.
+           * The default text that appears on statements for non-card charges outside of Japan. For card charges, if you don't set a `statement_descriptor_prefix`, this text is also used as the statement descriptor prefix. In that case, if concatenating the statement descriptor suffix causes the combined statement descriptor to exceed 22 characters, we truncate the `statement_descriptor` text to limit the full descriptor to 22 characters. For more information about statement descriptors and their requirements, see the [account settings documentation](https://docs.stripe.com/get-started/account/statement-descriptors).
            */
           statement_descriptor?: string;
 
           /**
-           * The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).
+           * The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_kana?: string;
 
           /**
-           * The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).
+           * The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
            */
           statement_descriptor_kanji?: string;
         }

diff --git a/types/Billing/AlertsResource.d.ts b/types/Billing/AlertsResource.d.ts
@@ -0,0 +1,176 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      interface AlertCreateParams {
+        /**
+         * The type of alert to create.
+         */
+        alert_type: 'usage_threshold';
+
+        /**
+         * The title of the alert.
+         */
+        title: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Filters to limit the scope of an alert.
+         */
+        filter?: AlertCreateParams.Filter;
+
+        /**
+         * The configuration of the usage threshold.
+         */
+        usage_threshold_config?: AlertCreateParams.UsageThresholdConfig;
+      }
+
+      namespace AlertCreateParams {
+        interface Filter {
+          /**
+           * Limit the scope to this alert only to this customer.
+           */
+          customer?: string;
+        }
+
+        interface UsageThresholdConfig {
+          /**
+           * Defines at which value the alert will fire.
+           */
+          gte: number;
+
+          /**
+           * The [Billing Meter](https://stripe.com/api/billing/meter) ID whose usage is monitored.
+           */
+          meter?: string;
+
+          /**
+           * Whether the alert should only fire only once, or once per billing cycle.
+           */
+          recurrence: 'one_time';
+        }
+      }
+
+      interface AlertRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AlertListParams extends PaginationParams {
+        /**
+         * Filter results to only include this type of alert.
+         */
+        alert_type?: 'usage_threshold';
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * Filter results to only include alerts with the given meter.
+         */
+        meter?: string;
+      }
+
+      interface AlertActivateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AlertArchiveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface AlertDeactivateParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class AlertsResource {
+        /**
+         * Creates a billing alert
+         */
+        create(
+          params: AlertCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Retrieves a billing alert given an ID
+         */
+        retrieve(
+          id: string,
+          params?: AlertRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Lists billing active and inactive alerts
+         */
+        list(
+          params?: AlertListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.Alert>;
+        list(options?: RequestOptions): ApiListPromise<Stripe.Billing.Alert>;
+
+        /**
+         * Reactivates this alert, allowing it to trigger again.
+         */
+        activate(
+          id: string,
+          params?: AlertActivateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        activate(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Archives this alert, removing it from the list view and APIs. This is non-reversible.
+         */
+        archive(
+          id: string,
+          params?: AlertArchiveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        archive(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+
+        /**
+         * Deactivates this alert, preventing it from triggering.
+         */
+        deactivate(
+          id: string,
+          params?: AlertDeactivateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+        deactivate(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Billing.Alert>>;
+      }
+    }
+  }
+}
diff --git a/types/Cards.d.ts b/types/Cards.d.ts
@@ -71,7 +71,7 @@ declare module 'stripe' {
       available_payout_methods?: Array<Card.AvailablePayoutMethod> | null;
 
       /**
-       * Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
+       * Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
        */
       brand: string;
 
@@ -81,7 +81,7 @@ declare module 'stripe' {
       country: string | null;
 
       /**
-       * Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+       * Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
        */
       currency?: string | null;
 

diff --git a/types/Charges.d.ts b/types/Charges.d.ts
@@ -62,7 +62,7 @@ declare module 'stripe' {
       billing_details: Charge.BillingDetails;
 
       /**
-       * The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This only works for card payments.
+       * The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.
        */
       calculated_statement_descriptor: string | null;
 
@@ -214,12 +214,12 @@ declare module 'stripe' {
       source_transfer: string | Stripe.Transfer | null;
 
       /**
-       * For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers' statements. Must contain at least one letter, maximum 22 characters.
+       * For a non-card charge, text that appears on the customer's statement as the [statement descriptor](https://docs.stripe.com/get-started/account/statement-descriptors). This value overrides the account's default statement descriptor. For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix.
        */
       statement_descriptor: string | null;
 
       /**
-       * Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
+       * Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.corp.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.
        */
       statement_descriptor_suffix: string | null;
 
@@ -1211,6 +1211,11 @@ declare module 'stripe' {
              * Time at which the payment was collected while offline
              */
             stored_at: number | null;
+
+            /**
+             * The method used to process this payment method offline. Only deferred is allowed.
+             */
+            type: 'deferred' | null;
           }
 
           type ReadMethod =