Skip to content

SWI-12497 Update SDK Based on Recent Spec Changes #258

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
+28 −28
Merged

SWI-12497 Update SDK Based on Recent Spec Changes #258

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
16 changes: 8 additions & 8 deletions api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@ paths:
schema:
type: string
style: simple
- description: Media ID to retrieve.
example: 14762070468292kw2fuqty55yp2b2/0/bw.png
- description: The ID of the media file.
example: bw.png
explode: false
in: path
name: mediaId
Expand Down Expand Up @@ -227,8 +227,8 @@ paths:
schema:
type: string
style: simple
- description: Media ID to retrieve.
example: 14762070468292kw2fuqty55yp2b2/0/bw.png
- description: The ID of the media file.
example: bw.png
explode: false
in: path
name: mediaId
Expand Down Expand Up @@ -320,8 +320,8 @@ paths:
schema:
type: string
style: simple
- description: Media ID to retrieve.
example: 14762070468292kw2fuqty55yp2b2/0/bw.png
- description: The ID of the media file.
example: bw.png
explode: false
in: path
name: mediaId
Expand Down Expand Up @@ -7363,8 +7363,8 @@ components:
type: string
style: simple
mediaId:
description: Media ID to retrieve.
example: 14762070468292kw2fuqty55yp2b2/0/bw.png
description: The ID of the media file.
example: bw.png
explode: false
in: path
name: mediaId
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 @@ -44,7 +44,7 @@ public class Example {

MediaApi apiInstance = new MediaApi(defaultClient);
String accountId = "9900000"; // 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.**
String mediaId = "14762070468292kw2fuqty55yp2b2/0/bw.png"; // String | Media ID to retrieve.
String mediaId = "bw.png"; // String | The ID of the media file.
try {
apiInstance.deleteMedia(accountId, mediaId);
} catch (ApiException e) {
Expand All @@ -63,7 +63,7 @@ public class Example {
| 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.** | |
| **mediaId** | **String**| Media ID to retrieve. | |
| **mediaId** | **String**| The ID of the media file. | |

### Return type

Expand Down Expand Up @@ -125,7 +125,7 @@ public class Example {

MediaApi apiInstance = new MediaApi(defaultClient);
String accountId = "9900000"; // 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.**
String mediaId = "14762070468292kw2fuqty55yp2b2/0/bw.png"; // String | Media ID to retrieve.
String mediaId = "bw.png"; // String | The ID of the media file.
try {
File result = apiInstance.getMedia(accountId, mediaId);
System.out.println(result);
Expand All @@ -145,7 +145,7 @@ public class Example {
| 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.** | |
| **mediaId** | **String**| Media ID to retrieve. | |
| **mediaId** | **String**| The ID of the media file. | |

### Return type

Expand Down Expand Up @@ -289,7 +289,7 @@ public class Example {

MediaApi apiInstance = new MediaApi(defaultClient);
String accountId = "9900000"; // 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.**
String mediaId = "14762070468292kw2fuqty55yp2b2/0/bw.png"; // String | Media ID to retrieve.
String mediaId = "bw.png"; // String | The ID of the media file.
File body = new File("/path/to/file"); // File |
String contentType = "audio/wav"; // String | The media type of the entity-body.
String cacheControl = "no-cache"; // String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
Expand All @@ -311,7 +311,7 @@ public class Example {
| 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.** | |
| **mediaId** | **String**| Media ID to retrieve. | |
| **mediaId** | **String**| The ID of the media file. | |
| **body** | **File**| | |
| **contentType** | **String**| The media type of the entity-body. | [optional] |
| **cacheControl** | **String**| General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] |
Expand Down
24 changes: 12 additions & 12 deletions src/main/java/com/bandwidth/sdk/api/MediaApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public void setCustomBaseUrl(String customBaseUrl) {
/**
* Build call for deleteMedia
* @param 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.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
Expand Down Expand Up @@ -162,7 +162,7 @@ private okhttp3.Call deleteMediaValidateBeforeCall(@javax.annotation.Nonnull Str
* Delete Media
* 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.
* @param 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.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
<table border="1">
Expand All @@ -187,7 +187,7 @@ public void deleteMedia(@javax.annotation.Nonnull String accountId, @javax.annot
* Delete Media
* Deletes a media file from Bandwidth API server. Make sure you don&#39;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.
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @return ApiResponse&lt;Void&gt;
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Expand All @@ -214,7 +214,7 @@ public ApiResponse<Void> deleteMediaWithHttpInfo(@javax.annotation.Nonnull Strin
* Delete Media (asynchronously)
* Deletes a media file from Bandwidth API server. Make sure you don&#39;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.
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
Expand Down Expand Up @@ -242,7 +242,7 @@ public okhttp3.Call deleteMediaAsync(@javax.annotation.Nonnull String accountId,
/**
* Build call for getMedia
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
Expand Down Expand Up @@ -328,7 +328,7 @@ private okhttp3.Call getMediaValidateBeforeCall(@javax.annotation.Nonnull String
* Get Media
* Downloads a media file you previously uploaded.
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @return File
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Expand All @@ -355,7 +355,7 @@ public File getMedia(@javax.annotation.Nonnull String accountId, @javax.annotati
* Get Media
* Downloads a media file you previously uploaded.
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @return ApiResponse&lt;File&gt;
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Expand Down Expand Up @@ -383,7 +383,7 @@ public ApiResponse<File> getMediaWithHttpInfo(@javax.annotation.Nonnull String a
* Get Media (asynchronously)
* Downloads a media file you previously uploaded.
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
Expand Down Expand Up @@ -580,7 +580,7 @@ public okhttp3.Call listMediaAsync(@javax.annotation.Nonnull String accountId, @
/**
* Build call for uploadMedia
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param body (required)
* @param contentType The media type of the entity-body. (optional)
* @param cacheControl General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional)
Expand Down Expand Up @@ -731,7 +731,7 @@ private okhttp3.Call uploadMediaValidateBeforeCall(@javax.annotation.Nonnull Str
* Upload Media
* 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).
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param body (required)
* @param contentType The media type of the entity-body. (optional)
* @param cacheControl General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional)
Expand Down Expand Up @@ -759,7 +759,7 @@ public void uploadMedia(@javax.annotation.Nonnull String accountId, @javax.annot
* Upload Media
* 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).
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param body (required)
* @param contentType The media type of the entity-body. (optional)
* @param cacheControl General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional)
Expand Down Expand Up @@ -789,7 +789,7 @@ public ApiResponse<Void> uploadMediaWithHttpInfo(@javax.annotation.Nonnull Strin
* Upload Media (asynchronously)
* 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).
* @param accountId This is your 7-digit Bandwidth Account ID, as shown in the Bandwidth App. The older ID format (&#x60;u-be8dvafwrs63rwpm7pfil4b&#x60;) is deprecated. **When migrating to OAuth authentication, you must use the 7-digit Account ID.** (required)
* @param mediaId Media ID to retrieve. (required)
* @param mediaId The ID of the media file. (required)
* @param body (required)
* @param contentType The media type of the entity-body. (optional)
* @param cacheControl General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional)
Expand Down