/** * Bandwidth * Bandwidth\'s Communication APIs * * The version of the OpenAPI document: 1.0.0 * Contact: letstalk@bandwidth.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { Media } from '../models'; /** * MediaApi - axios parameter creator */ export declare const MediaApiAxiosParamCreator: (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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMedia: (accountId: string, mediaId: string, options?: RawAxiosRequestConfig) => Promise; /** * Downloads a media file you previously uploaded. * @summary Get Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMedia: (accountId: string, mediaId: string, options?: RawAxiosRequestConfig) => Promise; /** * Gets a list of your media files. No query parameters are supported. * @summary List Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} [continuationToken] Continuation token used to retrieve subsequent media. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMedia: (accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * 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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadMedia: (accountId: string, mediaId: string, body: File, contentType?: string, cacheControl?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * MediaApi - functional programming interface */ export declare const MediaApiFp: (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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Downloads a media file you previously uploaded. * @summary Get Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a list of your media files. No query parameters are supported. * @summary List Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} [continuationToken] Continuation token used to retrieve subsequent media. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMedia(accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadMedia(accountId: string, mediaId: string, body: File, contentType?: string, cacheControl?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MediaApi - factory interface */ export declare const MediaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Downloads a media file you previously uploaded. * @summary Get Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets a list of your media files. No query parameters are supported. * @summary List Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} [continuationToken] Continuation token used to retrieve subsequent media. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMedia(accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * 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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadMedia(accountId: string, mediaId: string, body: File, contentType?: string, cacheControl?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MediaApi - object-oriented interface */ export declare 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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig): Promise>; /** * Downloads a media file you previously uploaded. * @summary Get Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMedia(accountId: string, mediaId: string, options?: RawAxiosRequestConfig): Promise>; /** * Gets a list of your media files. No query parameters are supported. * @summary List Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} [continuationToken] Continuation token used to retrieve subsequent media. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMedia(accountId: string, continuationToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * 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 Your Bandwidth Account ID. * @param {string} mediaId Media ID to retrieve. * @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. * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadMedia(accountId: string, mediaId: string, body: File, contentType?: string, cacheControl?: string, options?: RawAxiosRequestConfig): Promise>; }