Skip to content

Commit fdbd3a5

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-10424 Update SDK Based on Recent Spec Changes (#113)
* Generate SDK with OpenAPI Generator Version * remove old models * update test --------- Co-authored-by: DX-Bandwidth <dx@bandwidth.com> Co-authored-by: ckoegel <ckoegel1006@gmail.com>
1 parent bcd2521 commit fdbd3a5

22 files changed

Lines changed: 68 additions & 186 deletions

.openapi-generator/FILES

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ docs/BlockedWebhook.md
2424
docs/BridgeCompleteCallback.md
2525
docs/BridgeTargetCompleteCallback.md
2626
docs/BusinessEntityTypeEnum.md
27-
docs/BusinessRegistrationIssuingCountryEnum.md
2827
docs/BusinessRegistrationTypeEnum.md
2928
docs/CallDirectionEnum.md
3029
docs/CallRecordingMetadata.md
@@ -214,7 +213,6 @@ models/blocked-webhook.ts
214213
models/bridge-complete-callback.ts
215214
models/bridge-target-complete-callback.ts
216215
models/business-entity-type-enum.ts
217-
models/business-registration-issuing-country-enum.ts
218216
models/business-registration-type-enum.ts
219217
models/call-direction-enum.ts
220218
models/call-recording-metadata.ts

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,6 @@ Class | Method | HTTP request | Description
169169
- [BridgeCompleteCallback](docs/BridgeCompleteCallback.md)
170170
- [BridgeTargetCompleteCallback](docs/BridgeTargetCompleteCallback.md)
171171
- [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
172-
- [BusinessRegistrationIssuingCountryEnum](docs/BusinessRegistrationIssuingCountryEnum.md)
173172
- [BusinessRegistrationTypeEnum](docs/BusinessRegistrationTypeEnum.md)
174173
- [CallDirectionEnum](docs/CallDirectionEnum.md)
175174
- [CallRecordingMetadata](docs/CallRecordingMetadata.md)

api/media-api.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
169169
};
170170
},
171171
/**
172-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
172+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
173173
* @summary Upload Media
174174
* @param {string} accountId Your Bandwidth Account ID.
175175
* @param {string} mediaId Media ID to retrieve.
@@ -280,7 +280,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
280280
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
281281
},
282282
/**
283-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
283+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
284284
* @summary Upload Media
285285
* @param {string} accountId Your Bandwidth Account ID.
286286
* @param {string} mediaId Media ID to retrieve.
@@ -339,7 +339,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
339339
return localVarFp.listMedia(accountId, continuationToken, options).then((request) => request(axios, basePath));
340340
},
341341
/**
342-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
342+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
343343
* @summary Upload Media
344344
* @param {string} accountId Your Bandwidth Account ID.
345345
* @param {string} mediaId Media ID to retrieve.
@@ -396,7 +396,7 @@ export class MediaApi extends BaseAPI {
396396
}
397397

398398
/**
399-
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
399+
* Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
400400
* @summary Upload Media
401401
* @param {string} accountId Your Bandwidth Account ID.
402402
* @param {string} mediaId Media ID to retrieve.

bandwidth.yml

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ paths:
9595
under this account, the previous file will be overwritten.
9696
9797
98-
A list of supported media types can be found
99-
[here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
98+
A list of supported media types can be found at [Bandwidth
99+
Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
100100
operationId: uploadMedia
101101
tags:
102102
- Media
@@ -2255,8 +2255,8 @@ components:
22552255
22562256
For MMS, the API limits file size to 3.5MB. Specific carriers and
22572257
channels may have a smaller limit that could cause a large file to
2258-
fail, see
2259-
[here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits)
2258+
fail, see more at [Bandwidth
2259+
Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits)
22602260
for more details.
22612261
example: https://dev.bandwidth.com/images/bandwidth-logo.png
22622262
maxLength: 1000
@@ -5887,17 +5887,21 @@ components:
58875887
Government-issued business identifying number.
58885888
58895889
5890-
**Note:** If this field is provided, it is strongly recommended to also
5891-
provide `businessRegistrationType` and
5892-
`businessRegistrationIssuingCountry`. Submissions missing these fields
5893-
have a high likelihood of rejection.
5890+
**Note: As of October 19th, 2026 this field will be required when
5891+
`businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is
5892+
provided, `businessRegistrationType` and
5893+
`businessRegistrationIssuingCountry` are also required.**
58945894
nullable: true
58955895
maxLength: 500
58965896
example: 12-3456789
58975897
businessRegistrationTypeEnum:
58985898
type: string
5899-
description: |
5899+
description: >
59005900
The type of business registration number.
5901+
5902+
5903+
**Note: As of October 19th, 2026 this field will be required when
5904+
`businessRegistrationNumber` is provided.**
59015905
enum:
59025906
- EIN
59035907
- CBN
@@ -5919,20 +5923,16 @@ components:
59195923
- OTHER
59205924
example: EIN
59215925
nullable: true
5922-
businessRegistrationIssuingCountryEnum:
5926+
businessRegistrationIssuingCountry:
59235927
type: string
59245928
description: >-
59255929
The country issuing the business registration in ISO-3166-1 alpha-3
5926-
format. Alpha-2 country codes are acceptable, but the application will
5927-
convert them to alpha-3 when received, so alpha-3 is encouraged.
5930+
format. Alpha-2 format is accepted by the API, but alpha-3 is highly
5931+
encouraged.
59285932
59295933
5930-
**Note:** If this field is omitted but `businessRegistrationType` is
5931-
provided, the application will attempt to infer the country based on the
5932-
registration type. However, if the application cannot confidently infer
5933-
the country, the submission may be rejected. To ensure the highest
5934-
likelihood of acceptance, it is recommended to provide both
5935-
`businessRegistrationType` and `businessRegistrationIssuingCountry`.
5934+
**Note: As of October 19th, 2026 this field will be required when
5935+
`businessRegistrationNumber` is provided.**
59365936
59375937
59385938
| Registration Type | Supported Countries |
@@ -5974,30 +5974,22 @@ components:
59745974
| UID | CHE |
59755975
59765976
| OTHER | Must Provide Country Code |
5977-
enum:
5978-
- USA
5979-
- CAN
5980-
- HKG
5981-
- GBR
5982-
- IRL
5983-
- BRA
5984-
- NLD
5985-
- AUS
5986-
- FRA
5987-
- NZL
5988-
- DEU
5989-
- ESP
5990-
- CHE
5991-
- CYP
5992-
- IND
5993-
- CHN
5994-
- BGR
59955977
example: USA
5996-
nullable: false
5978+
nullable: true
59975979
businessEntityTypeEnum:
59985980
type: string
5999-
description: |
5981+
description: >
60005982
The type of registered business.
5983+
5984+
5985+
**Note: As of October 19th, 2026 submissions using a value other than
5986+
`SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`,
5987+
`businessRegistrationType`, and `businessRegistrationIssuingCountry`.
5988+
5989+
Submissions using `SOLE_PROPRIETOR` must _omit_
5990+
`businessRegistrationNumber`, `businessRegistrationType`, and
5991+
`businessRegistrationIssuingCountry`. Failure to adhere to these
5992+
constraints will result in a 400 Bad Request rejection.**
60015993
enum:
60025994
- SOLE_PROPRIETOR
60035995
- PRIVATE_PROFIT
@@ -6106,7 +6098,7 @@ components:
61066098
businessRegistrationType:
61076099
$ref: '#/components/schemas/businessRegistrationTypeEnum'
61086100
businessRegistrationIssuingCountry:
6109-
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6101+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
61106102
businessEntityType:
61116103
$ref: '#/components/schemas/businessEntityTypeEnum'
61126104
helpMessageResponse:
@@ -6161,7 +6153,7 @@ components:
61616153
businessEntityType:
61626154
$ref: '#/components/schemas/businessEntityTypeEnum'
61636155
businessRegistrationIssuingCountry:
6164-
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6156+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
61656157
helpMessageResponse:
61666158
$ref: '#/components/schemas/helpMessageResponse'
61676159
ageGatedContent:
@@ -6657,13 +6649,15 @@ components:
66576649
description: Government-issued business identifying number.
66586650
businessRegistrationType:
66596651
$ref: '#/components/schemas/businessRegistrationTypeEnum'
6652+
description: The type of business registration number.
66606653
businessRegistrationIssuingCountry:
6661-
$ref: '#/components/schemas/businessRegistrationIssuingCountryEnum'
6654+
$ref: '#/components/schemas/businessRegistrationIssuingCountry'
66626655
description: >-
66636656
The country issuing the business registration in ISO-3166-1 alpha-3
66646657
format.
66656658
businessEntityType:
66666659
$ref: '#/components/schemas/businessEntityTypeEnum'
6660+
description: The type of registered business.
66676661
tfvStatusEnum:
66686662
type: string
66696663
enum:

docs/BusinessEntityTypeEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# BusinessEntityTypeEnum
22

3-
The type of registered business.
3+
The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.**
44

55
## Enum
66

docs/BusinessRegistrationIssuingCountryEnum.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/BusinessRegistrationTypeEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# BusinessRegistrationTypeEnum
22

3-
The type of business registration number.
3+
The type of business registration number. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.**
44

55
## Enum
66

docs/MediaApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.listMedia(
198198
# **uploadMedia**
199199
> uploadMedia(body)
200200
201-
Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-).
201+
Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported).
202202

203203
### Example
204204

docs/MmsMessageContentFile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**fileUrl** | **string** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see [here](https://support.bandwidth.com/hc/en-us/articles/360014235473-What-are-the-MMS-file-size-limits) for more details. | [default to undefined]
8+
**fileUrl** | **string** | The URL of a media attachment. For MMS, the API limits file size to 3.5MB. Specific carriers and channels may have a smaller limit that could cause a large file to fail, see more at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823216-what-are-the-mms-file-size-limits) for more details. | [default to undefined]
99

1010
## Example
1111

docs/TfvSubmissionInfo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
1717
**privacyPolicyUrl** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] [default to undefined]
1818
**termsAndConditionsUrl** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] [default to undefined]
1919
**businessDba** | **string** | The company \&#39;Doing Business As\&#39;. | [optional] [default to undefined]
20-
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note:** If this field is provided, it is strongly recommended to also provide &#x60;businessRegistrationType&#x60; and &#x60;businessRegistrationIssuingCountry&#x60;. Submissions missing these fields have a high likelihood of rejection. | [optional] [default to undefined]
20+
**businessRegistrationNumber** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when &#x60;businessEntityType&#x60; is _not_ &#x60;SOLE_PROPRIETOR&#x60;. If this field is provided, &#x60;businessRegistrationType&#x60; and &#x60;businessRegistrationIssuingCountry&#x60; are also required.** | [optional] [default to undefined]
2121
**businessRegistrationType** | [**BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] [default to undefined]
22-
**businessRegistrationIssuingCountry** | [**BusinessRegistrationIssuingCountryEnum**](BusinessRegistrationIssuingCountryEnum.md) | | [optional] [default to undefined]
22+
**businessRegistrationIssuingCountry** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when &#x60;businessRegistrationNumber&#x60; is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] [default to undefined]
2323
**businessEntityType** | [**BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [default to undefined]
2424

2525
## Example

0 commit comments

Comments
 (0)