Class: Courier::Models::CreateJourneyRequest

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

Direct Known Subclasses

JourneyCreateParams, JourneyReplaceParams

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(name:, nodes:, cancelation_token: nil, enabled: nil, state: nil) ⇒ Object

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

Request body for creating a journey.

Parameters:




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

Instance Attribute Details

#cancelation_token ⇒ String?

Cancelation token stored on the journey definition. It tags every run the journey creates so that POST /journeys/cancel can later cancel those runs by token. Accepts a templated string such as order-{{data.order_id}}, which is resolved per run when the journey is invoked. On a replace, omitting this field preserves any existing token and sending a value replaces it.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :cancelation_token, String

#enabled ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :enabled, Courier::Internal::Type::Boolean

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

#nodes ⇒ Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneyAudienceTriggerNode, Courier::Models::JourneyWebhookTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyNode::JourneyAddToDigestNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>

Parameters:

  • value (::Array[Courier::Models::journey_node])

Returns:



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

required :nodes, -> { Courier::Internal::Type::ArrayOf[union: Courier::JourneyNode] }

#state ⇒ Symbol, ...

Lifecycle state of a journey.

Returns:



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

optional :state, enum: -> { Courier::JourneyState }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/courier/models/create_journey_request.rbs', line 39

def to_hash: -> {