/** * 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 { Conference } from '../models'; import type { ConferenceMember } from '../models'; import type { ConferenceRecordingMetadata } from '../models'; import type { UpdateConference } from '../models'; import type { UpdateConferenceMember } from '../models'; /** * ConferencesApi - axios parameter creator */ export declare const ConferencesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Downloads the specified recording file. * @summary Download Conference Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadConferenceRecording: (accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns information about the specified conference. * @summary Get Conference Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConference: (accountId: string, conferenceId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns information about the specified conference member. * @summary Get Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceMember: (accountId: string, conferenceId: string, memberId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns metadata for the specified recording. * @summary Get Conference Recording Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceRecording: (accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference. * @summary Get Conference Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferenceRecordings: (accountId: string, conferenceId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a max of 1000 conferences, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of conferences in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel=\"next\"`) will be returned in the response. The url can be used to retrieve the next page of conference records. * @summary Get Conferences * @param {string} accountId Your Bandwidth Account ID. * @param {string} [name] Filter results by the `name` field. * @param {string} [minCreatedTime] Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). * @param {string} [maxCreatedTime] Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). * @param {number} [pageSize] Specifies the max number of conferences that will be returned. * @param {string} [pageToken] Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferences: (accountId: string, name?: string, minCreatedTime?: string, maxCreatedTime?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update the conference state. * @summary Update Conference * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {UpdateConference} updateConference * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConference: (accountId: string, conferenceId: string, updateConference: UpdateConference, options?: RawAxiosRequestConfig) => Promise; /** * Update the conference BXML document. * @summary Update Conference BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceBxml: (accountId: string, conferenceId: string, body: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates settings for a particular conference member. * @summary Update Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {UpdateConferenceMember} updateConferenceMember * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceMember: (accountId: string, conferenceId: string, memberId: string, updateConferenceMember: UpdateConferenceMember, options?: RawAxiosRequestConfig) => Promise; }; /** * ConferencesApi - functional programming interface */ export declare const ConferencesApiFp: (configuration?: Configuration) => { /** * Downloads the specified recording file. * @summary Download Conference Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about the specified conference. * @summary Get Conference Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConference(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about the specified conference member. * @summary Get Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceMember(accountId: string, conferenceId: string, memberId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns metadata for the specified recording. * @summary Get Conference Recording Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference. * @summary Get Conference Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferenceRecordings(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns a max of 1000 conferences, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of conferences in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel=\"next\"`) will be returned in the response. The url can be used to retrieve the next page of conference records. * @summary Get Conferences * @param {string} accountId Your Bandwidth Account ID. * @param {string} [name] Filter results by the `name` field. * @param {string} [minCreatedTime] Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). * @param {string} [maxCreatedTime] Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). * @param {number} [pageSize] Specifies the max number of conferences that will be returned. * @param {string} [pageToken] Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferences(accountId: string, name?: string, minCreatedTime?: string, maxCreatedTime?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Update the conference state. * @summary Update Conference * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {UpdateConference} updateConference * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConference(accountId: string, conferenceId: string, updateConference: UpdateConference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update the conference BXML document. * @summary Update Conference BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceBxml(accountId: string, conferenceId: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates settings for a particular conference member. * @summary Update Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {UpdateConferenceMember} updateConferenceMember * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceMember(accountId: string, conferenceId: string, memberId: string, updateConferenceMember: UpdateConferenceMember, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConferencesApi - factory interface */ export declare const ConferencesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Downloads the specified recording file. * @summary Download Conference Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns information about the specified conference. * @summary Get Conference Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConference(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns information about the specified conference member. * @summary Get Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceMember(accountId: string, conferenceId: string, memberId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns metadata for the specified recording. * @summary Get Conference Recording Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference. * @summary Get Conference Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferenceRecordings(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a max of 1000 conferences, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of conferences in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel=\"next\"`) will be returned in the response. The url can be used to retrieve the next page of conference records. * @summary Get Conferences * @param {string} accountId Your Bandwidth Account ID. * @param {string} [name] Filter results by the `name` field. * @param {string} [minCreatedTime] Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). * @param {string} [maxCreatedTime] Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). * @param {number} [pageSize] Specifies the max number of conferences that will be returned. * @param {string} [pageToken] Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferences(accountId: string, name?: string, minCreatedTime?: string, maxCreatedTime?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Update the conference state. * @summary Update Conference * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {UpdateConference} updateConference * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConference(accountId: string, conferenceId: string, updateConference: UpdateConference, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update the conference BXML document. * @summary Update Conference BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceBxml(accountId: string, conferenceId: string, body: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates settings for a particular conference member. * @summary Update Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {UpdateConferenceMember} updateConferenceMember * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceMember(accountId: string, conferenceId: string, memberId: string, updateConferenceMember: UpdateConferenceMember, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ConferencesApi - object-oriented interface */ export declare class ConferencesApi extends BaseAPI { /** * Downloads the specified recording file. * @summary Download Conference Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns information about the specified conference. * @summary Get Conference Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConference(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns information about the specified conference member. * @summary Get Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceMember(accountId: string, conferenceId: string, memberId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns metadata for the specified recording. * @summary Get Conference Recording Information * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConferenceRecording(accountId: string, conferenceId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns a (potentially empty) list of metadata for the recordings that took place during the specified conference. * @summary Get Conference Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferenceRecordings(accountId: string, conferenceId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns a max of 1000 conferences, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of conferences in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel=\"next\"`) will be returned in the response. The url can be used to retrieve the next page of conference records. * @summary Get Conferences * @param {string} accountId Your Bandwidth Account ID. * @param {string} [name] Filter results by the `name` field. * @param {string} [minCreatedTime] Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). * @param {string} [maxCreatedTime] Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). * @param {number} [pageSize] Specifies the max number of conferences that will be returned. * @param {string} [pageToken] Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConferences(accountId: string, name?: string, minCreatedTime?: string, maxCreatedTime?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig): Promise>; /** * Update the conference state. * @summary Update Conference * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {UpdateConference} updateConference * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConference(accountId: string, conferenceId: string, updateConference: UpdateConference, options?: RawAxiosRequestConfig): Promise>; /** * Update the conference BXML document. * @summary Update Conference BXML * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceBxml(accountId: string, conferenceId: string, body: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates settings for a particular conference member. * @summary Update Conference Member * @param {string} accountId Your Bandwidth Account ID. * @param {string} conferenceId Programmable Voice API Conference ID. * @param {string} memberId Programmable Voice API Conference Member ID. * @param {UpdateConferenceMember} updateConferenceMember * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateConferenceMember(accountId: string, conferenceId: string, memberId: string, updateConferenceMember: UpdateConferenceMember, options?: RawAxiosRequestConfig): Promise>; }