Class: Telnyx::Models::EmailValidations::BatchCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/email_validations/batch_create_params.rb,
sig/telnyx/models/email_validations/batch_create_params.rbs

Overview

See Also:

  • Telnyx::Resources::EmailValidations::Batch#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(emails:, webhook_url: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailValidations::BatchCreateParams for more details.

Parameters:

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

    URL for batch completion webhook. Empty string is treated as omitted. SSRF-prote

  • idempotency_key (String) (defaults to: nil)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/telnyx/models/email_validations/batch_create_params.rb', line 28

Instance Attribute Details

#emails ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


14
 
# File 'lib/telnyx/models/email_validations/batch_create_params.rb', line 14

required :emails, Telnyx::Internal::Type::ArrayOf[String]

#idempotency_key ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


26
 
# File 'lib/telnyx/models/email_validations/batch_create_params.rb', line 26

optional :idempotency_key, String

#webhook_url ⇒ String?

URL for batch completion webhook. Empty string is treated as omitted. SSRF-protected; private/reserved IPs and internal hostnames are rejected.

Parameters:

  • (String)

Returns:

  • (String, nil) 


21
 
# File 'lib/telnyx/models/email_validations/batch_create_params.rb', line 21

optional :webhook_url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


33
 
# File 'sig/telnyx/models/email_validations/batch_create_params.rbs', line 33

def to_hash: -> {