orb-billing 0.2.0 → 0.3.0

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

@@ -5,8 +5,7 @@ module Orb
     module Customers
       # @see Orb::Resources::Customers::BalanceTransactions#create
       class BalanceTransactionCreateParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute amount
@@ -25,15 +24,14 @@ module Orb
         #   @return [String, nil]
         optional :description, String, nil?: true
 
-        # @!parse
-        #   # @param amount [String]
-        #   # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
-        #   # @param description [String, nil]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(amount:, type:, description: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(amount:, type:, description: nil, request_options: {})
+        #   @param amount [String]
+        #
+        #   @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
+        #
+        #   @param description [String, nil] An optional description that can be specified around this entry.
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
         module Type
           extend Orb::Internal::Type::Enum
@@ -41,11 +39,8 @@ module Orb
           INCREMENT = :increment
           DECREMENT = :decrement
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -65,35 +65,31 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type]
         required :type, enum: -> { Orb::Models::Customers::BalanceTransactionCreateResponse::Type }
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param action [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action]
-        #   # @param amount [String]
-        #   # @param created_at [Time]
-        #   # @param credit_note [Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, nil]
-        #   # @param description [String, nil]
-        #   # @param ending_balance [String]
-        #   # @param invoice [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil]
-        #   # @param starting_balance [String]
-        #   # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type]
-        #   #
-        #   def initialize(
-        #     id:,
-        #     action:,
-        #     amount:,
-        #     created_at:,
-        #     credit_note:,
-        #     description:,
-        #     ending_balance:,
-        #     invoice:,
-        #     starting_balance:,
-        #     type:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Customers::BalanceTransactionCreateResponse} for more details.
+        #
+        #   @param id [String] A unique id for this transaction.
+        #
+        #   @param action [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action]
+        #
+        #   @param amount [String] The value of the amount changed in the transaction.
+        #
+        #   @param created_at [Time] The creation time of this transaction.
+        #
+        #   @param credit_note [Orb::Models::Customers::BalanceTransactionCreateResponse::CreditNote, nil]
+        #
+        #   @param description [String, nil] An optional description provided for manual customer balance adjustments.
+        #
+        #   @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
+        #   ...
+        #
+        #   @param invoice [Orb::Models::Customers::BalanceTransactionCreateResponse::Invoice, nil]
+        #
+        #   @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
+        #   ...
+        #
+        #   @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type]
 
         # @see Orb::Models::Customers::BalanceTransactionCreateResponse#action
         module Action
@@ -109,11 +105,8 @@ module Orb
           OVERPAYMENT_REFUND = :overpayment_refund
           EXTERNAL_PAYMENT = :external_payment
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
         # @see Orb::Models::Customers::BalanceTransactionCreateResponse#credit_note
@@ -124,12 +117,8 @@ module Orb
           #   @return [String]
           required :id, String
 
-          # @!parse
-          #   # @param id [String]
-          #   #
-          #   def initialize(id:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:)
+          #   @param id [String] The id of the Credit note
         end
 
         # @see Orb::Models::Customers::BalanceTransactionCreateResponse#invoice
@@ -140,12 +129,8 @@ module Orb
           #   @return [String]
           required :id, String
 
-          # @!parse
-          #   # @param id [String]
-          #   #
-          #   def initialize(id:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:)
+          #   @param id [String] The Invoice id
         end
 
         # @see Orb::Models::Customers::BalanceTransactionCreateResponse#type
@@ -155,11 +140,8 @@ module Orb
           INCREMENT = :increment
           DECREMENT = :decrement
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -5,8 +5,7 @@ module Orb
     module Customers
       # @see Orb::Resources::Customers::BalanceTransactions#list
       class BalanceTransactionListParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute cursor
@@ -16,16 +15,12 @@ module Orb
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!attribute [r] limit
+        # @!attribute limit
         #   The number of items to fetch. Defaults to 20.
         #
         #   @return [Integer, nil]
         optional :limit, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :limit
-
         # @!attribute operation_time_gt
         #
         #   @return [Time, nil]
@@ -46,29 +41,24 @@ module Orb
         #   @return [Time, nil]
         optional :operation_time_lte, Time, nil?: true
 
-        # @!parse
-        #   # @param cursor [String, nil]
-        #   # @param limit [Integer]
-        #   # @param operation_time_gt [Time, nil]
-        #   # @param operation_time_gte [Time, nil]
-        #   # @param operation_time_lt [Time, nil]
-        #   # @param operation_time_lte [Time, nil]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(
-        #     cursor: nil,
-        #     limit: nil,
-        #     operation_time_gt: nil,
-        #     operation_time_gte: nil,
-        #     operation_time_lt: nil,
-        #     operation_time_lte: nil,
-        #     request_options: {},
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Customers::BalanceTransactionListParams} 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.
+        #
+        #   @param operation_time_gt [Time, nil]
+        #
+        #   @param operation_time_gte [Time, nil]
+        #
+        #   @param operation_time_lt [Time, nil]
+        #
+        #   @param operation_time_lte [Time, nil]
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

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

@@ -65,35 +65,31 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type]
         required :type, enum: -> { Orb::Models::Customers::BalanceTransactionListResponse::Type }
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param action [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action]
-        #   # @param amount [String]
-        #   # @param created_at [Time]
-        #   # @param credit_note [Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, nil]
-        #   # @param description [String, nil]
-        #   # @param ending_balance [String]
-        #   # @param invoice [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil]
-        #   # @param starting_balance [String]
-        #   # @param type [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type]
-        #   #
-        #   def initialize(
-        #     id:,
-        #     action:,
-        #     amount:,
-        #     created_at:,
-        #     credit_note:,
-        #     description:,
-        #     ending_balance:,
-        #     invoice:,
-        #     starting_balance:,
-        #     type:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Customers::BalanceTransactionListResponse} for more details.
+        #
+        #   @param id [String] A unique id for this transaction.
+        #
+        #   @param action [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action]
+        #
+        #   @param amount [String] The value of the amount changed in the transaction.
+        #
+        #   @param created_at [Time] The creation time of this transaction.
+        #
+        #   @param credit_note [Orb::Models::Customers::BalanceTransactionListResponse::CreditNote, nil]
+        #
+        #   @param description [String, nil] An optional description provided for manual customer balance adjustments.
+        #
+        #   @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
+        #   ...
+        #
+        #   @param invoice [Orb::Models::Customers::BalanceTransactionListResponse::Invoice, nil]
+        #
+        #   @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
+        #   ...
+        #
+        #   @param type [Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type]
 
         # @see Orb::Models::Customers::BalanceTransactionListResponse#action
         module Action
@@ -109,11 +105,8 @@ module Orb
           OVERPAYMENT_REFUND = :overpayment_refund
           EXTERNAL_PAYMENT = :external_payment
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
         # @see Orb::Models::Customers::BalanceTransactionListResponse#credit_note
@@ -124,12 +117,8 @@ module Orb
           #   @return [String]
           required :id, String
 
-          # @!parse
-          #   # @param id [String]
-          #   #
-          #   def initialize(id:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:)
+          #   @param id [String] The id of the Credit note
         end
 
         # @see Orb::Models::Customers::BalanceTransactionListResponse#invoice
@@ -140,12 +129,8 @@ module Orb
           #   @return [String]
           required :id, String
 
-          # @!parse
-          #   # @param id [String]
-          #   #
-          #   def initialize(id:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:)
+          #   @param id [String] The Invoice id
         end
 
         # @see Orb::Models::Customers::BalanceTransactionListResponse#type
@@ -155,11 +140,8 @@ module Orb
           INCREMENT = :increment
           DECREMENT = :decrement
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -5,8 +5,7 @@ module Orb
     module Customers
       # @see Orb::Resources::Customers::Costs#list_by_external_id
       class CostListByExternalIDParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute currency
@@ -36,16 +35,20 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
         optional :view_mode, enum: -> { Orb::Models::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
 
-        # @!parse
-        #   # @param currency [String, nil]
-        #   # @param timeframe_end [Time, nil]
-        #   # @param timeframe_start [Time, nil]
-        #   # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Customers::CostListByExternalIDParams} for more details.
+        #
+        #   @param currency [String, nil] The currency or custom pricing unit to use.
+        #
+        #   @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
+        #
+        #   @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
+        #
+        #   @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
+        #   ...
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
         # Controls whether Orb returns cumulative costs since the start of the billing
         # period, or incremental day-by-day costs. If your customer has minimums or
@@ -57,11 +60,8 @@ module Orb
           PERIODIC = :periodic
           CUMULATIVE = :cumulative
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -11,12 +11,8 @@ module Orb
         required :data,
                  -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CostListByExternalIDResponse::Data] }
 
-        # @!parse
-        #   # @param data [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data>]
-        #   #
-        #   def initialize(data:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(data:)
+        #   @param data [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data>]
 
         class Data < Orb::Internal::Type::BaseModel
           # @!attribute per_price_costs
@@ -47,16 +43,16 @@ module Orb
           #   @return [String]
           required :total, String
 
-          # @!parse
-          #   # @param per_price_costs [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost>]
-          #   # @param subtotal [String]
-          #   # @param timeframe_end [Time]
-          #   # @param timeframe_start [Time]
-          #   # @param total [String]
-          #   #
-          #   def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:)
+          #   @param per_price_costs [Array<Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost>]
+          #
+          #   @param subtotal [String] Total costs for the timeframe, excluding any minimums and discounts.
+          #
+          #   @param timeframe_end [Time]
+          #
+          #   @param timeframe_start [Time]
+          #
+          #   @param total [String] Total costs for the timeframe, including any minimums and discounts.
 
           class PerPriceCost < Orb::Internal::Type::BaseModel
             # @!attribute price
@@ -89,16 +85,16 @@ module Orb
             #   @return [Float, nil]
             optional :quantity, Float, nil?: true
 
-            # @!parse
-            #   # @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]
-            #   # @param price_id [String]
-            #   # @param subtotal [String]
-            #   # @param total [String]
-            #   # @param quantity [Float, nil]
-            #   #
-            #   def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!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_id [String] The price the cost is associated with
+            #
+            #   @param subtotal [String] Price's contributions for the timeframe, excluding any minimums and discounts.
+            #
+            #   @param total [String] Price's contributions for the timeframe, including minimums and discounts.
+            #
+            #   @param quantity [Float, nil] The price's quantity for the timeframe
           end
         end
       end

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

@@ -5,8 +5,7 @@ module Orb
     module Customers
       # @see Orb::Resources::Customers::Costs#list
       class CostListParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute currency
@@ -36,16 +35,20 @@ module Orb
         #   @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
         optional :view_mode, enum: -> { Orb::Models::Customers::CostListParams::ViewMode }, nil?: true
 
-        # @!parse
-        #   # @param currency [String, nil]
-        #   # @param timeframe_end [Time, nil]
-        #   # @param timeframe_start [Time, nil]
-        #   # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Customers::CostListParams} for more details.
+        #
+        #   @param currency [String, nil] The currency or custom pricing unit to use.
+        #
+        #   @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
+        #
+        #   @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
+        #
+        #   @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
+        #   ...
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
         # Controls whether Orb returns cumulative costs since the start of the billing
         # period, or incremental day-by-day costs. If your customer has minimums or
@@ -57,11 +60,8 @@ module Orb
           PERIODIC = :periodic
           CUMULATIVE = :cumulative
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

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

@@ -10,12 +10,8 @@ module Orb
         #   @return [Array<Orb::Models::Customers::CostListResponse::Data>]
         required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Customers::CostListResponse::Data] }
 
-        # @!parse
-        #   # @param data [Array<Orb::Models::Customers::CostListResponse::Data>]
-        #   #
-        #   def initialize(data:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(data:)
+        #   @param data [Array<Orb::Models::Customers::CostListResponse::Data>]
 
         class Data < Orb::Internal::Type::BaseModel
           # @!attribute per_price_costs
@@ -46,16 +42,16 @@ module Orb
           #   @return [String]
           required :total, String
 
-          # @!parse
-          #   # @param per_price_costs [Array<Orb::Models::Customers::CostListResponse::Data::PerPriceCost>]
-          #   # @param subtotal [String]
-          #   # @param timeframe_end [Time]
-          #   # @param timeframe_start [Time]
-          #   # @param total [String]
-          #   #
-          #   def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:)
+          #   @param per_price_costs [Array<Orb::Models::Customers::CostListResponse::Data::PerPriceCost>]
+          #
+          #   @param subtotal [String] Total costs for the timeframe, excluding any minimums and discounts.
+          #
+          #   @param timeframe_end [Time]
+          #
+          #   @param timeframe_start [Time]
+          #
+          #   @param total [String] Total costs for the timeframe, including any minimums and discounts.
 
           class PerPriceCost < Orb::Internal::Type::BaseModel
             # @!attribute price
@@ -88,16 +84,16 @@ module Orb
             #   @return [Float, nil]
             optional :quantity, Float, nil?: true
 
-            # @!parse
-            #   # @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]
-            #   # @param price_id [String]
-            #   # @param subtotal [String]
-            #   # @param total [String]
-            #   # @param quantity [Float, nil]
-            #   #
-            #   def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!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_id [String] The price the cost is associated with
+            #
+            #   @param subtotal [String] Price's contributions for the timeframe, excluding any minimums and discounts.
+            #
+            #   @param total [String] Price's contributions for the timeframe, including minimums and discounts.
+            #
+            #   @param quantity [Float, nil] The price's quantity for the timeframe
           end
         end
       end