Update generated code for v1380

stripe · Nov 26, 2024 · 3a4719c · 3a4719c
1 parent e6cd438
commit 3a4719c
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 29 deletions.
diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION
@@ -1 +1 @@
-v1379
+v1380
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/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,

diff --git a/types/Billing/CreditGrants.d.ts b/types/Billing/CreditGrants.d.ts
@@ -39,7 +39,7 @@ declare module 'stripe' {
         customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
         /**
-         * The time when the billing credits become effective—when they're eligible for use.
+         * The time when the billing credits become effective-when they're eligible for use.
          */
         effective_at: number | null;
 
@@ -113,7 +113,7 @@ declare module 'stripe' {
         namespace ApplicabilityConfig {
           interface Scope {
             /**
-             * The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
+             * The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
              */
             price_type: 'metered';
           }

diff --git a/types/Billing/CreditGrantsResource.d.ts b/types/Billing/CreditGrantsResource.d.ts
@@ -25,7 +25,7 @@ declare module 'stripe' {
         customer: string;
 
         /**
-         * The time when the billing credits become effective—when they're eligible for use. Defaults to the current timestamp if not specified.
+         * The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
          */
         effective_at?: number;
 
@@ -35,12 +35,12 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * The time when the billing credits will expire. If not specified, the billing credits don't expire.
+         * The time when the billing credits expire. If not specified, the billing credits don't expire.
          */
         expires_at?: number;
 
         /**
-         * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
+         * Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
          */
         metadata?: Stripe.MetadataParam;
 
@@ -87,7 +87,7 @@ declare module 'stripe' {
         namespace ApplicabilityConfig {
           interface Scope {
             /**
-             * 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';
           }
@@ -115,7 +115,7 @@ declare module 'stripe' {
         expires_at?: Stripe.Emptyable<number>;
 
         /**
-         * Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
+         * Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
          */
         metadata?: Stripe.MetadataParam;
       }
@@ -148,15 +148,15 @@ declare module 'stripe' {
 
       class CreditGrantsResource {
         /**
-         * Creates a credit grant
+         * Creates a credit grant.
          */
         create(
           params: CreditGrantCreateParams,
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
 
         /**
-         * Retrieves a credit grant
+         * Retrieves a credit grant.
          */
         retrieve(
           id: string,
@@ -169,7 +169,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Billing.CreditGrant>>;
 
         /**
-         * Updates a credit grant
+         * Updates a credit grant.
          */
         update(
           id: string,

diff --git a/types/Billing/MeterEventAdjustmentsResource.d.ts b/types/Billing/MeterEventAdjustmentsResource.d.ts
@@ -36,7 +36,7 @@ declare module 'stripe' {
 
       class MeterEventAdjustmentsResource {
         /**
-         * Creates a billing meter event adjustment
+         * Creates a billing meter event adjustment.
          */
         create(
           params: MeterEventAdjustmentCreateParams,

diff --git a/types/Billing/MeterEvents.d.ts b/types/Billing/MeterEvents.d.ts
@@ -4,8 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Billing {
       /**
-       * A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.
-       * Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.
+       * Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.
        */
       interface MeterEvent {
         /**

diff --git a/types/Billing/MeterEventsResource.d.ts b/types/Billing/MeterEventsResource.d.ts
@@ -22,7 +22,7 @@ declare module 'stripe' {
         expand?: Array<string>;
 
         /**
-         * A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
+         * A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
          */
         identifier?: string;
 
@@ -34,7 +34,7 @@ declare module 'stripe' {
 
       class MeterEventsResource {
         /**
-         * Creates a billing meter event
+         * Creates a billing meter event.
          */
         create(
           params: MeterEventCreateParams,

diff --git a/types/Billing/Meters.d.ts b/types/Billing/Meters.d.ts
@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Billing {
       /**
-       * A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.
+       * Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
        *
        * Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
        */

diff --git a/types/Billing/MetersResource.d.ts b/types/Billing/MetersResource.d.ts
@@ -10,7 +10,7 @@ declare module 'stripe' {
         default_aggregation: MeterCreateParams.DefaultAggregation;
 
         /**
-         * The meter's name.
+         * The meter's name. Not visible to the customer.
          */
         display_name: string;
 
@@ -43,7 +43,7 @@ declare module 'stripe' {
       namespace MeterCreateParams {
         interface CustomerMapping {
           /**
-           * The key in the usage event payload to use for mapping the event to a customer.
+           * The key in the meter event payload to use for mapping the event to a customer.
            */
           event_payload_key: string;
 
@@ -83,7 +83,7 @@ declare module 'stripe' {
 
       interface MeterUpdateParams {
         /**
-         * The meter's name.
+         * The meter's name. Not visible to the customer.
          */
         display_name?: string;
 
@@ -156,15 +156,15 @@ declare module 'stripe' {
 
       class MetersResource {
         /**
-         * Creates a billing meter
+         * Creates a billing meter.
          */
         create(
           params: MeterCreateParams,
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
 
         /**
-         * Retrieves a billing meter given an ID
+         * Retrieves a billing meter given an ID.
          */
         retrieve(
           id: string,
@@ -177,7 +177,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Billing.Meter>>;
 
         /**
-         * Updates a billing meter
+         * Updates a billing meter.
          */
         update(
           id: string,
@@ -195,7 +195,7 @@ declare module 'stripe' {
         list(options?: RequestOptions): ApiListPromise<Stripe.Billing.Meter>;
 
         /**
-         * Deactivates a billing meter
+         * When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
          */
         deactivate(
           id: string,
@@ -217,7 +217,7 @@ declare module 'stripe' {
         ): ApiListPromise<Stripe.Billing.MeterEventSummary>;
 
         /**
-         * Reactivates a billing meter
+         * When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
          */
         reactivate(
           id: string,