Class: Telnyx::Models::MessagingTollfree::Verification::VerificationRequestEgress

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb,
sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs

Overview

See Also:

  • Telnyx::Resources::MessagingTollfree::Verification::Requests#create

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 ⇒ Object 



154
 
# File 'sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs', line 154

def initialize: (

Instance Attribute Details

#additional_information ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 17

required :additional_information, String, api_name: :additionalInformation

#age_gated_content ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


124
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 124

optional :age_gated_content, Telnyx::Internal::Type::Boolean, api_name: :ageGatedContent

#business_addr1 ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 22

required :business_addr1, String, api_name: :businessAddr1

#business_addr2 ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


129
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 129

optional :business_addr2, String, api_name: :businessAddr2

#business_city ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


27
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 27

required :business_city, String, api_name: :businessCity

#business_contact_email ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


32
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 32

required :business_contact_email, String, api_name: :businessContactEmail

#business_contact_first_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


37
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 37

required :business_contact_first_name, String, api_name: :businessContactFirstName

#business_contact_last_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


42
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 42

required :business_contact_last_name, String, api_name: :businessContactLastName

#business_contact_phone ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


47
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 47

required :business_contact_phone, String, api_name: :businessContactPhone

#business_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


52
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 52

required :business_name, String, api_name: :businessName

#business_registration_country ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


134
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 134

optional :business_registration_country, String, api_name: :businessRegistrationCountry

#business_registration_number ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


139
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 139

optional :business_registration_number, String, api_name: :businessRegistrationNumber

#business_registration_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


144
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 144

optional :business_registration_type, String, api_name: :businessRegistrationType

#business_state ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


57
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 57

required :business_state, String, api_name: :businessState

#business_zip ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


62
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 62

required :business_zip, String, api_name: :businessZip

#campaign_verify_authorization_token ⇒ String?

Campaign Verify Authorization Token required for Political use case submissions starting February 17, 2026

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


151
152
153
154
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 151

optional :campaign_verify_authorization_token,
String,
api_name: :campaignVerifyAuthorizationToken,
nil?: true

#corporate_website ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


67
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 67

required :corporate_website, String, api_name: :corporateWebsite

#doing_business_as ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


159
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 159

optional :doing_business_as, String, api_name: :doingBusinessAs

#entity_type ⇒ Symbol, ...

Business entity classification

Returns:



165
166
167
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 165

optional :entity_type,
enum: -> { Telnyx::MessagingTollfree::Verification::TollFreeVerificationEntityType },
api_name: :entityType

#help_message_response ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


172
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 172

optional :help_message_response, String, api_name: :helpMessageResponse

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 12

required :id, String

#isv_reseller ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


177
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 177

optional :isv_reseller, String, api_name: :isvReseller

#message_volume ⇒ Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume

Message Volume Enums

Parameters:

  • value (Telnyx::Models::MessagingTollfree::Verification::volume)

Returns:



73
74
75
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 73

required :message_volume,
enum: -> { Telnyx::MessagingTollfree::Verification::Volume },
api_name: :messageVolume

#opt_in_confirmation_response ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


182
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 182

optional :opt_in_confirmation_response, String, api_name: :optInConfirmationResponse

#opt_in_keywords ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


187
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 187

optional :opt_in_keywords, String, api_name: :optInKeywords

#opt_in_workflow ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


80
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 80

required :opt_in_workflow, String, api_name: :optInWorkflow

#opt_in_workflow_image_urls ⇒ Array<Telnyx::Models::MessagingTollfree::Verification::URL>

Parameters:

  • value (::Array[Telnyx::MessagingTollfree::Verification::URL])

Returns:



85
86
87
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 85

required :opt_in_workflow_image_urls,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingTollfree::Verification::URL] },
api_name: :optInWorkflowImageURLs

#phone_numbers ⇒ Array<Telnyx::Models::MessagingTollfree::Verification::TfPhoneNumber>

Parameters:

  • value (::Array[Telnyx::MessagingTollfree::Verification::TfPhoneNumber])

Returns:



92
93
94
95
96
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 92

required :phone_numbers,
-> {
  Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingTollfree::Verification::TfPhoneNumber]
},
api_name: :phoneNumbers

#privacy_policy_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


192
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 192

optional :privacy_policy_url, String, api_name: :privacyPolicyURL

#production_message_content ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


101
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 101

required :production_message_content, String, api_name: :productionMessageContent

#terms_and_condition_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


197
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 197

optional :terms_and_condition_url, String, api_name: :termsAndConditionURL

#use_case ⇒ Symbol, Telnyx::Models::MessagingTollfree::Verification::UseCaseCategories

Tollfree usecase categories

Parameters:

  • value (Telnyx::Models::MessagingTollfree::Verification::use_case_categories)

Returns:



107
108
109
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 107

required :use_case,
enum: -> { Telnyx::MessagingTollfree::Verification::UseCaseCategories },
api_name: :useCase

#use_case_summary ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


114
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 114

required :use_case_summary, String, api_name: :useCaseSummary

#verification_request_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


119
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 119

required :verification_request_id, String, api_name: :verificationRequestId

#verification_status ⇒ Symbol, ...

Tollfree verification status

Returns:



203
204
205
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 203

optional :verification_status,
enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationStatus },
api_name: :verificationStatus

#webhook_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


210
 
# File 'lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb', line 210

optional :webhook_url, String, api_name: :webhookUrl

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


193
 
# File 'sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs', line 193

def to_hash: -> {