Class: Courier::Models::JourneyThrottleDynamicNode

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

Modules: Scope, Type

Instance Attribute Summary

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

  Condition spec for a journey node.

• #id ⇒ String^?
• #max_allowed ⇒ Integer
• #period ⇒ String
• #scope ⇒ Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope
• #throttle_key ⇒ String
• #type ⇒ Symbol, Courier::Models::JourneyThrottleDynamicNode::Type

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(max_allowed:, period:, scope:, throttle_key:, type:, id: nil, conditions: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see JourneyThrottleDynamicNode for more details.

• #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(max_allowed:, period:, scope:, throttle_key:, type:, id: nil, conditions: nil) ⇒ Object

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

Throttle the journey by a dynamic throttle_key, allowing at most max_allowed invocations per period.

Parameters:

• max_allowed (Integer)
• period (String)
• scope (Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope)
• throttle_key (String)
• type (Symbol, Courier::Models::JourneyThrottleDynamicNode::Type)
• id (String) (defaults to: nil)
• conditions (Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup) (defaults to: nil) —

  Condition spec for a journey node. Accepts a single condition atom, an AND/OR gr

# File 'lib/courier/models/journey_throttle_dynamic_node.rb', line 44

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_throttle_dynamic_node.rb', line 42

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

#id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :id, String

#max_allowed ⇒ Integer

Parameters:

• value (Integer)

Returns:

• (Integer)

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

required :max_allowed, Integer

#period ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :period, String

#scope ⇒ Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope

Parameters:

• value (Courier::Models::JourneyThrottleDynamicNode::scope)

Returns:

• (Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope)

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

required :scope, enum: -> { Courier::JourneyThrottleDynamicNode::Scope }

#throttle_key ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/courier/models/journey_throttle_dynamic_node.rb', line 24

required :throttle_key, String

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

Parameters:

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

Returns:

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

# File 'lib/courier/models/journey_throttle_dynamic_node.rb', line 29

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/courier/models/journey_throttle_dynamic_node.rb', line 71

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/courier/models/journey_throttle_dynamic_node.rbs', line 45

def to_hash: -> {