Class: Courier::Models::JourneyAudienceTriggerNode

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

Defined Under Namespace

Modules: TriggerType, Type

Instance Attribute Summary collapse

Class Method 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(audience_id:, trigger_type:, type:, id: nil, conditions: nil) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::JourneyAudienceTriggerNode for more details.

Trigger fired when a user newly matches an Audience. Leaving and re-joining the Audience re-enters the Journey. Membership is new-members-only: users already in the Audience when the Journey is published do not enter. Unlike the v2 Automations audience trigger, there is no member scope, event type, or frequency mode to configure, and audience_id must name one Audience — wildcards are not supported.

Parameters:




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

Instance Attribute Details

#audience_id ⇒ String

The Audience to watch. Must name a single Audience; wildcards are not supported.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :audience_id, String

#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:



33
 
# File 'lib/courier/models/journey_audience_trigger_node.rb', line 33

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

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/courier/models/journey_audience_trigger_node.rb', line 25

optional :id, String

#trigger_type ⇒ Symbol, Courier::Models::JourneyAudienceTriggerNode::TriggerType

Parameters:

  • value (Courier::Models::JourneyAudienceTriggerNode::trigger_type)

Returns:



15
 
# File 'lib/courier/models/journey_audience_trigger_node.rb', line 15

required :trigger_type, enum: -> { Courier::JourneyAudienceTriggerNode::TriggerType }

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

Parameters:

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

Returns:



20
 
# File 'lib/courier/models/journey_audience_trigger_node.rb', line 20

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/courier/models/journey_audience_trigger_node.rb', line 62

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


37
 
# File 'sig/courier/models/journey_audience_trigger_node.rbs', line 37

def to_hash: -> {