Class: Courier::Models::JourneyRunStep

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

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(action:, status:, created_at: nil, message_id: nil, node_id: nil, updated_at: nil) ⇒ Object

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

One executed node of a Journey run. node_id is the id of the node in the published Journey, so a step maps directly onto the Journey graph.

Parameters:

  • action (String) —

    The kind of node that ran, e.g. send, delay, or exit.

  • status (String) —

    The state of the step: the seven run statuses, plus SKIPPED and COMPUTING. N

  • created_at (String) (defaults to: nil) —

    When the step started, as an ISO 8601 timestamp.

  • message_id (String) (defaults to: nil) —

    The message this step produced, present on send steps. Pass it to `GET /messages

  • node_id (String) (defaults to: nil) —

    The id of the node in the published Journey that this step executed.

  • updated_at (String) (defaults to: nil) —

    When the step last changed state, as an ISO 8601 timestamp.




# File 'lib/courier/models/journey_run_step.rb', line 45

Instance Attribute Details

#action ⇒ String

The kind of node that ran, e.g. send, delay, or exit.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :action, String

#created_at ⇒ String?

When the step started, as an ISO 8601 timestamp.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :created_at, String

#message_id ⇒ String?

The message this step produced, present on send steps. Pass it to GET /messages/{message_id} for delivery status. A send to a List or an Audience yields one id for the request, not one per recipient.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/courier/models/journey_run_step.rb', line 31

optional :message_id, String

#node_id ⇒ String?

The id of the node in the published Journey that this step executed.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :node_id, String

#status ⇒ String

The state of the step: the seven run statuses, plus SKIPPED and COMPUTING. Not an enum — new values have been added before.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/courier/models/journey_run_step.rb', line 17

required :status, String

#updated_at ⇒ String?

When the step last changed state, as an ISO 8601 timestamp.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :updated_at, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


43
 
# File 'sig/courier/models/journey_run_step.rbs', line 43

def to_hash: -> {