Class: Twilio::REST::Messaging::V1::TollfreeVerificationList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ TollfreeVerificationList

Initialize the TollfreeVerificationList



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

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

Instance Method Details

#create(business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :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, external_reference_id: :unset, business_registration_number: :unset, business_registration_authority: :unset, business_registration_country: :unset, business_type: :unset, business_registration_phone_number: :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, opt_in_keywords: :unset, vetting_provider: :unset, vetting_id: :unset) ⇒ TollfreeVerificationInstance

Create the TollfreeVerificationInstance



74
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
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 74

def create(
  business_name: nil, 
  business_website: nil, 
  notification_email: nil, 
  use_case_categories: nil, 
  use_case_summary: nil, 
  production_message_sample: nil, 
  opt_in_image_urls: nil, 
  opt_in_type: nil, 
  message_volume: nil, 
  tollfree_phone_number_sid: nil, 
  customer_profile_sid: :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, 
  external_reference_id: :unset, 
  business_registration_number: :unset, 
  business_registration_authority: :unset, 
  business_registration_country: :unset, 
  business_type: :unset, 
  business_registration_phone_number: :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, 
  opt_in_keywords: :unset, 
  vetting_provider: :unset, 
  vetting_id: :unset
)

    data = Twilio::Values.of({
        'BusinessName' => business_name,
        'BusinessWebsite' => business_website,
        'NotificationEmail' => notification_email,
        '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,
        'TollfreePhoneNumberSid' => tollfree_phone_number_sid,
        'CustomerProfileSid' => customer_profile_sid,
        '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,
        'ExternalReferenceId' => external_reference_id,
        'BusinessRegistrationNumber' => business_registration_number,
        'BusinessRegistrationAuthority' => business_registration_authority,
        'BusinessRegistrationCountry' => business_registration_country,
        'BusinessType' => business_type,
        'BusinessRegistrationPhoneNumber' => business_registration_phone_number,
        '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,
        'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e },
        'VettingProvider' => vetting_provider,
        'VettingId' => vetting_id,
    })

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

#create_with_metadata(business_name: nil, business_website: nil, notification_email: nil, use_case_categories: nil, use_case_summary: nil, production_message_sample: nil, opt_in_image_urls: nil, opt_in_type: nil, message_volume: nil, tollfree_phone_number_sid: nil, customer_profile_sid: :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, external_reference_id: :unset, business_registration_number: :unset, business_registration_authority: :unset, business_registration_country: :unset, business_type: :unset, business_registration_phone_number: :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, opt_in_keywords: :unset, vetting_provider: :unset, vetting_id: :unset) ⇒ TollfreeVerificationInstance

Create the TollfreeVerificationInstanceMetadata



207
208
209
210
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
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 207

def create_with_metadata(
  business_name: nil, 
  business_website: nil, 
  notification_email: nil, 
  use_case_categories: nil, 
  use_case_summary: nil, 
  production_message_sample: nil, 
  opt_in_image_urls: nil, 
  opt_in_type: nil, 
  message_volume: nil, 
  tollfree_phone_number_sid: nil, 
  customer_profile_sid: :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, 
  external_reference_id: :unset, 
  business_registration_number: :unset, 
  business_registration_authority: :unset, 
  business_registration_country: :unset, 
  business_type: :unset, 
  business_registration_phone_number: :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, 
  opt_in_keywords: :unset, 
  vetting_provider: :unset, 
  vetting_id: :unset
)

    data = Twilio::Values.of({
        'BusinessName' => business_name,
        'BusinessWebsite' => business_website,
        'NotificationEmail' => notification_email,
        '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,
        'TollfreePhoneNumberSid' => tollfree_phone_number_sid,
        'CustomerProfileSid' => customer_profile_sid,
        '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,
        'ExternalReferenceId' => external_reference_id,
        'BusinessRegistrationNumber' => business_registration_number,
        'BusinessRegistrationAuthority' => business_registration_authority,
        'BusinessRegistrationCountry' => business_registration_country,
        'BusinessType' => business_type,
        'BusinessRegistrationPhoneNumber' => business_registration_phone_number,
        '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,
        'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e },
        'VettingProvider' => vetting_provider,
        'VettingId' => vetting_id,
    })

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

#each ⇒ Object

When passed a block, yields TollfreeVerificationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 406

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of TollfreeVerificationInstance records from the API. Request is executed immediately.



458
459
460
461
462
463
464
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 458

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
TollfreeVerificationPage.new(@version, response, @solution)
end

#list(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, limit: nil, page_size: nil) ⇒ Array

Lists TollfreeVerificationInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.



323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 323

def list(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, limit: nil, page_size: nil)
    self.stream(
        tollfree_phone_number_sid: tollfree_phone_number_sid,
        status: status,
        external_reference_id: external_reference_id,
        include_sub_accounts: include_sub_accounts,
        trust_product_sid: trust_product_sid,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, limit: nil, page_size: nil) ⇒ Array 



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 383

def list_with_metadata(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'TollfreePhoneNumberSid' => tollfree_phone_number_sid,
        'Status' => status,
        'ExternalReferenceId' => external_reference_id,
        'IncludeSubAccounts' => include_sub_accounts,
        
        'TrustProductSid' =>  Twilio.serialize_list(trust_product_sid) { |e| e },
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    TollfreeVerificationPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of TollfreeVerificationInstance records from the API. Request is executed immediately.



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 432

def page(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'TollfreePhoneNumberSid' => tollfree_phone_number_sid,
        'Status' => status,
        'ExternalReferenceId' => external_reference_id,
        'IncludeSubAccounts' => include_sub_accounts,
        
        'TrustProductSid' =>  Twilio.serialize_list(trust_product_sid) { |e| e },
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    TollfreeVerificationPage.new(@version, response, @solution)
end

#stream(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 351

def stream(tollfree_phone_number_sid: :unset, status: :unset, external_reference_id: :unset, include_sub_accounts: :unset, trust_product_sid: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        tollfree_phone_number_sid: tollfree_phone_number_sid,
        status: status,
        external_reference_id: external_reference_id,
        include_sub_accounts: include_sub_accounts,
        trust_product_sid: trust_product_sid,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



469
470
471
 
# File 'lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb', line 469

def to_s
    '#<Twilio.Messaging.V1.TollfreeVerificationList>'
end