Class: Courier::Models::JourneyResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/journey_response.rb

Overview

See Also:

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(id:, created:, creator:, enabled:, name:, nodes:, published:, state:, updated:, updater:) ⇒ Object

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

Parameters:




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

Instance Attribute Details

#created ⇒ Integer?

Returns:

  • (Integer, nil) 


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

required :created, Integer, nil?: true

#creator ⇒ String?

Returns:

  • (String, nil) 


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

required :creator, String, nil?: true

#enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

#nodes ⇒ Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, 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::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>

Returns:



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

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

#published ⇒ Integer?

Returns:

  • (Integer, nil) 


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

required :published, Integer, nil?: true

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

Lifecycle state of a journey.

Returns:



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

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

#updated ⇒ Integer?

Returns:

  • (Integer, nil) 


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

required :updated, Integer, nil?: true

#updater ⇒ String?

Returns:

  • (String, nil) 


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

required :updater, String, nil?: true