From 94fe22b5aa8525bf1865404111596ee71a57b20e Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 26 Nov 2024 15:12:53 +0000 Subject: [PATCH] Update generated code for v1380 --- OPENAPI_VERSION | 2 +- .../billing/credit_balance_transaction.rb | 2 +- lib/stripe/resources/billing/credit_grant.rb | 4 ++-- lib/stripe/resources/billing/meter.rb | 14 +++++++------- lib/stripe/resources/billing/meter_event.rb | 5 ++--- .../resources/billing/meter_event_adjustment.rb | 2 +- .../billing/credit_balance_summary_service.rb | 2 +- .../billing/credit_balance_transaction_service.rb | 4 ++-- .../services/billing/credit_grant_service.rb | 6 +++--- .../billing/meter_event_adjustment_service.rb | 2 +- lib/stripe/services/billing/meter_event_service.rb | 2 +- lib/stripe/services/billing/meter_service.rb | 10 +++++----- 12 files changed, 27 insertions(+), 28 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 038066775..8486b1411 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v1370 \ No newline at end of file +v1380 \ No newline at end of file diff --git a/lib/stripe/resources/billing/credit_balance_transaction.rb b/lib/stripe/resources/billing/credit_balance_transaction.rb index 113cb9861..9c56614cf 100644 --- a/lib/stripe/resources/billing/credit_balance_transaction.rb +++ b/lib/stripe/resources/billing/credit_balance_transaction.rb @@ -12,7 +12,7 @@ def self.object_name "billing.credit_balance_transaction" end - # Retrieve a list of credit balance transactions + # Retrieve a list of credit balance transactions. def self.list(filters = {}, opts = {}) request_stripe_object( method: :get, diff --git a/lib/stripe/resources/billing/credit_grant.rb b/lib/stripe/resources/billing/credit_grant.rb index 43839816a..b3202db9c 100644 --- a/lib/stripe/resources/billing/credit_grant.rb +++ b/lib/stripe/resources/billing/credit_grant.rb @@ -16,7 +16,7 @@ def self.object_name "billing.credit_grant" end - # Creates a credit grant + # Creates a credit grant. def self.create(params = {}, opts = {}) request_stripe_object( method: :post, @@ -56,7 +56,7 @@ def self.list(filters = {}, opts = {}) ) end - # Updates a credit grant + # Updates a credit grant. def self.update(id, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/billing/meter.rb b/lib/stripe/resources/billing/meter.rb index 6ef7ad9ec..08a95fa82 100644 --- a/lib/stripe/resources/billing/meter.rb +++ b/lib/stripe/resources/billing/meter.rb @@ -3,7 +3,7 @@ module Stripe module 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) class Meter < APIResource @@ -21,12 +21,12 @@ def self.object_name operations: %i[list], resource_plural: "event_summaries" - # Creates a billing meter + # Creates a billing meter. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/billing/meters", params: params, opts: opts) end - # 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. def deactivate(params = {}, opts = {}) request_stripe_object( method: :post, @@ -36,7 +36,7 @@ def deactivate(params = {}, opts = {}) ) end - # 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. def self.deactivate(id, params = {}, opts = {}) request_stripe_object( method: :post, @@ -51,7 +51,7 @@ def self.list(filters = {}, opts = {}) request_stripe_object(method: :get, path: "/v1/billing/meters", params: filters, opts: opts) end - # 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. def reactivate(params = {}, opts = {}) request_stripe_object( method: :post, @@ -61,7 +61,7 @@ def reactivate(params = {}, opts = {}) ) end - # 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. def self.reactivate(id, params = {}, opts = {}) request_stripe_object( method: :post, @@ -71,7 +71,7 @@ def self.reactivate(id, params = {}, opts = {}) ) end - # Updates a billing meter + # Updates a billing meter. def self.update(id, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/billing/meter_event.rb b/lib/stripe/resources/billing/meter_event.rb index 53190ce8a..4bab67629 100644 --- a/lib/stripe/resources/billing/meter_event.rb +++ b/lib/stripe/resources/billing/meter_event.rb @@ -3,8 +3,7 @@ module Stripe module 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. class MeterEvent < APIResource extend Stripe::APIOperations::Create @@ -13,7 +12,7 @@ def self.object_name "billing.meter_event" end - # Creates a billing meter event + # Creates a billing meter event. def self.create(params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/billing/meter_event_adjustment.rb b/lib/stripe/resources/billing/meter_event_adjustment.rb index 8cd345852..d9fa06e4f 100644 --- a/lib/stripe/resources/billing/meter_event_adjustment.rb +++ b/lib/stripe/resources/billing/meter_event_adjustment.rb @@ -12,7 +12,7 @@ def self.object_name "billing.meter_event_adjustment" end - # Creates a billing meter event adjustment + # Creates a billing meter event adjustment. def self.create(params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/services/billing/credit_balance_summary_service.rb b/lib/stripe/services/billing/credit_balance_summary_service.rb index b86ad906b..8ddc26271 100644 --- a/lib/stripe/services/billing/credit_balance_summary_service.rb +++ b/lib/stripe/services/billing/credit_balance_summary_service.rb @@ -4,7 +4,7 @@ module Stripe module Billing class CreditBalanceSummaryService < StripeService - # Retrieves the credit balance summary for a customer + # Retrieves the credit balance summary for a customer. def retrieve(params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/billing/credit_balance_transaction_service.rb b/lib/stripe/services/billing/credit_balance_transaction_service.rb index 399f880d3..7bba1bf45 100644 --- a/lib/stripe/services/billing/credit_balance_transaction_service.rb +++ b/lib/stripe/services/billing/credit_balance_transaction_service.rb @@ -4,7 +4,7 @@ module Stripe module Billing class CreditBalanceTransactionService < StripeService - # Retrieve a list of credit balance transactions + # Retrieve a list of credit balance transactions. def list(params = {}, opts = {}) request( method: :get, @@ -15,7 +15,7 @@ def list(params = {}, opts = {}) ) end - # Retrieves a credit balance transaction + # Retrieves a credit balance transaction. def retrieve(id, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/billing/credit_grant_service.rb b/lib/stripe/services/billing/credit_grant_service.rb index 78a92b1b1..ccb7414b0 100644 --- a/lib/stripe/services/billing/credit_grant_service.rb +++ b/lib/stripe/services/billing/credit_grant_service.rb @@ -4,7 +4,7 @@ module Stripe module Billing class CreditGrantService < StripeService - # Creates a credit grant + # Creates a credit grant. def create(params = {}, opts = {}) request( method: :post, @@ -37,7 +37,7 @@ def list(params = {}, opts = {}) ) end - # Retrieves a credit grant + # Retrieves a credit grant. def retrieve(id, params = {}, opts = {}) request( method: :get, @@ -48,7 +48,7 @@ def retrieve(id, params = {}, opts = {}) ) end - # Updates a credit grant + # Updates a credit grant. def update(id, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/billing/meter_event_adjustment_service.rb b/lib/stripe/services/billing/meter_event_adjustment_service.rb index 147b8c0d0..f38e0d9ac 100644 --- a/lib/stripe/services/billing/meter_event_adjustment_service.rb +++ b/lib/stripe/services/billing/meter_event_adjustment_service.rb @@ -4,7 +4,7 @@ module Stripe module Billing class MeterEventAdjustmentService < StripeService - # Creates a billing meter event adjustment + # Creates a billing meter event adjustment. def create(params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/billing/meter_event_service.rb b/lib/stripe/services/billing/meter_event_service.rb index d12445ce0..bf67a6529 100644 --- a/lib/stripe/services/billing/meter_event_service.rb +++ b/lib/stripe/services/billing/meter_event_service.rb @@ -4,7 +4,7 @@ module Stripe module Billing class MeterEventService < StripeService - # Creates a billing meter event + # Creates a billing meter event. def create(params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/billing/meter_service.rb b/lib/stripe/services/billing/meter_service.rb index dbb2d2f49..6d9001393 100644 --- a/lib/stripe/services/billing/meter_service.rb +++ b/lib/stripe/services/billing/meter_service.rb @@ -11,7 +11,7 @@ def initialize(requestor) @event_summaries = Stripe::Billing::MeterEventSummaryService.new(@requestor) end - # Creates a billing meter + # Creates a billing meter. def create(params = {}, opts = {}) request( method: :post, @@ -22,7 +22,7 @@ def create(params = {}, opts = {}) ) end - # 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. def deactivate(id, params = {}, opts = {}) request( method: :post, @@ -44,7 +44,7 @@ def list(params = {}, opts = {}) ) end - # 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. def reactivate(id, params = {}, opts = {}) request( method: :post, @@ -55,7 +55,7 @@ def reactivate(id, params = {}, opts = {}) ) end - # Retrieves a billing meter given an ID + # Retrieves a billing meter given an ID. def retrieve(id, params = {}, opts = {}) request( method: :get, @@ -66,7 +66,7 @@ def retrieve(id, params = {}, opts = {}) ) end - # Updates a billing meter + # Updates a billing meter. def update(id, params = {}, opts = {}) request( method: :post,