Class: MetronomeSDK::Models::V1::CustomerDetail

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

Overview

See Also:

Defined Under Namespace

Classes: CurrentBillableStatus, CustomerConfig

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(salesforce_account_id: ) ⇒ Object

Parameters:

  • salesforce_account_id (String, nil) (defaults to: ) —

    The Salesforce account ID for the customer




# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 69

Instance Attribute Details

#archived_at ⇒ Time?

RFC 3339 timestamp indicating when the customer was archived. Null if the customer is active.

Returns:

  • (Time, nil) 


61
 
# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 61

optional :archived_at, Time, nil?: true

#created_at ⇒ Time

RFC 3339 timestamp indicating when the customer was created.

Returns:

  • (Time) 


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

required :created_at, Time

#current_billable_status ⇒ MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus?

This field’s availability is dependent on your client’s configuration.

Returns:



67
 
# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 67

optional :current_billable_status, -> { MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus }

#custom_fields ⇒ Hash{Symbol=>String}

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

Returns:

  • (Hash{Symbol=>String}) 


24
 
# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 24

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

#customer_config ⇒ MetronomeSDK::Models::V1::CustomerDetail::CustomerConfig

Returns:



29
 
# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 29

required :customer_config, -> { MetronomeSDK::V1::CustomerDetail::CustomerConfig }

#external_id ⇒ String

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

Returns:

  • (String) 


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

required :external_id, String

#id ⇒ String

the Metronome ID of the customer

Returns:

  • (String) 


12
 
# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 12

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>) 


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

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

#name ⇒ String

Returns:

  • (String) 


48
 
# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 48

required :name, String

#updated_at ⇒ Time

RFC 3339 timestamp indicating when the customer was last updated.

Returns:

  • (Time) 


54
 
# File 'lib/metronome_sdk/models/v1/customer_detail.rb', line 54

required :updated_at, Time