You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit e3856ab
Browse filesBrowse the repository at this point in the historyBrowse files
* 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.
35
35
* @summary Delete Media
36
36
* @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.**
37
-
* @param {string} mediaId Media ID to retrieve.
37
+
* @param {string} mediaId The ID of the media file.
* @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.**
83
-
* @param {string} mediaId Media ID to retrieve.
83
+
* @param {string} mediaId The ID of the media file.
* 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).
173
173
* @summary Upload Media
174
174
* @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.**
175
-
* @param {string} mediaId Media ID to retrieve.
175
+
* @param {string} mediaId The ID of the media file.
176
176
* @param {File} body
177
177
* @param {string} [contentType] The media type of the entity-body.
178
178
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
* 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.
241
241
* @summary Delete Media
242
242
* @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.**
243
-
* @param {string} mediaId Media ID to retrieve.
243
+
* @param {string} mediaId The ID of the media file.
* @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.**
257
-
* @param {string} mediaId Media ID to retrieve.
257
+
* @param {string} mediaId The ID of the media file.
* 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).
283
283
* @summary Upload Media
284
284
* @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.**
285
-
* @param {string} mediaId Media ID to retrieve.
285
+
* @param {string} mediaId The ID of the media file.
286
286
* @param {File} body
287
287
* @param {string} [contentType] The media type of the entity-body.
288
288
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
* 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.
309
309
* @summary Delete Media
310
310
* @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.**
311
-
* @param {string} mediaId Media ID to retrieve.
311
+
* @param {string} mediaId The ID of the media file.
* @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.**
322
-
* @param {string} mediaId Media ID to retrieve.
322
+
* @param {string} mediaId The ID of the media file.
* 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).
342
342
* @summary Upload Media
343
343
* @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.**
344
-
* @param {string} mediaId Media ID to retrieve.
344
+
* @param {string} mediaId The ID of the media file.
345
345
* @param {File} body
346
346
* @param {string} [contentType] The media type of the entity-body.
347
347
* @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 {
362
362
* 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.
363
363
* @summary Delete Media
364
364
* @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.**
365
-
* @param {string} mediaId Media ID to retrieve.
365
+
* @param {string} mediaId The ID of the media file.
@@ -374,7 +374,7 @@ export class MediaApi extends BaseAPI {
374
374
* Downloads a media file you previously uploaded.
375
375
* @summary Get Media
376
376
* @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.**
377
-
* @param {string} mediaId Media ID to retrieve.
377
+
* @param {string} mediaId The ID of the media file.
@@ -398,7 +398,7 @@ export class MediaApi extends BaseAPI {
398
398
* 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).
399
399
* @summary Upload Media
400
400
* @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.**
401
-
* @param {string} mediaId Media ID to retrieve.
401
+
* @param {string} mediaId The ID of the media file.
402
402
* @param {File} body
403
403
* @param {string} [contentType] The media type of the entity-body.
404
404
* @param {string} [cacheControl] General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
Copy file name to clipboardExpand all lines: docs/MediaApi.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ const configuration = new Configuration();
26
26
const apiInstance =newMediaApi(configuration);
27
27
28
28
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)
30
30
31
31
const { status, data } =awaitapiInstance.deleteMedia(
|**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|
42
-
|**mediaId**|[**string**]|Media ID to retrieve. | defaults to undefined|
42
+
|**mediaId**|[**string**]|The ID of the media file. | defaults to undefined|
43
43
44
44
45
45
### Return type
@@ -88,7 +88,7 @@ const configuration = new Configuration();
88
88
const apiInstance =newMediaApi(configuration);
89
89
90
90
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)
92
92
93
93
const { status, data } =awaitapiInstance.getMedia(
|**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|
104
-
|**mediaId**|[**string**]|Media ID to retrieve. | defaults to undefined|
104
+
|**mediaId**|[**string**]|The ID of the media file. | defaults to undefined|
105
105
106
106
107
107
### Return type
@@ -212,7 +212,7 @@ const configuration = new Configuration();
212
212
const apiInstance =newMediaApi(configuration);
213
213
214
214
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)
216
216
let body:File; //
217
217
let contentType:string; //The media type of the entity-body. (optional) (default to undefined)
218
218
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)
|**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|
235
-
|**mediaId**|[**string**]|Media ID to retrieve. | defaults to undefined|
235
+
|**mediaId**|[**string**]|The ID of the media file. | defaults to undefined|
236
236
|**contentType**|[**string**]| The media type of the entity-body. | (optional) defaults to undefined|
237
237
|**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|
0 commit comments