orb-billing 0.3.1 → 0.4.0

data/lib/orb/models/invoice_line_item_create_response.rb

@@ -41,8 +41,8 @@ module Orb
 
       # @!attribute discount
       #
-      #   @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
-      required :discount, union: -> { Orb::Models::Discount }, nil?: true
+      #   @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
+      required :discount, union: -> { Orb::Discount }, nil?: true
 
       # @!attribute end_date
       #   The end date of the range of time applied for this line item's price.
@@ -120,8 +120,8 @@ module Orb
       #   For more on the types of prices, see
       #   [the core concepts documentation](/core-concepts#plan-and-price)
       #
-      #   @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, nil]
-      required :price, union: -> { Orb::Models::Price }, nil?: true
+      #   @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, nil]
+      required :price, union: -> { Orb::Price }, nil?: true
 
       # @!attribute quantity
       #   Either the fixed fee quantity or the usage during the service period.
@@ -170,24 +170,20 @@ module Orb
       #   @param id [String] A unique ID for this line item.
       #
       #   @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
-      #   ...
       #
       #   @param adjustments [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
-      #   ...
       #
       #   @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
-      #   ...
       #
       #   @param credits_applied [String] The number of prepaid credits applied.
       #
-      #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+      #   @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
       #
       #   @param end_date [Time] The end date of the range of time applied for this line item's price.
       #
       #   @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
       #
       #   @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
-      #   ...
       #
       #   @param maximum [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil] This field is deprecated in favor of `adjustments`.
       #
@@ -201,23 +197,19 @@ module Orb
       #
       #   @param partially_invoiced_amount [String] Any amount applied from a partial invoice
       #
-      #   @param price [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, nil] The Price resource represents a price that can be billed on a subscription, resu
-      #   ...
+      #   @param price [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, nil] The Price resource represents a price that can be billed on a subscription, resu
       #
       #   @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
       #
       #   @param start_date [Time] The start date of the range of time applied for this line item's price.
       #
       #   @param sub_line_items [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
-      #   ...
       #
       #   @param subtotal [String] The line amount before before any adjustments.
       #
       #   @param tax_amounts [Array<Orb::Models::InvoiceLineItemCreateResponse::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
-      #   ...
       #
       #   @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
-      #   ...
 
       module Adjustment
         extend Orb::Internal::Type::Union
@@ -290,12 +282,10 @@ module Orb
           #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
           #
           #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-          #   ...
           #
           #   @param reason [String, nil] The reason for the adjustment.
           #
           #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
-          #   ...
           #
           #   @param adjustment_type [Symbol, :usage_discount]
         end
@@ -353,12 +343,10 @@ module Orb
           #   @param amount [String] The value applied by an adjustment.
           #
           #   @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
-          #   ...
           #
           #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
           #
           #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-          #   ...
           #
           #   @param reason [String, nil] The reason for the adjustment.
           #
@@ -420,10 +408,8 @@ module Orb
           #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
           #
           #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-          #   ...
           #
           #   @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
-          #   ...
           #
           #   @param reason [String, nil] The reason for the adjustment.
           #
@@ -491,12 +477,10 @@ module Orb
           #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
           #
           #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-          #   ...
           #
           #   @param item_id [String] The item ID that revenue from this minimum will be attributed to.
           #
           #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
-          #   ...
           #
           #   @param reason [String, nil] The reason for the adjustment.
           #
@@ -558,10 +542,8 @@ module Orb
           #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
           #
           #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
-          #   ...
           #
           #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
-          #   ...
           #
           #   @param reason [String, nil] The reason for the adjustment.
           #
@@ -570,6 +552,18 @@ module Orb
 
         # @!method self.variants
         #   @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias do
+            T.any(
+              Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount,
+              Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount,
+              Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount,
+              Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum,
+              Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum
+            )
+          end
+        end
       end
 
       # @deprecated
@@ -596,7 +590,6 @@ module Orb
         #   This field is deprecated in favor of `adjustments`.
         #
         #   @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
-        #   ...
         #
         #   @param maximum_amount [String] Maximum amount applied
       end
@@ -625,7 +618,6 @@ module Orb
         #   This field is deprecated in favor of `adjustments`.
         #
         #   @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
-        #   ...
         #
         #   @param minimum_amount [String] Minimum amount applied
       end
@@ -873,6 +865,16 @@ module Orb
 
         # @!method self.variants
         #   @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias do
+            T.any(
+              Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix,
+              Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier,
+              Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null
+            )
+          end
+        end
       end
 
       class TaxAmount < Orb::Internal::Type::BaseModel

data/lib/orb/models/invoice_list_params.rb

@@ -36,8 +36,8 @@ module Orb
 
       # @!attribute date_type
       #
-      #   @return [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
-      optional :date_type, enum: -> { Orb::Models::InvoiceListParams::DateType }, nil?: true
+      #   @return [Symbol, Orb::InvoiceListParams::DateType, nil]
+      optional :date_type, enum: -> { Orb::InvoiceListParams::DateType }, nil?: true
 
       # @!attribute due_date
       #
@@ -101,10 +101,8 @@ module Orb
 
       # @!attribute status
       #
-      #   @return [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
-      optional :status,
-               -> { Orb::Internal::Type::ArrayOf[enum: Orb::Models::InvoiceListParams::Status] },
-               nil?: true
+      #   @return [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
+      optional :status, -> { Orb::Internal::Type::ArrayOf[enum: Orb::InvoiceListParams::Status] }, nil?: true
 
       # @!attribute subscription_id
       #
@@ -122,16 +120,14 @@ module Orb
       #   @param amount_lt [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 date_type [Symbol, Orb::InvoiceListParams::DateType, nil]
       #
       #   @param due_date [Date, 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]
       #
@@ -151,7 +147,7 @@ module Orb
       #
       #   @param limit [Integer] The number of items to fetch. Defaults to 20.
       #
-      #   @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
+      #   @param status [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
       #
       #   @param subscription_id [String, nil]
       #

data/lib/orb/models/invoice_update_params.rb

@@ -20,7 +20,6 @@ module Orb
       #   {Orb::Models::InvoiceUpdateParams} for more details.
       #
       #   @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}]
     end

data/lib/orb/models/item.rb

@@ -16,8 +16,8 @@ module Orb
 
       # @!attribute external_connections
       #
-      #   @return [Array<Orb::Models::Item::ExternalConnection>]
-      required :external_connections, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Item::ExternalConnection] }
+      #   @return [Array<Orb::Item::ExternalConnection>]
+      required :external_connections, -> { Orb::Internal::Type::ArrayOf[Orb::Item::ExternalConnection] }
 
       # @!attribute name
       #
@@ -31,15 +31,14 @@ module Orb
       #
       #   @param id [String]
       #   @param created_at [Time]
-      #   @param external_connections [Array<Orb::Models::Item::ExternalConnection>]
+      #   @param external_connections [Array<Orb::Item::ExternalConnection>]
       #   @param name [String]
 
       class ExternalConnection < Orb::Internal::Type::BaseModel
         # @!attribute external_connection_name
         #
-        #   @return [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
-        required :external_connection_name,
-                 enum: -> { Orb::Models::Item::ExternalConnection::ExternalConnectionName }
+        #   @return [Symbol, Orb::Item::ExternalConnection::ExternalConnectionName]
+        required :external_connection_name, enum: -> { Orb::Item::ExternalConnection::ExternalConnectionName }
 
         # @!attribute external_entity_id
         #
@@ -47,10 +46,10 @@ module Orb
         required :external_entity_id, String
 
         # @!method initialize(external_connection_name:, external_entity_id:)
-        #   @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
+        #   @param external_connection_name [Symbol, Orb::Item::ExternalConnection::ExternalConnectionName]
         #   @param external_entity_id [String]
 
-        # @see Orb::Models::Item::ExternalConnection#external_connection_name
+        # @see Orb::Item::ExternalConnection#external_connection_name
         module ExternalConnectionName
           extend Orb::Internal::Type::Enum
 

data/lib/orb/models/item_list_params.rb

@@ -25,7 +25,6 @@ module Orb
       #   {Orb::Models::ItemListParams} for more details.
       #
       #   @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.
       #

data/lib/orb/models/item_update_params.rb

@@ -9,9 +9,9 @@ module Orb
 
       # @!attribute external_connections
       #
-      #   @return [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
+      #   @return [Array<Orb::ItemUpdateParams::ExternalConnection>, nil]
       optional :external_connections,
-               -> { Orb::Internal::Type::ArrayOf[Orb::Models::ItemUpdateParams::ExternalConnection] },
+               -> { Orb::Internal::Type::ArrayOf[Orb::ItemUpdateParams::ExternalConnection] },
                nil?: true
 
       # @!attribute name
@@ -20,16 +20,16 @@ module Orb
       optional :name, String, nil?: true
 
       # @!method initialize(external_connections: nil, name: nil, request_options: {})
-      #   @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
+      #   @param external_connections [Array<Orb::ItemUpdateParams::ExternalConnection>, nil]
       #   @param name [String, nil]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class ExternalConnection < Orb::Internal::Type::BaseModel
         # @!attribute external_connection_name
         #
-        #   @return [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
+        #   @return [Symbol, Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
         required :external_connection_name,
-                 enum: -> { Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName }
+                 enum: -> { Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName }
 
         # @!attribute external_entity_id
         #
@@ -37,10 +37,10 @@ module Orb
         required :external_entity_id, String
 
         # @!method initialize(external_connection_name:, external_entity_id:)
-        #   @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
+        #   @param external_connection_name [Symbol, Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
         #   @param external_entity_id [String]
 
-        # @see Orb::Models::ItemUpdateParams::ExternalConnection#external_connection_name
+        # @see Orb::ItemUpdateParams::ExternalConnection#external_connection_name
         module ExternalConnectionName
           extend Orb::Internal::Type::Enum
 

data/lib/orb/models/metric_create_params.rb

@@ -52,7 +52,6 @@ module Orb
       #   @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}]
     end

data/lib/orb/models/metric_list_params.rb

@@ -53,7 +53,6 @@ module Orb
       #   @param created_at_lte [Time, nil]
       #
       #   @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.
       #

data/lib/orb/models/metric_update_params.rb

@@ -20,7 +20,6 @@ module Orb
       #   {Orb::Models::MetricUpdateParams} for more details.
       #
       #   @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}]
     end

data/lib/orb/models/percentage_discount.rb

@@ -12,8 +12,8 @@ module Orb
 
       # @!attribute discount_type
       #
-      #   @return [Symbol, Orb::Models::PercentageDiscount::DiscountType]
-      required :discount_type, enum: -> { Orb::Models::PercentageDiscount::DiscountType }
+      #   @return [Symbol, Orb::PercentageDiscount::DiscountType]
+      required :discount_type, enum: -> { Orb::PercentageDiscount::DiscountType }
 
       # @!attribute percentage_discount
       #   Only available if discount_type is `percentage`. This is a number between 0
@@ -28,20 +28,18 @@ module Orb
       optional :reason, String, nil?: true
 
       # @!method initialize(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Orb::Models::PercentageDiscount} for more details.
+      #   Some parameter documentations has been truncated, see {Orb::PercentageDiscount}
+      #   for more details.
       #
       #   @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #   ...
       #
-      #   @param discount_type [Symbol, Orb::Models::PercentageDiscount::DiscountType]
+      #   @param discount_type [Symbol, Orb::PercentageDiscount::DiscountType]
       #
       #   @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and
-      #   ...
       #
       #   @param reason [String, nil]
 
-      # @see Orb::Models::PercentageDiscount#discount_type
+      # @see Orb::PercentageDiscount#discount_type
       module DiscountType
         extend Orb::Internal::Type::Enum