Class: Courier::Models::JourneySendNode::Message

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

Overview

See Also:

  • Courier::Models::JourneySendNode#message

Defined Under Namespace

Classes: Context, Delay, To

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(until_:, timezone: nil) ⇒ Object

Parameters:

  • until_ (String)
  • timezone (String) (defaults to: nil) 



# File 'lib/courier/models/journey_send_node.rb', line 89

Instance Attribute Details

#context ⇒ Courier::Models::JourneySendNode::Message::Context?

Tenant context for this send. Set it to deliver on behalf of one of your customers, so the message uses that tenant's brand and settings.

Returns:



64
 
# File 'lib/courier/models/journey_send_node.rb', line 64

optional :context, -> { Courier::JourneySendNode::Message::Context }

#data ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


69
 
# File 'lib/courier/models/journey_send_node.rb', line 69

optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]

#delay ⇒ Courier::Models::JourneySendNode::Message::Delay?

Returns:



74
 
# File 'lib/courier/models/journey_send_node.rb', line 74

optional :delay, -> { Courier::JourneySendNode::Message::Delay }

#template ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


79
 
# File 'lib/courier/models/journey_send_node.rb', line 79

optional :template, String

#to ⇒ Courier::Models::JourneySendNode::Message::To?

Recipient override for this send. Provide exactly one of email_override, phone_number_override, user_id_override, slack, or ms_teams — not a combination.

Returns:



87
 
# File 'lib/courier/models/journey_send_node.rb', line 87

optional :to, -> { Courier::JourneySendNode::Message::To }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


93
 
# File 'sig/courier/models/journey_send_node.rbs', line 93

def to_hash: -> {