Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 | 12x 12x 12x 12x 7x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 12x 7x 7x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 12x 2x 12x 2x 12x 1x 12x 1x 12x 1x 12x | /* tslint:disable */
/* eslint-disable */
/**
* 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 globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import type { CallState } from '../models';
// @ts-ignore
import type { CreateCall } from '../models';
// @ts-ignore
import type { CreateCallResponse } from '../models';
// @ts-ignore
import type { UpdateCall } from '../models';
// @ts-ignore
import type { VoiceApiError } from '../models';
/**
* CallsApi - axios parameter creator
*/
export const CallsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* 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. <b>Please note:</b> 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: async (accountId: string, createCall: CreateCall, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('createCall', 'accountId', accountId)
// verify required parameter 'createCall' is not null or undefined
assertParamExists('createCall', 'createCall', createCall)
const localVarPath = `/accounts/{accountId}/calls`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Basic required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication OAuth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(createCall, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (accountId: string, callId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('getCallState', 'accountId', accountId)
// verify required parameter 'callId' is not null or undefined
assertParamExists('getCallState', 'callId', callId)
const localVarPath = `/accounts/{accountId}/calls/{callId}`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Basic required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication OAuth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, disconnectCause?: string, pageSize?: number, pageToken?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('listCalls', 'accountId', accountId)
const localVarPath = `/accounts/{accountId}/calls`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Basic required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication OAuth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
Iif (to !== undefined) {
localVarQueryParameter['to'] = to;
}
Iif (from !== undefined) {
localVarQueryParameter['from'] = from;
}
Iif (minStartTime !== undefined) {
localVarQueryParameter['minStartTime'] = minStartTime;
}
Iif (maxStartTime !== undefined) {
localVarQueryParameter['maxStartTime'] = maxStartTime;
}
Iif (disconnectCause !== undefined) {
localVarQueryParameter['disconnectCause'] = disconnectCause;
}
Iif (pageSize !== undefined) {
localVarQueryParameter['pageSize'] = pageSize;
}
Iif (pageToken !== undefined) {
localVarQueryParameter['pageToken'] = pageToken;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (accountId: string, callId: string, updateCall: UpdateCall, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('updateCall', 'accountId', accountId)
// verify required parameter 'callId' is not null or undefined
assertParamExists('updateCall', 'callId', callId)
// verify required parameter 'updateCall' is not null or undefined
assertParamExists('updateCall', 'updateCall', updateCall)
const localVarPath = `/accounts/{accountId}/calls/{callId}`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Basic required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication OAuth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(updateCall, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (accountId: string, callId: string, body: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('updateCallBxml', 'accountId', accountId)
// verify required parameter 'callId' is not null or undefined
assertParamExists('updateCallBxml', 'callId', callId)
// verify required parameter 'body' is not null or undefined
assertParamExists('updateCallBxml', 'body', body)
const localVarPath = `/accounts/{accountId}/calls/{callId}/bxml`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
.replace(`{${"callId"}}`, encodeURIComponent(String(callId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Basic required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication OAuth2 required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration)
localVarHeaderParameter['Content-Type'] = 'application/xml';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* CallsApi - functional programming interface
*/
export const CallsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = CallsApiAxiosParamCreator(configuration)
return {
/**
* 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. <b>Please note:</b> 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}
*/
async createCall(accountId: string, createCall: CreateCall, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCallResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.createCall(accountId, createCall, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CallsApi.createCall']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async getCallState(accountId: string, callId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallState>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getCallState(accountId, callId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CallsApi.getCallState']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async 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<Array<CallState>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listCalls(accountId, to, from, minStartTime, maxStartTime, disconnectCause, pageSize, pageToken, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CallsApi.listCalls']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async updateCall(accountId: string, callId: string, updateCall: UpdateCall, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCall(accountId, callId, updateCall, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CallsApi.updateCall']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async updateCallBxml(accountId: string, callId: string, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCallBxml(accountId, callId, body, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CallsApi.updateCallBxml']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* CallsApi - factory interface
*/
export const CallsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = CallsApiFp(configuration)
return {
/**
* 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. <b>Please note:</b> 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<CreateCallResponse> {
return localVarFp.createCall(accountId, createCall, options).then((request) => request(axios, basePath));
},
/**
* 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<CallState> {
return localVarFp.getCallState(accountId, callId, options).then((request) => request(axios, basePath));
},
/**
* 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<Array<CallState>> {
return localVarFp.listCalls(accountId, to, from, minStartTime, maxStartTime, disconnectCause, pageSize, pageToken, options).then((request) => request(axios, basePath));
},
/**
* 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<void> {
return localVarFp.updateCall(accountId, callId, updateCall, options).then((request) => request(axios, basePath));
},
/**
* 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<void> {
return localVarFp.updateCallBxml(accountId, callId, body, options).then((request) => request(axios, basePath));
},
};
};
/**
* CallsApi - object-oriented interface
*/
export 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. <b>Please note:</b> 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}
*/
public createCall(accountId: string, createCall: CreateCall, options?: RawAxiosRequestConfig) {
return CallsApiFp(this.configuration).createCall(accountId, createCall, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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}
*/
public getCallState(accountId: string, callId: string, options?: RawAxiosRequestConfig) {
return CallsApiFp(this.configuration).getCallState(accountId, callId, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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}
*/
public listCalls(accountId: string, to?: string, from?: string, minStartTime?: string, maxStartTime?: string, disconnectCause?: string, pageSize?: number, pageToken?: string, options?: RawAxiosRequestConfig) {
return CallsApiFp(this.configuration).listCalls(accountId, to, from, minStartTime, maxStartTime, disconnectCause, pageSize, pageToken, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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}
*/
public updateCall(accountId: string, callId: string, updateCall: UpdateCall, options?: RawAxiosRequestConfig) {
return CallsApiFp(this.configuration).updateCall(accountId, callId, updateCall, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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}
*/
public updateCallBxml(accountId: string, callId: string, body: string, options?: RawAxiosRequestConfig) {
return CallsApiFp(this.configuration).updateCallBxml(accountId, callId, body, options).then((request) => request(this.axios, this.basePath));
}
}
|