Class: MetronomeSDK::Models::V1::Contracts::RateCardCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Alias, CreditTypeConversion

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(name: , ending_before: nil, starting_at: nil) ⇒ Object

Parameters:

  • name (String) (defaults to: )
  • ending_before (Time) (defaults to: nil)
  • starting_at (Time) (defaults to: nil) 



# File 'lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb', line 86

Instance Attribute Details

#aliases ⇒ Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias>?

Reference this alias when creating a contract. If the same alias is assigned to multiple rate cards, it will reference the rate card to which it was most recently assigned. It is not exposed to end customers.

Returns:



24
25
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb', line 24

optional :aliases,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardCreateParams::Alias] }

#credit_type_conversions ⇒ Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion>?

Required when using custom pricing units in rates.

Returns:



31
32
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb', line 31

optional :credit_type_conversions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardCreateParams::CreditTypeConversion] }

#custom_fields ⇒ Hash{Symbol=>String}?

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

Returns:

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


38
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb', line 38

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

#description ⇒ String?

Returns:

  • (String, nil) 


43
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb', line 43

optional :description, String

#fiat_credit_type_id ⇒ String?

The Metronome ID of the credit type to associate with the rate card, defaults to USD (cents) if not passed.

Returns:

  • (String, nil) 


50
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb', line 50

optional :fiat_credit_type_id, String

#name ⇒ String

Used only in UI/API. It is not exposed to end customers.

Returns:

  • (String) 


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

required :name, String