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 | 12x 12x 12x 12x 3x 2x 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 2x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 12x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 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 { AsyncLookupRequest } from '../models';
// @ts-ignore
import type { CreateAsyncBulkLookupResponse } from '../models';
// @ts-ignore
import type { CreateSyncLookupResponse } from '../models';
// @ts-ignore
import type { GetAsyncBulkLookupResponse } from '../models';
// @ts-ignore
import type { LookupErrorResponse } from '../models';
// @ts-ignore
import type { SyncLookupRequest } from '../models';
/**
* PhoneNumberLookupApi - axios parameter creator
*/
export const PhoneNumberLookupApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.
* @summary Create Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createAsyncBulkLookup: async (accountId: string, asyncLookupRequest: AsyncLookupRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('createAsyncBulkLookup', 'accountId', accountId)
// verify required parameter 'asyncLookupRequest' is not null or undefined
assertParamExists('createAsyncBulkLookup', 'asyncLookupRequest', asyncLookupRequest)
const localVarPath = `/accounts/{accountId}/phoneNumberLookup/bulk`
.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(asyncLookupRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
* @summary Create Synchronous Number Lookup
* @param {string} accountId
* @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSyncLookup: async (accountId: string, syncLookupRequest: SyncLookupRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('createSyncLookup', 'accountId', accountId)
// verify required parameter 'syncLookupRequest' is not null or undefined
assertParamExists('createSyncLookup', 'syncLookupRequest', syncLookupRequest)
const localVarPath = `/accounts/{accountId}/phoneNumberLookup`
.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(syncLookupRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.
* @summary Get Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {string} requestId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAsyncBulkLookup: async (accountId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'accountId' is not null or undefined
assertParamExists('getAsyncBulkLookup', 'accountId', accountId)
// verify required parameter 'requestId' is not null or undefined
assertParamExists('getAsyncBulkLookup', 'requestId', requestId)
const localVarPath = `/accounts/{accountId}/phoneNumberLookup/bulk/{requestId}`
.replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)))
.replace(`{${"requestId"}}`, encodeURIComponent(String(requestId)));
// 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,
};
},
}
};
/**
* PhoneNumberLookupApi - functional programming interface
*/
export const PhoneNumberLookupApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = PhoneNumberLookupApiAxiosParamCreator(configuration)
return {
/**
* Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.
* @summary Create Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createAsyncBulkLookup(accountId: string, asyncLookupRequest: AsyncLookupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAsyncBulkLookupResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.createAsyncBulkLookup(accountId, asyncLookupRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.createAsyncBulkLookup']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
* @summary Create Synchronous Number Lookup
* @param {string} accountId
* @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createSyncLookup(accountId: string, syncLookupRequest: SyncLookupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSyncLookupResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.createSyncLookup(accountId, syncLookupRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.createSyncLookup']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.
* @summary Get Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {string} requestId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getAsyncBulkLookup(accountId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAsyncBulkLookupResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAsyncBulkLookup(accountId, requestId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['PhoneNumberLookupApi.getAsyncBulkLookup']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* PhoneNumberLookupApi - factory interface
*/
export const PhoneNumberLookupApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = PhoneNumberLookupApiFp(configuration)
return {
/**
* Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.
* @summary Create Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createAsyncBulkLookup(accountId: string, asyncLookupRequest: AsyncLookupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAsyncBulkLookupResponse> {
return localVarFp.createAsyncBulkLookup(accountId, asyncLookupRequest, options).then((request) => request(axios, basePath));
},
/**
* Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
* @summary Create Synchronous Number Lookup
* @param {string} accountId
* @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createSyncLookup(accountId: string, syncLookupRequest: SyncLookupRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateSyncLookupResponse> {
return localVarFp.createSyncLookup(accountId, syncLookupRequest, options).then((request) => request(axios, basePath));
},
/**
* Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.
* @summary Get Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {string} requestId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAsyncBulkLookup(accountId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAsyncBulkLookupResponse> {
return localVarFp.getAsyncBulkLookup(accountId, requestId, options).then((request) => request(axios, basePath));
},
};
};
/**
* PhoneNumberLookupApi - object-oriented interface
*/
export class PhoneNumberLookupApi extends BaseAPI {
/**
* Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.
* @summary Create Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {AsyncLookupRequest} asyncLookupRequest Asynchronous bulk phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public createAsyncBulkLookup(accountId: string, asyncLookupRequest: AsyncLookupRequest, options?: RawAxiosRequestConfig) {
return PhoneNumberLookupApiFp(this.configuration).createAsyncBulkLookup(accountId, asyncLookupRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
* @summary Create Synchronous Number Lookup
* @param {string} accountId
* @param {SyncLookupRequest} syncLookupRequest Synchronous phone number lookup request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public createSyncLookup(accountId: string, syncLookupRequest: SyncLookupRequest, options?: RawAxiosRequestConfig) {
return PhoneNumberLookupApiFp(this.configuration).createSyncLookup(accountId, syncLookupRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
* Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.
* @summary Get Asynchronous Bulk Number Lookup
* @param {string} accountId
* @param {string} requestId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
public getAsyncBulkLookup(accountId: string, requestId: string, options?: RawAxiosRequestConfig) {
return PhoneNumberLookupApiFp(this.configuration).getAsyncBulkLookup(accountId, requestId, options).then((request) => request(this.axios, this.basePath));
}
}
|