Class: Telnyx::Models::EmailDomains::EmailWebhook

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/email_domains/email_webhook.rb,
sig/telnyx/models/email_domains/email_webhook.rbs

Overview

See Also:

  • Telnyx::Resources::EmailDomains::Webhooks#list

Defined Under Namespace

Modules: RecordType

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:, created_at:, domain_id:, events:, record_type:, updated_at:, url:) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailDomains::EmailWebhook for more details.

Parameters:




# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 46

Instance Attribute Details

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


16
 
# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 16

required :created_at, Time

#domain_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 21

required :domain_id, String

#events ⇒ Array<Symbol, Telnyx::Models::EmailDomains::EmailWebhookEvent>

Allowlist of event types delivered to this webhook. At least one event is required — there is no default-to-all.

Parameters:

  • value (::Array[Telnyx::Models::EmailDomains::email_webhook_event])

Returns:



28
 
# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 28

required :events, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::EmailDomains::EmailWebhookEvent] }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 11

required :id, String

#record_type ⇒ Symbol, Telnyx::Models::EmailDomains::EmailWebhook::RecordType

Parameters:

  • value (Telnyx::Models::EmailDomains::EmailWebhook::record_type)

Returns:



33
 
# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 33

required :record_type, enum: -> { Telnyx::EmailDomains::EmailWebhook::RecordType }

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


38
 
# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 38

required :updated_at, Time

#url ⇒ String

HTTPS endpoint to deliver subscribed events to.

Parameters:

  • value (String)

Returns:

  • (String) 


44
 
# File 'lib/telnyx/models/email_domains/email_webhook.rb', line 44

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


40
 
# File 'sig/telnyx/models/email_domains/email_webhook.rbs', line 40

def to_hash: -> {