Class: Knockapi::Models::Message::Source

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/message.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

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(_typename:, categories:, key:, version_id:, step_ref: nil, type: nil, workflow_recipient_run_id: nil, workflow_run_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Knockapi::Models::Message::Source for more details.

The workflow or guide that triggered the message.

Parameters:

  • _typename (String)
  • categories (Array<String>) —

    The categories associated with the message.

  • key (String) —

    The key of the workflow or guide that triggered the message.

  • version_id (String) —

    The ID of the version of the workflow or guide that triggered the message.

  • step_ref (String, nil) (defaults to: nil) —

    The step reference for the step in the workflow that generated the message.

  • type (Symbol, Knockapi::Models::Message::Source::Type) (defaults to: nil) —

    Whether this message was generated from a workflow, broadcast, or guide.

  • workflow_recipient_run_id (String, nil) (defaults to: nil) —

    The unique identifier for the workflow recipient run that generated this message

  • workflow_run_id (String, nil) (defaults to: nil) —

    The unique identifier for the workflow run that generated this message. Only pre




# File 'lib/knockapi/models/message.rb', line 269

Instance Attribute Details

#_typename ⇒ String

Returns:

  • (String) 


223
 
# File 'lib/knockapi/models/message.rb', line 223

required :_typename, String, api_name: :__typename

#categories ⇒ Array<String>

The categories associated with the message.

Returns:

  • (Array<String>) 


229
 
# File 'lib/knockapi/models/message.rb', line 229

required :categories, Knockapi::Internal::Type::ArrayOf[String]

#key ⇒ String

The key of the workflow or guide that triggered the message.

Returns:

  • (String) 


235
 
# File 'lib/knockapi/models/message.rb', line 235

required :key, String

#step_ref ⇒ String?

The step reference for the step in the workflow that generated the message.

Returns:

  • (String, nil) 


247
 
# File 'lib/knockapi/models/message.rb', line 247

optional :step_ref, String, nil?: true

#type ⇒ Symbol, ...

Whether this message was generated from a workflow, broadcast, or guide.

Returns:



253
 
# File 'lib/knockapi/models/message.rb', line 253

optional :type, enum: -> { Knockapi::Message::Source::Type }

#version_id ⇒ String

The ID of the version of the workflow or guide that triggered the message.

Returns:

  • (String) 


241
 
# File 'lib/knockapi/models/message.rb', line 241

required :version_id, String

#workflow_recipient_run_id ⇒ String?

The unique identifier for the workflow recipient run that generated this message. Only present for workflow/broadcast messages.

Returns:

  • (String, nil) 


260
 
# File 'lib/knockapi/models/message.rb', line 260

optional :workflow_recipient_run_id, String, nil?: true

#workflow_run_id ⇒ String?

The unique identifier for the workflow run that generated this message. Only present for workflow/broadcast messages.

Returns:

  • (String, nil) 


267
 
# File 'lib/knockapi/models/message.rb', line 267

optional :workflow_run_id, String, nil?: true