orb-billing 0.2.0 → 0.3.1

data/lib/orb/resources/events.rb

@@ -9,6 +9,9 @@ module Orb
       # @return [Orb::Resources::Events::Volume]
       attr_reader :volume
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::EventUpdateParams} for more details.
+      #
       # This endpoint is used to amend a single usage event with a given `event_id`.
       # `event_id` refers to the `idempotency_key` passed in during ingestion. The event
       # will maintain its existing `event_id` after the amendment.
@@ -58,11 +61,20 @@ module Orb
       # @overload update(event_id, event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
       #
       # @param event_id [String]
-      # @param event_name [String]
-      # @param properties [Object]
-      # @param timestamp [Time]
-      # @param customer_id [String, nil]
-      # @param external_customer_id [String, nil]
+      #
+      # @param event_name [String] A name to meaningfully identify the action or event type.
+      #
+      # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
+      # ...
+      #
+      # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
+      # ...
+      #
+      # @param customer_id [String, nil] The Orb Customer identifier
+      #
+      # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::EventUpdateResponse]
@@ -137,6 +149,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::EventIngestParams} for more details.
+      #
       # Orb's event ingestion model and API is designed around two core principles:
       #
       # 1. **Data fidelity**: The accuracy of your billing model depends on a robust
@@ -344,9 +359,14 @@ module Orb
       #
       # @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {})
       #
-      # @param events [Array<Orb::Models::EventIngestParams::Event>]
-      # @param backfill_id [String, nil]
-      # @param debug [Boolean]
+      # @param events [Array<Orb::Models::EventIngestParams::Event>] Body param:
+      #
+      # @param backfill_id [String, nil] Query param: If this ingestion request is part of a backfill, this parameter tie
+      # ...
+      #
+      # @param debug [Boolean] Query param: Flag to enable additional debug information in the endpoint respons
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::EventIngestResponse]
@@ -365,6 +385,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::EventSearchParams} for more details.
+      #
       # This endpoint returns a filtered set of events for an account in a
       # [paginated list format](/api-reference/pagination).
       #
@@ -383,9 +406,15 @@ module Orb
       #
       # @overload search(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {})
       #
-      # @param event_ids [Array<String>]
-      # @param timeframe_end [Time, nil]
-      # @param timeframe_start [Time, nil]
+      # @param event_ids [Array<String>] This is an explicit array of IDs to filter by. Note that an event's ID is the id
+      # ...
+      #
+      # @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified
+      # ...
+      #
+      # @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::EventSearchResponse]

data/lib/orb/resources/invoice_line_items.rb

@@ -3,17 +3,27 @@
 module Orb
   module Resources
     class InvoiceLineItems
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceLineItemCreateParams} for more details.
+      #
       # This creates a one-off fixed fee invoice line item on an Invoice. This can only
       # be done for invoices that are in a `draft` status.
       #
       # @overload create(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {})
       #
-      # @param amount [String]
-      # @param end_date [Date]
-      # @param invoice_id [String]
-      # @param name [String]
-      # @param quantity [Float]
-      # @param start_date [Date]
+      # @param amount [String] The total amount in the invoice's currency to add to the line item.
+      #
+      # @param end_date [Date] A date string to specify the line item's end date in the customer's timezone.
+      #
+      # @param invoice_id [String] The id of the Invoice to add this line item.
+      #
+      # @param name [String] The item name associated with this line item. If an item with the same name exis
+      # ...
+      #
+      # @param quantity [Float] The number of units on the line item
+      #
+      # @param start_date [Date] A date string to specify the line item's start date in the customer's timezone.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::InvoiceLineItemCreateResponse]

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::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>] 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,10 +14,13 @@ 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]
+        # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
         #
         # @see Orb::Models::Prices::ExternalPriceIDUpdateParams
         def update(external_price_id, params = {})
@@ -37,7 +43,7 @@ module Orb
         # @param external_price_id [String]
         # @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]
+        # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
         #
         # @see Orb::Models::Prices::ExternalPriceIDFetchParams
         def fetch(external_price_id, params = {})