bandwidth-sdk 14.0.0 → 14.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +9 -9
  3. data/README.md +42 -10
  4. data/bandwidth.yml +1102 -0
  5. data/coverage/.last_run.json +1 -1
  6. data/coverage/.resultset.json +1204 -231
  7. data/coverage/index.html +20499 -10053
  8. data/custom_templates/README.mustache +6 -6
  9. data/docs/AdditionalDenialReason.md +22 -0
  10. data/docs/Address.md +30 -0
  11. data/docs/Contact.md +24 -0
  12. data/docs/Error.md +22 -0
  13. data/docs/FailureWebhook.md +28 -0
  14. data/docs/LinksObject.md +24 -0
  15. data/docs/OptInWorkflow.md +20 -0
  16. data/docs/TelephoneNumber.md +18 -0
  17. data/docs/TfvBasicAuthentication.md +20 -0
  18. data/docs/TfvCallbackStatusEnum.md +15 -0
  19. data/docs/TfvError.md +22 -0
  20. data/docs/TfvStatus.md +32 -0
  21. data/docs/TfvStatusEnum.md +15 -0
  22. data/docs/TfvSubmissionInfo.md +34 -0
  23. data/docs/TfvSubmissionWrapper.md +18 -0
  24. data/docs/TollFreeVerificationApi.md +585 -0
  25. data/docs/VerificationDenialWebhook.md +32 -0
  26. data/docs/VerificationRequest.md +36 -0
  27. data/docs/VerificationUpdateRequest.md +34 -0
  28. data/docs/VerificationWebhook.md +24 -0
  29. data/docs/WebhookSubscription.md +30 -0
  30. data/docs/WebhookSubscriptionBasicAuthentication.md +20 -0
  31. data/docs/WebhookSubscriptionRequestSchema.md +22 -0
  32. data/docs/WebhookSubscriptionTypeEnum.md +15 -0
  33. data/docs/WebhookSubscriptionsListBody.md +22 -0
  34. data/lib/bandwidth-sdk/api/toll_free_verification_api.rb +614 -0
  35. data/lib/bandwidth-sdk/configuration.rb +48 -0
  36. data/lib/bandwidth-sdk/models/additional_denial_reason.rb +254 -0
  37. data/lib/bandwidth-sdk/models/address.rb +501 -0
  38. data/lib/bandwidth-sdk/models/contact.rb +393 -0
  39. data/lib/bandwidth-sdk/models/error.rb +232 -0
  40. data/lib/bandwidth-sdk/models/failure_webhook.rb +304 -0
  41. data/lib/bandwidth-sdk/models/links_object.rb +243 -0
  42. data/lib/bandwidth-sdk/models/opt_in_workflow.rb +265 -0
  43. data/lib/bandwidth-sdk/models/telephone_number.rb +213 -0
  44. data/lib/bandwidth-sdk/models/tfv_basic_authentication.rb +273 -0
  45. data/lib/bandwidth-sdk/models/tfv_callback_status_enum.rb +40 -0
  46. data/lib/bandwidth-sdk/models/tfv_error.rb +232 -0
  47. data/lib/bandwidth-sdk/models/tfv_status.rb +342 -0
  48. data/lib/bandwidth-sdk/models/tfv_status_enum.rb +43 -0
  49. data/lib/bandwidth-sdk/models/tfv_submission_info.rb +452 -0
  50. data/lib/bandwidth-sdk/models/tfv_submission_wrapper.rb +212 -0
  51. data/lib/bandwidth-sdk/models/verification_denial_webhook.rb +325 -0
  52. data/lib/bandwidth-sdk/models/verification_request.rb +547 -0
  53. data/lib/bandwidth-sdk/models/verification_update_request.rb +501 -0
  54. data/lib/bandwidth-sdk/models/verification_webhook.rb +303 -0
  55. data/lib/bandwidth-sdk/models/webhook_subscription.rb +328 -0
  56. data/lib/bandwidth-sdk/models/webhook_subscription_basic_authentication.rb +274 -0
  57. data/lib/bandwidth-sdk/models/webhook_subscription_request_schema.rb +306 -0
  58. data/lib/bandwidth-sdk/models/webhook_subscription_type_enum.rb +40 -0
  59. data/lib/bandwidth-sdk/models/webhook_subscriptions_list_body.rb +242 -0
  60. data/lib/bandwidth-sdk/version.rb +1 -1
  61. data/lib/bandwidth-sdk.rb +25 -0
  62. data/openapi-config.yml +1 -1
  63. data/spec/call_utils.rb +2 -2
  64. data/spec/smoke/toll_free_verification_api_spec.rb +69 -0
  65. data/spec/spec_helper.rb +1 -1
  66. data/spec/unit/api/mfa_api_spec.rb +1 -1
  67. data/spec/unit/api/toll_free_verification_api_spec.rb +278 -0
  68. data/spec/unit/client/api_client_spec.rb +1 -1
  69. metadata +100 -46
@@ -0,0 +1,585 @@
1
+ # Bandwidth::TollFreeVerificationApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_webhook_subscription**](TollFreeVerificationApi.md#create_webhook_subscription) | **POST** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription |
8
+ | [**delete_webhook_subscription**](TollFreeVerificationApi.md#delete_webhook_subscription) | **DELETE** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription |
9
+ | [**get_toll_free_verification_status**](TollFreeVerificationApi.md#get_toll_free_verification_status) | **GET** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status |
10
+ | [**list_toll_free_use_cases**](TollFreeVerificationApi.md#list_toll_free_use_cases) | **GET** /tollFreeVerification/useCases | List Toll-Free Use Cases |
11
+ | [**list_webhook_subscriptions**](TollFreeVerificationApi.md#list_webhook_subscriptions) | **GET** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | List Webhook Subscriptions |
12
+ | [**request_toll_free_verification**](TollFreeVerificationApi.md#request_toll_free_verification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification |
13
+ | [**update_toll_free_verification_request**](TollFreeVerificationApi.md#update_toll_free_verification_request) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request |
14
+ | [**update_webhook_subscription**](TollFreeVerificationApi.md#update_webhook_subscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription |
15
+
16
+
17
+ ## create_webhook_subscription
18
+
19
+ > <WebhookSubscription> create_webhook_subscription(account_id, webhook_subscription_request_schema)
20
+
21
+ Create Webhook Subscription
22
+
23
+ Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'bandwidth-sdk'
30
+ # setup authorization
31
+ Bandwidth.configure do |config|
32
+ # Configure HTTP basic authorization: Basic
33
+ config.username = 'YOUR USERNAME'
34
+ config.password = 'YOUR PASSWORD'
35
+ end
36
+
37
+ api_instance = Bandwidth::TollFreeVerificationApi.new
38
+ account_id = '9900000' # String | Your Bandwidth Account ID.
39
+ webhook_subscription_request_schema = Bandwidth::WebhookSubscriptionRequestSchema.new({callback_url: 'https://www.example.com/path/to/resource'}) # WebhookSubscriptionRequestSchema | Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
40
+
41
+ begin
42
+ # Create Webhook Subscription
43
+ result = api_instance.create_webhook_subscription(account_id, webhook_subscription_request_schema)
44
+ p result
45
+ rescue Bandwidth::ApiError => e
46
+ puts "Error when calling TollFreeVerificationApi->create_webhook_subscription: #{e}"
47
+ end
48
+ ```
49
+
50
+ #### Using the create_webhook_subscription_with_http_info variant
51
+
52
+ This returns an Array which contains the response data, status code and headers.
53
+
54
+ > <Array(<WebhookSubscription>, Integer, Hash)> create_webhook_subscription_with_http_info(account_id, webhook_subscription_request_schema)
55
+
56
+ ```ruby
57
+ begin
58
+ # Create Webhook Subscription
59
+ data, status_code, headers = api_instance.create_webhook_subscription_with_http_info(account_id, webhook_subscription_request_schema)
60
+ p status_code # => 2xx
61
+ p headers # => { ... }
62
+ p data # => <WebhookSubscription>
63
+ rescue Bandwidth::ApiError => e
64
+ puts "Error when calling TollFreeVerificationApi->create_webhook_subscription_with_http_info: #{e}"
65
+ end
66
+ ```
67
+
68
+ ### Parameters
69
+
70
+ | Name | Type | Description | Notes |
71
+ | ---- | ---- | ----------- | ----- |
72
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
73
+ | **webhook_subscription_request_schema** | [**WebhookSubscriptionRequestSchema**](WebhookSubscriptionRequestSchema.md) | Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. | |
74
+
75
+ ### Return type
76
+
77
+ [**WebhookSubscription**](WebhookSubscription.md)
78
+
79
+ ### Authorization
80
+
81
+ [Basic](../README.md#Basic)
82
+
83
+ ### HTTP request headers
84
+
85
+ - **Content-Type**: application/json
86
+ - **Accept**: application/json
87
+
88
+
89
+ ## delete_webhook_subscription
90
+
91
+ > delete_webhook_subscription(account_id, id)
92
+
93
+ Delete Webhook Subscription
94
+
95
+ Delete a webhook subscription by ID.
96
+
97
+ ### Examples
98
+
99
+ ```ruby
100
+ require 'time'
101
+ require 'bandwidth-sdk'
102
+ # setup authorization
103
+ Bandwidth.configure do |config|
104
+ # Configure HTTP basic authorization: Basic
105
+ config.username = 'YOUR USERNAME'
106
+ config.password = 'YOUR PASSWORD'
107
+ end
108
+
109
+ api_instance = Bandwidth::TollFreeVerificationApi.new
110
+ account_id = '9900000' # String | Your Bandwidth Account ID.
111
+ id = '7bt57JcsVYJrN9K1OcV1Nu' # String | Webhook subscription ID
112
+
113
+ begin
114
+ # Delete Webhook Subscription
115
+ api_instance.delete_webhook_subscription(account_id, id)
116
+ rescue Bandwidth::ApiError => e
117
+ puts "Error when calling TollFreeVerificationApi->delete_webhook_subscription: #{e}"
118
+ end
119
+ ```
120
+
121
+ #### Using the delete_webhook_subscription_with_http_info variant
122
+
123
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
124
+
125
+ > <Array(nil, Integer, Hash)> delete_webhook_subscription_with_http_info(account_id, id)
126
+
127
+ ```ruby
128
+ begin
129
+ # Delete Webhook Subscription
130
+ data, status_code, headers = api_instance.delete_webhook_subscription_with_http_info(account_id, id)
131
+ p status_code # => 2xx
132
+ p headers # => { ... }
133
+ p data # => nil
134
+ rescue Bandwidth::ApiError => e
135
+ puts "Error when calling TollFreeVerificationApi->delete_webhook_subscription_with_http_info: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ | Name | Type | Description | Notes |
142
+ | ---- | ---- | ----------- | ----- |
143
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
144
+ | **id** | **String** | Webhook subscription ID | |
145
+
146
+ ### Return type
147
+
148
+ nil (empty response body)
149
+
150
+ ### Authorization
151
+
152
+ [Basic](../README.md#Basic)
153
+
154
+ ### HTTP request headers
155
+
156
+ - **Content-Type**: Not defined
157
+ - **Accept**: application/json
158
+
159
+
160
+ ## get_toll_free_verification_status
161
+
162
+ > <TfvStatus> get_toll_free_verification_status(account_id, phone_number)
163
+
164
+ Get Toll-Free Verification Status
165
+
166
+ Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available.
167
+
168
+ ### Examples
169
+
170
+ ```ruby
171
+ require 'time'
172
+ require 'bandwidth-sdk'
173
+ # setup authorization
174
+ Bandwidth.configure do |config|
175
+ # Configure HTTP basic authorization: Basic
176
+ config.username = 'YOUR USERNAME'
177
+ config.password = 'YOUR PASSWORD'
178
+ end
179
+
180
+ api_instance = Bandwidth::TollFreeVerificationApi.new
181
+ account_id = '9900000' # String | Your Bandwidth Account ID.
182
+ phone_number = '+18885555555' # String | Valid Toll-Free telephone number in E.164 format.
183
+
184
+ begin
185
+ # Get Toll-Free Verification Status
186
+ result = api_instance.get_toll_free_verification_status(account_id, phone_number)
187
+ p result
188
+ rescue Bandwidth::ApiError => e
189
+ puts "Error when calling TollFreeVerificationApi->get_toll_free_verification_status: #{e}"
190
+ end
191
+ ```
192
+
193
+ #### Using the get_toll_free_verification_status_with_http_info variant
194
+
195
+ This returns an Array which contains the response data, status code and headers.
196
+
197
+ > <Array(<TfvStatus>, Integer, Hash)> get_toll_free_verification_status_with_http_info(account_id, phone_number)
198
+
199
+ ```ruby
200
+ begin
201
+ # Get Toll-Free Verification Status
202
+ data, status_code, headers = api_instance.get_toll_free_verification_status_with_http_info(account_id, phone_number)
203
+ p status_code # => 2xx
204
+ p headers # => { ... }
205
+ p data # => <TfvStatus>
206
+ rescue Bandwidth::ApiError => e
207
+ puts "Error when calling TollFreeVerificationApi->get_toll_free_verification_status_with_http_info: #{e}"
208
+ end
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ | Name | Type | Description | Notes |
214
+ | ---- | ---- | ----------- | ----- |
215
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
216
+ | **phone_number** | **String** | Valid Toll-Free telephone number in E.164 format. | |
217
+
218
+ ### Return type
219
+
220
+ [**TfvStatus**](TfvStatus.md)
221
+
222
+ ### Authorization
223
+
224
+ [Basic](../README.md#Basic)
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: Not defined
229
+ - **Accept**: application/json
230
+
231
+
232
+ ## list_toll_free_use_cases
233
+
234
+ > Array&lt;String&gt; list_toll_free_use_cases
235
+
236
+ List Toll-Free Use Cases
237
+
238
+ Lists valid toll-free use cases.
239
+
240
+ ### Examples
241
+
242
+ ```ruby
243
+ require 'time'
244
+ require 'bandwidth-sdk'
245
+ # setup authorization
246
+ Bandwidth.configure do |config|
247
+ # Configure HTTP basic authorization: Basic
248
+ config.username = 'YOUR USERNAME'
249
+ config.password = 'YOUR PASSWORD'
250
+ end
251
+
252
+ api_instance = Bandwidth::TollFreeVerificationApi.new
253
+
254
+ begin
255
+ # List Toll-Free Use Cases
256
+ result = api_instance.list_toll_free_use_cases
257
+ p result
258
+ rescue Bandwidth::ApiError => e
259
+ puts "Error when calling TollFreeVerificationApi->list_toll_free_use_cases: #{e}"
260
+ end
261
+ ```
262
+
263
+ #### Using the list_toll_free_use_cases_with_http_info variant
264
+
265
+ This returns an Array which contains the response data, status code and headers.
266
+
267
+ > <Array(Array&lt;String&gt;, Integer, Hash)> list_toll_free_use_cases_with_http_info
268
+
269
+ ```ruby
270
+ begin
271
+ # List Toll-Free Use Cases
272
+ data, status_code, headers = api_instance.list_toll_free_use_cases_with_http_info
273
+ p status_code # => 2xx
274
+ p headers # => { ... }
275
+ p data # => Array&lt;String&gt;
276
+ rescue Bandwidth::ApiError => e
277
+ puts "Error when calling TollFreeVerificationApi->list_toll_free_use_cases_with_http_info: #{e}"
278
+ end
279
+ ```
280
+
281
+ ### Parameters
282
+
283
+ This endpoint does not need any parameter.
284
+
285
+ ### Return type
286
+
287
+ **Array&lt;String&gt;**
288
+
289
+ ### Authorization
290
+
291
+ [Basic](../README.md#Basic)
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: Not defined
296
+ - **Accept**: application/json
297
+
298
+
299
+ ## list_webhook_subscriptions
300
+
301
+ > <WebhookSubscriptionsListBody> list_webhook_subscriptions(account_id)
302
+
303
+ List Webhook Subscriptions
304
+
305
+ Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null).
306
+
307
+ ### Examples
308
+
309
+ ```ruby
310
+ require 'time'
311
+ require 'bandwidth-sdk'
312
+ # setup authorization
313
+ Bandwidth.configure do |config|
314
+ # Configure HTTP basic authorization: Basic
315
+ config.username = 'YOUR USERNAME'
316
+ config.password = 'YOUR PASSWORD'
317
+ end
318
+
319
+ api_instance = Bandwidth::TollFreeVerificationApi.new
320
+ account_id = '9900000' # String | Your Bandwidth Account ID.
321
+
322
+ begin
323
+ # List Webhook Subscriptions
324
+ result = api_instance.list_webhook_subscriptions(account_id)
325
+ p result
326
+ rescue Bandwidth::ApiError => e
327
+ puts "Error when calling TollFreeVerificationApi->list_webhook_subscriptions: #{e}"
328
+ end
329
+ ```
330
+
331
+ #### Using the list_webhook_subscriptions_with_http_info variant
332
+
333
+ This returns an Array which contains the response data, status code and headers.
334
+
335
+ > <Array(<WebhookSubscriptionsListBody>, Integer, Hash)> list_webhook_subscriptions_with_http_info(account_id)
336
+
337
+ ```ruby
338
+ begin
339
+ # List Webhook Subscriptions
340
+ data, status_code, headers = api_instance.list_webhook_subscriptions_with_http_info(account_id)
341
+ p status_code # => 2xx
342
+ p headers # => { ... }
343
+ p data # => <WebhookSubscriptionsListBody>
344
+ rescue Bandwidth::ApiError => e
345
+ puts "Error when calling TollFreeVerificationApi->list_webhook_subscriptions_with_http_info: #{e}"
346
+ end
347
+ ```
348
+
349
+ ### Parameters
350
+
351
+ | Name | Type | Description | Notes |
352
+ | ---- | ---- | ----------- | ----- |
353
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
354
+
355
+ ### Return type
356
+
357
+ [**WebhookSubscriptionsListBody**](WebhookSubscriptionsListBody.md)
358
+
359
+ ### Authorization
360
+
361
+ [Basic](../README.md#Basic)
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: Not defined
366
+ - **Accept**: application/json
367
+
368
+
369
+ ## request_toll_free_verification
370
+
371
+ > request_toll_free_verification(account_id, verification_request)
372
+
373
+ Request Toll-Free Verification
374
+
375
+ Submit a request for verification of a toll-free phone number.
376
+
377
+ ### Examples
378
+
379
+ ```ruby
380
+ require 'time'
381
+ require 'bandwidth-sdk'
382
+ # setup authorization
383
+ Bandwidth.configure do |config|
384
+ # Configure HTTP basic authorization: Basic
385
+ config.username = 'YOUR USERNAME'
386
+ config.password = 'YOUR PASSWORD'
387
+ end
388
+
389
+ api_instance = Bandwidth::TollFreeVerificationApi.new
390
+ account_id = '9900000' # String | Your Bandwidth Account ID.
391
+ verification_request = Bandwidth::VerificationRequest.new({business_address: Bandwidth::Address.new({name: 'Bandwidth Inc.', addr1: '2230 Bandmate Way', city: 'Raleigh', state: 'NC', zip: '27606', url: 'https://www.example.com/path/to/resource'}), business_contact: Bandwidth::Contact.new({first_name: 'John', last_name: 'Doe', email: 'foo@bar.com', phone_number: '+19192654500'}), message_volume: 10000, phone_numbers: ['+18005555555'], use_case: '2FA', use_case_summary: 'use_case_summary_example', production_message_content: 'production_message_content_example', opt_in_workflow: Bandwidth::OptInWorkflow.new({description: 'Opt In Flow', image_urls: ['https://www.example.com/path/to/resource']})}) # VerificationRequest | Request for verification of a toll-free phone number.
392
+
393
+ begin
394
+ # Request Toll-Free Verification
395
+ api_instance.request_toll_free_verification(account_id, verification_request)
396
+ rescue Bandwidth::ApiError => e
397
+ puts "Error when calling TollFreeVerificationApi->request_toll_free_verification: #{e}"
398
+ end
399
+ ```
400
+
401
+ #### Using the request_toll_free_verification_with_http_info variant
402
+
403
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
404
+
405
+ > <Array(nil, Integer, Hash)> request_toll_free_verification_with_http_info(account_id, verification_request)
406
+
407
+ ```ruby
408
+ begin
409
+ # Request Toll-Free Verification
410
+ data, status_code, headers = api_instance.request_toll_free_verification_with_http_info(account_id, verification_request)
411
+ p status_code # => 2xx
412
+ p headers # => { ... }
413
+ p data # => nil
414
+ rescue Bandwidth::ApiError => e
415
+ puts "Error when calling TollFreeVerificationApi->request_toll_free_verification_with_http_info: #{e}"
416
+ end
417
+ ```
418
+
419
+ ### Parameters
420
+
421
+ | Name | Type | Description | Notes |
422
+ | ---- | ---- | ----------- | ----- |
423
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
424
+ | **verification_request** | [**VerificationRequest**](VerificationRequest.md) | Request for verification of a toll-free phone number. | |
425
+
426
+ ### Return type
427
+
428
+ nil (empty response body)
429
+
430
+ ### Authorization
431
+
432
+ [Basic](../README.md#Basic)
433
+
434
+ ### HTTP request headers
435
+
436
+ - **Content-Type**: application/json
437
+ - **Accept**: application/json
438
+
439
+
440
+ ## update_toll_free_verification_request
441
+
442
+ > update_toll_free_verification_request(account_id, phone_number, tfv_submission_wrapper)
443
+
444
+ Update Toll-Free Verification Request
445
+
446
+ Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true).
447
+
448
+ ### Examples
449
+
450
+ ```ruby
451
+ require 'time'
452
+ require 'bandwidth-sdk'
453
+ # setup authorization
454
+ Bandwidth.configure do |config|
455
+ # Configure HTTP basic authorization: Basic
456
+ config.username = 'YOUR USERNAME'
457
+ config.password = 'YOUR PASSWORD'
458
+ end
459
+
460
+ api_instance = Bandwidth::TollFreeVerificationApi.new
461
+ account_id = '9900000' # String | Your Bandwidth Account ID.
462
+ phone_number = '+18885555555' # String | Valid Toll-Free telephone number in E.164 format.
463
+ tfv_submission_wrapper = Bandwidth::TfvSubmissionWrapper.new # TfvSubmissionWrapper | Update a request for verification of a toll-free phone number.
464
+
465
+ begin
466
+ # Update Toll-Free Verification Request
467
+ api_instance.update_toll_free_verification_request(account_id, phone_number, tfv_submission_wrapper)
468
+ rescue Bandwidth::ApiError => e
469
+ puts "Error when calling TollFreeVerificationApi->update_toll_free_verification_request: #{e}"
470
+ end
471
+ ```
472
+
473
+ #### Using the update_toll_free_verification_request_with_http_info variant
474
+
475
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
476
+
477
+ > <Array(nil, Integer, Hash)> update_toll_free_verification_request_with_http_info(account_id, phone_number, tfv_submission_wrapper)
478
+
479
+ ```ruby
480
+ begin
481
+ # Update Toll-Free Verification Request
482
+ data, status_code, headers = api_instance.update_toll_free_verification_request_with_http_info(account_id, phone_number, tfv_submission_wrapper)
483
+ p status_code # => 2xx
484
+ p headers # => { ... }
485
+ p data # => nil
486
+ rescue Bandwidth::ApiError => e
487
+ puts "Error when calling TollFreeVerificationApi->update_toll_free_verification_request_with_http_info: #{e}"
488
+ end
489
+ ```
490
+
491
+ ### Parameters
492
+
493
+ | Name | Type | Description | Notes |
494
+ | ---- | ---- | ----------- | ----- |
495
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
496
+ | **phone_number** | **String** | Valid Toll-Free telephone number in E.164 format. | |
497
+ | **tfv_submission_wrapper** | [**TfvSubmissionWrapper**](TfvSubmissionWrapper.md) | Update a request for verification of a toll-free phone number. | |
498
+
499
+ ### Return type
500
+
501
+ nil (empty response body)
502
+
503
+ ### Authorization
504
+
505
+ [Basic](../README.md#Basic)
506
+
507
+ ### HTTP request headers
508
+
509
+ - **Content-Type**: application/json
510
+ - **Accept**: application/json
511
+
512
+
513
+ ## update_webhook_subscription
514
+
515
+ > <WebhookSubscription> update_webhook_subscription(account_id, id, webhook_subscription_request_schema)
516
+
517
+ Update Webhook Subscription
518
+
519
+ Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated).
520
+
521
+ ### Examples
522
+
523
+ ```ruby
524
+ require 'time'
525
+ require 'bandwidth-sdk'
526
+ # setup authorization
527
+ Bandwidth.configure do |config|
528
+ # Configure HTTP basic authorization: Basic
529
+ config.username = 'YOUR USERNAME'
530
+ config.password = 'YOUR PASSWORD'
531
+ end
532
+
533
+ api_instance = Bandwidth::TollFreeVerificationApi.new
534
+ account_id = '9900000' # String | Your Bandwidth Account ID.
535
+ id = '7bt57JcsVYJrN9K1OcV1Nu' # String | Webhook subscription ID
536
+ webhook_subscription_request_schema = Bandwidth::WebhookSubscriptionRequestSchema.new({callback_url: 'https://www.example.com/path/to/resource'}) # WebhookSubscriptionRequestSchema | Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to.
537
+
538
+ begin
539
+ # Update Webhook Subscription
540
+ result = api_instance.update_webhook_subscription(account_id, id, webhook_subscription_request_schema)
541
+ p result
542
+ rescue Bandwidth::ApiError => e
543
+ puts "Error when calling TollFreeVerificationApi->update_webhook_subscription: #{e}"
544
+ end
545
+ ```
546
+
547
+ #### Using the update_webhook_subscription_with_http_info variant
548
+
549
+ This returns an Array which contains the response data, status code and headers.
550
+
551
+ > <Array(<WebhookSubscription>, Integer, Hash)> update_webhook_subscription_with_http_info(account_id, id, webhook_subscription_request_schema)
552
+
553
+ ```ruby
554
+ begin
555
+ # Update Webhook Subscription
556
+ data, status_code, headers = api_instance.update_webhook_subscription_with_http_info(account_id, id, webhook_subscription_request_schema)
557
+ p status_code # => 2xx
558
+ p headers # => { ... }
559
+ p data # => <WebhookSubscription>
560
+ rescue Bandwidth::ApiError => e
561
+ puts "Error when calling TollFreeVerificationApi->update_webhook_subscription_with_http_info: #{e}"
562
+ end
563
+ ```
564
+
565
+ ### Parameters
566
+
567
+ | Name | Type | Description | Notes |
568
+ | ---- | ---- | ----------- | ----- |
569
+ | **account_id** | **String** | Your Bandwidth Account ID. | |
570
+ | **id** | **String** | Webhook subscription ID | |
571
+ | **webhook_subscription_request_schema** | [**WebhookSubscriptionRequestSchema**](WebhookSubscriptionRequestSchema.md) | Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. | |
572
+
573
+ ### Return type
574
+
575
+ [**WebhookSubscription**](WebhookSubscription.md)
576
+
577
+ ### Authorization
578
+
579
+ [Basic](../README.md#Basic)
580
+
581
+ ### HTTP request headers
582
+
583
+ - **Content-Type**: application/json
584
+ - **Accept**: application/json
585
+
@@ -0,0 +1,32 @@
1
+ # Bandwidth::VerificationDenialWebhook
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | User&#39;s account ID. | [optional] |
8
+ | **additional_denial_reasons** | [**Array&lt;AdditionalDenialReason&gt;**](AdditionalDenialReason.md) | An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. | [optional] |
9
+ | **decline_reason_description** | **String** | Explanation for why a verification request was declined. | [optional] |
10
+ | **denial_status_code** | **Integer** | Reason code for denial. | [optional] |
11
+ | **internal_ticket_number** | **String** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
12
+ | **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
13
+ | **resubmit_allowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] |
14
+ | **status** | **String** | | [optional][default to &#39;UNVERIFIED&#39;] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'bandwidth-sdk'
20
+
21
+ instance = Bandwidth::VerificationDenialWebhook.new(
22
+ account_id: 1234567,
23
+ additional_denial_reasons: [{&quot;statusCode&quot;:512,&quot;reason&quot;:&quot;Reason A&quot;,&quot;resubmitAllowed&quot;:true},{&quot;statusCode&quot;:513,&quot;reason&quot;:&quot;Reason B&quot;,&quot;resubmitAllowed&quot;:true}],
24
+ decline_reason_description: Invalid Information - Can&#39;t Validate URL - Website is not accessible / not available,
25
+ denial_status_code: 511,
26
+ internal_ticket_number: acde070d-8c4c-4f0d-9d8a-162843c10333,
27
+ phone_number: +18005555555,
28
+ resubmit_allowed: true,
29
+ status: UNVERIFIED
30
+ )
31
+ ```
32
+
@@ -0,0 +1,36 @@
1
+ # Bandwidth::VerificationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **business_address** | [**Address**](Address.md) | | |
8
+ | **business_contact** | [**Contact**](Contact.md) | | |
9
+ | **message_volume** | **Integer** | Estimated monthly volume of messages from the toll-free number. | |
10
+ | **phone_numbers** | **Array&lt;String&gt;** | | |
11
+ | **use_case** | **String** | The category of the use case. | |
12
+ | **use_case_summary** | **String** | A general idea of the use case and customer. | |
13
+ | **production_message_content** | **String** | Example of message content. | |
14
+ | **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | | |
15
+ | **additional_information** | **String** | Any additional information. | [optional] |
16
+ | **isv_reseller** | **String** | ISV name. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'bandwidth-sdk'
22
+
23
+ instance = Bandwidth::VerificationRequest.new(
24
+ business_address: null,
25
+ business_contact: null,
26
+ message_volume: 10000,
27
+ phone_numbers: null,
28
+ use_case: 2FA,
29
+ use_case_summary: null,
30
+ production_message_content: null,
31
+ opt_in_workflow: null,
32
+ additional_information: null,
33
+ isv_reseller: Test ISV
34
+ )
35
+ ```
36
+
@@ -0,0 +1,34 @@
1
+ # Bandwidth::VerificationUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **business_address** | [**Address**](Address.md) | | |
8
+ | **business_contact** | [**Contact**](Contact.md) | | |
9
+ | **message_volume** | **Integer** | Estimated monthly volume of messages from the toll-free number. | |
10
+ | **use_case** | **String** | The category of the use case. | |
11
+ | **use_case_summary** | **String** | A general idea of the use case and customer. | |
12
+ | **production_message_content** | **String** | Example of message content. | |
13
+ | **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) | | |
14
+ | **additional_information** | **String** | Any additional information. | [optional] |
15
+ | **isv_reseller** | **String** | ISV name. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'bandwidth-sdk'
21
+
22
+ instance = Bandwidth::VerificationUpdateRequest.new(
23
+ business_address: null,
24
+ business_contact: null,
25
+ message_volume: 10000,
26
+ use_case: 2FA,
27
+ use_case_summary: null,
28
+ production_message_content: null,
29
+ opt_in_workflow: null,
30
+ additional_information: null,
31
+ isv_reseller: Test ISV
32
+ )
33
+ ```
34
+