Class: Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveResponse

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

Overview

See Also:

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

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:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_status:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, created_at: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, reason: nil, terms_and_condition_url: nil, updated_at: nil, webhook_url: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveResponse for more details.

A verification request and its status, suitable for returning to users

Parameters:

  • id (String)
  • additional_information (String)
  • business_addr1 (String)
  • business_city (String)
  • business_contact_email (String)
  • business_contact_first_name (String)
  • business_contact_last_name (String)
  • business_contact_phone (String)
  • business_name (String)
  • business_state (String)
  • business_zip (String)
  • corporate_website (String)
  • message_volume (Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume) —

    Message Volume Enums

  • opt_in_workflow (String)
  • opt_in_workflow_image_urls (Array<Telnyx::Models::MessagingTollfree::Verification::URL>)
  • phone_numbers (Array<Telnyx::Models::MessagingTollfree::Verification::TfPhoneNumber>)
  • production_message_content (String)
  • use_case (Symbol, Telnyx::Models::MessagingTollfree::Verification::UseCaseCategories) —

    Tollfree usecase categories

  • use_case_summary (String)
  • verification_status (Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus) —

    Tollfree verification status

  • age_gated_content (Boolean) (defaults to: nil)
  • business_addr2 (String) (defaults to: nil)
  • business_registration_country (String) (defaults to: nil)
  • business_registration_number (String) (defaults to: nil)
  • business_registration_type (String) (defaults to: nil)
  • campaign_verify_authorization_token (String, nil) (defaults to: nil) —

    Campaign Verify Authorization Token required for Political use case submissions

  • created_at (Time) (defaults to: nil)
  • doing_business_as (String) (defaults to: nil)
  • entity_type (Symbol, Telnyx::Models::MessagingTollfree::Verification::MessagingTollFreeVerificationEntityType) (defaults to: nil) —

    Business entity classification

  • help_message_response (String) (defaults to: nil)
  • isv_reseller (String) (defaults to: nil)
  • opt_in_confirmation_response (String) (defaults to: nil)
  • opt_in_keywords (String) (defaults to: nil)
  • privacy_policy_url (String) (defaults to: nil)
  • reason (String) (defaults to: nil)
  • terms_and_condition_url (String) (defaults to: nil)
  • updated_at (Time) (defaults to: nil)
  • webhook_url (String) (defaults to: nil) 



# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 224

Instance Attribute Details

#additional_information ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :additional_information, String, api_name: :additionalInformation

#age_gated_content ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


127
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 127

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/request_retrieve_response.rb', line 22

required :business_addr1, String, api_name: :businessAddr1

#business_addr2 ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


132
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 132

optional :business_addr2, String, api_name: :businessAddr2

#business_city ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


27
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.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/request_retrieve_response.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/request_retrieve_response.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/request_retrieve_response.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/request_retrieve_response.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/request_retrieve_response.rb', line 52

required :business_name, String, api_name: :businessName

#business_registration_country ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


137
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 137

optional :business_registration_country, String, api_name: :businessRegistrationCountry

#business_registration_number ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


142
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 142

optional :business_registration_number, String, api_name: :businessRegistrationNumber

#business_registration_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


147
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 147

optional :business_registration_type, String, api_name: :businessRegistrationType

#business_state ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


57
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.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/request_retrieve_response.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) 


154
155
156
157
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 154

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/request_retrieve_response.rb', line 67

required :corporate_website, String, api_name: :corporateWebsite

#created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


162
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 162

optional :created_at, Time, api_name: :createdAt

#doing_business_as ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


167
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 167

optional :doing_business_as, String, api_name: :doingBusinessAs

#entity_type ⇒ Symbol, ...

Business entity classification

Returns:



173
174
175
176
177
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 173

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

#help_message_response ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :help_message_response, String, api_name: :helpMessageResponse

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#isv_reseller ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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/request_retrieve_response.rb', line 73

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

#opt_in_confirmation_response ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :opt_in_confirmation_response, String, api_name: :optInConfirmationResponse

#opt_in_keywords ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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/request_retrieve_response.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/request_retrieve_response.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/request_retrieve_response.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) 


202
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 202

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/request_retrieve_response.rb', line 101

required :production_message_content, String, api_name: :productionMessageContent

#reason ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


207
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 207

optional :reason, String

#terms_and_condition_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


212
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 212

optional :terms_and_condition_url, String, api_name: :termsAndConditionURL

#updated_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


217
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 217

optional :updated_at, Time, api_name: :updatedAt

#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/request_retrieve_response.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/request_retrieve_response.rb', line 114

required :use_case_summary, String, api_name: :useCaseSummary

#verification_status ⇒ Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus

Tollfree verification status

Parameters:

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

Returns:



120
121
122
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 120

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

#webhook_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


222
 
# File 'lib/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rb', line 222

optional :webhook_url, String, api_name: :webhookUrl

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


201
 
# File 'sig/telnyx/models/messaging_tollfree/verification/request_retrieve_response.rbs', line 201

def to_hash: -> {