Class: Notiflows::Models::UserUpsertParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Notiflows::Models::UserUpsertParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/notiflows/models/user_upsert_params.rb

Overview

See Also:

• Resources::Users#upsert

Defined Under Namespace

Classes: ChannelSetting

Instance Attribute Summary

• #avatar ⇒ String^?

  URL to user's avatar image (must start with http:// or https://).

• #channel_settings ⇒ Array<Notiflows::Models::UserUpsertParams::ChannelSetting>^?

  Initial channel settings (e.g., device tokens for push).

• #custom_fields ⇒ Object^?

  Custom attributes.

• #email ⇒ String^?

  User's email address.

• #external_id ⇒ String

  Your system's unique identifier for this user.

• #first_name ⇒ String^?

  User's first name.

• #last_name ⇒ String^?

  User's last name.

• #locale ⇒ String^?

  BCP 47 locale code (e.g., en-US, es-ES, fr-FR).

• #phone ⇒ String^?

  User's phone number in E.164 format.

• #preferences ⇒ ::Notiflows::Models::Users::UpdatePreferencesRequest^?

  Request body for updating user preferences.

• #timezone ⇒ String^?

  IANA timezone (e.g., America/New_York, Europe/London).

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Notiflows::Internal::Type::BaseModel

Instance Attribute Details

#avatar ⇒ String^?

URL to user's avatar image (must start with http:// or https://)

Returns:

• (String, nil)

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

optional :avatar, String

#channel_settings ⇒ Array<Notiflows::Models::UserUpsertParams::ChannelSetting>^?

Initial channel settings (e.g., device tokens for push)

Returns:

• (Array<Notiflows::Models::UserUpsertParams::ChannelSetting>, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 26

optional :channel_settings,
-> { Notiflows::Internal::Type::ArrayOf[Notiflows::UserUpsertParams::ChannelSetting] }

#custom_fields ⇒ Object^?

Custom attributes. Deep-merged with existing values on update.

Returns:

• (Object, nil)

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

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

#email ⇒ String^?

User's email address

Returns:

• (String, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 39

optional :email, String

#external_id ⇒ String

Your system's unique identifier for this user. Required for creating new users.

Returns:

• (String)

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

required :external_id, String

#first_name ⇒ String^?

User's first name

Returns:

• (String, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 45

optional :first_name, String

#last_name ⇒ String^?

User's last name

Returns:

• (String, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 51

optional :last_name, String

#locale ⇒ String^?

BCP 47 locale code (e.g., en-US, es-ES, fr-FR)

Returns:

• (String, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 57

optional :locale, String

#phone ⇒ String^?

User's phone number in E.164 format

Returns:

• (String, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 63

optional :phone, String

#preferences ⇒ ::Notiflows::Models::Users::UpdatePreferencesRequest^?

Request body for updating user preferences. Only provided fields are updated.

Returns:

• (::Notiflows::Models::Users::UpdatePreferencesRequest, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 69

optional :preferences, -> { ::Notiflows::Users::UpdatePreferencesRequest }

#timezone ⇒ String^?

IANA timezone (e.g., America/New_York, Europe/London)

Returns:

• (String, nil)

# File 'lib/notiflows/models/user_upsert_params.rb', line 75

optional :timezone, String