/** * 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 { CallRecordingMetadata } from '../models'; import type { RecordingTranscriptions } from '../models'; import type { TranscribeRecording } from '../models'; import type { UpdateCallRecording } from '../models'; /** * RecordingsApi - axios parameter creator */ export declare const RecordingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecording: (accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes the specified recording\'s media. * @summary Delete Recording Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingMedia: (accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingTranscription: (accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Downloads the specified recording. * @summary Download Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadCallRecording: (accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns metadata for the specified recording. * @summary Get Call Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCallRecording: (accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [``](/docs/voice/bxml/playAudio) and [``](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [``](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item. * @summary Get Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordingTranscription: (accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria. * @summary Get Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} [to] Filter results by the `to` field. * @param {string} [from] Filter results by the `from` field. * @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). * @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAccountCallRecordings: (accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a (potentially empty) list of metadata for the recordings that took place during the specified call. * @summary List Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCallRecordings: (accountId: string, callId: string, options?: RawAxiosRequestConfig) => Promise; /** * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. * @summary Create Transcription Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {TranscribeRecording} transcribeRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ transcribeCallRecording: (accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: RawAxiosRequestConfig) => Promise; /** * Pause or resume a recording on an active phone call. * @summary Update Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {UpdateCallRecording} updateCallRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCallRecordingState: (accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: RawAxiosRequestConfig) => Promise; }; /** * RecordingsApi - functional programming interface */ export declare const RecordingsApiFp: (configuration?: Configuration) => { /** * Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the specified recording\'s media. * @summary Delete Recording Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Downloads the specified recording. * @summary Download Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns metadata for the specified recording. * @summary Get Call Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [``](/docs/voice/bxml/playAudio) and [``](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [``](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item. * @summary Get Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria. * @summary Get Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} [to] Filter results by the `to` field. * @param {string} [from] Filter results by the `from` field. * @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). * @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: 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 call. * @summary List Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCallRecordings(accountId: string, callId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. * @summary Create Transcription Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {TranscribeRecording} transcribeRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Pause or resume a recording on an active phone call. * @summary Update Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {UpdateCallRecording} updateCallRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RecordingsApi - factory interface */ export declare const RecordingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the specified recording\'s media. * @summary Delete Recording Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Downloads the specified recording. * @summary Download Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns metadata for the specified recording. * @summary Get Call Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [``](/docs/voice/bxml/playAudio) and [``](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [``](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item. * @summary Get Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria. * @summary Get Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} [to] Filter results by the `to` field. * @param {string} [from] Filter results by the `from` field. * @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). * @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a (potentially empty) list of metadata for the recordings that took place during the specified call. * @summary List Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCallRecordings(accountId: string, callId: string, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. * @summary Create Transcription Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {TranscribeRecording} transcribeRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: RawAxiosRequestConfig): AxiosPromise; /** * Pause or resume a recording on an active phone call. * @summary Update Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {UpdateCallRecording} updateCallRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RecordingsApi - object-oriented interface */ export declare class RecordingsApi extends BaseAPI { /** * Delete the recording information, media and transcription. Note: After the deletion is requested and a `204` is returned, neither the recording metadata nor the actual media nor its transcription will be accessible anymore. However, the media of the specified recording is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Deletes the specified recording\'s media. * @summary Delete Recording Media * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingMedia(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Deletes the specified recording\'s transcription. Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @summary Delete Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Downloads the specified recording. * @summary Download Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns metadata for the specified recording. * @summary Get Call Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCallRecording(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Downloads the specified transcription. If the recording was multi-channel, then there will be 2 transcripts. The caller/called party transcript will be the first item while [``](/docs/voice/bxml/playAudio) and [``](/docs/voice/bxml/speakSentence) transcript will be the second item. During a [``](/docs/voice/bxml/transfer) the A-leg transcript will be the first item while the B-leg transcript will be the second item. * @summary Get Transcription * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRecordingTranscription(accountId: string, callId: string, recordingId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of metadata for the recordings associated with the specified account. The list can be filtered by the optional from, to, minStartTime, and maxStartTime arguments. The list is capped at 1000 entries and may be empty if no recordings match the specified criteria. * @summary Get Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} [to] Filter results by the `to` field. * @param {string} [from] Filter results by the `from` field. * @param {string} [minStartTime] Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). * @param {string} [maxStartTime] Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAccountCallRecordings(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns a (potentially empty) list of metadata for the recordings that took place during the specified call. * @summary List Call Recordings * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCallRecordings(accountId: string, callId: string, options?: RawAxiosRequestConfig): Promise>; /** * Generate the transcription for a specific recording. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. * @summary Create Transcription Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {string} recordingId Programmable Voice API Recording ID. * @param {TranscribeRecording} transcribeRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ transcribeCallRecording(accountId: string, callId: string, recordingId: string, transcribeRecording: TranscribeRecording, options?: RawAxiosRequestConfig): Promise>; /** * Pause or resume a recording on an active phone call. * @summary Update Recording * @param {string} accountId Your Bandwidth Account ID. * @param {string} callId Programmable Voice API Call ID. * @param {UpdateCallRecording} updateCallRecording * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCallRecordingState(accountId: string, callId: string, updateCallRecording: UpdateCallRecording, options?: RawAxiosRequestConfig): Promise>; }