Class: Courier::Models::CreateJourneyRequest

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

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

Request body for creating a journey.

Parameters:




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

Instance Attribute Details

#enabled ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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

#name ⇒ 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::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:



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:



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

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