Class: MetronomeSDK::Models::V1::Customer

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/customer.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(id: , external_id: , ingest_aliases: , name: , custom_fields: nil) ⇒ Object

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

Parameters:

  • id (String) (defaults to: ) —

    the Metronome ID of the customer

  • external_id (String) (defaults to: ) —

    (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias

  • ingest_aliases (Array<String>) (defaults to: ) —

    aliases for this customer that can be used instead of the Metronome customer ID

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

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




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

Instance Attribute Details

#custom_fields ⇒ Hash{Symbol=>String}?

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

Returns:

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


36
 
# File 'lib/metronome_sdk/models/v1/customer.rb', line 36

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

#external_id ⇒ String

(deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias) that can be used in usage events

Returns:

  • (String) 


18
 
# File 'lib/metronome_sdk/models/v1/customer.rb', line 18

required :external_id, String

#id ⇒ String

the Metronome ID of the customer

Returns:

  • (String) 


11
 
# File 'lib/metronome_sdk/models/v1/customer.rb', line 11

required :id, String

#ingest_aliases ⇒ Array<String>

aliases for this customer that can be used instead of the Metronome customer ID in usage events

Returns:

  • (Array<String>) 


25
 
# File 'lib/metronome_sdk/models/v1/customer.rb', line 25

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

#name ⇒ String

Returns:

  • (String) 


30
 
# File 'lib/metronome_sdk/models/v1/customer.rb', line 30

required :name, String