Class IdentifyUserRequest
-
- All Implemented Interfaces:
public final class IdentifyUserRequestA 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classIdentifyUserRequest.BuilderA builder for IdentifyUserRequest.
-
Method Summary
Modifier and Type Method Description final Optional<String>avatar()URL to the user's avatar image. final Optional<InlineChannelDataRequest>channelData()A request to set channel data for a type of channel inline. final Optional<OffsetDateTime>createdAt()The creation date of the user from your system. final Optional<String>email()The primary email address for the user. final Optional<String>locale()The locale of the user. final Optional<String>name()Display name of the user. final Optional<String>phoneNumber()The E.164 phone number of the user (required for SMS channels). final Optional<InlinePreferenceSetRequest>preferences()Inline set preferences for a recipient, where the key is the preference set id. final Optional<String>timezone()The timezone of the user. final JsonField<String>_avatar()Returns the raw JSON value of avatar. final JsonField<InlineChannelDataRequest>_channelData()Returns the raw JSON value of channelData. final JsonField<OffsetDateTime>_createdAt()Returns the raw JSON value of createdAt. final JsonField<String>_email()Returns the raw JSON value of email. final JsonField<String>_locale()Returns the raw JSON value of locale. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_phoneNumber()Returns the raw JSON value of phoneNumber. final JsonField<InlinePreferenceSetRequest>_preferences()Returns the raw JSON value of preferences. final JsonField<String>_timezone()Returns the raw JSON value of timezone. final Map<String, JsonValue>_additionalProperties()final IdentifyUserRequest.BuildertoBuilder()final IdentifyUserRequestvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static IdentifyUserRequest.Builderbuilder()Returns a mutable builder for constructing an instance of IdentifyUserRequest. -
-
Method Detail
-
channelData
final Optional<InlineChannelDataRequest> channelData()
A request to set channel data for a type of channel inline.
-
createdAt
final Optional<OffsetDateTime> createdAt()
The creation date of the user from your system.
-
phoneNumber
final Optional<String> phoneNumber()
The E.164 phone number of the user (required for SMS channels).
-
preferences
final Optional<InlinePreferenceSetRequest> preferences()
Inline set preferences for a recipient, where the key is the preference set id.
-
timezone
final Optional<String> timezone()
The timezone of the user. Must be a valid tz database time zone * string. Used for /concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients.
-
_avatar
final JsonField<String> _avatar()
Returns the raw JSON value of avatar.
Unlike avatar, this method doesn't throw if the JSON field has an unexpected type.
-
_channelData
final JsonField<InlineChannelDataRequest> _channelData()
Returns the raw JSON value of channelData.
Unlike channelData, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<OffsetDateTime> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_email
final JsonField<String> _email()
Returns the raw JSON value of email.
Unlike email, this method doesn't throw if the JSON field has an unexpected type.
-
_locale
final JsonField<String> _locale()
Returns the raw JSON value of locale.
Unlike locale, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_phoneNumber
final JsonField<String> _phoneNumber()
Returns the raw JSON value of phoneNumber.
Unlike phoneNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_preferences
final JsonField<InlinePreferenceSetRequest> _preferences()
Returns the raw JSON value of preferences.
Unlike preferences, this method doesn't throw if the JSON field has an unexpected type.
-
_timezone
final JsonField<String> _timezone()
Returns the raw JSON value of timezone.
Unlike timezone, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final IdentifyUserRequest.Builder toBuilder()
-
validate
final IdentifyUserRequest validate()
-
builder
final static IdentifyUserRequest.Builder builder()
Returns a mutable builder for constructing an instance of IdentifyUserRequest.
-
-
-
-