Class: Trycourier::Models::UserRecipient

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/user_recipient.rb

Defined Under Namespace

Classes: Preferences

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(account_id: nil, context: nil, data: nil, email: nil, list_id: nil, locale: nil, phone_number: nil, preferences: nil, tenant_id: nil, user_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::UserRecipient for more details.

Parameters:

  • account_id (String, nil) (defaults to: nil) —

    Deprecated - Use ‘tenant_id` instead.

  • context (Trycourier::Models::MessageContext, nil) (defaults to: nil) —

    Context such as tenant_id to send the notification with.

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

    The user’s email address.

  • list_id (String, nil) (defaults to: nil) —

    The id of the list to send the message to.

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

    The user’s preferred ISO 639-1 language code.

  • phone_number (String, nil) (defaults to: nil) —

    The user’s phone number.

  • preferences (Trycourier::Models::UserRecipient::Preferences, nil) (defaults to: nil)
  • tenant_id (String, nil) (defaults to: nil) —

    The id of the tenant the user is associated with.

  • user_id (String, nil) (defaults to: nil) —

    The user’s unique identifier. Typically, this will match the user id of a user i




# File 'lib/trycourier/models/user_recipient.rb', line 65

Instance Attribute Details

#account_id ⇒ String?

Deprecated - Use ‘tenant_id` instead.

Returns:

  • (String, nil) 


10
 
# File 'lib/trycourier/models/user_recipient.rb', line 10

optional :account_id, String, nil?: true

#context ⇒ Trycourier::Models::MessageContext?

Context such as tenant_id to send the notification with.

Returns:



16
 
# File 'lib/trycourier/models/user_recipient.rb', line 16

optional :context, -> { Trycourier::MessageContext }, nil?: true

#data ⇒ Hash{Symbol=>Object}?

Returns:

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


21
 
# File 'lib/trycourier/models/user_recipient.rb', line 21

optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true

#email ⇒ String?

The user’s email address.

Returns:

  • (String, nil) 


27
 
# File 'lib/trycourier/models/user_recipient.rb', line 27

optional :email, String, nil?: true

#list_id ⇒ String?

The id of the list to send the message to.

Returns:

  • (String, nil) 


33
 
# File 'lib/trycourier/models/user_recipient.rb', line 33

optional :list_id, String, nil?: true

#locale ⇒ String?

The user’s preferred ISO 639-1 language code.

Returns:

  • (String, nil) 


39
 
# File 'lib/trycourier/models/user_recipient.rb', line 39

optional :locale, String, nil?: true

#phone_number ⇒ String?

The user’s phone number.

Returns:

  • (String, nil) 


45
 
# File 'lib/trycourier/models/user_recipient.rb', line 45

optional :phone_number, String, nil?: true

#preferences ⇒ Trycourier::Models::UserRecipient::Preferences?

Returns:



50
 
# File 'lib/trycourier/models/user_recipient.rb', line 50

optional :preferences, -> { Trycourier::UserRecipient::Preferences }, nil?: true

#tenant_id ⇒ String?

The id of the tenant the user is associated with.

Returns:

  • (String, nil) 


56
 
# File 'lib/trycourier/models/user_recipient.rb', line 56

optional :tenant_id, String, nil?: true

#user_id ⇒ String?

The user’s unique identifier. Typically, this will match the user id of a user in your system.

Returns:

  • (String, nil) 


63
 
# File 'lib/trycourier/models/user_recipient.rb', line 63

optional :user_id, String, nil?: true