orb-billing 0.5.1 → 0.5.3

data/lib/orb/resources/customers.rb

@@ -34,13 +34,13 @@ module Orb
       #
       # @param name [String] The full name of the customer
       #
-      # @param accounting_sync_configuration [Orb::CustomerCreateParams::AccountingSyncConfiguration, nil]
+      # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, 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::CustomerCreateParams::BillingAddress, nil]
+      # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
       #
       # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
       #
@@ -48,27 +48,27 @@ module Orb
       #
       # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
       #
-      # @param hierarchy [Orb::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      # @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::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # @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::CustomerCreateParams::ReportingConfiguration, nil]
+      # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
       #
-      # @param shipping_address [Orb::CustomerCreateParams::ShippingAddress, nil]
+      # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
       #
-      # @param tax_configuration [Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
+      # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
       #
-      # @param tax_id [Orb::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # @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::Customer]
+      # @return [Orb::Models::Customer]
       #
       # @see Orb::Models::CustomerCreateParams
       def create(params)
@@ -95,13 +95,13 @@ module Orb
       #
       # @param customer_id [String]
       #
-      # @param accounting_sync_configuration [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
+      # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, 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::CustomerUpdateParams::BillingAddress, nil]
+      # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
       #
       # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
       #
@@ -111,27 +111,27 @@ module Orb
       #
       # @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::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      # @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::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # @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::CustomerUpdateParams::ReportingConfiguration, nil]
+      # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
       #
-      # @param shipping_address [Orb::CustomerUpdateParams::ShippingAddress, nil]
+      # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
       #
-      # @param tax_configuration [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
+      # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
       #
-      # @param tax_id [Orb::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # @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::Customer]
+      # @return [Orb::Models::Customer]
       #
       # @see Orb::Models::CustomerUpdateParams
       def update(customer_id, params = {})
@@ -171,7 +171,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Internal::Page<Orb::Customer>]
+      # @return [Orb::Internal::Page<Orb::Models::Customer>]
       #
       # @see Orb::Models::CustomerListParams
       def list(params = {})
@@ -236,7 +236,7 @@ module Orb
       # @param customer_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Customer]
+      # @return [Orb::Models::Customer]
       #
       # @see Orb::Models::CustomerFetchParams
       def fetch(customer_id, params = {})
@@ -259,7 +259,7 @@ module Orb
       # @param external_customer_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Customer]
+      # @return [Orb::Models::Customer]
       #
       # @see Orb::Models::CustomerFetchByExternalIDParams
       def fetch_by_external_id(external_customer_id, params = {})
@@ -334,13 +334,13 @@ module Orb
       #
       # @param id [String]
       #
-      # @param accounting_sync_configuration [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
+      # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, 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::CustomerUpdateByExternalIDParams::BillingAddress, nil]
+      # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
       #
       # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
       #
@@ -350,27 +350,27 @@ module Orb
       #
       # @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::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      # @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::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # @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::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
+      # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
       #
-      # @param shipping_address [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
+      # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
       #
-      # @param tax_configuration [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
+      # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
       #
-      # @param tax_id [Orb::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # @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::Customer]
+      # @return [Orb::Models::Customer]
       #
       # @see Orb::Models::CustomerUpdateByExternalIDParams
       def update_by_external_id(id, params = {})

data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb

@@ -11,7 +11,7 @@ module Orb
         # @param external_dimensional_price_group_id [String]
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Orb::DimensionalPriceGroup]
+        # @return [Orb::Models::DimensionalPriceGroup]
         #
         # @see Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDRetrieveParams
         def retrieve(external_dimensional_price_group_id, params = {})

data/lib/orb/resources/dimensional_price_groups.rb

@@ -32,7 +32,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::DimensionalPriceGroup]
+      # @return [Orb::Models::DimensionalPriceGroup]
       #
       # @see Orb::Models::DimensionalPriceGroupCreateParams
       def create(params)
@@ -53,7 +53,7 @@ module Orb
       # @param dimensional_price_group_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::DimensionalPriceGroup]
+      # @return [Orb::Models::DimensionalPriceGroup]
       #
       # @see Orb::Models::DimensionalPriceGroupRetrieveParams
       def retrieve(dimensional_price_group_id, params = {})
@@ -78,7 +78,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Internal::Page<Orb::DimensionalPriceGroup>]
+      # @return [Orb::Internal::Page<Orb::Models::DimensionalPriceGroup>]
       #
       # @see Orb::Models::DimensionalPriceGroupListParams
       def list(params = {})

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

@@ -33,7 +33,7 @@ module Orb
         #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Orb::Events::EventVolumes]
+        # @return [Orb::Models::Events::EventVolumes]
         #
         # @see Orb::Models::Events::VolumeListParams
         def list(params)

data/lib/orb/resources/events.rb

@@ -356,7 +356,7 @@ module Orb
       #
       # @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {})
       #
-      # @param events [Array<Orb::EventIngestParams::Event>] Body param:
+      # @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
       #

data/lib/orb/resources/invoices.rb

@@ -14,13 +14,13 @@ module Orb
       #
       # @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::InvoiceCreateParams::LineItem>]
+      # @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
       #
       # @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::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil] An optional discount to attach to the invoice.
+      # @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
       #
@@ -32,7 +32,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Invoice]
+      # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoiceCreateParams
       def create(params)
@@ -57,7 +57,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Invoice]
+      # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoiceUpdateParams
       def update(invoice_id, params = {})
@@ -100,7 +100,7 @@ module Orb
       #
       # @param customer_id [String, nil]
       #
-      # @param date_type [Symbol, Orb::InvoiceListParams::DateType, nil]
+      # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
       #
       # @param due_date [Date, nil]
       #
@@ -124,13 +124,13 @@ module Orb
       #
       # @param limit [Integer] The number of items to fetch. Defaults to 20.
       #
-      # @param status [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
+      # @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::Invoice>]
+      # @return [Orb::Internal::Page<Orb::Models::Invoice>]
       #
       # @see Orb::Models::InvoiceListParams
       def list(params = {})
@@ -162,7 +162,7 @@ module Orb
       # @param invoice_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Invoice]
+      # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoiceFetchParams
       def fetch(invoice_id, params = {})
@@ -215,7 +215,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Invoice]
+      # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoiceIssueParams
       def issue(invoice_id, params = {})
@@ -244,7 +244,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Invoice]
+      # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoiceMarkPaidParams
       def mark_paid(invoice_id, params)
@@ -266,7 +266,7 @@ module Orb
       # @param invoice_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Invoice]
+      # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoicePayParams
       def pay(invoice_id, params = {})
@@ -295,7 +295,7 @@ module Orb
       # @param invoice_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Invoice]
+      # @return [Orb::Models::Invoice]
       #
       # @see Orb::Models::InvoiceVoidParams
       def void(invoice_id, params = {})

data/lib/orb/resources/items.rb

@@ -11,7 +11,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Item]
+      # @return [Orb::Models::Item]
       #
       # @see Orb::Models::ItemCreateParams
       def create(params)
@@ -24,11 +24,11 @@ module Orb
       # @overload update(item_id, external_connections: nil, name: nil, request_options: {})
       #
       # @param item_id [String]
-      # @param external_connections [Array<Orb::ItemUpdateParams::ExternalConnection>, nil]
+      # @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
       # @param name [String, nil]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Item]
+      # @return [Orb::Models::Item]
       #
       # @see Orb::Models::ItemUpdateParams
       def update(item_id, params = {})
@@ -56,7 +56,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Internal::Page<Orb::Item>]
+      # @return [Orb::Internal::Page<Orb::Models::Item>]
       #
       # @see Orb::Models::ItemListParams
       def list(params = {})
@@ -78,7 +78,7 @@ module Orb
       # @param item_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Item]
+      # @return [Orb::Models::Item]
       #
       # @see Orb::Models::ItemFetchParams
       def fetch(item_id, params = {})

data/lib/orb/resources/metrics.rb

@@ -24,7 +24,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::BillableMetric]
+      # @return [Orb::Models::BillableMetric]
       #
       # @see Orb::Models::MetricCreateParams
       def create(params)
@@ -53,7 +53,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::BillableMetric]
+      # @return [Orb::Models::BillableMetric]
       #
       # @see Orb::Models::MetricUpdateParams
       def update(metric_id, params = {})
@@ -90,7 +90,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Internal::Page<Orb::BillableMetric>]
+      # @return [Orb::Internal::Page<Orb::Models::BillableMetric>]
       #
       # @see Orb::Models::MetricListParams
       def list(params = {})
@@ -118,7 +118,7 @@ module Orb
       # @param metric_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::BillableMetric]
+      # @return [Orb::Models::BillableMetric]
       #
       # @see Orb::Models::MetricFetchParams
       def fetch(metric_id, params = {})

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

@@ -22,7 +22,7 @@ module Orb
         #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Orb::Plan]
+        # @return [Orb::Models::Plan]
         #
         # @see Orb::Models::Plans::ExternalPlanIDUpdateParams
         def update(other_external_plan_id, params = {})
@@ -58,7 +58,7 @@ module Orb
         # @param external_plan_id [String]
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Orb::Plan]
+        # @return [Orb::Models::Plan]
         #
         # @see Orb::Models::Plans::ExternalPlanIDFetchParams
         def fetch(external_plan_id, params = {})

data/lib/orb/resources/plans.rb

@@ -17,7 +17,7 @@ module Orb
       #
       # @param name [String]
       #
-      # @param prices [Array<Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      # @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.
       #
@@ -27,11 +27,11 @@ module Orb
       #
       # @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
       #
-      # @param status [Symbol, Orb::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
+      # @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::Plan]
+      # @return [Orb::Models::Plan]
       #
       # @see Orb::Models::PlanCreateParams
       def create(params)
@@ -57,7 +57,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Plan]
+      # @return [Orb::Models::Plan]
       #
       # @see Orb::Models::PlanUpdateParams
       def update(plan_id, params = {})
@@ -94,11 +94,11 @@ module Orb
       #
       # @param limit [Integer] The number of items to fetch. Defaults to 20.
       #
-      # @param status [Symbol, Orb::PlanListParams::Status] The plan status to filter to ('active', 'archived', or 'draft').
+      # @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::Plan>]
+      # @return [Orb::Internal::Page<Orb::Models::Plan>]
       #
       # @see Orb::Models::PlanListParams
       def list(params = {})
@@ -141,7 +141,7 @@ module Orb
       # @param plan_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Plan]
+      # @return [Orb::Models::Plan]
       #
       # @see Orb::Models::PlanFetchParams
       def fetch(plan_id, params = {})

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

@@ -19,7 +19,7 @@ module Orb
         #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
+        # @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 = {})
@@ -42,7 +42,7 @@ module Orb
         # @param external_price_id [String]
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
+        # @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 = {})

data/lib/orb/resources/prices.rb

@@ -22,33 +22,33 @@ 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::PriceCreateParams::Cadence] The cadence to bill for this price on.
+      # @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::PriceCreateParams::ModelType]
+      # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType]
       #
       # @param name [String] The name of the price.
       #
-      # @param unit_config [Orb::PriceCreateParams::UnitConfig]
+      # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig]
       #
-      # @param package_config [Orb::PriceCreateParams::PackageConfig]
+      # @param package_config [Orb::Models::PriceCreateParams::PackageConfig]
       #
-      # @param matrix_config [Orb::PriceCreateParams::MatrixConfig]
+      # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig]
       #
-      # @param matrix_with_allocation_config [Orb::PriceCreateParams::MatrixWithAllocationConfig]
+      # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig]
       #
-      # @param tiered_config [Orb::PriceCreateParams::TieredConfig]
+      # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig]
       #
-      # @param tiered_bps_config [Orb::PriceCreateParams::TieredBpsConfig]
+      # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig]
       #
-      # @param bps_config [Orb::PriceCreateParams::BpsConfig]
+      # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig]
       #
-      # @param bulk_bps_config [Orb::PriceCreateParams::BulkBpsConfig]
+      # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig]
       #
-      # @param bulk_config [Orb::PriceCreateParams::BulkConfig]
+      # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig]
       #
       # @param threshold_total_amount_config [Hash{Symbol=>Object}]
       #
@@ -92,7 +92,7 @@ module Orb
       #
       # @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::PriceCreateParams::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
+      # @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.
       #
@@ -102,13 +102,13 @@ module Orb
       #
       # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
       #
-      # @param invoicing_cycle_configuration [Orb::PriceCreateParams::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
+      # @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::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
+      # @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::PriceCreateParams
       def create(params)
@@ -131,7 +131,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
+      # @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::PriceUpdateParams
       def update(price_id, params = {})
@@ -159,7 +159,7 @@ module Orb
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Internal::Page<Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk>]
+      # @return [Orb::Internal::Page<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::PriceListParams
       def list(params = {})
@@ -238,7 +238,7 @@ module Orb
       # @param price_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
+      # @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::PriceFetchParams
       def fetch(price_id, params = {})