Class: Courier::Models::JourneyRun

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/journey_run.rb,
sig/courier/models/journey_run.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(run_id:, source:, created_at: nil, status: nil, template_id: nil, updated_at: nil) ⇒ Object

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

One run of a Journey. status and created_at are absent on a small number of legacy runs stored without them.

Parameters:

  • run_id (String) —

    A unique identifier representing the run.

  • source (Array<String>) —

    Internal provenance strings describing what started the run, e.g. `invoke/<journ

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

    When the run started, as an ISO 8601 timestamp.

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

    The state of the run: PROCESSING, PROCESSED, WAITING, CANCELED, ERROR,

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

    The id of the Journey this run belongs to.

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

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




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

Instance Attribute Details

#created_at ⇒ String?

When the run started, as an ISO 8601 timestamp.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :created_at, String

#run_id ⇒ String

A unique identifier representing the run.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :run_id, String

#source ⇒ Array<String>

Internal provenance strings describing what started the run, e.g. invoke/<journey_id> or segment/page/Pricing Page. Diagnostic only — the format is unstable and should not be parsed.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


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

required :source, Courier::Internal::Type::ArrayOf[String]

#status ⇒ String?

The state of the run: PROCESSING, PROCESSED, WAITING, CANCELED, ERROR, THROTTLED, or NOT PROCESSED. Not an enum — new values have been added before.

Parameters:

  • (String)

Returns:

  • (String, nil) 


32
 
# File 'lib/courier/models/journey_run.rb', line 32

optional :status, String

#template_id ⇒ String?

The id of the Journey this run belongs to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :template_id, String

#updated_at ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


44
 
# File 'lib/courier/models/journey_run.rb', line 44

optional :updated_at, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {