Class: Zavudev::Models::Sender

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/sender.rb,
sig/zavudev/models/sender.rbs

Overview

See Also:

  • Zavudev::Resources::Senders#create

Defined Under Namespace

Classes: Whatsapp

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(id:, name:, phone_number:, channels: nil, created_at: nil, email_address: nil, email_catch_all_enabled: nil, email_receiving_enabled: nil, is_default: nil, updated_at: nil, webhook: nil, whatsapp: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::Sender for more details.

Parameters:

  • id (String)
  • name (String)
  • phone_number (String) —

    Phone number in E.164 format.

  • channels (Array<String>) (defaults to: nil) —

    Channels this sender can actually send on right now, computed from its configura

  • created_at (Time) (defaults to: nil)
  • email_address (String) (defaults to: nil) —

    From-address for the email channel, if configured.

  • email_catch_all_enabled (Boolean) (defaults to: nil) —

    Whether catch-all receiving is enabled. When true (and emailReceivingEnabled is

  • email_receiving_enabled (Boolean) (defaults to: nil) —

    Whether inbound email receiving is enabled for this sender.

  • is_default (Boolean) (defaults to: nil) —

    Whether this sender is the project's default.

  • updated_at (Time) (defaults to: nil)
  • webhook (Zavudev::Models::SenderWebhook) (defaults to: nil) —

    Webhook configuration for the sender.

  • whatsapp (Zavudev::Models::Sender::Whatsapp) (defaults to: nil) —

    WhatsApp Business Account information. Only present if a WABA is connected.




# File 'lib/zavudev/models/sender.rb', line 81

Instance Attribute Details

#channels ⇒ Array<String>?

Channels this sender can actually send on right now, computed from its configuration. Empty means the sender cannot send or receive anything yet: a phoneNumber alone does not enable SMS or voice. Check this rather than inferring capability from phoneNumber or emailAddress.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


30
 
# File 'lib/zavudev/models/sender.rb', line 30

optional :channels, Zavudev::Internal::Type::ArrayOf[String]

#created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


35
 
# File 'lib/zavudev/models/sender.rb', line 35

optional :created_at, Time, api_name: :createdAt

#email_address ⇒ String?

From-address for the email channel, if configured.

Parameters:

  • (String)

Returns:

  • (String, nil) 


41
 
# File 'lib/zavudev/models/sender.rb', line 41

optional :email_address, String, api_name: :emailAddress

#email_catch_all_enabled ⇒ Boolean?

Whether catch-all receiving is enabled. When true (and emailReceivingEnabled is true), this sender receives email addressed to any local part at its domain, not just its own address. The original recipient is delivered in the message.inbound webhook's data.to.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


50
 
# File 'lib/zavudev/models/sender.rb', line 50

optional :email_catch_all_enabled, Zavudev::Internal::Type::Boolean, api_name: :emailCatchAllEnabled

#email_receiving_enabled ⇒ Boolean?

Whether inbound email receiving is enabled for this sender.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


56
 
# File 'lib/zavudev/models/sender.rb', line 56

optional :email_receiving_enabled, Zavudev::Internal::Type::Boolean, api_name: :emailReceivingEnabled

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/zavudev/models/sender.rb', line 10

required :id, String

#is_default ⇒ Boolean?

Whether this sender is the project's default.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


62
 
# File 'lib/zavudev/models/sender.rb', line 62

optional :is_default, Zavudev::Internal::Type::Boolean, api_name: :isDefault

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/zavudev/models/sender.rb', line 15

required :name, String

#phone_number ⇒ String

Phone number in E.164 format.

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/zavudev/models/sender.rb', line 21

required :phone_number, String, api_name: :phoneNumber

#updated_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


67
 
# File 'lib/zavudev/models/sender.rb', line 67

optional :updated_at, Time, api_name: :updatedAt

#webhook ⇒ Zavudev::Models::SenderWebhook?

Webhook configuration for the sender.

Parameters:

Returns:



73
 
# File 'lib/zavudev/models/sender.rb', line 73

optional :webhook, -> { Zavudev::SenderWebhook }

#whatsapp ⇒ Zavudev::Models::Sender::Whatsapp?

WhatsApp Business Account information. Only present if a WABA is connected.

Parameters:

  • (Zavudev::Sender::Whatsapp)

Returns:



79
 
# File 'lib/zavudev/models/sender.rb', line 79

optional :whatsapp, -> { Zavudev::Sender::Whatsapp }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


77
 
# File 'sig/zavudev/models/sender.rbs', line 77

def to_hash: -> {