orb-billing 0.2.0 → 0.3.1

data/lib/orb/resources/customers/credits/top_ups.rb

@@ -5,6 +5,9 @@ module Orb
     class Customers
       class Credits
         class TopUps
+          # Some parameter documentations has been truncated, see
+          # {Orb::Models::Customers::Credits::TopUpCreateParams} for more details.
+          #
           # This endpoint allows you to create a new top-up for a specified customer's
           # balance. While this top-up is active, the customer's balance will added in
           # increments of the specified amount whenever the balance reaches the specified
@@ -16,14 +19,27 @@ module Orb
           # @overload create(customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
           #
           # @param customer_id [String]
-          # @param amount [String]
-          # @param currency [String]
-          # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings]
-          # @param per_unit_cost_basis [String]
-          # @param threshold [String]
-          # @param active_from [Time, nil]
-          # @param expires_after [Integer, nil]
-          # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil]
+          #
+          # @param amount [String] The amount to increment when the threshold is reached.
+          #
+          # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          # ...
+          #
+          # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          # ...
+          #
+          # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
+          # ...
+          #
+          # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          # ...
+          #
+          # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
+          #
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Orb::Models::Customers::Credits::TopUpCreateResponse]
@@ -40,13 +56,20 @@ module Orb
             )
           end
 
+          # Some parameter documentations has been truncated, see
+          # {Orb::Models::Customers::Credits::TopUpListParams} for more details.
+          #
           # List top-ups
           #
           # @overload list(customer_id, cursor: nil, limit: nil, request_options: {})
           #
           # @param customer_id [String]
-          # @param cursor [String, nil]
-          # @param limit [Integer]
+          #
+          # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # ...
+          #
+          # @param limit [Integer] The number of items to fetch. Defaults to 20.
+          #
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::TopUpListResponse>]
@@ -90,6 +113,10 @@ module Orb
             )
           end
 
+          # Some parameter documentations has been truncated, see
+          # {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams} for more
+          # details.
+          #
           # This endpoint allows you to create a new top-up for a specified customer's
           # balance. While this top-up is active, the customer's balance will added in
           # increments of the specified amount whenever the balance reaches the specified
@@ -101,14 +128,27 @@ module Orb
           # @overload create_by_external_id(external_customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
           #
           # @param external_customer_id [String]
-          # @param amount [String]
-          # @param currency [String]
-          # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings]
-          # @param per_unit_cost_basis [String]
-          # @param threshold [String]
-          # @param active_from [Time, nil]
-          # @param expires_after [Integer, nil]
-          # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil]
+          #
+          # @param amount [String] The amount to increment when the threshold is reached.
+          #
+          # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          # ...
+          #
+          # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          # ...
+          #
+          # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
+          # ...
+          #
+          # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          # ...
+          #
+          # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
+          #
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse]
@@ -155,13 +195,20 @@ module Orb
             )
           end
 
+          # Some parameter documentations has been truncated, see
+          # {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
+          #
           # List top-ups by external ID
           #
           # @overload list_by_external_id(external_customer_id, cursor: nil, limit: nil, request_options: {})
           #
           # @param external_customer_id [String]
-          # @param cursor [String, nil]
-          # @param limit [Integer]
+          #
+          # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # ...
+          #
+          # @param limit [Integer] The number of items to fetch. Defaults to 20.
+          #
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::TopUpListByExternalIDResponse>]

data/lib/orb/resources/customers/credits.rb

@@ -10,6 +10,9 @@ module Orb
         # @return [Orb::Resources::Customers::Credits::TopUps]
         attr_reader :top_ups
 
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Customers::CreditListParams} for more details.
+        #
         # Returns a paginated list of unexpired, non-zero credit blocks for a customer.
         #
         # If `include_all_blocks` is set to `true`, all credit blocks (including expired
@@ -21,10 +24,17 @@ module Orb
         # @overload list(customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
         #
         # @param customer_id [String]
-        # @param currency [String, nil]
-        # @param cursor [String, nil]
-        # @param include_all_blocks [Boolean]
-        # @param limit [Integer]
+        #
+        # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Customers::CreditListResponse>]
@@ -42,6 +52,9 @@ module Orb
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Customers::CreditListByExternalIDParams} for more details.
+        #
         # Returns a paginated list of unexpired, non-zero credit blocks for a customer.
         #
         # If `include_all_blocks` is set to `true`, all credit blocks (including expired
@@ -53,10 +66,17 @@ module Orb
         # @overload list_by_external_id(external_customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
         #
         # @param external_customer_id [String]
-        # @param currency [String, nil]
-        # @param cursor [String, nil]
-        # @param include_all_blocks [Boolean]
-        # @param limit [Integer]
+        #
+        # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Customers::CreditListByExternalIDResponse>]

data/lib/orb/resources/customers.rb

@@ -12,6 +12,9 @@ module Orb
       # @return [Orb::Resources::Customers::BalanceTransactions]
       attr_reader :balance_transactions
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerCreateParams} for more details.
+      #
       # This operation is used to create an Orb customer, who is party to the core
       # billing relationship. See [Customer](/core-concepts##customer) for an overview
       # of the customer resource.
@@ -27,24 +30,52 @@ module Orb
       #
       # @overload create(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {})
       #
-      # @param email [String]
-      # @param name [String]
+      # @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
+      # ...
+      #
+      # @param name [String] The full name of the customer
+      #
       # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
-      # @param additional_emails [Array<String>, nil]
-      # @param auto_collection [Boolean, nil]
+      #
+      # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
+      # ...
+      #
+      # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
+      # ...
+      #
       # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
-      # @param currency [String, nil]
+      #
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # ...
+      #
       # @param email_delivery [Boolean, nil]
-      # @param external_customer_id [String, nil]
-      # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil]
-      # @param payment_provider_id [String, nil]
+      #
+      # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
+      # ...
+      #
+      # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # ...
+      #
+      # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
+      # ...
+      #
       # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
+      #
       # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
-      # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
-      # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil]
-      # @param timezone [String, nil]
+      #
+      # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
+      #
+      # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # ...
+      #
+      # @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Customer]
@@ -61,6 +92,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerUpdateParams} for more details.
+      #
       # This endpoint can be used to update the `payment_provider`,
       # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
       # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
@@ -70,23 +104,49 @@ module Orb
       # @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
       #
       # @param customer_id [String]
+      #
       # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
-      # @param additional_emails [Array<String>, nil]
-      # @param auto_collection [Boolean, nil]
+      #
+      # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
+      # ...
+      #
+      # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
+      # ...
+      #
       # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
-      # @param currency [String, nil]
-      # @param email [String, nil]
+      #
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # ...
+      #
+      # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
+      #
       # @param email_delivery [Boolean, nil]
-      # @param external_customer_id [String, nil]
-      # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param name [String, nil]
-      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil]
-      # @param payment_provider_id [String, nil]
+      #
+      # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
+      # ...
+      #
+      # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param name [String, nil] The full name of the customer
+      #
+      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # ...
+      #
+      # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
+      # ...
+      #
       # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
+      #
       # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
-      # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
-      # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil]
+      #
+      # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
+      #
+      # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Customer]
@@ -103,6 +163,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerListParams} for more details.
+      #
       # This endpoint returns a list of all customers for an account. The list of
       # customers is ordered starting from the most recently created customer. This
       # endpoint follows Orb's
@@ -113,11 +176,18 @@ module Orb
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
       #
       # @param created_at_gt [Time, nil]
+      #
       # @param created_at_gte [Time, nil]
+      #
       # @param created_at_lt [Time, nil]
+      #
       # @param created_at_lte [Time, nil]
-      # @param cursor [String, nil]
-      # @param limit [Integer]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Customer>]
@@ -271,6 +341,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
+      #
       # This endpoint is used to update customer details given an `external_customer_id`
       # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the
       # resource and semantics of this endpoint exactly mirror
@@ -279,23 +352,49 @@ module Orb
       # @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
       #
       # @param id [String]
+      #
       # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
-      # @param additional_emails [Array<String>, nil]
-      # @param auto_collection [Boolean, nil]
+      #
+      # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
+      # ...
+      #
+      # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
+      # ...
+      #
       # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
-      # @param currency [String, nil]
-      # @param email [String, nil]
+      #
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # ...
+      #
+      # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
+      #
       # @param email_delivery [Boolean, nil]
-      # @param external_customer_id [String, nil]
-      # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param name [String, nil]
-      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
-      # @param payment_provider_id [String, nil]
+      #
+      # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
+      # ...
+      #
+      # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param name [String, nil] The full name of the customer
+      #
+      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # ...
+      #
+      # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
+      # ...
+      #
       # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
+      #
       # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
-      # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
-      # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil]
+      #
+      # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
+      #
+      # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Customer]

data/lib/orb/resources/dimensional_price_groups.rb

@@ -6,6 +6,9 @@ module Orb
       # @return [Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID]
       attr_reader :external_dimensional_price_group_id
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::DimensionalPriceGroupCreateParams} for more details.
+      #
       # A dimensional price group is used to partition the result of a billable metric
       # by a set of dimensions. Prices in a price group must specify the parition used
       # to derive their usage.
@@ -18,10 +21,16 @@ module Orb
       # @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
       #
       # @param billable_metric_id [String]
-      # @param dimensions [Array<String>]
+      #
+      # @param dimensions [Array<String>] The set of keys (in order) used to disambiguate prices in the group.
+      #
       # @param name [String]
+      #
       # @param external_dimensional_price_group_id [String, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::DimensionalPriceGroup]
@@ -57,12 +66,18 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::DimensionalPriceGroupListParams} for more details.
+      #
       # List dimensional price groups
       #
       # @overload list(cursor: nil, limit: nil, request_options: {})
       #
-      # @param cursor [String, nil]
-      # @param limit [Integer]
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::DimensionalPriceGroup>]

data/lib/orb/resources/events/backfills.rb

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Events
       class Backfills
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Events::BackfillCreateParams} for more details.
+        #
         # Creating the backfill enables adding or replacing past events, even those that
         # are older than the ingestion grace period. Performing a backfill in Orb involves
         # 3 steps:
@@ -44,13 +47,27 @@ module Orb
         #
         # @overload create(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {})
         #
-        # @param timeframe_end [Time]
-        # @param timeframe_start [Time]
-        # @param close_time [Time, nil]
-        # @param customer_id [String, nil]
-        # @param deprecation_filter [String, nil]
-        # @param external_customer_id [String, nil]
-        # @param replace_existing_events [Boolean]
+        # @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
+        # ...
+        #
+        # @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
+        # ...
+        #
+        # @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
+        # ...
+        #
+        # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
+        # ...
+        #
+        # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+        # ...
+        #
+        # @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
+        # ...
+        #
+        # @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
+        # ...
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Events::BackfillCreateResponse]
@@ -67,6 +84,9 @@ module Orb
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Events::BackfillListParams} for more details.
+        #
         # This endpoint returns a list of all backfills in a list format.
         #
         # The list of backfills is ordered starting from the most recently created
@@ -77,8 +97,11 @@ module Orb
         #
         # @overload list(cursor: nil, limit: nil, request_options: {})
         #
-        # @param cursor [String, nil]
-        # @param limit [Integer]
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Events::BackfillListResponse>]

data/lib/orb/resources/events/volume.rb

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Events
       class Volume
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Events::VolumeListParams} for more details.
+        #
         # This endpoint returns the event volume for an account in a
         # [paginated list format](/api-reference/pagination).
         #
@@ -20,10 +23,17 @@ module Orb
         #
         # @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {})
         #
-        # @param timeframe_start [Time]
-        # @param cursor [String, nil]
-        # @param limit [Integer]
-        # @param timeframe_end [Time]
+        # @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date
+        # ...
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
+        # @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe
+        # ...
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Events::EventVolumes]