Class: Notiflows::Models::NotiflowRunParams::Recipient

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Notiflows::Models::NotiflowRunParams::Recipient

Defined in:

lib/notiflows/models/notiflow_run_params.rb

Instance Attribute Summary

• #avatar ⇒ String^?

  Avatar URL.

• #custom_fields ⇒ Object^?

  Custom attributes.

• #email ⇒ String^?

  Email address (used if user is auto-created).

• #external_id ⇒ String

  Your system's unique identifier for this user (required).

• #first_name ⇒ String^?

  First name.

• #last_name ⇒ String^?

  Last name.

• #locale ⇒ String^?

  BCP 47 locale.

• #phone ⇒ String^?

  Phone number in E.164 format.

• #timezone ⇒ String^?

  IANA timezone.

Instance Method Summary

• #initialize(external_id:, avatar: nil, custom_fields: nil, email: nil, first_name: nil, last_name: nil, locale: nil, phone: nil, timezone: nil) ⇒ Object constructor

  Recipient specification for running a notiflow.

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

Recipient specification for running a notiflow. Users are auto-created if they don't exist.

Parameters:

• external_id (String) —

  Your system's unique identifier for this user (required)

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

  Avatar URL

• custom_fields (Object) (defaults to: nil) —

  Custom attributes

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

  Email address (used if user is auto-created)

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

  First name

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

  Last name

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

  BCP 47 locale

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

  Phone number in E.164 format

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

  IANA timezone

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

Instance Attribute Details

#avatar ⇒ String^?

Avatar URL

Returns:

• (String, nil)

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

optional :avatar, String

#custom_fields ⇒ Object^?

Custom attributes

Returns:

• (Object, nil)

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

optional :custom_fields, Notiflows::Internal::Type::Unknown

#email ⇒ String^?

Email address (used if user is auto-created)

Returns:

• (String, nil)

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

optional :email, String

#external_id ⇒ String

Your system's unique identifier for this user (required)

Returns:

• (String)

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

required :external_id, String

#first_name ⇒ String^?

First name

Returns:

• (String, nil)

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

optional :first_name, String

#last_name ⇒ String^?

Last name

Returns:

• (String, nil)

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

optional :last_name, String

#locale ⇒ String^?

BCP 47 locale

Returns:

• (String, nil)

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

optional :locale, String

#phone ⇒ String^?

Phone number in E.164 format

Returns:

• (String, nil)

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

optional :phone, String

#timezone ⇒ String^?

IANA timezone

Returns:

• (String, nil)

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

optional :timezone, String