Class: Courier::Models::UserProfile

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Courier::Models::UserProfile

Defined in:

lib/courier/models/user_profile.rb,
sig/courier/models/user_profile.rbs

Defined Under Namespace

Classes: Address

Instance Attribute Summary

• #address ⇒ Courier::Models::UserProfile::Address^?
• #airship ⇒ Courier::Models::AirshipProfile^?
• #apn ⇒ Courier::Models::Token, ...

  Apple Push Notification device tokens.

• #aws_sns ⇒ Courier::Models::AwsSns^?

  Routes a push notification through the AWS SNS provider.

• #birthdate ⇒ String^?
• #custom ⇒ Hash{Symbol=>Object}^?

  A free form object.

• #discord ⇒ Courier::Models::SendToChannel, ...
• #email ⇒ String^?
• #email_verified ⇒ Boolean^?
• #expo ⇒ Courier::Models::Token, ...

  Expo push tokens.

• #facebook_psid ⇒ String^?
• #family_name ⇒ String^?
• #firebase_token ⇒ String, ...
• #gender ⇒ String^?
• #given_name ⇒ String^?
• #intercom ⇒ Courier::Models::Intercom^?
• #locale ⇒ String^?
• #middle_name ⇒ String^?
• #ms_teams ⇒ Courier::Models::SendToMsTeamsUserID, ...
• #name ⇒ String^?
• #nickname ⇒ String^?
• #phone_number ⇒ String^?
• #phone_number_verified ⇒ Boolean^?
• #picture ⇒ String^?
• #preferred_name ⇒ String^?
• #profile ⇒ String^?
• #slack ⇒ Courier::Models::SendToSlackChannel, ...
• #sub ⇒ String^?
• #updated_at ⇒ String^?
• #website ⇒ String^?
• #zoneinfo ⇒ String^?

Instance Method Summary

• #initialize(address: nil, airship: nil, apn: nil, aws_sns: nil, birthdate: nil, custom: nil, discord: nil, email: nil, email_verified: nil, expo: nil, facebook_psid: nil, family_name: nil, firebase_token: nil, gender: nil, given_name: nil, intercom: nil, locale: nil, middle_name: nil, ms_teams: nil, name: nil, nickname: nil, phone_number: nil, phone_number_verified: nil, picture: nil, preferred_name: nil, profile: nil, slack: nil, sub: nil, updated_at: nil, website: nil, zoneinfo: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see UserProfile for more details.

• #to_hash ⇒ {

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(address: nil, airship: nil, apn: nil, aws_sns: nil, birthdate: nil, custom: nil, discord: nil, email: nil, email_verified: nil, expo: nil, facebook_psid: nil, family_name: nil, firebase_token: nil, gender: nil, given_name: nil, intercom: nil, locale: nil, middle_name: nil, ms_teams: nil, name: nil, nickname: nil, phone_number: nil, phone_number_verified: nil, picture: nil, preferred_name: nil, profile: nil, slack: nil, sub: nil, updated_at: nil, website: nil, zoneinfo: nil) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::UserProfile for more details.

Parameters:

• address (Courier::Models::UserProfile::Address, nil) (defaults to: nil)
• airship (Courier::Models::AirshipProfile, nil) (defaults to: nil)
• apn (Courier::Models::Token, Courier::Models::MultipleTokens, nil) (defaults to: nil) —

  Apple Push Notification device tokens. Supply either a single token or a `toke

• aws_sns (Courier::Models::AwsSns, nil) (defaults to: nil) —

  Routes a push notification through the AWS SNS provider. The target ARN must be

• birthdate (String, nil) (defaults to: nil)
• custom (Hash{Symbol=>Object}, nil) (defaults to: nil) —

  A free form object. Due to a limitation of the API Explorer, you can only enter

• discord (Courier::Models::SendToChannel, Courier::Models::SendDirectMessage, nil) (defaults to: nil)
• email (String, nil) (defaults to: nil)
• email_verified (Boolean, nil) (defaults to: nil)
• expo (Courier::Models::Token, Courier::Models::MultipleTokens, nil) (defaults to: nil) —

  Expo push tokens. Supply either a single token or a tokens value.

• facebook_psid (String, nil) (defaults to: nil)
• family_name (String, nil) (defaults to: nil)
• firebase_token (String, Array<String>, nil) (defaults to: nil)
• gender (String, nil) (defaults to: nil)
• given_name (String, nil) (defaults to: nil)
• intercom (Courier::Models::Intercom, nil) (defaults to: nil)
• locale (String, nil) (defaults to: nil)
• middle_name (String, nil) (defaults to: nil)
• ms_teams (Courier::Models::SendToMsTeamsUserID, Courier::Models::SendToMsTeamsEmail, Courier::Models::SendToMsTeamsChannelID, Courier::Models::SendToMsTeamsConversationID, Courier::Models::SendToMsTeamsChannelName, nil) (defaults to: nil)
• name (String, nil) (defaults to: nil)
• nickname (String, nil) (defaults to: nil)
• phone_number (String, nil) (defaults to: nil)
• phone_number_verified (Boolean, nil) (defaults to: nil)
• picture (String, nil) (defaults to: nil)
• preferred_name (String, nil) (defaults to: nil)
• profile (String, nil) (defaults to: nil)
• slack (Courier::Models::SendToSlackChannel, Courier::Models::SendToSlackEmail, Courier::Models::SendToSlackUserID, nil) (defaults to: nil)
• sub (String, nil) (defaults to: nil)
• updated_at (String, nil) (defaults to: nil)
• website (String, nil) (defaults to: nil)
• zoneinfo (String, nil) (defaults to: nil)

# File 'lib/courier/models/user_profile.rb', line 173

Instance Attribute Details

#address ⇒ Courier::Models::UserProfile::Address^?

Parameters:

• value (Courier::UserProfile::Address, nil)

Returns:

• (Courier::Models::UserProfile::Address, nil)

# File 'lib/courier/models/user_profile.rb', line 9

optional :address, -> { Courier::UserProfile::Address }, nil?: true

#airship ⇒ Courier::Models::AirshipProfile^?

Parameters:

• value (Courier::AirshipProfile, nil)

Returns:

• (Courier::Models::AirshipProfile, nil)

# File 'lib/courier/models/user_profile.rb', line 14

optional :airship, -> { Courier::AirshipProfile }, nil?: true

#apn ⇒ Courier::Models::Token, ...

Apple Push Notification device tokens. Supply either a single token or a tokens value. A bare string is rejected by the provider — the token must be wrapped in this object.

Parameters:

• value (Courier::Models::apn, nil)

Returns:

• (Courier::Models::Token, Courier::Models::MultipleTokens, nil)

# File 'lib/courier/models/user_profile.rb', line 22

optional :apn, union: -> { Courier::Apn }, nil?: true

#aws_sns ⇒ Courier::Models::AwsSns^?

Routes a push notification through the AWS SNS provider. The target ARN must be nested under aws_sns — a top-level target_arn on the profile is ignored by the provider.

Parameters:

• value (Courier::AwsSns, nil)

Returns:

• (Courier::Models::AwsSns, nil)

# File 'lib/courier/models/user_profile.rb', line 30

optional :aws_sns, -> { Courier::AwsSns }, nil?: true

#birthdate ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 35

optional :birthdate, String, nil?: true

#custom ⇒ Hash{Symbol=>Object}^?

A free form object. Due to a limitation of the API Explorer, you can only enter string key/values below, but this API accepts more complex object structures.

Parameters:

• value (::Hash[Symbol, top], nil)

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/courier/models/user_profile.rb', line 42

optional :custom, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true

#discord ⇒ Courier::Models::SendToChannel, ...

Parameters:

• value (Courier::Models::discord, nil)

Returns:

• (Courier::Models::SendToChannel, Courier::Models::SendDirectMessage, nil)

# File 'lib/courier/models/user_profile.rb', line 47

optional :discord, union: -> { Courier::Discord }, nil?: true

#email ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 52

optional :email, String, nil?: true

#email_verified ⇒ Boolean^?

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/courier/models/user_profile.rb', line 57

optional :email_verified, Courier::Internal::Type::Boolean, nil?: true

#expo ⇒ Courier::Models::Token, ...

Expo push tokens. Supply either a single token or a tokens value.

Parameters:

• value (Courier::Models::expo, nil)

Returns:

• (Courier::Models::Token, Courier::Models::MultipleTokens, nil)

# File 'lib/courier/models/user_profile.rb', line 63

optional :expo, union: -> { Courier::Expo }, nil?: true

#facebook_psid ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 68

optional :facebook_psid, String, api_name: :facebookPSID, nil?: true

#family_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 73

optional :family_name, String, nil?: true

#firebase_token ⇒ String, ...

Parameters:

• value (Courier::Models::user_profile_firebase_token, nil)

Returns:

• (String, Array<String>, nil)

# File 'lib/courier/models/user_profile.rb', line 78

optional :firebase_token,
union: -> { Courier::UserProfileFirebaseToken },
api_name: :firebaseToken,
nil?: true

#gender ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 86

optional :gender, String, nil?: true

#given_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 91

optional :given_name, String, nil?: true

#intercom ⇒ Courier::Models::Intercom^?

Parameters:

• value (Courier::Intercom, nil)

Returns:

• (Courier::Models::Intercom, nil)

# File 'lib/courier/models/user_profile.rb', line 96

optional :intercom, -> { Courier::Intercom }, nil?: true

#locale ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 101

optional :locale, String, nil?: true

#middle_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 106

optional :middle_name, String, nil?: true

#ms_teams ⇒ Courier::Models::SendToMsTeamsUserID, ...

Parameters:

• value (Courier::Models::ms_teams, nil)

Returns:

• (Courier::Models::SendToMsTeamsUserID, Courier::Models::SendToMsTeamsEmail, Courier::Models::SendToMsTeamsChannelID, Courier::Models::SendToMsTeamsConversationID, Courier::Models::SendToMsTeamsChannelName, nil)

# File 'lib/courier/models/user_profile.rb', line 111

optional :ms_teams, union: -> { Courier::MsTeams }, nil?: true

#name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 116

optional :name, String, nil?: true

#nickname ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 121

optional :nickname, String, nil?: true

#phone_number ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 126

optional :phone_number, String, nil?: true

#phone_number_verified ⇒ Boolean^?

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/courier/models/user_profile.rb', line 131

optional :phone_number_verified, Courier::Internal::Type::Boolean, nil?: true

#picture ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 136

optional :picture, String, nil?: true

#preferred_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 141

optional :preferred_name, String, nil?: true

#profile ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 146

optional :profile, String, nil?: true

#slack ⇒ Courier::Models::SendToSlackChannel, ...

Parameters:

• value (Courier::Models::slack, nil)

Returns:

• (Courier::Models::SendToSlackChannel, Courier::Models::SendToSlackEmail, Courier::Models::SendToSlackUserID, nil)

# File 'lib/courier/models/user_profile.rb', line 151

optional :slack, union: -> { Courier::Slack }, nil?: true

#sub ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 156

optional :sub, String, nil?: true

#updated_at ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 161

optional :updated_at, String, nil?: true

#website ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 166

optional :website, String, nil?: true

#zoneinfo ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/courier/models/user_profile.rb', line 171

optional :zoneinfo, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/courier/models/user_profile.rbs', line 135

def to_hash: -> {