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

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

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(name: , aliases: nil, credit_type_conversions: nil, custom_fields: nil, description: nil, fiat_credit_type_id: nil, request_options: {}) ⇒ Object

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

Parameters:

  • name (String) (defaults to: )

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

  • aliases (Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias>) (defaults to: nil)

    Reference this alias when creating a contract. If the same alias is assigned to

  • credit_type_conversions (Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion>) (defaults to: nil)

    Required when using custom pricing units in rates.

  • custom_fields (Hash{Symbol=>String}) (defaults to: nil)

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

  • description (String) (defaults to: nil)
  • fiat_credit_type_id (String) (defaults to: nil)

    The Metronome ID of the credit type to associate with the rate card, defaults to

  • request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb', line 70

class Alias < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute name
  #
  #   @return [String]
  required :name, String

  # @!attribute ending_before
  #
  #   @return [Time, nil]
  optional :ending_before, Time

  # @!attribute starting_at
  #
  #   @return [Time, nil]
  optional :starting_at, Time

  # @!method initialize(name:, ending_before: nil, starting_at: nil)
  #   @param name [String]
  #   @param ending_before [Time]
  #   @param starting_at [Time]
end

Instance Attribute Details

#ending_beforeTime?

Returns:

  • (Time, nil)


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

optional :ending_before, Time

#nameString

Returns:

  • (String)


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

required :name, String

#starting_atTime?

Returns:

  • (Time, nil)


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

optional :starting_at, Time