Class: MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate

Defined in:

lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb

Overview

See Also:

• #overwrite_rate

Defined Under Namespace

Modules: RateType

Instance Attribute Summary

• #credit_type ⇒ MetronomeSDK::Models::CreditTypeData^?
• #custom_rate ⇒ Hash{Symbol=>Object}^?

  Only set for CUSTOM rate_type.

• #is_prorated ⇒ Boolean^?

  Default proration configuration.

• #price ⇒ Float^?

  Default price.

• #quantity ⇒ Float^?

  Default quantity.

• #rate_type ⇒ Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType
• #tiers ⇒ Array<MetronomeSDK::Models::Tier>^?

  Only set for TIERED rate_type.

Instance Method Summary

• #initialize(rate_type: , credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see OverwriteRate for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(rate_type: , credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate for more details.

Parameters:

• rate_type (Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType) (defaults to: )
• credit_type (MetronomeSDK::Models::CreditTypeData) (defaults to: nil)
• custom_rate (Hash{Symbol=>Object}) (defaults to: nil) —

  Only set for CUSTOM rate_type. This field is interpreted by custom rate processo

• is_prorated (Boolean) (defaults to: nil) —

  Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be

• price (Float) (defaults to: nil) —

  Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t

• quantity (Float) (defaults to: nil) —

  Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

• tiers (Array<MetronomeSDK::Models::Tier>) (defaults to: nil) —

  Only set for TIERED rate_type.

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 865

Instance Attribute Details

#credit_type ⇒ MetronomeSDK::Models::CreditTypeData^?

Returns:

• (MetronomeSDK::Models::CreditTypeData, nil)

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 830

optional :credit_type, -> { MetronomeSDK::CreditTypeData }

#custom_rate ⇒ Hash{Symbol=>Object}^?

Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 837

optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]

#is_prorated ⇒ Boolean^?

Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.

Returns:

• (Boolean, nil)

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 844

optional :is_prorated, MetronomeSDK::Internal::Type::Boolean

#price ⇒ Float^?

Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 851

optional :price, Float

#quantity ⇒ Float^?

Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 857

optional :quantity, Float

#rate_type ⇒ Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType)

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 824

required :rate_type,
enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddOverride::OverwriteRate::RateType }

#tiers ⇒ Array<MetronomeSDK::Models::Tier>^?

Only set for TIERED rate_type.

Returns:

• (Array<MetronomeSDK::Models::Tier>, nil)

# File 'lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb', line 863

optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }