Skip to content

Commit b54eb53

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

19 files changed

Lines changed: 155 additions & 33 deletions

‎api/openapi.yaml‎

Lines changed: 60 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6327,7 +6327,7 @@ components:
63276327
latestMessageDeliveryStatusDate: 2025-05-18
63286328
- phoneNumber: "+10072904498"
63296329
countryCodeA3: USA
6330-
lineType: FIXED
6330+
lineType: MOBILE
63316331
voiceProvider: VERIZON
63326332
latestMessageDeliveryStatus: DEACTIVATED
63336333
initialMessageDeliveryStatusDate: 2025-09-05
@@ -6341,6 +6341,14 @@ components:
63416341
deactivationDate: 2025-09-29 01:23:00
63426342
deactivationEvent: DEACTIVATED
63436343
latestMessageDeliveryStatus: UNKNOWN
6344+
- phoneNumber: "+10072904500"
6345+
lineType: FIXED
6346+
countryCodeA3: USA
6347+
voiceProvider: VERIZON
6348+
deactivationReporter: Verizon Wireless
6349+
deactivationDate: 2025-09-29 01:23:00
6350+
deactivationEvent: DEACTIVATED
6351+
latestMessageDeliveryStatus: NOT_ENABLED
63446352
errors: []
63456353
badRequestExample:
63466354
summary: Example Bad Request Error
@@ -8363,15 +8371,17 @@ components:
83638371
type: string
83648372
media:
83658373
example:
8366-
contentLength: 0
8374+
contentLength: 1024
83678375
content: content
8368-
mediaName: mediaName
8376+
mediaName: image.png
83698377
properties:
83708378
content:
83718379
type: string
83728380
contentLength:
8381+
example: 1024
83738382
type: integer
83748383
mediaName:
8384+
example: image.png
83758385
type: string
83768386
title: Media
83778387
type: object
@@ -9569,6 +9579,7 @@ components:
95699579
- `inboundCallback` indicates an inbound MO message or a multichannel message client's response to a suggestion or location request.
95709580
discriminator:
95719581
mapping:
9582+
message-sending: "#/components/schemas/statusCallback"
95729583
message-sent: "#/components/schemas/statusCallback"
95739584
message-delivered: "#/components/schemas/statusCallback"
95749585
message-failed: "#/components/schemas/statusCallback"
@@ -13297,10 +13308,12 @@ components:
1329713308
- ACTIVE: A message was successfully sent to the number (delivery code 0).
1329813309
- DEACTIVATED: A message was not delivered to a number (delivery code 720)
1329913310
- UNKNOWN: Bandwidth cannot find an delivery status entry for the number.
13311+
- NOT_ENABLED: The phone number is not enabled for messaging, so there is no delivery status information.
1330013312
enum:
1330113313
- ACTIVE
1330213314
- DEACTIVATED
1330313315
- UNKNOWN
13316+
- NOT_ENABLED
1330413317
type: string
1330513318
lineTypeEnum:
1330613319
enum:
@@ -13714,24 +13727,31 @@ components:
1371413727
privacyPolicyUrl:
1371513728
description: The Toll-Free Verification request privacy policy URL.
1371613729
example: http://your-company.com/privacyPolicy
13730+
maxLength: 500
1371713731
type: string
1371813732
termsAndConditionsUrl:
1371913733
description: The Toll-Free Verification request terms and conditions policy
1372013734
URL.
1372113735
example: http://your-company.com/termsAndConditions
13736+
maxLength: 500
1372213737
type: string
1372313738
businessDba:
1372413739
description: The company 'Doing Business As'.
1372513740
example: Another Company Name Inc.
13741+
maxLength: 500
1372613742
type: string
1372713743
businessRegistrationNumber:
13728-
description: Government-issued business identifying number.
13744+
description: |
13745+
Government-issued business identifying number.
13746+
13747+
**Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
1372913748
example: 12-3456789
1373013749
maxLength: 500
1373113750
nullable: true
1373213751
type: string
1373313752
businessRegistrationTypeEnum:
13734-
description: The type of business registration number.
13753+
description: |
13754+
The type of business registration number.
1373513755
enum:
1373613756
- EIN
1373713757
- CBN
@@ -13751,11 +13771,14 @@ components:
1375113771
- CNPJ
1375213772
- UID
1375313773
- OTHER
13774+
example: EIN
1375413775
nullable: true
1375513776
type: string
1375613777
businessRegistrationIssuingCountryEnum:
1375713778
description: |-
13758-
The country issuing the business registration in ISO-3166-1 alpha-3 format.
13779+
The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 country codes are acceptable, but the application will convert them to alpha-3 when received, so alpha-3 is encouraged.
13780+
13781+
**Note:** If this field is omitted but `businessRegistrationType` is provided, the application will attempt to infer the country based on the registration type. However, if the application cannot confidently infer the country, the submission may be rejected. To ensure the highest likelihood of acceptance, it is recommended to provide both `businessRegistrationType` and `businessRegistrationIssuingCountry`.
1375913782

1376013783
| Registration Type | Supported Countries |
1376113784
|----------------------|------------------------------------|
@@ -13791,17 +13814,23 @@ components:
1379113814
- DEU
1379213815
- ESP
1379313816
- CHE
13817+
- CYP
13818+
- IND
13819+
- CHN
13820+
- BGR
13821+
example: USA
1379413822
nullable: false
1379513823
type: string
1379613824
businessEntityTypeEnum:
13797-
description: "The type of registered business. If no option is applicable, please\
13798-
\ provide \"SOLE_PROPRIETOR\" as a value."
13825+
description: |
13826+
The type of registered business.
1379913827
enum:
1380013828
- SOLE_PROPRIETOR
1380113829
- PRIVATE_PROFIT
1380213830
- PUBLIC_PROFIT
1380313831
- NON_PROFIT
1380413832
- GOVERNMENT
13833+
example: PRIVATE_PROFIT
1380513834
nullable: false
1380613835
type: string
1380713836
helpMessageResponse:
@@ -13910,18 +13939,24 @@ components:
1391013939
privacyPolicyUrl:
1391113940
description: The Toll-Free Verification request privacy policy URL.
1391213941
example: http://your-company.com/privacyPolicy
13942+
maxLength: 500
1391313943
type: string
1391413944
termsAndConditionsUrl:
1391513945
description: The Toll-Free Verification request terms and conditions policy
1391613946
URL.
1391713947
example: http://your-company.com/termsAndConditions
13948+
maxLength: 500
1391813949
type: string
1391913950
businessDba:
1392013951
description: The company 'Doing Business As'.
1392113952
example: Another Company Name Inc.
13953+
maxLength: 500
1392213954
type: string
1392313955
businessRegistrationNumber:
13924-
description: Government-issued business identifying number.
13956+
description: |
13957+
Government-issued business identifying number.
13958+
13959+
**Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
1392513960
example: 12-3456789
1392613961
maxLength: 500
1392713962
nullable: true
@@ -14014,18 +14049,24 @@ components:
1401414049
privacyPolicyUrl:
1401514050
description: The Toll-Free Verification request privacy policy URL.
1401614051
example: http://your-company.com/privacyPolicy
14052+
maxLength: 500
1401714053
type: string
1401814054
termsAndConditionsUrl:
1401914055
description: The Toll-Free Verification request terms and conditions policy
1402014056
URL.
1402114057
example: http://your-company.com/termsAndConditions
14058+
maxLength: 500
1402214059
type: string
1402314060
businessDba:
1402414061
description: The company 'Doing Business As'.
1402514062
example: Another Company Name Inc.
14063+
maxLength: 500
1402614064
type: string
1402714065
businessRegistrationNumber:
14028-
description: Government-issued business identifying number.
14066+
description: |
14067+
Government-issued business identifying number.
14068+
14069+
**Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
1402914070
example: 12-3456789
1403014071
maxLength: 500
1403114072
nullable: true
@@ -14690,7 +14731,7 @@ components:
1469014731
phoneNumber: "+19192654500"
1469114732
email: foo@bar.com
1469214733
messageVolume: 10000
14693-
businessEntityType: SOLE_PROPRIETOR
14734+
businessEntityType: PRIVATE_PROFIT
1469414735
businessRegistrationType: EIN
1469514736
privacyPolicyUrl: http://your-company.com/privacyPolicy
1469614737
optInWorkflow:
@@ -14789,7 +14830,7 @@ components:
1478914830
phoneNumber: "+19192654500"
1479014831
email: foo@bar.com
1479114832
messageVolume: 10000
14792-
businessEntityType: SOLE_PROPRIETOR
14833+
businessEntityType: PRIVATE_PROFIT
1479314834
businessRegistrationType: EIN
1479414835
privacyPolicyUrl: http://your-company.com/privacyPolicy
1479514836
optInWorkflow:
@@ -14862,18 +14903,24 @@ components:
1486214903
privacyPolicyUrl:
1486314904
description: The Toll-Free Verification request privacy policy URL.
1486414905
example: http://your-company.com/privacyPolicy
14906+
maxLength: 500
1486514907
type: string
1486614908
termsAndConditionsUrl:
1486714909
description: The Toll-Free Verification request terms and conditions policy
1486814910
URL.
1486914911
example: http://your-company.com/termsAndConditions
14912+
maxLength: 500
1487014913
type: string
1487114914
businessDba:
1487214915
description: The company 'Doing Business As'.
1487314916
example: Another Company Name Inc.
14917+
maxLength: 500
1487414918
type: string
1487514919
businessRegistrationNumber:
14876-
description: Government-issued business identifying number.
14920+
description: |
14921+
Government-issued business identifying number.
14922+
14923+
**Note:** If this field is provided, it is strongly recommended to also provide `businessRegistrationType` and `businessRegistrationIssuingCountry`. Submissions missing these fields have a high likelihood of rejection.
1487714924
example: 12-3456789
1487814925
maxLength: 500
1487914926
nullable: true

‎bandwidth.yml‎

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1956,8 +1956,10 @@ components:
19561956
type: string
19571957
contentLength:
19581958
type: integer
1959+
example: 1024
19591960
mediaName:
19601961
type: string
1962+
example: image.png
19611963
segmentCount:
19621964
type: integer
19631965
description: >-
@@ -2744,6 +2746,7 @@ components:
27442746
discriminator:
27452747
propertyName: type
27462748
mapping:
2749+
message-sending: '#/components/schemas/statusCallback'
27472750
message-sent: '#/components/schemas/statusCallback'
27482751
message-delivered: '#/components/schemas/statusCallback'
27492752
message-failed: '#/components/schemas/statusCallback'
@@ -5510,10 +5513,14 @@ components:
55105513
55115514
- UNKNOWN: Bandwidth cannot find an delivery status entry for the
55125515
number.
5516+
5517+
- NOT_ENABLED: The phone number is not enabled for messaging, so there
5518+
is no delivery status information.
55135519
enum:
55145520
- ACTIVE
55155521
- DEACTIVATED
55165522
- UNKNOWN
5523+
- NOT_ENABLED
55175524
lineTypeEnum:
55185525
type: string
55195526
enum:
@@ -5816,25 +5823,36 @@ components:
58165823
type: string
58175824
privacyPolicyUrl:
58185825
description: The Toll-Free Verification request privacy policy URL.
5826+
maxLength: 500
58195827
example: http://your-company.com/privacyPolicy
58205828
type: string
58215829
termsAndConditionsUrl:
58225830
description: The Toll-Free Verification request terms and conditions policy URL.
5831+
maxLength: 500
58235832
example: http://your-company.com/termsAndConditions
58245833
type: string
58255834
businessDba:
58265835
description: The company 'Doing Business As'.
5836+
maxLength: 500
58275837
example: Another Company Name Inc.
58285838
type: string
58295839
businessRegistrationNumber:
58305840
type: string
5831-
description: Government-issued business identifying number.
5841+
description: >
5842+
Government-issued business identifying number.
5843+
5844+
5845+
**Note:** If this field is provided, it is strongly recommended to also
5846+
provide `businessRegistrationType` and
5847+
`businessRegistrationIssuingCountry`. Submissions missing these fields
5848+
have a high likelihood of rejection.
58325849
nullable: true
58335850
maxLength: 500
58345851
example: 12-3456789
58355852
businessRegistrationTypeEnum:
58365853
type: string
5837-
description: The type of business registration number.
5854+
description: |
5855+
The type of business registration number.
58385856
enum:
58395857
- EIN
58405858
- CBN
@@ -5854,12 +5872,22 @@ components:
58545872
- CNPJ
58555873
- UID
58565874
- OTHER
5875+
example: EIN
58575876
nullable: true
58585877
businessRegistrationIssuingCountryEnum:
58595878
type: string
58605879
description: >-
58615880
The country issuing the business registration in ISO-3166-1 alpha-3
5862-
format.
5881+
format. Alpha-2 country codes are acceptable, but the application will
5882+
convert them to alpha-3 when received, so alpha-3 is encouraged.
5883+
5884+
5885+
**Note:** If this field is omitted but `businessRegistrationType` is
5886+
provided, the application will attempt to infer the country based on the
5887+
registration type. However, if the application cannot confidently infer
5888+
the country, the submission may be rejected. To ensure the highest
5889+
likelihood of acceptance, it is recommended to provide both
5890+
`businessRegistrationType` and `businessRegistrationIssuingCountry`.
58635891
58645892
58655893
| Registration Type | Supported Countries |
@@ -5915,18 +5943,23 @@ components:
59155943
- DEU
59165944
- ESP
59175945
- CHE
5946+
- CYP
5947+
- IND
5948+
- CHN
5949+
- BGR
5950+
example: USA
59185951
nullable: false
59195952
businessEntityTypeEnum:
59205953
type: string
5921-
description: >-
5922-
The type of registered business. If no option is applicable, please
5923-
provide "SOLE_PROPRIETOR" as a value.
5954+
description: |
5955+
The type of registered business.
59245956
enum:
59255957
- SOLE_PROPRIETOR
59265958
- PRIVATE_PROFIT
59275959
- PUBLIC_PROFIT
59285960
- NON_PROFIT
59295961
- GOVERNMENT
5962+
example: PRIVATE_PROFIT
59305963
nullable: false
59315964
helpMessageResponse:
59325965
type: string
@@ -6576,10 +6609,14 @@ components:
65766609
$ref: '#/components/schemas/businessDba'
65776610
businessRegistrationNumber:
65786611
$ref: '#/components/schemas/businessRegistrationNumber'
6612+
description: Government-issued business identifying number.
65796613
businessRegistrationType:
65806614
$ref: '#/components/schemas/businessRegistrationTypeEnum'
65816615
businessRegistrationIssuingCountry:
65826616
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6617+
description: >-
6618+
The country issuing the business registration in ISO-3166-1 alpha-3
6619+
format.
65836620
businessEntityType:
65846621
$ref: '#/components/schemas/businessEntityTypeEnum'
65856622
tfvStatusEnum:
@@ -8117,7 +8154,7 @@ components:
81178154
latestMessageDeliveryStatusDate: '2025-05-18'
81188155
- phoneNumber: '+10072904498'
81198156
countryCodeA3: USA
8120-
lineType: FIXED
8157+
lineType: MOBILE
81218158
voiceProvider: VERIZON
81228159
latestMessageDeliveryStatus: DEACTIVATED
81238160
initialMessageDeliveryStatusDate: '2025-09-05'
@@ -8131,6 +8168,14 @@ components:
81318168
deactivationDate: '2025-09-29 01:23:00'
81328169
deactivationEvent: DEACTIVATED
81338170
latestMessageDeliveryStatus: UNKNOWN
8171+
- phoneNumber: '+10072904500'
8172+
lineType: FIXED
8173+
countryCodeA3: USA
8174+
voiceProvider: VERIZON
8175+
deactivationReporter: Verizon Wireless
8176+
deactivationDate: '2025-09-29 01:23:00'
8177+
deactivationEvent: DEACTIVATED
8178+
latestMessageDeliveryStatus: NOT_ENABLED
81348179
errors: []
81358180
badRequestExample:
81368181
summary: Example Bad Request Error

0 commit comments

Comments
 (0)