Class: Knockapi::Models::IdentifyUserRequest

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

Direct Known Subclasses

UserUpdateParams

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(avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil) ⇒ Object

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

A set of parameters to identify a user with. Does not include the user ID, as that’s specified elsewhere in the request. You can supply any additional properties you’d like to upsert for the user.

Parameters:




# File 'lib/knockapi/models/identify_user_request.rb', line 72

Instance Attribute Details

#avatar ⇒ String?

A URL for the avatar of the user.

Returns:

  • (String, nil) 


10
 
# File 'lib/knockapi/models/identify_user_request.rb', line 10

optional :avatar, String, nil?: true

#channel_data ⇒ Hash{Symbol=>Knockapi::Models::Recipients::PushChannelDataTokensOnly, Knockapi::Models::Recipients::PushChannelDataDevicesOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataTargetArnsOnly, Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly, Knockapi::Models::Recipients::OneSignalChannelDataPlayerIDsOnly, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}?

A request to set channel data for a type of channel inline.

Returns:



16
17
18
19
20
 
# File 'lib/knockapi/models/identify_user_request.rb', line 16

optional :channel_data,
-> {
  Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
},
nil?: true

#created_at ⇒ Time?

The creation date of the user from your system.

Returns:

  • (Time, nil) 


26
 
# File 'lib/knockapi/models/identify_user_request.rb', line 26

optional :created_at, Time, nil?: true

#email ⇒ String?

The primary email address for the user.

Returns:

  • (String, nil) 


32
 
# File 'lib/knockapi/models/identify_user_request.rb', line 32

optional :email, String, nil?: true

#locale ⇒ String?

The locale of the user. Used for [message localization](/concepts/translations).

Returns:

  • (String, nil) 


38
 
# File 'lib/knockapi/models/identify_user_request.rb', line 38

optional :locale, String, nil?: true

#name ⇒ String?

Display name of the user.

Returns:

  • (String, nil) 


44
 
# File 'lib/knockapi/models/identify_user_request.rb', line 44

optional :name, String, nil?: true

#phone_number ⇒ String?

The (www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels).

Returns:

  • (String, nil) 


51
 
# File 'lib/knockapi/models/identify_user_request.rb', line 51

optional :phone_number, String, nil?: true

#preferences ⇒ Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}?

Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences rather than replacing them.

Returns:



59
60
61
 
# File 'lib/knockapi/models/identify_user_request.rb', line 59

optional :preferences,
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
nil?: true

#timezone ⇒ String?

The timezone of the user. Must be a valid [tz database time zone string](en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).

Returns:

  • (String, nil) 


70
 
# File 'lib/knockapi/models/identify_user_request.rb', line 70

optional :timezone, String, nil?: true