Class: Notiflows::Models::NotiflowRunParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/notiflows/models/notiflow_run_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Actor, Recipient

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(external_id:, avatar: nil, custom_fields: nil, email: nil, first_name: nil, last_name: nil, locale: nil, phone: nil, timezone: nil) ⇒ Object

Actor (triggering user) specification. Accessible in templates as actor.*.

Parameters:

  • external_id (String) —

    Your system's identifier for the actor (required)

  • avatar (String) (defaults to: nil)
  • custom_fields (Object) (defaults to: nil)
  • email (String) (defaults to: nil)
  • first_name (String) (defaults to: nil)
  • last_name (String) (defaults to: nil)
  • locale (String) (defaults to: nil)
  • phone (String) (defaults to: nil)
  • timezone (String) (defaults to: nil) 



# File 'lib/notiflows/models/notiflow_run_params.rb', line 96

Instance Attribute Details

#actor ⇒ Notiflows::Models::NotiflowRunParams::Actor?

Actor (triggering user) specification. Accessible in templates as actor.*.

Returns:



14
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 14

optional :actor, -> { Notiflows::NotiflowRunParams::Actor }

#data ⇒ Object?

Template variables. Accessible in notification templates as data.*.

Returns:

  • (Object, nil) 


20
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 20

optional :data, Notiflows::Internal::Type::Unknown

#recipients ⇒ Array<Notiflows::Models::NotiflowRunParams::Recipient>?

List of recipients. Each recipient must have an external_id. Users are auto-created if they don't exist.

Returns:



27
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 27

optional :recipients, -> { Notiflows::Internal::Type::ArrayOf[Notiflows::NotiflowRunParams::Recipient] }

#topic ⇒ String?

Topic name for pub/sub targeting. Cannot be used with recipients.

Returns:

  • (String, nil) 


33
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 33

optional :topic, String