diff --git a/api/media-api.ts b/api/media-api.ts index 0ac5392..71c3de6 100644 --- a/api/media-api.ts +++ b/api/media-api.ts @@ -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} */ @@ -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} */ @@ -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. @@ -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} */ @@ -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} */ @@ -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. @@ -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} */ @@ -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} */ @@ -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. @@ -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} */ @@ -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} */ @@ -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. diff --git a/bandwidth.yml b/bandwidth.yml index 4b88b45..53949fe 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -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: diff --git a/docs/MediaApi.md b/docs/MediaApi.md index 3ca9399..c0393c1 100644 --- a/docs/MediaApi.md +++ b/docs/MediaApi.md @@ -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, @@ -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 @@ -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, @@ -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 @@ -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) @@ -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|