orb-billing 0.2.0 → 0.3.0

data/lib/orb/resources/invoices.rb

@@ -3,20 +3,40 @@
 module Orb
   module Resources
     class Invoices
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceCreateParams} for more details.
+      #
       # This endpoint is used to create a one-off invoice for a customer.
       #
       # @overload create(currency:, invoice_date:, line_items:, net_terms:, customer_id: nil, discount: nil, external_customer_id: nil, memo: nil, metadata: nil, will_auto_issue: nil, request_options: {})
       #
-      # @param currency [String]
-      # @param invoice_date [Time]
+      # @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i
+      # ...
+      #
+      # @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
+      # ...
+      #
       # @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
-      # @param net_terms [Integer]
-      # @param customer_id [String, nil]
-      # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
-      # @param external_customer_id [String, nil]
-      # @param memo [String, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param will_auto_issue [Boolean]
+      #
+      # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
+      # ...
+      #
+      # @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
+      # ...
+      #
+      # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice.
+      #
+      # @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of
+      # ...
+      #
+      # @param memo [String, nil] An optional memo to attach to the invoice.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param will_auto_issue [Boolean] When true, this invoice will be submitted for issuance upon creation. When false
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Invoice]
@@ -33,6 +53,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceUpdateParams} for more details.
+      #
       # This endpoint allows you to update the `metadata` property on an invoice. If you
       # pass null for the metadata value, it will clear any existing metadata for that
       # invoice.
@@ -42,7 +65,10 @@ module Orb
       # @overload update(invoice_id, metadata: nil, request_options: {})
       #
       # @param invoice_id [String]
-      # @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::Invoice]
@@ -59,6 +85,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceListParams} for more details.
+      #
       # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an
       # account in a list format.
       #
@@ -76,24 +105,45 @@ module Orb
       # @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
       #
       # @param amount [String, nil]
+      #
       # @param amount_gt [String, nil]
+      #
       # @param amount_lt [String, nil]
-      # @param cursor [String, nil]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
       # @param customer_id [String, nil]
+      #
       # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
+      #
       # @param due_date [Date, nil]
-      # @param due_date_window [String, nil]
+      #
+      # @param due_date_window [String, nil] Filters invoices by their due dates within a specific time range in the past. Sp
+      # ...
+      #
       # @param due_date_gt [Date, nil]
+      #
       # @param due_date_lt [Date, nil]
+      #
       # @param external_customer_id [String, nil]
+      #
       # @param invoice_date_gt [Time, nil]
+      #
       # @param invoice_date_gte [Time, nil]
+      #
       # @param invoice_date_lt [Time, nil]
+      #
       # @param invoice_date_lte [Time, nil]
+      #
       # @param is_recurring [Boolean, nil]
-      # @param limit [Integer]
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
       # @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
+      #
       # @param subscription_id [String, nil]
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Invoice>]
@@ -163,6 +213,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceIssueParams} for more details.
+      #
       # This endpoint allows an eligible invoice to be issued manually. This is only
       # possible with invoices where status is `draft`, `will_auto_issue` is false, and
       # an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
@@ -173,7 +226,10 @@ module Orb
       # @overload issue(invoice_id, synchronous: nil, request_options: {})
       #
       # @param invoice_id [String]
-      # @param synchronous [Boolean]
+      #
+      # @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Invoice]
@@ -196,9 +252,13 @@ module Orb
       # @overload mark_paid(invoice_id, payment_received_date:, external_id: nil, notes: nil, request_options: {})
       #
       # @param invoice_id [String]
-      # @param payment_received_date [Date]
-      # @param external_id [String, nil]
-      # @param notes [String, nil]
+      #
+      # @param payment_received_date [Date] A date string to specify the date of the payment.
+      #
+      # @param external_id [String, nil] An optional external ID to associate with the payment.
+      #
+      # @param notes [String, nil] An optional note to associate with the payment.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Invoice]

data/lib/orb/resources/items.rb

@@ -7,7 +7,8 @@ module Orb
       #
       # @overload create(name:, request_options: {})
       #
-      # @param name [String]
+      # @param name [String] The name of the item.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Item]
@@ -41,13 +42,19 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::ItemListParams} for more details.
+      #
       # This endpoint returns a list of all Items, ordered in descending order by
       # creation time.
       #
       # @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::Item>]

data/lib/orb/resources/metrics.rb

@@ -3,17 +3,26 @@
 module Orb
   module Resources
     class Metrics
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::MetricCreateParams} for more details.
+      #
       # This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
       # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
       # description of constructing SQL queries with examples.
       #
       # @overload create(description:, item_id:, name:, sql:, metadata: nil, request_options: {})
       #
-      # @param description [String, nil]
-      # @param item_id [String]
-      # @param name [String]
-      # @param sql [String]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      # @param description [String, nil] A description of the metric.
+      #
+      # @param item_id [String] The id of the item
+      #
+      # @param name [String] The name of the metric.
+      #
+      # @param sql [String] A sql string defining the metric.
+      #
+      # @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::BillableMetric]
@@ -30,6 +39,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::MetricUpdateParams} for more details.
+      #
       # This endpoint allows you to update the `metadata` property on a metric. If you
       # pass `null` for the metadata value, it will clear any existing metadata for that
       # invoice.
@@ -37,7 +49,10 @@ module Orb
       # @overload update(metric_id, metadata: nil, request_options: {})
       #
       # @param metric_id [String]
-      # @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::BillableMetric]
@@ -54,6 +69,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::MetricListParams} for more details.
+      #
       # This endpoint is used to fetch [metric](/core-concepts##metric) details given a
       # metric identifier. It returns information about the metrics including its name,
       # description, and item.
@@ -61,11 +79,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::BillableMetric>]

data/lib/orb/resources/plans/external_plan_id.rb

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Plans
       class ExternalPlanID
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.
+        #
         # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
         # existing plan.
         #
@@ -12,8 +15,13 @@ module Orb
         # @overload update(other_external_plan_id, external_plan_id: nil, metadata: nil, request_options: {})
         #
         # @param other_external_plan_id [String]
-        # @param external_plan_id [String, nil]
-        # @param metadata [Hash{Symbol=>String, nil}, nil]
+        #
+        # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        # ...
+        #
+        # @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::Plan]

data/lib/orb/resources/plans.rb

@@ -6,18 +6,35 @@ module Orb
       # @return [Orb::Resources::Plans::ExternalPlanID]
       attr_reader :external_plan_id
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::PlanCreateParams} for more details.
+      #
       # This endpoint allows creation of plans including their prices.
       #
       # @overload create(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
       #
-      # @param currency [String]
+      # @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan
+      # ...
+      #
       # @param name [String]
-      # @param prices [Array<Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice>]
-      # @param default_invoice_memo [String, nil]
+      #
+      # @param prices [Array<Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      # ...
+      #
+      # @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
+      # ...
+      #
       # @param external_plan_id [String, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param net_terms [Integer, nil]
-      # @param status [Symbol, Orb::Models::PlanCreateParams::Status]
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
+      # ...
+      #
+      # @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Plan]
@@ -28,6 +45,9 @@ module Orb
         @client.request(method: :post, path: "plans", body: parsed, model: Orb::Models::Plan, options: options)
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::PlanUpdateParams} for more details.
+      #
       # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
       # existing plan.
       #
@@ -36,8 +56,13 @@ module Orb
       # @overload update(plan_id, external_plan_id: nil, metadata: nil, request_options: {})
       #
       # @param plan_id [String]
-      # @param external_plan_id [String, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      #
+      # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+      # ...
+      #
+      # @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::Plan]
@@ -54,6 +79,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::PlanListParams} for more details.
+      #
       # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for
       # an account in a list format. The list of plans is ordered starting from the most
       # recently created plan. The response also includes
@@ -63,12 +91,20 @@ module Orb
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: 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 status [Symbol, Orb::Models::PlanListParams::Status]
+      #
+      # @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 status [Symbol, Orb::Models::PlanListParams::Status] The plan status to filter to ('active', 'archived', or 'draft').
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Plan>]

data/lib/orb/resources/prices/external_price_id.rb

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Prices
       class ExternalPriceID
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Prices::ExternalPriceIDUpdateParams} for more details.
+        #
         # This endpoint allows you to update the `metadata` property on a price. If you
         # pass null for the metadata value, it will clear any existing metadata for that
         # price.
@@ -11,7 +14,10 @@ module Orb
         # @overload update(external_price_id, metadata: nil, request_options: {})
         #
         # @param external_price_id [String]
-        # @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::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]

data/lib/orb/resources/prices.rb

@@ -6,6 +6,9 @@ module Orb
       # @return [Orb::Resources::Prices::ExternalPriceID]
       attr_reader :external_price_id
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::PriceCreateParams} for more details.
+      #
       # This endpoint is used to create a [price](/product-catalog/price-configuration).
       # A price created using this endpoint is always an add-on, meaning that it’s not
       # associated with a specific plan and can instead be individually added to
@@ -19,48 +22,96 @@ module Orb
       #
       # @overload create(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {})
       #
-      # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence]
-      # @param currency [String]
-      # @param item_id [String]
+      # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] The cadence to bill for this price on.
+      #
+      # @param currency [String] An ISO 4217 currency string for which this price is billed in.
+      #
+      # @param item_id [String] The id of the item the price will be associated with.
+      #
       # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType]
-      # @param name [String]
+      #
+      # @param name [String] The name of the price.
+      #
       # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig]
+      #
       # @param package_config [Orb::Models::PriceCreateParams::PackageConfig]
+      #
       # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig]
+      #
       # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig]
+      #
       # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig]
+      #
       # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig]
+      #
       # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig]
+      #
       # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig]
+      #
       # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig]
+      #
       # @param threshold_total_amount_config [Hash{Symbol=>Object}]
+      #
       # @param tiered_package_config [Hash{Symbol=>Object}]
+      #
       # @param grouped_tiered_config [Hash{Symbol=>Object}]
+      #
       # @param max_group_tiered_package_config [Hash{Symbol=>Object}]
+      #
       # @param tiered_with_minimum_config [Hash{Symbol=>Object}]
+      #
       # @param package_with_allocation_config [Hash{Symbol=>Object}]
+      #
       # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}]
+      #
       # @param unit_with_percent_config [Hash{Symbol=>Object}]
+      #
       # @param tiered_with_proration_config [Hash{Symbol=>Object}]
+      #
       # @param unit_with_proration_config [Hash{Symbol=>Object}]
+      #
       # @param grouped_allocation_config [Hash{Symbol=>Object}]
+      #
       # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
+      #
       # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
+      #
       # @param matrix_with_display_name_config [Hash{Symbol=>Object}]
+      #
       # @param bulk_with_proration_config [Hash{Symbol=>Object}]
+      #
       # @param grouped_tiered_package_config [Hash{Symbol=>Object}]
+      #
       # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
+      #
       # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
+      #
       # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
-      # @param billable_metric_id [String, nil]
-      # @param billed_in_advance [Boolean, nil]
-      # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil]
-      # @param conversion_rate [Float, nil]
-      # @param external_price_id [String, nil]
-      # @param fixed_price_quantity [Float, nil]
-      # @param invoice_grouping_key [String, nil]
-      # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      #
+      # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
+      # ...
+      #
+      # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
+      # ...
+      #
+      # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
+      # ...
+      #
+      # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
+      #
+      # @param external_price_id [String, nil] An alias for the price.
+      #
+      # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
+      # ...
+      #
+      # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
+      #
+      # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
+      # ...
+      #
+      # @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::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
@@ -71,6 +122,9 @@ module Orb
         @client.request(method: :post, path: "prices", body: parsed, model: Orb::Models::Price, options: options)
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::PriceUpdateParams} for more details.
+      #
       # This endpoint allows you to update the `metadata` property on a price. If you
       # pass null for the metadata value, it will clear any existing metadata for that
       # price.
@@ -78,7 +132,10 @@ module Orb
       # @overload update(price_id, metadata: nil, request_options: {})
       #
       # @param price_id [String]
-      # @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::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
@@ -95,13 +152,19 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::PriceListParams} for more details.
+      #
       # This endpoint is used to list all add-on prices created using the
       # [price creation endpoint](/api-reference/price/create-price).
       #
       # @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::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice>]
@@ -119,6 +182,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::PriceEvaluateParams} for more details.
+      #
       # This endpoint is used to evaluate the output of a price for a given customer and
       # time range. It enables filtering and grouping the output using
       # [computed properties](/extensibility/advanced-metrics#computed-properties),
@@ -144,12 +210,21 @@ module Orb
       # @overload evaluate(price_id, timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {})
       #
       # @param price_id [String]
-      # @param timeframe_end [Time]
-      # @param timeframe_start [Time]
-      # @param customer_id [String, nil]
-      # @param external_customer_id [String, nil]
-      # @param filter [String, nil]
-      # @param grouping_keys [Array<String>]
+      #
+      # @param timeframe_end [Time] The exclusive upper bound for event timestamps
+      #
+      # @param timeframe_start [Time] The inclusive lower bound for event timestamps
+      #
+      # @param customer_id [String, nil] The ID of the customer to which this evaluation is scoped.
+      #
+      # @param external_customer_id [String, nil] The external customer ID of the customer to which this evaluation is scoped.
+      #
+      # @param filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+      # ...
+      #
+      # @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::PriceEvaluateResponse]

data/lib/orb/resources/subscription_changes.rb

@@ -37,8 +37,11 @@ module Orb
       # @overload apply(subscription_change_id, description: nil, previously_collected_amount: nil, request_options: {})
       #
       # @param subscription_change_id [String]
-      # @param description [String, nil]
-      # @param previously_collected_amount [String, nil]
+      #
+      # @param description [String, nil] Description to apply to the balance transaction representing this credit.
+      #
+      # @param previously_collected_amount [String, nil] Amount already collected to apply to the customer's balance.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::SubscriptionChangeApplyResponse]