Class: Twilio::REST::Trusthub::V1::ComplianceTollfreeInquiriesList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ComplianceTollfreeInquiriesList

Initialize the ComplianceTollfreeInquiriesList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/ComplianceInquiries/Tollfree/Initialize"
    
end

Instance Method Details

#create(tollfree_phone_number: nil, notification_email: nil, customer_profile_sid: :unset, business_name: :unset, business_website: :unset, use_case_categories: :unset, use_case_summary: :unset, production_message_sample: :unset, opt_in_image_urls: :unset, opt_in_type: :unset, message_volume: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, theme_set_id: :unset, skip_messaging_use_case: :unset, business_registration_number: :unset, business_registration_authority: :unset, business_registration_country: :unset, business_type: :unset, doing_business_as: :unset, opt_in_confirmation_message: :unset, help_message_sample: :unset, privacy_policy_url: :unset, terms_and_conditions_url: :unset, age_gated_content: :unset, external_reference_id: :unset, opt_in_keywords: :unset, vetting_id: :unset, vetting_provider: :unset) ⇒ ComplianceTollfreeInquiriesInstance

Create the ComplianceTollfreeInquiriesInstance

Parameters:

  • tollfree_phone_number (String) (defaults to: nil) —

    The Tollfree phone number to be verified

  • notification_email (String) (defaults to: nil) —

    The email address to receive the notification about the verification result.

  • customer_profile_sid (String) (defaults to: :unset) —

    The Customer Profile Sid associated with the Account.

  • business_name (String) (defaults to: :unset) —

    The name of the business or organization using the Tollfree number.

  • business_website (String) (defaults to: :unset) —

    The website of the business or organization using the Tollfree number.

  • use_case_categories (Array[String]) (defaults to: :unset) —

    The category of the use case for the Tollfree Number. List as many are applicable..

  • use_case_summary (String) (defaults to: :unset) —

    Use this to further explain how messaging is used by the business or organization.

  • production_message_sample (String) (defaults to: :unset) —

    An example of message content, i.e. a sample message.

  • opt_in_image_urls (Array[String]) (defaults to: :unset) —

    Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.

  • opt_in_type (OptInType) (defaults to: :unset)
  • message_volume (String) (defaults to: :unset) —

    Estimate monthly volume of messages from the Tollfree Number.

  • business_street_address (String) (defaults to: :unset) —

    The address of the business or organization using the Tollfree number.

  • business_street_address2 (String) (defaults to: :unset) —

    The address of the business or organization using the Tollfree number.

  • business_city (String) (defaults to: :unset) —

    The city of the business or organization using the Tollfree number.

  • business_state_province_region (String) (defaults to: :unset) —

    The state/province/region of the business or organization using the Tollfree number.

  • business_postal_code (String) (defaults to: :unset) —

    The postal code of the business or organization using the Tollfree number.

  • business_country (String) (defaults to: :unset) —

    The country of the business or organization using the Tollfree number.

  • additional_information (String) (defaults to: :unset) —

    Additional information to be provided for verification.

  • business_contact_first_name (String) (defaults to: :unset) —

    The first name of the contact for the business or organization using the Tollfree number.

  • business_contact_last_name (String) (defaults to: :unset) —

    The last name of the contact for the business or organization using the Tollfree number.

  • business_contact_email (String) (defaults to: :unset) —

    The email address of the contact for the business or organization using the Tollfree number.

  • business_contact_phone (String) (defaults to: :unset) —

    The phone number of the contact for the business or organization using the Tollfree number.

  • theme_set_id (String) (defaults to: :unset) —

    Theme id for styling the inquiry form.

  • skip_messaging_use_case (Boolean) (defaults to: :unset) —

    Skip the messaging use case screen of the inquiry form.

  • business_registration_number (String) (defaults to: :unset) —

    The Business Registration Number of the business or organization.

  • business_registration_authority (String) (defaults to: :unset) —

    The Business Registration Authority of the business or organization.

  • business_registration_country (String) (defaults to: :unset) —

    The Business Registration Country of the business or organization.

  • business_type (BusinessType) (defaults to: :unset)
  • doing_business_as (String) (defaults to: :unset) —

    Trade name, sub entity, or downstream business name of business being submitted for verification.

  • opt_in_confirmation_message (String) (defaults to: :unset) —

    The confirmation message sent to users when they opt in to receive messages.

  • help_message_sample (String) (defaults to: :unset) —

    A sample help message provided to users.

  • privacy_policy_url (String) (defaults to: :unset) —

    The URL to the privacy policy for the business or organization.

  • terms_and_conditions_url (String) (defaults to: :unset) —

    The URL to the terms and conditions for the business or organization.

  • age_gated_content (Boolean) (defaults to: :unset) —

    Indicates if the content is age gated.

  • external_reference_id (String) (defaults to: :unset) —

    A legally recognized business registration number.

  • opt_in_keywords (Array[String]) (defaults to: :unset) —

    List of keywords that users can text in to opt in to receive messages.

  • vetting_id (String) (defaults to: :unset) —

    Unique identifier for the created Vetting .

  • vetting_provider (String) (defaults to: :unset) —

    Name of the vetting provider.

Returns:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb', line 75

def create(
    tollfree_phone_number: nil, 
    notification_email: nil, 
    customer_profile_sid: :unset, 
    business_name: :unset, 
    business_website: :unset, 
    use_case_categories: :unset, 
    use_case_summary: :unset, 
    production_message_sample: :unset, 
    opt_in_image_urls: :unset, 
    opt_in_type: :unset, 
    message_volume: :unset, 
    business_street_address: :unset, 
    business_street_address2: :unset, 
    business_city: :unset, 
    business_state_province_region: :unset, 
    business_postal_code: :unset, 
    business_country: :unset, 
    additional_information: :unset, 
    business_contact_first_name: :unset, 
    business_contact_last_name: :unset, 
    business_contact_email: :unset, 
    business_contact_phone: :unset, 
    theme_set_id: :unset, 
    skip_messaging_use_case: :unset, 
    business_registration_number: :unset, 
    business_registration_authority: :unset, 
    business_registration_country: :unset, 
    business_type: :unset, 
    doing_business_as: :unset, 
    opt_in_confirmation_message: :unset, 
    help_message_sample: :unset, 
    privacy_policy_url: :unset, 
    terms_and_conditions_url: :unset, 
    age_gated_content: :unset, 
    external_reference_id: :unset, 
    opt_in_keywords: :unset, 
    vetting_id: :unset, 
    vetting_provider: :unset
)

    data = Twilio::Values.of({
        'TollfreePhoneNumber' => tollfree_phone_number,
        'NotificationEmail' => notification_email,
        'CustomerProfileSid' => customer_profile_sid,
        'BusinessName' => business_name,
        'BusinessWebsite' => business_website,
        'UseCaseCategories' => Twilio.serialize_list(use_case_categories) { |e| e },
        'UseCaseSummary' => use_case_summary,
        'ProductionMessageSample' => production_message_sample,
        'OptInImageUrls' => Twilio.serialize_list(opt_in_image_urls) { |e| e },
        'OptInType' => opt_in_type,
        'MessageVolume' => message_volume,
        'BusinessStreetAddress' => business_street_address,
        'BusinessStreetAddress2' => business_street_address2,
        'BusinessCity' => business_city,
        'BusinessStateProvinceRegion' => business_state_province_region,
        'BusinessPostalCode' => business_postal_code,
        'BusinessCountry' => business_country,
        'AdditionalInformation' => additional_information,
        'BusinessContactFirstName' => business_contact_first_name,
        'BusinessContactLastName' => business_contact_last_name,
        'BusinessContactEmail' => business_contact_email,
        'BusinessContactPhone' => business_contact_phone,
        'ThemeSetId' => theme_set_id,
        'SkipMessagingUseCase' => skip_messaging_use_case,
        'BusinessRegistrationNumber' => business_registration_number,
        'BusinessRegistrationAuthority' => business_registration_authority,
        'BusinessRegistrationCountry' => business_registration_country,
        'BusinessType' => business_type,
        'DoingBusinessAs' => doing_business_as,
        'OptInConfirmationMessage' => opt_in_confirmation_message,
        'HelpMessageSample' => help_message_sample,
        'PrivacyPolicyUrl' => privacy_policy_url,
        'TermsAndConditionsUrl' => terms_and_conditions_url,
        'AgeGatedContent' => age_gated_content,
        'ExternalReferenceId' => external_reference_id,
        'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e },
        'VettingId' => vetting_id,
        'VettingProvider' => vetting_provider,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ComplianceTollfreeInquiriesInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(tollfree_phone_number: nil, notification_email: nil, customer_profile_sid: :unset, business_name: :unset, business_website: :unset, use_case_categories: :unset, use_case_summary: :unset, production_message_sample: :unset, opt_in_image_urls: :unset, opt_in_type: :unset, message_volume: :unset, business_street_address: :unset, business_street_address2: :unset, business_city: :unset, business_state_province_region: :unset, business_postal_code: :unset, business_country: :unset, additional_information: :unset, business_contact_first_name: :unset, business_contact_last_name: :unset, business_contact_email: :unset, business_contact_phone: :unset, theme_set_id: :unset, skip_messaging_use_case: :unset, business_registration_number: :unset, business_registration_authority: :unset, business_registration_country: :unset, business_type: :unset, doing_business_as: :unset, opt_in_confirmation_message: :unset, help_message_sample: :unset, privacy_policy_url: :unset, terms_and_conditions_url: :unset, age_gated_content: :unset, external_reference_id: :unset, opt_in_keywords: :unset, vetting_id: :unset, vetting_provider: :unset) ⇒ ComplianceTollfreeInquiriesInstance

Create the ComplianceTollfreeInquiriesInstanceMetadata

Parameters:

  • tollfree_phone_number (String) (defaults to: nil) —

    The Tollfree phone number to be verified

  • notification_email (String) (defaults to: nil) —

    The email address to receive the notification about the verification result.

  • customer_profile_sid (String) (defaults to: :unset) —

    The Customer Profile Sid associated with the Account.

  • business_name (String) (defaults to: :unset) —

    The name of the business or organization using the Tollfree number.

  • business_website (String) (defaults to: :unset) —

    The website of the business or organization using the Tollfree number.

  • use_case_categories (Array[String]) (defaults to: :unset) —

    The category of the use case for the Tollfree Number. List as many are applicable..

  • use_case_summary (String) (defaults to: :unset) —

    Use this to further explain how messaging is used by the business or organization.

  • production_message_sample (String) (defaults to: :unset) —

    An example of message content, i.e. a sample message.

  • opt_in_image_urls (Array[String]) (defaults to: :unset) —

    Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.

  • opt_in_type (OptInType) (defaults to: :unset)
  • message_volume (String) (defaults to: :unset) —

    Estimate monthly volume of messages from the Tollfree Number.

  • business_street_address (String) (defaults to: :unset) —

    The address of the business or organization using the Tollfree number.

  • business_street_address2 (String) (defaults to: :unset) —

    The address of the business or organization using the Tollfree number.

  • business_city (String) (defaults to: :unset) —

    The city of the business or organization using the Tollfree number.

  • business_state_province_region (String) (defaults to: :unset) —

    The state/province/region of the business or organization using the Tollfree number.

  • business_postal_code (String) (defaults to: :unset) —

    The postal code of the business or organization using the Tollfree number.

  • business_country (String) (defaults to: :unset) —

    The country of the business or organization using the Tollfree number.

  • additional_information (String) (defaults to: :unset) —

    Additional information to be provided for verification.

  • business_contact_first_name (String) (defaults to: :unset) —

    The first name of the contact for the business or organization using the Tollfree number.

  • business_contact_last_name (String) (defaults to: :unset) —

    The last name of the contact for the business or organization using the Tollfree number.

  • business_contact_email (String) (defaults to: :unset) —

    The email address of the contact for the business or organization using the Tollfree number.

  • business_contact_phone (String) (defaults to: :unset) —

    The phone number of the contact for the business or organization using the Tollfree number.

  • theme_set_id (String) (defaults to: :unset) —

    Theme id for styling the inquiry form.

  • skip_messaging_use_case (Boolean) (defaults to: :unset) —

    Skip the messaging use case screen of the inquiry form.

  • business_registration_number (String) (defaults to: :unset) —

    The Business Registration Number of the business or organization.

  • business_registration_authority (String) (defaults to: :unset) —

    The Business Registration Authority of the business or organization.

  • business_registration_country (String) (defaults to: :unset) —

    The Business Registration Country of the business or organization.

  • business_type (BusinessType) (defaults to: :unset)
  • doing_business_as (String) (defaults to: :unset) —

    Trade name, sub entity, or downstream business name of business being submitted for verification.

  • opt_in_confirmation_message (String) (defaults to: :unset) —

    The confirmation message sent to users when they opt in to receive messages.

  • help_message_sample (String) (defaults to: :unset) —

    A sample help message provided to users.

  • privacy_policy_url (String) (defaults to: :unset) —

    The URL to the privacy policy for the business or organization.

  • terms_and_conditions_url (String) (defaults to: :unset) —

    The URL to the terms and conditions for the business or organization.

  • age_gated_content (Boolean) (defaults to: :unset) —

    Indicates if the content is age gated.

  • external_reference_id (String) (defaults to: :unset) —

    A legally recognized business registration number.

  • opt_in_keywords (Array[String]) (defaults to: :unset) —

    List of keywords that users can text in to opt in to receive messages.

  • vetting_id (String) (defaults to: :unset) —

    Unique identifier for the created Vetting .

  • vetting_provider (String) (defaults to: :unset) —

    Name of the vetting provider.

Returns:



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb', line 211

def create_with_metadata(
  tollfree_phone_number: nil, 
  notification_email: nil, 
  customer_profile_sid: :unset, 
  business_name: :unset, 
  business_website: :unset, 
  use_case_categories: :unset, 
  use_case_summary: :unset, 
  production_message_sample: :unset, 
  opt_in_image_urls: :unset, 
  opt_in_type: :unset, 
  message_volume: :unset, 
  business_street_address: :unset, 
  business_street_address2: :unset, 
  business_city: :unset, 
  business_state_province_region: :unset, 
  business_postal_code: :unset, 
  business_country: :unset, 
  additional_information: :unset, 
  business_contact_first_name: :unset, 
  business_contact_last_name: :unset, 
  business_contact_email: :unset, 
  business_contact_phone: :unset, 
  theme_set_id: :unset, 
  skip_messaging_use_case: :unset, 
  business_registration_number: :unset, 
  business_registration_authority: :unset, 
  business_registration_country: :unset, 
  business_type: :unset, 
  doing_business_as: :unset, 
  opt_in_confirmation_message: :unset, 
  help_message_sample: :unset, 
  privacy_policy_url: :unset, 
  terms_and_conditions_url: :unset, 
  age_gated_content: :unset, 
  external_reference_id: :unset, 
  opt_in_keywords: :unset, 
  vetting_id: :unset, 
  vetting_provider: :unset
)

    data = Twilio::Values.of({
        'TollfreePhoneNumber' => tollfree_phone_number,
        'NotificationEmail' => notification_email,
        'CustomerProfileSid' => customer_profile_sid,
        'BusinessName' => business_name,
        'BusinessWebsite' => business_website,
        'UseCaseCategories' => Twilio.serialize_list(use_case_categories) { |e| e },
        'UseCaseSummary' => use_case_summary,
        'ProductionMessageSample' => production_message_sample,
        'OptInImageUrls' => Twilio.serialize_list(opt_in_image_urls) { |e| e },
        'OptInType' => opt_in_type,
        'MessageVolume' => message_volume,
        'BusinessStreetAddress' => business_street_address,
        'BusinessStreetAddress2' => business_street_address2,
        'BusinessCity' => business_city,
        'BusinessStateProvinceRegion' => business_state_province_region,
        'BusinessPostalCode' => business_postal_code,
        'BusinessCountry' => business_country,
        'AdditionalInformation' => additional_information,
        'BusinessContactFirstName' => business_contact_first_name,
        'BusinessContactLastName' => business_contact_last_name,
        'BusinessContactEmail' => business_contact_email,
        'BusinessContactPhone' => business_contact_phone,
        'ThemeSetId' => theme_set_id,
        'SkipMessagingUseCase' => skip_messaging_use_case,
        'BusinessRegistrationNumber' => business_registration_number,
        'BusinessRegistrationAuthority' => business_registration_authority,
        'BusinessRegistrationCountry' => business_registration_country,
        'BusinessType' => business_type,
        'DoingBusinessAs' => doing_business_as,
        'OptInConfirmationMessage' => opt_in_confirmation_message,
        'HelpMessageSample' => help_message_sample,
        'PrivacyPolicyUrl' => privacy_policy_url,
        'TermsAndConditionsUrl' => terms_and_conditions_url,
        'AgeGatedContent' => age_gated_content,
        'ExternalReferenceId' => external_reference_id,
        'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e },
        'VettingId' => vetting_id,
        'VettingProvider' => vetting_provider,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    compliance_tollfree_inquiries_instance = ComplianceTollfreeInquiriesInstance.new(
        @version,
        response.body,
    )
    ComplianceTollfreeInquiriesInstanceMetadata.new(
        @version,
        compliance_tollfree_inquiries_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



316
317
318
 
# File 'lib/twilio-ruby/rest/trusthub/v1/compliance_tollfree_inquiries.rb', line 316

def to_s
    '#<Twilio.Trusthub.V1.ComplianceTollfreeInquiriesList>'
end