Class: MetronomeSDK::Models::V1::Customers::CustomerAlert

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

Overview

See Also:

Defined Under Namespace

Modules: CustomerStatus Classes: Alert

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(key: , value: nil) ⇒ Object

Parameters:

  • key (String) (defaults to: )
  • value (String) (defaults to: nil) 



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

Instance Attribute Details

#alert ⇒ MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert

Returns:



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

required :alert, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert }

#customer_status ⇒ Symbol, ...

The status of the threshold notification. If the notification is archived, null will be returned.

Returns:



19
20
21
 
# File 'lib/metronome_sdk/models/v1/customers/customer_alert.rb', line 19

required :customer_status,
enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::CustomerStatus },
nil?: true

#triggered_by ⇒ String?

If present, indicates the reason the threshold notification was triggered.

Returns:

  • (String, nil) 


27
 
# File 'lib/metronome_sdk/models/v1/customers/customer_alert.rb', line 27

optional :triggered_by, String, nil?: true