Class: Courier::Models::JourneyThrottleStaticNode

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

Defined Under Namespace

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

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

Throttle the journey by a static scope (user or global), allowing at most max_allowed invocations per period.

Parameters:




# File 'lib/courier/models/journey_throttle_static_node.rb', line 39

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:



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

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

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :id, String

#max_allowed ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :max_allowed, Integer

#period ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :period, String

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

Parameters:

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

Returns:



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

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

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

Parameters:

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

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/courier/models/journey_throttle_static_node.rb', line 65

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {