Class: MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb

Overview

See Also:

Defined Under Namespace

Modules: BillingFrequency

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(entitled: , product_custom_fields: , product_id: , product_name: , product_tags: , rate: , starting_at: , billing_frequency: nil, commit_rate: nil, ending_before: nil, pricing_group_values: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse for more details.

Parameters:

  • entitled (Boolean) (defaults to: )
  • product_custom_fields (Hash{Symbol=>String}) (defaults to: ) —

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

  • product_id (String) (defaults to: )
  • product_name (String) (defaults to: )
  • product_tags (Array<String>) (defaults to: )
  • rate (MetronomeSDK::Models::Rate) (defaults to: )
  • starting_at (Time) (defaults to: )
  • billing_frequency (Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency) (defaults to: nil)
  • commit_rate (MetronomeSDK::Models::CommitRate) (defaults to: nil) —

    A distinct rate on the rate card. You can choose to use this rate rather than li

  • ending_before (Time) (defaults to: nil)
  • pricing_group_values (Hash{Symbol=>String}) (defaults to: nil) 



# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 69

Instance Attribute Details

#billing_frequency ⇒ Symbol, ...

Returns:



49
50
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 49

optional :billing_frequency,
enum: -> { MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency }

#commit_rate ⇒ MetronomeSDK::Models::CommitRate?

A distinct rate on the rate card. You can choose to use this rate rather than list rate when consuming a credit or commit.

Returns:



57
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 57

optional :commit_rate, -> { MetronomeSDK::CommitRate }

#ending_before ⇒ Time?

Returns:

  • (Time, nil) 


62
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 62

optional :ending_before, Time

#entitled ⇒ Boolean

Returns:

  • (Boolean) 


13
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 13

required :entitled, MetronomeSDK::Internal::Type::Boolean

#pricing_group_values ⇒ Hash{Symbol=>String}?

Returns:

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


67
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 67

optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

#product_custom_fields ⇒ Hash{Symbol=>String}

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

Returns:

  • (Hash{Symbol=>String}) 


19
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 19

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

#product_id ⇒ String

Returns:

  • (String) 


24
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 24

required :product_id, String

#product_name ⇒ String

Returns:

  • (String) 


29
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 29

required :product_name, String

#product_tags ⇒ Array<String>

Returns:

  • (Array<String>) 


34
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 34

required :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

#rate ⇒ MetronomeSDK::Models::Rate

Returns:



39
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 39

required :rate, -> { MetronomeSDK::Rate }

#starting_at ⇒ Time

Returns:

  • (Time) 


44
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb', line 44

required :starting_at, Time