Skip to content

SWI-12494 Update SDK Based on Recent Spec Changes #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ckoegel merged 1 commit into from
Sep 8, 2026
+20 −20
Merged

SWI-12494 Update SDK Based on Recent Spec Changes #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions api/media-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
* Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
* @summary Delete Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand Down Expand Up @@ -80,7 +80,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
* Downloads a media file you previously uploaded.
* @summary Get Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand Down Expand Up @@ -172,7 +172,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
* 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).
* @summary Upload Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {File} body
* @param {string} [contentType] The media type of the entity-body.
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
Expand Down Expand Up @@ -240,7 +240,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
* Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
* @summary Delete Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand All @@ -254,7 +254,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
* Downloads a media file you previously uploaded.
* @summary Get Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand Down Expand Up @@ -282,7 +282,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
* 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).
* @summary Upload Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {File} body
* @param {string} [contentType] The media type of the entity-body.
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
Expand All @@ -308,7 +308,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
* Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
* @summary Delete Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand All @@ -319,7 +319,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
* Downloads a media file you previously uploaded.
* @summary Get Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand All @@ -341,7 +341,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
* 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).
* @summary Upload Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {File} body
* @param {string} [contentType] The media type of the entity-body.
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
Expand All @@ -362,7 +362,7 @@ export class MediaApi extends BaseAPI {
* Deletes a media file from Bandwidth API server. Make sure you don\'t have any application scripts still using the media before you delete. If you accidentally delete a media file you can immediately upload a new file with the same name.
* @summary Delete Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand All @@ -374,7 +374,7 @@ export class MediaApi extends BaseAPI {
* Downloads a media file you previously uploaded.
* @summary Get Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
Expand All @@ -398,7 +398,7 @@ export class MediaApi extends BaseAPI {
* 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).
* @summary Upload Media
* @param {string} accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.**
* @param {string} mediaId Media ID to retrieve.
* @param {string} mediaId The ID of the media file.
* @param {File} body
* @param {string} [contentType] The media type of the entity-body.
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
Expand Down
4 changes: 2 additions & 2 deletions bandwidth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8237,8 +8237,8 @@ components:
in: path
name: mediaId
required: true
description: Media ID to retrieve.
example: 14762070468292kw2fuqty55yp2b2/0/bw.png
description: The ID of the media file.
example: bw.png
schema:
type: string
contentType:
Expand Down
12 changes: 6 additions & 6 deletions docs/MediaApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const configuration = new Configuration();
const apiInstance = new MediaApi(configuration);

let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
let mediaId: string; //Media ID to retrieve. (default to undefined)
let mediaId: string; //The ID of the media file. (default to undefined)

const { status, data } = await apiInstance.deleteMedia(
accountId,
Expand All @@ -39,7 +39,7 @@ const { status, data } = await apiInstance.deleteMedia(
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|


### Return type
Expand Down Expand Up @@ -88,7 +88,7 @@ const configuration = new Configuration();
const apiInstance = new MediaApi(configuration);

let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
let mediaId: string; //Media ID to retrieve. (default to undefined)
let mediaId: string; //The ID of the media file. (default to undefined)

const { status, data } = await apiInstance.getMedia(
accountId,
Expand All @@ -101,7 +101,7 @@ const { status, data } = await apiInstance.getMedia(
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|


### Return type
Expand Down Expand Up @@ -212,7 +212,7 @@ const configuration = new Configuration();
const apiInstance = new MediaApi(configuration);

let accountId: string; //This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (default to undefined)
let mediaId: string; //Media ID to retrieve. (default to undefined)
let mediaId: string; //The ID of the media file. (default to undefined)
let body: File; //
let contentType: string; //The media type of the entity-body. (optional) (default to undefined)
let cacheControl: string; //General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) (default to undefined)
Expand All @@ -232,7 +232,7 @@ const { status, data } = await apiInstance.uploadMedia(
|------------- | ------------- | ------------- | -------------|
| **body** | **File**| | |
| **accountId** | [**string**] | This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (`u-be8dvafwrs63rwpm7pfil4b`) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** | defaults to undefined|
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
| **contentType** | [**string**] | The media type of the entity-body. | (optional) defaults to undefined|
| **cacheControl** | [**string**] | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | (optional) defaults to undefined|

Expand Down