Class: MetronomeSDK::Models::V1::PlanDetail

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/plan_detail.rb,
sig/metronome_sdk/models/v1/plan_detail.rbs

Defined Under Namespace

Classes: CreditGrant, Minimum, OverageRate

Instance Attribute Summary collapse

Instance Method Summary collapse

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(credit_type:, name:, start_period:, value:) ⇒ Object

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

Parameters:

  • credit_type (MetronomeSDK::Models::CreditTypeData)
  • name (String)
  • start_period (Float) —

    Used in price ramps. Indicates how many billing periods pass before the charge

  • value (Float) 



# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 116

Instance Attribute Details

#credit_grants ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>?

Returns:



26
27
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 26

optional :credit_grants,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::CreditGrant] }

#custom_fields ⇒ Hash{Symbol=>String}

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


16
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 16

required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


32
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 32

optional :description, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 10

required :id, String

#minimums ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>?

Returns:



37
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 37

optional :minimums, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum] }

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 21

required :name, String

#overage_rates ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>?

Returns:



42
43
 
# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 42

optional :overage_rates,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::OverageRate] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


54
 
# File 'sig/metronome_sdk/models/v1/plan_detail.rbs', line 54

def to_hash: -> {