Class: Courier::Models::JourneyResponse

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Overview

See Also:

• Courier::Resources::Journeys#create

Instance Attribute Summary

• #cancelation_token ⇒ String^?

  The journey cancelation token, or null when none is set.

• #created ⇒ Integer^?
• #creator ⇒ String^?
• #enabled ⇒ Boolean
• #id ⇒ String
• #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>
• #published ⇒ Integer^?
• #state ⇒ Symbol, Courier::Models::JourneyState

  Lifecycle state of a journey.

• #updated ⇒ Integer^?
• #updater ⇒ String^?

Instance Method Summary

• #initialize(id:, cancelation_token:, created:, creator:, enabled:, name:, nodes:, published:, state:, updated:, updater:) ⇒ Object constructor

  Some parameter documentations has been truncated, see JourneyResponse 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(id:, cancelation_token:, created:, creator:, enabled:, name:, nodes:, published:, state:, updated:, updater:) ⇒ Object

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

A journey, with its current draft or published nodes and metadata.

Parameters:

• id (String)
• cancelation_token (String, nil) —

  The journey cancelation token, or null when none is set. A token authored in the

• created (Integer, nil)
• creator (String, nil)
• enabled (Boolean)
• 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>)
• published (Integer, nil)
• state (Symbol, Courier::Models::JourneyState) —

  Lifecycle state of a journey.

• updated (Integer, nil)
• updater (String, nil)

# File 'lib/courier/models/journey_response.rb', line 66

Instance Attribute Details

#cancelation_token ⇒ String^?

The journey cancelation token, or null when none is set. A token authored in the dashboard is returned in its raw templated form, such as order-{{data.order_id}}, so it can be read back and asserted.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/journey_response.rb', line 18

required :cancelation_token, String, nil?: true

#created ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/courier/models/journey_response.rb', line 23

required :created, Integer, nil?: true

#creator ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/journey_response.rb', line 28

required :creator, String, nil?: true

#enabled ⇒ Boolean

Parameters:

• value (Boolean)

Returns:

• (Boolean)

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

required :enabled, Courier::Internal::Type::Boolean

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/courier/models/journey_response.rb', line 38

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:

• (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>)

# File 'lib/courier/models/journey_response.rb', line 43

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

#published ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/courier/models/journey_response.rb', line 48

required :published, Integer, nil?: true

#state ⇒ Symbol, Courier::Models::JourneyState

Lifecycle state of a journey.

Parameters:

• value (Courier::Models::journey_state)

Returns:

• (Symbol, Courier::Models::JourneyState)

# File 'lib/courier/models/journey_response.rb', line 54

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

#updated ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/courier/models/journey_response.rb', line 59

required :updated, Integer, nil?: true

#updater ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/journey_response.rb', line 64

required :updater, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/courier/models/journey_response.rbs', line 55

def to_hash: -> {