orb-billing 0.3.0 → 0.3.2

data/lib/orb/models/customers/cost_list_response.rb

@@ -57,8 +57,8 @@ module Orb
             # @!attribute price
             #   The price object
             #
-            #   @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]
-            required :price, union: -> { Orb::Models::Price }
+            #   @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]
+            required :price, union: -> { Orb::Price }
 
             # @!attribute price_id
             #   The price the cost is associated with
@@ -85,7 +85,7 @@ module Orb
             optional :quantity, Float, nil?: true
 
             # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
-            #   @param price [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] The price object
+            #   @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] The price object
             #
             #   @param price_id [String] The price the cost is associated with
             #

data/lib/orb/models/customers/credit_list_by_external_id_params.rb

@@ -41,10 +41,8 @@ module Orb
         #   @param currency [String, nil] The ledger currency or custom pricing unit to use.
         #
         #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
-        #   ...
         #
         #   @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
-        #   ...
         #
         #   @param limit [Integer] The number of items to fetch. Defaults to 20.
         #

data/lib/orb/models/customers/credit_list_params.rb

@@ -41,10 +41,8 @@ module Orb
         #   @param currency [String, nil] The ledger currency or custom pricing unit to use.
         #
         #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
-        #   ...
         #
         #   @param include_all_blocks [Boolean] If set to True, all expired and depleted blocks, as well as active block will be
-        #   ...
         #
         #   @param limit [Integer] The number of items to fetch. Defaults to 20.
         #

data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb

@@ -18,9 +18,11 @@ module Orb
 
           # @!attribute entry_type
           #
-          #   @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
+          #   @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
           required :entry_type,
-                   enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType }
+                   enum: -> {
+                     Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType
+                   }
 
           # @!attribute currency
           #   The currency or custom pricing unit to use for this ledger entry. If this is a
@@ -56,9 +58,9 @@ module Orb
           #   per_unit_cost_basis, as the calculation of the invoice total is done on that
           #   basis.
           #
-          #   @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
+          #   @return [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
           optional :invoice_settings,
-                   -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings },
+                   -> { Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings },
                    nil?: true
 
           # @!attribute metadata
@@ -93,9 +95,9 @@ module Orb
           # @!attribute void_reason
           #   Can only be specified when `entry_type=void`. The reason for the void.
           #
-          #   @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
+          #   @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
           optional :void_reason,
-                   enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason },
+                   enum: -> { Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason },
                    nil?: true
 
           # @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
@@ -104,36 +106,28 @@ module Orb
           #   details.
           #
           #   @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
-          #   ...
           #
-          #   @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
+          #   @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
           #
           #   @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
           #
           #   @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
-          #   ...
           #
           #   @param block_id [String] The ID of the block to reverse a decrement from.
           #
           #   @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
-          #   ...
           #
           #   @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
-          #   ...
           #
           #   @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
-          #   ...
           #
-          #   @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
-          #   ...
+          #   @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
           #
           #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
-          #   ...
           #
           #   @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
-          #   ...
           #
-          #   @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
+          #   @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
           #
           #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
@@ -177,7 +171,7 @@ module Orb
 
             # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
             #   Some parameter documentations has been truncated, see
-            #   {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
+            #   {Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
             #   for more details.
             #
             #   Passing `invoice_settings` automatically generates an invoice for the newly
@@ -186,15 +180,12 @@ module Orb
             #   basis.
             #
             #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
-            #   ...
             #
             #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
-            #   ...
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
             #   @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
-            #   ...
           end
 
           # Can only be specified when `entry_type=void`. The reason for the void.