Skip to content

Commit e3856ab

Browse files
Generate SDK with OpenAPI Generator Version (#136)
Co-authored-by: DX-Bandwidth <dx@bandwidth.com>
1 parent 3090a3c commit e3856ab

3 files changed

Lines changed: 20 additions & 20 deletions

File tree

‎api/media-api.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
3434
* 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.
3535
* @summary Delete Media
3636
* @param {string} 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.**
37-
* @param {string} mediaId Media ID to retrieve.
37+
* @param {string} mediaId The ID of the media file.
3838
* @param {*} [options] Override http request option.
3939
* @throws {RequiredError}
4040
*/
@@ -80,7 +80,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
8080
* Downloads a media file you previously uploaded.
8181
* @summary Get Media
8282
* @param {string} 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.**
83-
* @param {string} mediaId Media ID to retrieve.
83+
* @param {string} mediaId The ID of the media file.
8484
* @param {*} [options] Override http request option.
8585
* @throws {RequiredError}
8686
*/
@@ -172,7 +172,7 @@ export const MediaApiAxiosParamCreator = function (configuration?: Configuration
172172
* 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 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.**
175-
* @param {string} mediaId Media ID to retrieve.
175+
* @param {string} mediaId The ID of the media file.
176176
* @param {File} body
177177
* @param {string} [contentType] The media type of the entity-body.
178178
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
@@ -240,7 +240,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
240240
* 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.
241241
* @summary Delete Media
242242
* @param {string} 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.**
243-
* @param {string} mediaId Media ID to retrieve.
243+
* @param {string} mediaId The ID of the media file.
244244
* @param {*} [options] Override http request option.
245245
* @throws {RequiredError}
246246
*/
@@ -254,7 +254,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
254254
* Downloads a media file you previously uploaded.
255255
* @summary Get Media
256256
* @param {string} 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.**
257-
* @param {string} mediaId Media ID to retrieve.
257+
* @param {string} mediaId The ID of the media file.
258258
* @param {*} [options] Override http request option.
259259
* @throws {RequiredError}
260260
*/
@@ -282,7 +282,7 @@ export const MediaApiFp = function(configuration?: Configuration) {
282282
* 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).
283283
* @summary Upload Media
284284
* @param {string} 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.**
285-
* @param {string} mediaId Media ID to retrieve.
285+
* @param {string} mediaId The ID of the media file.
286286
* @param {File} body
287287
* @param {string} [contentType] The media type of the entity-body.
288288
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
@@ -308,7 +308,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
308308
* 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.
309309
* @summary Delete Media
310310
* @param {string} 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.**
311-
* @param {string} mediaId Media ID to retrieve.
311+
* @param {string} mediaId The ID of the media file.
312312
* @param {*} [options] Override http request option.
313313
* @throws {RequiredError}
314314
*/
@@ -319,7 +319,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
319319
* Downloads a media file you previously uploaded.
320320
* @summary Get Media
321321
* @param {string} 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.**
322-
* @param {string} mediaId Media ID to retrieve.
322+
* @param {string} mediaId The ID of the media file.
323323
* @param {*} [options] Override http request option.
324324
* @throws {RequiredError}
325325
*/
@@ -341,7 +341,7 @@ export const MediaApiFactory = function (configuration?: Configuration, basePath
341341
* 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).
342342
* @summary Upload Media
343343
* @param {string} 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.**
344-
* @param {string} mediaId Media ID to retrieve.
344+
* @param {string} mediaId The ID of the media file.
345345
* @param {File} body
346346
* @param {string} [contentType] The media type of the entity-body.
347347
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
@@ -362,7 +362,7 @@ export class MediaApi extends BaseAPI {
362362
* 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.
363363
* @summary Delete Media
364364
* @param {string} 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.**
365-
* @param {string} mediaId Media ID to retrieve.
365+
* @param {string} mediaId The ID of the media file.
366366
* @param {*} [options] Override http request option.
367367
* @throws {RequiredError}
368368
*/
@@ -374,7 +374,7 @@ export class MediaApi extends BaseAPI {
374374
* Downloads a media file you previously uploaded.
375375
* @summary Get Media
376376
* @param {string} 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.**
377-
* @param {string} mediaId Media ID to retrieve.
377+
* @param {string} mediaId The ID of the media file.
378378
* @param {*} [options] Override http request option.
379379
* @throws {RequiredError}
380380
*/
@@ -398,7 +398,7 @@ export class MediaApi extends BaseAPI {
398398
* 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).
399399
* @summary Upload Media
400400
* @param {string} 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.**
401-
* @param {string} mediaId Media ID to retrieve.
401+
* @param {string} mediaId The ID of the media file.
402402
* @param {File} body
403403
* @param {string} [contentType] The media type of the entity-body.
404404
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.

‎bandwidth.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8237,8 +8237,8 @@ components:
82378237
in: path
82388238
name: mediaId
82398239
required: true
8240-
description: Media ID to retrieve.
8241-
example: 14762070468292kw2fuqty55yp2b2/0/bw.png
8240+
description: The ID of the media file.
8241+
example: bw.png
82428242
schema:
82438243
type: string
82448244
contentType:

‎docs/MediaApi.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const configuration = new Configuration();
2626
const apiInstance = new MediaApi(configuration);
2727

2828
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)
29-
let mediaId: string; //Media ID to retrieve. (default to undefined)
29+
let mediaId: string; //The ID of the media file. (default to undefined)
3030

3131
const { status, data } = await apiInstance.deleteMedia(
3232
accountId,
@@ -39,7 +39,7 @@ const { status, data } = await apiInstance.deleteMedia(
3939
|Name | Type | Description | Notes|
4040
|------------- | ------------- | ------------- | -------------|
4141
| **accountId** | [**string**] | 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.** | defaults to undefined|
42-
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
42+
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
4343

4444

4545
### Return type
@@ -88,7 +88,7 @@ const configuration = new Configuration();
8888
const apiInstance = new MediaApi(configuration);
8989

9090
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)
91-
let mediaId: string; //Media ID to retrieve. (default to undefined)
91+
let mediaId: string; //The ID of the media file. (default to undefined)
9292

9393
const { status, data } = await apiInstance.getMedia(
9494
accountId,
@@ -101,7 +101,7 @@ const { status, data } = await apiInstance.getMedia(
101101
|Name | Type | Description | Notes|
102102
|------------- | ------------- | ------------- | -------------|
103103
| **accountId** | [**string**] | 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.** | defaults to undefined|
104-
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
104+
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
105105

106106

107107
### Return type
@@ -212,7 +212,7 @@ const configuration = new Configuration();
212212
const apiInstance = new MediaApi(configuration);
213213

214214
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)
215-
let mediaId: string; //Media ID to retrieve. (default to undefined)
215+
let mediaId: string; //The ID of the media file. (default to undefined)
216216
let body: File; //
217217
let contentType: string; //The media type of the entity-body. (optional) (default to undefined)
218218
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)
@@ -232,7 +232,7 @@ const { status, data } = await apiInstance.uploadMedia(
232232
|------------- | ------------- | ------------- | -------------|
233233
| **body** | **File**| | |
234234
| **accountId** | [**string**] | 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.** | defaults to undefined|
235-
| **mediaId** | [**string**] | Media ID to retrieve. | defaults to undefined|
235+
| **mediaId** | [**string**] | The ID of the media file. | defaults to undefined|
236236
| **contentType** | [**string**] | The media type of the entity-body. | (optional) defaults to undefined|
237237
| **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|
238238

0 commit comments

Comments
 (0)