Class: Courier::Models::NotificationTemplatePayload

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/notification_template_payload.rb

Defined Under Namespace

Classes: Brand, Routing, Subscription

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

Routing strategy reference, or null for none.

Parameters:

  • strategy_id (String) 



# File 'lib/courier/models/notification_template_payload.rb', line 42

Instance Attribute Details

#brand ⇒ Courier::Models::NotificationTemplatePayload::Brand?

Brand reference, or null for no brand.

Returns:



10
 
# File 'lib/courier/models/notification_template_payload.rb', line 10

required :brand, -> { Courier::NotificationTemplatePayload::Brand }, nil?: true

#content ⇒ Courier::Models::ElementalContent

Elemental content definition.

Returns:



16
 
# File 'lib/courier/models/notification_template_payload.rb', line 16

required :content, -> { Courier::ElementalContent }

#name ⇒ String

Display name for the template.

Returns:

  • (String) 


22
 
# File 'lib/courier/models/notification_template_payload.rb', line 22

required :name, String

#routing ⇒ Courier::Models::NotificationTemplatePayload::Routing?

Routing strategy reference, or null for none.

Returns:



28
 
# File 'lib/courier/models/notification_template_payload.rb', line 28

required :routing, -> { Courier::NotificationTemplatePayload::Routing }, nil?: true

#subscription ⇒ Courier::Models::NotificationTemplatePayload::Subscription?

Subscription topic reference, or null for none.

Returns:



34
 
# File 'lib/courier/models/notification_template_payload.rb', line 34

required :subscription, -> { Courier::NotificationTemplatePayload::Subscription }, nil?: true

#tags ⇒ Array<String>

Tags for categorization. Send empty array for none.

Returns:

  • (Array<String>) 


40
 
# File 'lib/courier/models/notification_template_payload.rb', line 40

required :tags, Courier::Internal::Type::ArrayOf[String]