Class: Sentdm::Models::TemplateEventPayload

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/template_event_payload.rb,
sig/sentdm/models/template_event_payload.rbs

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(account_id: nil, category: nil, channel: nil, language: nil, reason: nil, status: nil, template_id: nil, template_name: nil, whatsapp_template_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Sentdm::Models::TemplateEventPayload for more details.

Body of a template status event. Delivered when a template's review outcome changes, so you can react without polling.

Parameters:

  • account_id (String) (defaults to: nil) —

    The account the template belongs to.

  • category (String) (defaults to: nil) —

    The template's category, for example UTILITY, MARKETING, or

  • channel (String) (defaults to: nil) —

    The channel the template applies to.

  • language (String) (defaults to: nil) —

    The template's language code, for example en_US.

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

    Why the template reached Status, when a reason was given. Populated on a

  • status (String) (defaults to: nil) —

    The review status the template just reached, for example APPROVED or

  • template_id (String) (defaults to: nil) —

    The template in Sent.

  • template_name (String) (defaults to: nil) —

    The template's display name.

  • whatsapp_template_id (String) (defaults to: nil) —

    The template's identifier with Meta, assigned when the template is submitted for




# File 'lib/sentdm/models/template_event_payload.rb', line 62

Instance Attribute Details

#account_id ⇒ String?

The account the template belongs to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


10
 
# File 'lib/sentdm/models/template_event_payload.rb', line 10

optional :account_id, String

#category ⇒ String?

The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.

Parameters:

  • (String)

Returns:

  • (String, nil) 


16
 
# File 'lib/sentdm/models/template_event_payload.rb', line 16

optional :category, String

#channel ⇒ String?

The channel the template applies to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


22
 
# File 'lib/sentdm/models/template_event_payload.rb', line 22

optional :channel, String

#language ⇒ String?

The template's language code, for example en_US.

Parameters:

  • (String)

Returns:

  • (String, nil) 


28
 
# File 'lib/sentdm/models/template_event_payload.rb', line 28

optional :language, String

#reason ⇒ String?

Why the template reached Status, when a reason was given. Populated on a rejection.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


35
 
# File 'lib/sentdm/models/template_event_payload.rb', line 35

optional :reason, String, nil?: true

#status ⇒ String?

The review status the template just reached, for example APPROVED or REJECTED.

Parameters:

  • (String)

Returns:

  • (String, nil) 


41
 
# File 'lib/sentdm/models/template_event_payload.rb', line 41

optional :status, String

#template_id ⇒ String?

The template in Sent.

Parameters:

  • (String)

Returns:

  • (String, nil) 


47
 
# File 'lib/sentdm/models/template_event_payload.rb', line 47

optional :template_id, String

#template_name ⇒ String?

The template's display name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


53
 
# File 'lib/sentdm/models/template_event_payload.rb', line 53

optional :template_name, String

#whatsapp_template_id ⇒ String?

The template's identifier with Meta, assigned when the template is submitted for review.

Parameters:

  • (String)

Returns:

  • (String, nil) 


60
 
# File 'lib/sentdm/models/template_event_payload.rb', line 60

optional :whatsapp_template_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/sentdm/models/template_event_payload.rbs', line 63

def to_hash: -> {