Skip to content

Commit 1f5cd65

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-7881 Update SDK Based on Recent Spec Changes (#188)
* Generate SDK with OpenAPI Generator Version * update businessDba tests * blocked webhook test --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: ckoegel <[email protected]>
1 parent 4d7a65d commit 1f5cd65

18 files changed

+700
-96
lines changed

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ docs/AccountStatistics.md
77
docs/AdditionalDenialReason.md
88
docs/Address.md
99
docs/AnswerCallback.md
10+
docs/BlockedWebhook.md
1011
docs/BridgeCompleteCallback.md
1112
docs/BridgeTargetCompleteCallback.md
1213
docs/CallDirectionEnum.md
@@ -200,6 +201,7 @@ src/main/java/com/bandwidth/sdk/model/AccountStatistics.java
200201
src/main/java/com/bandwidth/sdk/model/AdditionalDenialReason.java
201202
src/main/java/com/bandwidth/sdk/model/Address.java
202203
src/main/java/com/bandwidth/sdk/model/AnswerCallback.java
204+
src/main/java/com/bandwidth/sdk/model/BlockedWebhook.java
203205
src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java
204206
src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java
205207
src/main/java/com/bandwidth/sdk/model/CallDirectionEnum.java

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@ Class | Method | HTTP request | Description
178178
- [AdditionalDenialReason](docs/AdditionalDenialReason.md)
179179
- [Address](docs/Address.md)
180180
- [AnswerCallback](docs/AnswerCallback.md)
181+
- [BlockedWebhook](docs/BlockedWebhook.md)
181182
- [BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
182183
- [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
183184
- [CallDirectionEnum](docs/CallDirectionEnum.md)

‎api/openapi.yaml‎

Lines changed: 58 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6791,6 +6791,7 @@ components:
67916791
- $ref: '#/components/schemas/verificationWebhook'
67926792
- $ref: '#/components/schemas/verificationDenialWebhook'
67936793
- $ref: '#/components/schemas/failureWebhook'
6794+
- $ref: '#/components/schemas/blockedWebhook'
67946795
description: Verification callback status of a toll-free phone number.
67956796
required: true
67966797
webhookSubscriptionRequest:
@@ -12217,16 +12218,16 @@ components:
1221712218
privacyPolicyUrl:
1221812219
description: The Toll-Free Verification request privacy policy URL. (Not Available
1221912220
Until 5/28/2025)
12220-
example: http://your-company.com/privacyPolicyUrl.pdf
12221+
example: http://your-company.com/privacyPolicy
1222112222
type: string
1222212223
termsAndConditionsUrl:
1222312224
description: The Toll-Free Verification request terms and conditions policy
1222412225
URL. (Not Available Until 5/28/2025)
12225-
example: http://your-company.com/termsAndConditionsUrl.pdf
12226+
example: http://your-company.com/termsAndConditions
1222612227
type: string
12227-
businessDBA:
12228+
businessDba:
1222812229
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
12229-
example: SecondCompany Name
12230+
example: Another Company Name Inc.
1223012231
type: string
1223112232
additionalDenialReason:
1223212233
properties:
@@ -12326,16 +12327,16 @@ components:
1232612327
privacyPolicyUrl:
1232712328
description: The Toll-Free Verification request privacy policy URL. (Not
1232812329
Available Until 5/28/2025)
12329-
example: http://your-company.com/privacyPolicyUrl.pdf
12330+
example: http://your-company.com/privacyPolicy
1233012331
type: string
1233112332
termsAndConditionsUrl:
1233212333
description: The Toll-Free Verification request terms and conditions policy
1233312334
URL. (Not Available Until 5/28/2025)
12334-
example: http://your-company.com/termsAndConditionsUrl.pdf
12335+
example: http://your-company.com/termsAndConditions
1233512336
type: string
12336-
businessDBA:
12337+
businessDba:
1233712338
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
12338-
example: SecondCompany Name
12339+
example: Another Company Name Inc.
1233912340
type: string
1234012341
required:
1234112342
- businessAddress
@@ -12398,16 +12399,16 @@ components:
1239812399
privacyPolicyUrl:
1239912400
description: The Toll-Free Verification request privacy policy URL. (Not
1240012401
Available Until 5/28/2025)
12401-
example: http://your-company.com/privacyPolicyUrl.pdf
12402+
example: http://your-company.com/privacyPolicy
1240212403
type: string
1240312404
termsAndConditionsUrl:
1240412405
description: The Toll-Free Verification request terms and conditions policy
1240512406
URL. (Not Available Until 5/28/2025)
12406-
example: http://your-company.com/termsAndConditionsUrl.pdf
12407+
example: http://your-company.com/termsAndConditions
1240712408
type: string
12408-
businessDBA:
12409+
businessDba:
1240912410
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
12410-
example: SecondCompany Name
12411+
example: Another Company Name Inc.
1241112412
type: string
1241212413
required:
1241312414
- businessAddress
@@ -12587,6 +12588,41 @@ components:
1258712588
format: uuid
1258812589
type: string
1258912590
type: object
12591+
blockedWebhook:
12592+
properties:
12593+
accountId:
12594+
description: User's account ID.
12595+
example: "1234567"
12596+
type: string
12597+
phoneNumber:
12598+
description: Toll-free telephone number in E.164 format.
12599+
example: "+18005555555"
12600+
maxLength: 12
12601+
minLength: 12
12602+
nullable: false
12603+
pattern: "^\\+1(800|833|844|855|866|877|888)[2-9]\\d{6}$"
12604+
type: string
12605+
status:
12606+
$ref: '#/components/schemas/tfvCallbackStatusEnum'
12607+
internalTicketNumber:
12608+
description: Unique identifier (UUID) generated by Bandwidth to assist in
12609+
tracking the verification status of a toll-free number.
12610+
example: acde070d-8c4c-4f0d-9d8a-162843c10333
12611+
format: uuid
12612+
type: string
12613+
blocked:
12614+
description: Whether a Toll-Free Verification is blocked. This attribute
12615+
will only be defined when the number is blocked. (Not Available Until
12616+
5/28/2025)
12617+
example: true
12618+
type: boolean
12619+
blockedReason:
12620+
description: The reason why the Toll-Free Verification is blocked. This
12621+
attribute will only be defined when the number is blocked. (Not Available
12622+
Until 5/28/2025)
12623+
example: Toll-free number was used to send spam messages
12624+
type: string
12625+
type: object
1259012626
tfvSubmissionWrapper:
1259112627
properties:
1259212628
submission:
@@ -13002,8 +13038,8 @@ components:
1300213038
submission:
1300313039
additionalInformation: Any additional information
1300413040
useCase: 2FA
13005-
termsAndConditionsUrl: http://your-company.com/termsAndConditionsUrl.pdf
13006-
businessDBA: SecondCompany Name
13041+
termsAndConditionsUrl: http://your-company.com/termsAndConditions
13042+
businessDba: Another Company Name Inc.
1300713043
isvReseller: Test ISV
1300813044
businessContact:
1300913045
firstName: John
@@ -13020,7 +13056,7 @@ components:
1302013056
name: Bandwidth Inc.
1302113057
state: NC
1302213058
url: https://www.example.com/path/to/resource
13023-
privacyPolicyUrl: http://your-company.com/privacyPolicyUrl.pdf
13059+
privacyPolicyUrl: http://your-company.com/privacyPolicy
1302413060
useCaseSummary: Text summarizing the use case for the toll-free number
1302513061
optInWorkflow:
1302613062
imageUrls:
@@ -13088,8 +13124,8 @@ components:
1308813124
example:
1308913125
additionalInformation: Any additional information
1309013126
useCase: 2FA
13091-
termsAndConditionsUrl: http://your-company.com/termsAndConditionsUrl.pdf
13092-
businessDBA: SecondCompany Name
13127+
termsAndConditionsUrl: http://your-company.com/termsAndConditions
13128+
businessDba: Another Company Name Inc.
1309313129
isvReseller: Test ISV
1309413130
businessContact:
1309513131
firstName: John
@@ -13106,7 +13142,7 @@ components:
1310613142
name: Bandwidth Inc.
1310713143
state: NC
1310813144
url: https://www.example.com/path/to/resource
13109-
privacyPolicyUrl: http://your-company.com/privacyPolicyUrl.pdf
13145+
privacyPolicyUrl: http://your-company.com/privacyPolicy
1311013146
useCaseSummary: Text summarizing the use case for the toll-free number
1311113147
optInWorkflow:
1311213148
imageUrls:
@@ -13163,16 +13199,16 @@ components:
1316313199
privacyPolicyUrl:
1316413200
description: The Toll-Free Verification request privacy policy URL. (Not
1316513201
Available Until 5/28/2025)
13166-
example: http://your-company.com/privacyPolicyUrl.pdf
13202+
example: http://your-company.com/privacyPolicy
1316713203
type: string
1316813204
termsAndConditionsUrl:
1316913205
description: The Toll-Free Verification request terms and conditions policy
1317013206
URL. (Not Available Until 5/28/2025)
13171-
example: http://your-company.com/termsAndConditionsUrl.pdf
13207+
example: http://your-company.com/termsAndConditions
1317213208
type: string
13173-
businessDBA:
13209+
businessDba:
1317413210
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
13175-
example: SecondCompany Name
13211+
example: Another Company Name Inc.
1317613212
type: string
1317713213
type: object
1317813214
tfvStatusEnum:

‎bandwidth.yml‎

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5253,17 +5253,17 @@ components:
52535253
description: >-
52545254
The Toll-Free Verification request privacy policy URL. (Not Available
52555255
Until 5/28/2025)
5256-
example: http://your-company.com/privacyPolicyUrl.pdf
5256+
example: http://your-company.com/privacyPolicy
52575257
type: string
52585258
termsAndConditionsUrl:
52595259
description: >-
52605260
The Toll-Free Verification request terms and conditions policy URL. (Not
52615261
Available Until 5/28/2025)
5262-
example: http://your-company.com/termsAndConditionsUrl.pdf
5262+
example: http://your-company.com/termsAndConditions
52635263
type: string
5264-
businessDBA:
5264+
businessDba:
52655265
description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
5266-
example: SecondCompany Name
5266+
example: Another Company Name Inc.
52675267
type: string
52685268
additionalDenialReason:
52695269
properties:
@@ -5349,8 +5349,8 @@ components:
53495349
$ref: '#/components/schemas/privacyPolicyUrl'
53505350
termsAndConditionsUrl:
53515351
$ref: '#/components/schemas/termsAndConditionsUrl'
5352-
businessDBA:
5353-
$ref: '#/components/schemas/businessDBA'
5352+
businessDba:
5353+
$ref: '#/components/schemas/businessDba'
53545354
verificationUpdateRequest:
53555355
type: object
53565356
required:
@@ -5388,8 +5388,8 @@ components:
53885388
$ref: '#/components/schemas/privacyPolicyUrl'
53895389
termsAndConditionsUrl:
53905390
$ref: '#/components/schemas/termsAndConditionsUrl'
5391-
businessDBA:
5392-
$ref: '#/components/schemas/businessDBA'
5391+
businessDba:
5392+
$ref: '#/components/schemas/businessDba'
53935393
tfvBasicAuthentication:
53945394
type: object
53955395
properties:
@@ -5483,6 +5483,21 @@ components:
54835483
$ref: '#/components/schemas/tfvCallbackStatusEnum'
54845484
internalTicketNumber:
54855485
$ref: '#/components/schemas/internalTicketNumberForWebhook'
5486+
blockedWebhook:
5487+
type: object
5488+
properties:
5489+
accountId:
5490+
$ref: '#/components/schemas/accountId1'
5491+
phoneNumber:
5492+
$ref: '#/components/schemas/tfPhoneNumber'
5493+
status:
5494+
$ref: '#/components/schemas/tfvCallbackStatusEnum'
5495+
internalTicketNumber:
5496+
$ref: '#/components/schemas/internalTicketNumberForWebhook'
5497+
blocked:
5498+
$ref: '#/components/schemas/blocked'
5499+
blockedReason:
5500+
$ref: '#/components/schemas/blockedReason'
54865501
tfvSubmissionWrapper:
54875502
type: object
54885503
properties:
@@ -5849,8 +5864,8 @@ components:
58495864
$ref: '#/components/schemas/privacyPolicyUrl'
58505865
termsAndConditionsUrl:
58515866
$ref: '#/components/schemas/termsAndConditionsUrl'
5852-
businessDBA:
5853-
$ref: '#/components/schemas/businessDBA'
5867+
businessDba:
5868+
$ref: '#/components/schemas/businessDba'
58545869
tfvStatusEnum:
58555870
type: string
58565871
enum:
@@ -7468,6 +7483,7 @@ components:
74687483
- $ref: '#/components/schemas/verificationWebhook'
74697484
- $ref: '#/components/schemas/verificationDenialWebhook'
74707485
- $ref: '#/components/schemas/failureWebhook'
7486+
- $ref: '#/components/schemas/blockedWebhook'
74717487
webhookSubscriptionRequest:
74727488
description: >-
74737489
Information about a webhook that Bandwidth should send upon the

‎docs/BlockedWebhook.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
3+
# BlockedWebhook
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**accountId** | **String** | User&#39;s account ID. | [optional] |
11+
|**phoneNumber** | **String** | Toll-free telephone number in E.164 format. | [optional] |
12+
|**status** | **TfvCallbackStatusEnum** | | [optional] |
13+
|**internalTicketNumber** | **UUID** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
14+
|**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] |
15+
|**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] |
16+
17+
18+

‎docs/TfvSubmissionInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
|**isvReseller** | **String** | ISV name. | [optional] |
1919
|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
2020
|**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] |
21+
|**businessDba** | **String** | The company &#39;Doing Business As&#39;. (Not Available Until 5/28/2025) | [optional] |
2222

2323

2424

‎docs/VerificationRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
|**isvReseller** | **String** | ISV name. | [optional] |
2020
|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
2121
|**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] |
22+
|**businessDba** | **String** | The company &#39;Doing Business As&#39;. (Not Available Until 5/28/2025) | [optional] |
2323

2424

2525

‎docs/VerificationUpdateRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
|**isvReseller** | **String** | ISV name. | [optional] |
1919
|**privacyPolicyUrl** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
2020
|**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] |
21+
|**businessDba** | **String** | The company &#39;Doing Business As&#39;. (Not Available Until 5/28/2025) | [optional] |
2222

2323

2424

‎src/main/java/com/bandwidth/sdk/JSON.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ private static Class getClassByDiscriminator(Map classByDiscriminatorValue, Stri
117117
gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.AdditionalDenialReason.CustomTypeAdapterFactory());
118118
gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.Address.CustomTypeAdapterFactory());
119119
gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.AnswerCallback.CustomTypeAdapterFactory());
120+
gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.BlockedWebhook.CustomTypeAdapterFactory());
120121
gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.BridgeCompleteCallback.CustomTypeAdapterFactory());
121122
gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.BridgeTargetCompleteCallback.CustomTypeAdapterFactory());
122123
gsonBuilder.registerTypeAdapterFactory(new com.bandwidth.sdk.model.CallRecordingMetadata.CustomTypeAdapterFactory());

0 commit comments

Comments
 (0)