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

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) 


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

required :additional_information, String, api_name: :additionalInformation

#age_gated_content ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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

#business_addr1 ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_addr1, String, api_name: :businessAddr1

#business_addr2 ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :business_addr2, String, api_name: :businessAddr2

#business_city ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_city, String, api_name: :businessCity

#business_contact_email ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_contact_email, String, api_name: :businessContactEmail

#business_contact_first_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_contact_first_name, String, api_name: :businessContactFirstName

#business_contact_last_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_contact_last_name, String, api_name: :businessContactLastName

#business_contact_phone ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_contact_phone, String, api_name: :businessContactPhone

#business_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_name, String, api_name: :businessName

#business_registration_country ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :business_registration_country, String, api_name: :businessRegistrationCountry

#business_registration_number ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :business_registration_number, String, api_name: :businessRegistrationNumber

#business_registration_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :business_registration_type, String, api_name: :businessRegistrationType

#business_state ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :business_state, String, api_name: :businessState

#business_zip ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

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) 


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

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

#corporate_website ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :corporate_website, String, api_name: :corporateWebsite

#doing_business_as ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :doing_business_as, String, api_name: :doingBusinessAs

#entity_type ⇒ Symbol, ...

Business entity classification

Returns:



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

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

#help_message_response ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :help_message_response, String, api_name: :helpMessageResponse

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#isv_reseller ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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:



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

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

#opt_in_confirmation_response ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :opt_in_confirmation_response, String, api_name: :optInConfirmationResponse

#opt_in_keywords ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :opt_in_keywords, String, api_name: :optInKeywords

#opt_in_workflow ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

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:



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

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:



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

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

#privacy_policy_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :privacy_policy_url, String, api_name: :privacyPolicyURL

#production_message_content ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :production_message_content, String, api_name: :productionMessageContent

#terms_and_condition_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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:



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

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

#use_case_summary ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :use_case_summary, String, api_name: :useCaseSummary

#verification_request_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :verification_request_id, String, api_name: :verificationRequestId

#verification_status ⇒ Symbol, ...

Tollfree verification status

Returns:



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

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

#webhook_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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: -> {