Class: Courier::Models::JourneySendNode

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Courier::Models::JourneySendNode

Defined in:

lib/courier/models/journey_send_node.rb,
sig/courier/models/journey_send_node.rbs

Defined Under Namespace

Modules: Type Classes: Message

Constant Summary

Courier =

Returns:

• (:JourneyExperiment)

Instance Attribute Summary

• #conditions ⇒ Array<String>, ...

  Condition spec for a journey node.

• #experiment ⇒ Courier::Models::JourneyExperiment^?

  A/B experiment config for a send node.

• #id ⇒ String^?
• #message ⇒ Courier::Models::JourneySendNode::Message
• #type ⇒ Symbol, Courier::Models::JourneySendNode::Type

Instance Method Summary

• #initialize(email_override: nil, phone_number_override: nil, user_id_override: nil) ⇒ Object constructor
• #to_hash ⇒ {

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(email_override: nil, phone_number_override: nil, user_id_override: nil) ⇒ Object

Parameters:

• email_override (String) (defaults to: nil)
• phone_number_override (String) (defaults to: nil)
• user_id_override (String) (defaults to: nil)

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

Instance Attribute Details

#conditions ⇒ Array<String>, ...

Condition spec for a journey node. Accepts a single condition atom, an AND/OR group, or an AND/OR nested group. Omit the conditions property entirely to express "no conditions".

Returns:

• (Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup, nil)

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

optional :conditions, union: -> { Courier::JourneyConditionsField }

#experiment ⇒ Courier::Models::JourneyExperiment^?

A/B experiment config for a send node. The recipient is deterministically bucketed by bucketingKey and routed to one of the variants in proportion to its weight. Present on a send node INSTEAD OF message.template.

Returns:

• (Courier::Models::JourneyExperiment, nil)

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

optional :experiment, -> { Courier::JourneyExperiment }

#id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :id, String

#message ⇒ Courier::Models::JourneySendNode::Message

Parameters:

• value (Courier::JourneySendNode::Message)

Returns:

• (Courier::Models::JourneySendNode::Message)

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

required :message, -> { Courier::JourneySendNode::Message }

#type ⇒ Symbol, Courier::Models::JourneySendNode::Type

Parameters:

• value (Courier::Models::JourneySendNode::type_)

Returns:

• (Symbol, Courier::Models::JourneySendNode::Type)

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

required :type, enum: -> { Courier::JourneySendNode::Type }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {