/**
* 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 { CallState } from '../models';
import type { CreateCall } from '../models';
import type { CreateCallResponse } from '../models';
import type { UpdateCall } from '../models';
/**
* CallsApi - axios parameter creator
*/
export declare const CallsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. Please note: Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.
* @summary Create Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {CreateCall} createCall JSON object containing information to create an outbound call
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCall: (accountId: string, createCall: CreateCall, options?: RawAxiosRequestConfig) => Promise;
/**
* Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.
* @summary Get Call State Information
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCallState: (accountId: string, callId: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a max of 10000 calls, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of calls 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 call records. Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.
* @summary Get Calls
* @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 calls which have a `startTime` after or including `minStartTime` (in ISO8601 format).
* @param {string} [maxStartTime] Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
* @param {string} [disconnectCause] Filter results to calls with specified call Disconnect Cause.
* @param {number} [pageSize] Specifies the max number of calls 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}
*/
listCalls: (accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, disconnectCause?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Interrupts and redirects a call to a different URL that should return a BXML document.
* @summary Update Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {UpdateCall} updateCall JSON object containing information to redirect an existing call to a new BXML document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCall: (accountId: string, callId: string, updateCall: UpdateCall, options?: RawAxiosRequestConfig) => Promise;
/**
* Interrupts and replaces an active call\'s BXML document.
* @summary Update Call BXML
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCallBxml: (accountId: string, callId: string, body: string, options?: RawAxiosRequestConfig) => Promise;
};
/**
* CallsApi - functional programming interface
*/
export declare const CallsApiFp: (configuration?: Configuration) => {
/**
* Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. Please note: Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.
* @summary Create Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {CreateCall} createCall JSON object containing information to create an outbound call
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCall(accountId: string, createCall: CreateCall, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.
* @summary Get Call State Information
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCallState(accountId: string, callId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a max of 10000 calls, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of calls 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 call records. Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.
* @summary Get Calls
* @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 calls which have a `startTime` after or including `minStartTime` (in ISO8601 format).
* @param {string} [maxStartTime] Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
* @param {string} [disconnectCause] Filter results to calls with specified call Disconnect Cause.
* @param {number} [pageSize] Specifies the max number of calls 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}
*/
listCalls(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, disconnectCause?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Interrupts and redirects a call to a different URL that should return a BXML document.
* @summary Update Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {UpdateCall} updateCall JSON object containing information to redirect an existing call to a new BXML document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCall(accountId: string, callId: string, updateCall: UpdateCall, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Interrupts and replaces an active call\'s BXML document.
* @summary Update Call BXML
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCallBxml(accountId: string, callId: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* CallsApi - factory interface
*/
export declare const CallsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. Please note: Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.
* @summary Create Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {CreateCall} createCall JSON object containing information to create an outbound call
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCall(accountId: string, createCall: CreateCall, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.
* @summary Get Call State Information
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCallState(accountId: string, callId: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a max of 10000 calls, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of calls 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 call records. Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.
* @summary Get Calls
* @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 calls which have a `startTime` after or including `minStartTime` (in ISO8601 format).
* @param {string} [maxStartTime] Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
* @param {string} [disconnectCause] Filter results to calls with specified call Disconnect Cause.
* @param {number} [pageSize] Specifies the max number of calls 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}
*/
listCalls(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, disconnectCause?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Interrupts and redirects a call to a different URL that should return a BXML document.
* @summary Update Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {UpdateCall} updateCall JSON object containing information to redirect an existing call to a new BXML document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCall(accountId: string, callId: string, updateCall: UpdateCall, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Interrupts and replaces an active call\'s BXML document.
* @summary Update Call BXML
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCallBxml(accountId: string, callId: string, body: string, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* CallsApi - object-oriented interface
*/
export declare class CallsApi extends BaseAPI {
/**
* Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. Please note: Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.
* @summary Create Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {CreateCall} createCall JSON object containing information to create an outbound call
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCall(accountId: string, createCall: CreateCall, options?: RawAxiosRequestConfig): Promise>;
/**
* Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.
* @summary Get Call State Information
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCallState(accountId: string, callId: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a max of 10000 calls, sorted by `createdTime` from oldest to newest. **NOTE:** If the number of calls 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 call records. Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.
* @summary Get Calls
* @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 calls which have a `startTime` after or including `minStartTime` (in ISO8601 format).
* @param {string} [maxStartTime] Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
* @param {string} [disconnectCause] Filter results to calls with specified call Disconnect Cause.
* @param {number} [pageSize] Specifies the max number of calls 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}
*/
listCalls(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, disconnectCause?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Interrupts and redirects a call to a different URL that should return a BXML document.
* @summary Update Call
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {UpdateCall} updateCall JSON object containing information to redirect an existing call to a new BXML document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCall(accountId: string, callId: string, updateCall: UpdateCall, options?: RawAxiosRequestConfig): Promise>;
/**
* Interrupts and replaces an active call\'s BXML document.
* @summary Update Call BXML
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} callId Programmable Voice API Call ID.
* @param {string} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCallBxml(accountId: string, callId: string, body: string, options?: RawAxiosRequestConfig): Promise>;
}