Skip to content

Commit 0959969

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-7771 Update SDK Based on Recent Spec Changes (#185)
* Generate SDK with OpenAPI Generator Version * model unit tests --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent f1c8e3b commit 0959969

18 files changed

+696
-18
lines changed

api/openapi.yaml

Lines changed: 103 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12197,6 +12197,30 @@ components:
1219712197
via PUT.
1219812198
example: true
1219912199
type: boolean
12200+
blocked:
12201+
description: Whether a Toll-Free Verification is blocked. This attribute will
12202+
only be defined when the number is blocked. (Not Available Until 5/28/2025)
12203+
example: true
12204+
type: boolean
12205+
blockedReason:
12206+
description: The reason why the Toll-Free Verification is blocked. This attribute
12207+
will only be defined when the number is blocked. (Not Available Until 5/28/2025)
12208+
example: Toll-free number was used to send spam messages
12209+
type: string
12210+
privacyPolicyUrl:
12211+
description: The Toll-Free Verification request privacy policy URL. (Not Available
12212+
Until 5/28/2025)
12213+
example: http://your-company.com/privacyPolicyUrl.pdf
12214+
type: string
12215+
termsAndConditionsUrl:
12216+
description: The Toll-Free Verification request terms and conditions policy
12217+
URL. (Not Available Until 5/28/2025)
12218+
example: http://your-company.com/termsAndConditionsUrl.pdf
12219+
type: string
12220+
businessDBA:
12221+
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
12222+
example: SecondCompany Name
12223+
type: string
1220012224
additionalDenialReason:
1220112225
properties:
1220212226
statusCode:
@@ -12292,6 +12316,20 @@ components:
1229212316
minLength: 0
1229312317
nullable: true
1229412318
type: string
12319+
privacyPolicyUrl:
12320+
description: The Toll-Free Verification request privacy policy URL. (Not
12321+
Available Until 5/28/2025)
12322+
example: http://your-company.com/privacyPolicyUrl.pdf
12323+
type: string
12324+
termsAndConditionsUrl:
12325+
description: The Toll-Free Verification request terms and conditions policy
12326+
URL. (Not Available Until 5/28/2025)
12327+
example: http://your-company.com/termsAndConditionsUrl.pdf
12328+
type: string
12329+
businessDBA:
12330+
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
12331+
example: SecondCompany Name
12332+
type: string
1229512333
required:
1229612334
- businessAddress
1229712335
- businessContact
@@ -12338,6 +12376,7 @@ components:
1233812376
$ref: '#/components/schemas/optInWorkflow'
1233912377
additionalInformation:
1234012378
description: Any additional information.
12379+
example: Any additional information
1234112380
maxLength: 500
1234212381
minLength: 0
1234312382
nullable: true
@@ -12349,6 +12388,20 @@ components:
1234912388
minLength: 0
1235012389
nullable: true
1235112390
type: string
12391+
privacyPolicyUrl:
12392+
description: The Toll-Free Verification request privacy policy URL. (Not
12393+
Available Until 5/28/2025)
12394+
example: http://your-company.com/privacyPolicyUrl.pdf
12395+
type: string
12396+
termsAndConditionsUrl:
12397+
description: The Toll-Free Verification request terms and conditions policy
12398+
URL. (Not Available Until 5/28/2025)
12399+
example: http://your-company.com/termsAndConditionsUrl.pdf
12400+
type: string
12401+
businessDBA:
12402+
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
12403+
example: SecondCompany Name
12404+
type: string
1235212405
required:
1235312406
- businessAddress
1235412407
- businessContact
@@ -12491,6 +12544,18 @@ components:
1249112544
default: UNVERIFIED
1249212545
example: UNVERIFIED
1249312546
type: string
12547+
blocked:
12548+
description: Whether a Toll-Free Verification is blocked. This attribute
12549+
will only be defined when the number is blocked. (Not Available Until
12550+
5/28/2025)
12551+
example: true
12552+
type: boolean
12553+
blockedReason:
12554+
description: The reason why the Toll-Free Verification is blocked. This
12555+
attribute will only be defined when the number is blocked. (Not Available
12556+
Until 5/28/2025)
12557+
example: Toll-free number was used to send spam messages
12558+
type: string
1249412559
type: object
1249512560
verificationWebhook:
1249612561
properties:
@@ -12590,6 +12655,7 @@ components:
1259012655
type: object
1259112656
additionalInformation:
1259212657
description: Any additional information.
12658+
example: Any additional information
1259312659
maxLength: 500
1259412660
minLength: 0
1259512661
nullable: true
@@ -12921,12 +12987,16 @@ components:
1292112987
example:
1292212988
internalTicketNumber: acde070d-8c4c-4f0d-9d8a-162843c10333
1292312989
phoneNumber: "+18005555555"
12990+
blocked: true
12991+
blockedReason: Toll-free number was used to send spam messages
1292412992
resubmitAllowed: true
1292512993
createdDateTime: 2021-06-08T06:45:13Z
1292612994
modifiedDateTime: 2021-06-08T06:45:13Z
1292712995
submission:
12928-
additionalInformation: additionalInformation
12996+
additionalInformation: Any additional information
1292912997
useCase: 2FA
12998+
termsAndConditionsUrl: http://your-company.com/termsAndConditionsUrl.pdf
12999+
businessDBA: SecondCompany Name
1293013000
isvReseller: Test ISV
1293113001
businessContact:
1293213002
firstName: John
@@ -12943,6 +13013,7 @@ components:
1294313013
name: Bandwidth Inc.
1294413014
state: NC
1294513015
url: https://www.example.com/path/to/resource
13016+
privacyPolicyUrl: http://your-company.com/privacyPolicyUrl.pdf
1294613017
useCaseSummary: Text summarizing the use case for the toll-free number
1294713018
optInWorkflow:
1294813019
imageUrls:
@@ -12993,11 +13064,25 @@ components:
1299313064
type: string
1299413065
submission:
1299513066
$ref: '#/components/schemas/tfvSubmissionInfo'
13067+
blocked:
13068+
description: Whether a Toll-Free Verification is blocked. This attribute
13069+
will only be defined when the number is blocked. (Not Available Until
13070+
5/28/2025)
13071+
example: true
13072+
type: boolean
13073+
blockedReason:
13074+
description: The reason why the Toll-Free Verification is blocked. This
13075+
attribute will only be defined when the number is blocked. (Not Available
13076+
Until 5/28/2025)
13077+
example: Toll-free number was used to send spam messages
13078+
type: string
1299613079
type: object
1299713080
tfvSubmissionInfo:
1299813081
example:
12999-
additionalInformation: additionalInformation
13082+
additionalInformation: Any additional information
1300013083
useCase: 2FA
13084+
termsAndConditionsUrl: http://your-company.com/termsAndConditionsUrl.pdf
13085+
businessDBA: SecondCompany Name
1300113086
isvReseller: Test ISV
1300213087
businessContact:
1300313088
firstName: John
@@ -13014,6 +13099,7 @@ components:
1301413099
name: Bandwidth Inc.
1301513100
state: NC
1301613101
url: https://www.example.com/path/to/resource
13102+
privacyPolicyUrl: http://your-company.com/privacyPolicyUrl.pdf
1301713103
useCaseSummary: Text summarizing the use case for the toll-free number
1301813104
optInWorkflow:
1301913105
imageUrls:
@@ -13055,6 +13141,7 @@ components:
1305513141
$ref: '#/components/schemas/optInWorkflow'
1305613142
additionalInformation:
1305713143
description: Any additional information.
13144+
example: Any additional information
1305813145
maxLength: 500
1305913146
minLength: 0
1306013147
nullable: true
@@ -13066,6 +13153,20 @@ components:
1306613153
minLength: 0
1306713154
nullable: true
1306813155
type: string
13156+
privacyPolicyUrl:
13157+
description: The Toll-Free Verification request privacy policy URL. (Not
13158+
Available Until 5/28/2025)
13159+
example: http://your-company.com/privacyPolicyUrl.pdf
13160+
type: string
13161+
termsAndConditionsUrl:
13162+
description: The Toll-Free Verification request terms and conditions policy
13163+
URL. (Not Available Until 5/28/2025)
13164+
example: http://your-company.com/termsAndConditionsUrl.pdf
13165+
type: string
13166+
businessDBA:
13167+
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
13168+
example: SecondCompany Name
13169+
type: string
1306913170
type: object
1307013171
tfvStatusEnum:
1307113172
enum:

bandwidth.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5228,6 +5228,35 @@ components:
52285228
PUT.
52295229
example: true
52305230
type: boolean
5231+
blocked:
5232+
description: >-
5233+
Whether a Toll-Free Verification is blocked. This attribute will only be
5234+
defined when the number is blocked. (Not Available Until 5/28/2025)
5235+
example: true
5236+
type: boolean
5237+
blockedReason:
5238+
description: >-
5239+
The reason why the Toll-Free Verification is blocked. This attribute
5240+
will only be defined when the number is blocked. (Not Available Until
5241+
5/28/2025)
5242+
example: Toll-free number was used to send spam messages
5243+
type: string
5244+
privacyPolicyUrl:
5245+
description: >-
5246+
The Toll-Free Verification request privacy policy URL. (Not Available
5247+
Until 5/28/2025)
5248+
example: http://your-company.com/privacyPolicyUrl.pdf
5249+
type: string
5250+
termsAndConditionsUrl:
5251+
description: >-
5252+
The Toll-Free Verification request terms and conditions policy URL. (Not
5253+
Available Until 5/28/2025)
5254+
example: http://your-company.com/termsAndConditionsUrl.pdf
5255+
type: string
5256+
businessDBA:
5257+
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
5258+
example: SecondCompany Name
5259+
type: string
52315260
additionalDenialReason:
52325261
properties:
52335262
statusCode:
@@ -5308,6 +5337,12 @@ components:
53085337
example: Any additional information
53095338
isvReseller:
53105339
$ref: '#/components/schemas/isvReseller'
5340+
privacyPolicyUrl:
5341+
$ref: '#/components/schemas/privacyPolicyUrl'
5342+
termsAndConditionsUrl:
5343+
$ref: '#/components/schemas/termsAndConditionsUrl'
5344+
businessDBA:
5345+
$ref: '#/components/schemas/businessDBA'
53115346
verificationUpdateRequest:
53125347
type: object
53135348
required:
@@ -5341,6 +5376,12 @@ components:
53415376
$ref: '#/components/schemas/additionalInformation'
53425377
isvReseller:
53435378
$ref: '#/components/schemas/isvReseller'
5379+
privacyPolicyUrl:
5380+
$ref: '#/components/schemas/privacyPolicyUrl'
5381+
termsAndConditionsUrl:
5382+
$ref: '#/components/schemas/termsAndConditionsUrl'
5383+
businessDBA:
5384+
$ref: '#/components/schemas/businessDBA'
53445385
tfvBasicAuthentication:
53455386
type: object
53465387
properties:
@@ -5419,6 +5460,10 @@ components:
54195460
$ref: '#/components/schemas/resubmitAllowed'
54205461
status:
54215462
$ref: '#/components/schemas/tfvUnverifiedStatus'
5463+
blocked:
5464+
$ref: '#/components/schemas/blocked'
5465+
blockedReason:
5466+
$ref: '#/components/schemas/blockedReason'
54225467
verificationWebhook:
54235468
type: object
54245469
properties:
@@ -5501,6 +5546,7 @@ components:
55015546
minLength: 0
55025547
maxLength: 500
55035548
nullable: true
5549+
example: Any additional information
55045550
optInWorkflow:
55055551
type: object
55065552
nullable: false
@@ -5762,6 +5808,10 @@ components:
57625808
example: '2021-06-08T06:45:13.0Z'
57635809
submission:
57645810
$ref: '#/components/schemas/tfvSubmissionInfo'
5811+
blocked:
5812+
$ref: '#/components/schemas/blocked'
5813+
blockedReason:
5814+
$ref: '#/components/schemas/blockedReason'
57655815
tfvSubmissionInfo:
57665816
type: object
57675817
properties:
@@ -5787,6 +5837,12 @@ components:
57875837
$ref: '#/components/schemas/additionalInformation'
57885838
isvReseller:
57895839
$ref: '#/components/schemas/isvReseller'
5840+
privacyPolicyUrl:
5841+
$ref: '#/components/schemas/privacyPolicyUrl'
5842+
termsAndConditionsUrl:
5843+
$ref: '#/components/schemas/termsAndConditionsUrl'
5844+
businessDBA:
5845+
$ref: '#/components/schemas/businessDBA'
57905846
tfvStatusEnum:
57915847
type: string
57925848
enum:

docs/TfvStatus.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
|**createdDateTime** | **OffsetDateTime** | Date and time the verification request was created. | [optional] |
1616
|**modifiedDateTime** | **OffsetDateTime** | Date and time the verification request was last modified. | [optional] |
1717
|**submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) | | [optional] |
18+
|**blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
19+
|**blockedReason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
1820

1921

2022

docs/TfvSubmissionInfo.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
|**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | [optional] |
1717
|**additionalInformation** | **String** | Any additional information. | [optional] |
1818
|**isvReseller** | **String** | ISV name. | [optional] |
19+
|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
20+
|**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
21+
|**businessDBA** | **String** | The company &#39;Doing Business As&#39;. (Not Available Until 5/28/2025) | [optional] |
1922

2023

2124

docs/VerificationDenialWebhook.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
|**phoneNumber** | **String** | Toll-free telephone number in E.164 format. | [optional] |
1616
|**resubmitAllowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] |
1717
|**status** | **String** | | [optional] |
18+
|**blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
19+
|**blockedReason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
1820

1921

2022

docs/VerificationRequest.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
|**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | |
1818
|**additionalInformation** | **String** | Any additional information. | [optional] |
1919
|**isvReseller** | **String** | ISV name. | [optional] |
20+
|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
21+
|**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
22+
|**businessDBA** | **String** | The company &#39;Doing Business As&#39;. (Not Available Until 5/28/2025) | [optional] |
2023

2124

2225

docs/VerificationUpdateRequest.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
|**optInWorkflow** | [**OptInWorkflow**](OptInWorkflow.md) | | |
1717
|**additionalInformation** | **String** | Any additional information. | [optional] |
1818
|**isvReseller** | **String** | ISV name. | [optional] |
19+
|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
20+
|**termsAndConditionsUrl** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
21+
|**businessDBA** | **String** | The company &#39;Doing Business As&#39;. (Not Available Until 5/28/2025) | [optional] |
1922

2023

2124

0 commit comments

Comments
 (0)