@devmehq/sdk-js
Version:
DEV.ME SDK for JavaScript & TypeScript for Server & Browser, Compatible with Node.js & React & Vue.js & Angular
945 lines • 185 kB
JavaScript
/**
* DEV.ME API Documentation
* **DEV.ME API Platform** - 19 powerful services across 7 categories **Validation & Verification:** [Email Validation API](https://dev.me/products/email) • [Phone Validation API](https://dev.me/products/phone) • [IP Geolocation API](https://dev.me/products/ip) **Financial & Currency:** [Currency Exchange API](https://dev.me/products/currency) • [Currency List API](https://dev.me/products/currency-list) **Domain & Security:** [Domain WHOIS API](https://dev.me/products/domain-whois) • [DNS Lookup API](https://dev.me/products/dns-lookup) • [Domain Tools API](https://dev.me/products/domain-tools) **Content & Media:** [QR Code Generator API](https://dev.me/products/qr-code-generator) • [Image Placeholders API](https://dev.me/products/image-placeholder) • [Image Optimization API](https://dev.me/products/image-optimizer) **URL & Web:** [URL Shortening API](https://dev.me/products/short-url) • [Web Scraping API](https://dev.me/products/url-scrapper) • [URL Metadata API](https://dev.me/products/url-metadata) • [One-Time URL API](https://dev.me/products/onetime-url) **Global Data:** [Country Data API](https://dev.me/products/country) • [City Data API](https://dev.me/products/city) **Management:** [API Key Management](https://dev.me/dashboard) • [API Usage Analytics](https://dev.me/dashboard) **Quick Start:** Use API key `demo-key` for testing • Visit [dev.me](https://dev.me) for complete documentation **Authentication:** Header `x-api-key: YOUR_API_KEY` or Query Parameter `?x-api-key=YOUR_API_KEY` **[Rate Limits](https://dev.me/pricing):** Free (500/mo) • Essential (15K/mo) • Standard (60K/mo) • Professional (1M/mo) • Enterprise (Unlimited) **Support:** support@dev.me • [Documentation](https://dev.me/documentation)
*
* The version of the OpenAPI document: 1.0.0
* Contact: support@dev.me
*/
import globalAxios from 'axios';
import { BASE_PATH, BaseAPI, operationServerMap } from './base.js';
// Some imports not used depending on template conditions
import { assertParamExists, createRequestFunction, DUMMY_BASE_URL, serializeDataIfNeeded, setApiKeyToObject, setSearchParams, toPathString, } from './common.js';
export const PreviewQrCodeInTypeEnum = {
Url: 'url',
Text: 'text',
Email: 'email',
Phone: 'phone',
Sms: 'sms',
Wifi: 'wifi',
Vcard: 'vcard',
};
export const PreviewQrCodeInFormatEnum = {
Base64: 'base64',
};
export const QrCodeBaseTypeEnum = {
Url: 'url',
Text: 'text',
Email: 'email',
Phone: 'phone',
Sms: 'sms',
Wifi: 'wifi',
Vcard: 'vcard',
};
export const QrCodeGenerationSettingsErrorCorrectionLevelEnum = {
L: 'L',
M: 'M',
Q: 'Q',
H: 'H',
};
export const UpdateQrCodeInTypeEnum = {
Url: 'url',
Text: 'text',
Email: 'email',
Phone: 'phone',
Sms: 'sms',
Wifi: 'wifi',
Vcard: 'vcard',
};
/**
* APIKeyApi - axios parameter creator
*/
export const APIKeyApiAxiosParamCreator = (configuration) => ({
/**
* Create API Key - Generate a new API key
* @param {CreateApiKeyIn} createApiKeyIn API key configuration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1CreateApiKey: async (createApiKeyIn, options = {}) => {
// verify required parameter 'createApiKeyIn' is not null or undefined
assertParamExists('v1CreateApiKey', 'createApiKeyIn', createApiKeyIn);
const localVarPath = `/v1-create-api-key`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
localVarRequestOptions.data = serializeDataIfNeeded(createApiKeyIn, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Delete API Key - Remove an API key permanently
* @param {DeleteApiKeyIn} deleteApiKeyIn API key to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1DeleteApiKey: async (deleteApiKeyIn, options = {}) => {
// verify required parameter 'deleteApiKeyIn' is not null or undefined
assertParamExists('v1DeleteApiKey', 'deleteApiKeyIn', deleteApiKeyIn);
const localVarPath = `/v1-delete-api-key`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
localVarRequestOptions.data = serializeDataIfNeeded(deleteApiKeyIn, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Get API Key Details - Retrieve details of a specific API key
* @param {GetApiKeyDetailsIn} getApiKeyDetailsIn Request body with API key ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetApiKeyDetails: async (getApiKeyDetailsIn, options = {}) => {
// verify required parameter 'getApiKeyDetailsIn' is not null or undefined
assertParamExists('v1GetApiKeyDetails', 'getApiKeyDetailsIn', getApiKeyDetailsIn);
const localVarPath = `/v1-get-api-key-details`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
localVarRequestOptions.data = serializeDataIfNeeded(getApiKeyDetailsIn, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Who Am I - Get current user information
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetWhoAmI: async (options = {}) => {
const localVarPath = `/v1-who-am-i`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* List API Keys - Retrieve user\'s API keys
* @param {ListApiKeysIn} listApiKeysIn Request body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1ListApiKeys: async (listApiKeysIn, options = {}) => {
// verify required parameter 'listApiKeysIn' is not null or undefined
assertParamExists('v1ListApiKeys', 'listApiKeysIn', listApiKeysIn);
const localVarPath = `/v1-list-api-keys`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
localVarRequestOptions.data = serializeDataIfNeeded(listApiKeysIn, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Update API Key - Modify an existing API key
* @param {UpdateApiKeyIn} updateApiKeyIn Updated API key configuration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1UpdateApiKey: async (updateApiKeyIn, options = {}) => {
// verify required parameter 'updateApiKeyIn' is not null or undefined
assertParamExists('v1UpdateApiKey', 'updateApiKeyIn', updateApiKeyIn);
const localVarPath = `/v1-update-api-key`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
localVarRequestOptions.data = serializeDataIfNeeded(updateApiKeyIn, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
});
/**
* APIKeyApi - functional programming interface
*/
export const APIKeyApiFp = (configuration) => {
const localVarAxiosParamCreator = APIKeyApiAxiosParamCreator(configuration);
return {
/**
* Create API Key - Generate a new API key
* @param {CreateApiKeyIn} createApiKeyIn API key configuration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1CreateApiKey(createApiKeyIn, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1CreateApiKey(createApiKeyIn, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIKeyApi.v1CreateApiKey']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Delete API Key - Remove an API key permanently
* @param {DeleteApiKeyIn} deleteApiKeyIn API key to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1DeleteApiKey(deleteApiKeyIn, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1DeleteApiKey(deleteApiKeyIn, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIKeyApi.v1DeleteApiKey']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Get API Key Details - Retrieve details of a specific API key
* @param {GetApiKeyDetailsIn} getApiKeyDetailsIn Request body with API key ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1GetApiKeyDetails(getApiKeyDetailsIn, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetApiKeyDetails(getApiKeyDetailsIn, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIKeyApi.v1GetApiKeyDetails']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Who Am I - Get current user information
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1GetWhoAmI(options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetWhoAmI(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIKeyApi.v1GetWhoAmI']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* List API Keys - Retrieve user\'s API keys
* @param {ListApiKeysIn} listApiKeysIn Request body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1ListApiKeys(listApiKeysIn, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1ListApiKeys(listApiKeysIn, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIKeyApi.v1ListApiKeys']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Update API Key - Modify an existing API key
* @param {UpdateApiKeyIn} updateApiKeyIn Updated API key configuration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1UpdateApiKey(updateApiKeyIn, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1UpdateApiKey(updateApiKeyIn, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIKeyApi.v1UpdateApiKey']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
};
};
/**
* APIKeyApi - factory interface
*/
export const APIKeyApiFactory = (configuration, basePath, axios) => {
const localVarFp = APIKeyApiFp(configuration);
return {
/**
* Create API Key - Generate a new API key
* @param {APIKeyApiV1CreateApiKeyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1CreateApiKey(requestParameters, options) {
return localVarFp
.v1CreateApiKey(requestParameters.createApiKeyIn, options)
.then((request) => request(axios, basePath));
},
/**
* Delete API Key - Remove an API key permanently
* @param {APIKeyApiV1DeleteApiKeyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1DeleteApiKey(requestParameters, options) {
return localVarFp
.v1DeleteApiKey(requestParameters.deleteApiKeyIn, options)
.then((request) => request(axios, basePath));
},
/**
* Get API Key Details - Retrieve details of a specific API key
* @param {APIKeyApiV1GetApiKeyDetailsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetApiKeyDetails(requestParameters, options) {
return localVarFp
.v1GetApiKeyDetails(requestParameters.getApiKeyDetailsIn, options)
.then((request) => request(axios, basePath));
},
/**
* Who Am I - Get current user information
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetWhoAmI(options) {
return localVarFp.v1GetWhoAmI(options).then((request) => request(axios, basePath));
},
/**
* List API Keys - Retrieve user\'s API keys
* @param {APIKeyApiV1ListApiKeysRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1ListApiKeys(requestParameters, options) {
return localVarFp
.v1ListApiKeys(requestParameters.listApiKeysIn, options)
.then((request) => request(axios, basePath));
},
/**
* Update API Key - Modify an existing API key
* @param {APIKeyApiV1UpdateApiKeyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1UpdateApiKey(requestParameters, options) {
return localVarFp
.v1UpdateApiKey(requestParameters.updateApiKeyIn, options)
.then((request) => request(axios, basePath));
},
};
};
/**
* APIKeyApi - object-oriented interface
*/
export class APIKeyApi extends BaseAPI {
/**
* Create API Key - Generate a new API key
* @param {APIKeyApiV1CreateApiKeyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1CreateApiKey(requestParameters, options) {
return APIKeyApiFp(this.configuration)
.v1CreateApiKey(requestParameters.createApiKeyIn, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* Delete API Key - Remove an API key permanently
* @param {APIKeyApiV1DeleteApiKeyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1DeleteApiKey(requestParameters, options) {
return APIKeyApiFp(this.configuration)
.v1DeleteApiKey(requestParameters.deleteApiKeyIn, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* Get API Key Details - Retrieve details of a specific API key
* @param {APIKeyApiV1GetApiKeyDetailsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetApiKeyDetails(requestParameters, options) {
return APIKeyApiFp(this.configuration)
.v1GetApiKeyDetails(requestParameters.getApiKeyDetailsIn, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* Who Am I - Get current user information
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetWhoAmI(options) {
return APIKeyApiFp(this.configuration)
.v1GetWhoAmI(options)
.then((request) => request(this.axios, this.basePath));
}
/**
* List API Keys - Retrieve user\'s API keys
* @param {APIKeyApiV1ListApiKeysRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1ListApiKeys(requestParameters, options) {
return APIKeyApiFp(this.configuration)
.v1ListApiKeys(requestParameters.listApiKeysIn, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* Update API Key - Modify an existing API key
* @param {APIKeyApiV1UpdateApiKeyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1UpdateApiKey(requestParameters, options) {
return APIKeyApiFp(this.configuration)
.v1UpdateApiKey(requestParameters.updateApiKeyIn, options)
.then((request) => request(this.axios, this.basePath));
}
}
/**
* APIUsageApi - axios parameter creator
*/
export const APIUsageApiAxiosParamCreator = (configuration) => ({
/**
* Get API Usage - Retrieve API usage statistics
* @param {string} [from] Start date for usage period (ISO 8601 format) - eg: 2024-01-01
* @param {string} [to] End date for usage period (ISO 8601 format) - eg: 2024-01-31
* @param {string} [service] Filter by specific service name - eg: currency, country, ip
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetApiUsage: async (from, to, service, options = {}) => {
const localVarPath = `/v1-get-api-usage`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
if (from !== undefined) {
localVarQueryParameter.from = from;
}
if (to !== undefined) {
localVarQueryParameter.to = to;
}
if (service !== undefined) {
localVarQueryParameter.service = service;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Download API Usage - Export API usage data as CSV
* @param {string} [from] Start date for usage period (ISO 8601 format) - eg: 2024-01-01
* @param {string} [to] End date for usage period (ISO 8601 format) - eg: 2024-01-31
* @param {string} [service] Filter by specific service name - eg: currency, country, ip
* @param {string} [format] Export format csv,json, default: csv
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetDownloadApiUsage: async (from, to, service, format, options = {}) => {
const localVarPath = `/v1-download-api-usage`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
if (from !== undefined) {
localVarQueryParameter.from = from;
}
if (to !== undefined) {
localVarQueryParameter.to = to;
}
if (service !== undefined) {
localVarQueryParameter.service = service;
}
if (format !== undefined) {
localVarQueryParameter.format = format;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
});
/**
* APIUsageApi - functional programming interface
*/
export const APIUsageApiFp = (configuration) => {
const localVarAxiosParamCreator = APIUsageApiAxiosParamCreator(configuration);
return {
/**
* Get API Usage - Retrieve API usage statistics
* @param {string} [from] Start date for usage period (ISO 8601 format) - eg: 2024-01-01
* @param {string} [to] End date for usage period (ISO 8601 format) - eg: 2024-01-31
* @param {string} [service] Filter by specific service name - eg: currency, country, ip
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1GetApiUsage(from, to, service, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetApiUsage(from, to, service, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIUsageApi.v1GetApiUsage']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Download API Usage - Export API usage data as CSV
* @param {string} [from] Start date for usage period (ISO 8601 format) - eg: 2024-01-01
* @param {string} [to] End date for usage period (ISO 8601 format) - eg: 2024-01-31
* @param {string} [service] Filter by specific service name - eg: currency, country, ip
* @param {string} [format] Export format csv,json, default: csv
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1GetDownloadApiUsage(from, to, service, format, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetDownloadApiUsage(from, to, service, format, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['APIUsageApi.v1GetDownloadApiUsage']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
};
};
/**
* APIUsageApi - factory interface
*/
export const APIUsageApiFactory = (configuration, basePath, axios) => {
const localVarFp = APIUsageApiFp(configuration);
return {
/**
* Get API Usage - Retrieve API usage statistics
* @param {APIUsageApiV1GetApiUsageRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetApiUsage(requestParameters = {}, options) {
return localVarFp
.v1GetApiUsage(requestParameters.from, requestParameters.to, requestParameters.service, options)
.then((request) => request(axios, basePath));
},
/**
* Download API Usage - Export API usage data as CSV
* @param {APIUsageApiV1GetDownloadApiUsageRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetDownloadApiUsage(requestParameters = {}, options) {
return localVarFp
.v1GetDownloadApiUsage(requestParameters.from, requestParameters.to, requestParameters.service, requestParameters.format, options)
.then((request) => request(axios, basePath));
},
};
};
/**
* APIUsageApi - object-oriented interface
*/
export class APIUsageApi extends BaseAPI {
/**
* Get API Usage - Retrieve API usage statistics
* @param {APIUsageApiV1GetApiUsageRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetApiUsage(requestParameters = {}, options) {
return APIUsageApiFp(this.configuration)
.v1GetApiUsage(requestParameters.from, requestParameters.to, requestParameters.service, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* Download API Usage - Export API usage data as CSV
* @param {APIUsageApiV1GetDownloadApiUsageRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetDownloadApiUsage(requestParameters = {}, options) {
return APIUsageApiFp(this.configuration)
.v1GetDownloadApiUsage(requestParameters.from, requestParameters.to, requestParameters.service, requestParameters.format, options)
.then((request) => request(this.axios, this.basePath));
}
}
/**
* CountryApi - axios parameter creator
*/
export const CountryApiAxiosParamCreator = (configuration) => ({
/**
* Get City Details - Retrieve detailed information about a specific city
* @param {number} [id] City ID
* @param {string} [name] City name (must be exact match)
* @param {string} [countryCode] Country code (2 letter ISO code) - eg: US, GB
* @param {string} [stateCode] State/Province code - eg: CA, NY
* @param {Array<string>} [expand] Fields to include in response - eg: [\"name\", \"countryName\", \"stateName\"]
* @param {Array<string>} [exclude] Fields to exclude from response - eg: [\"countryId\", \"stateId\"]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetCityDetails: async (id, name, countryCode, stateCode, expand, exclude, options = {}) => {
const localVarPath = `/v1-get-city-details`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
if (id !== undefined) {
localVarQueryParameter.id = id;
}
if (name !== undefined) {
localVarQueryParameter.name = name;
}
if (countryCode !== undefined) {
localVarQueryParameter.countryCode = countryCode;
}
if (stateCode !== undefined) {
localVarQueryParameter.stateCode = stateCode;
}
if (expand) {
localVarQueryParameter.expand = expand;
}
if (exclude) {
localVarQueryParameter.exclude = exclude;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Get Country Details - Retrieve detailed information about a specific country
* @param {string} code Country code (2 or 3 letter ISO code) - eg: US, USA
* @param {Array<string>} [expand] Fields to include in response - eg: [\"name\", \"capital\", \"currencies\", \"languages\"]
* @param {Array<string>} [exclude] Fields to exclude from response - eg: [\"translations\", \"demonyms\"]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetCountryDetails: async (code, expand, exclude, options = {}) => {
// verify required parameter 'code' is not null or undefined
assertParamExists('v1GetCountryDetails', 'code', code);
const localVarPath = `/v1-get-country-details`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
if (code !== undefined) {
localVarQueryParameter.code = code;
}
if (expand) {
localVarQueryParameter.expand = expand;
}
if (exclude) {
localVarQueryParameter.exclude = exclude;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Get Factbook Details - Retrieve detailed CIA World Factbook information for a country
* @param {string} code Country code (2 or 3 letter ISO code) - eg: US, USA
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1GetFactbookDetails: async (code, options = {}) => {
// verify required parameter 'code' is not null or undefined
assertParamExists('v1GetFactbookDetails', 'code', code);
const localVarPath = `/v1-get-factbook-details`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
if (code !== undefined) {
localVarQueryParameter.code = code;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* List Cities - Search and retrieve cities by name and country
* @param {string} [name] City name to search for (partial match supported)
* @param {Array<string>} [country] Filter by country codes (2 letter ISO codes) - eg: [\"US\", \"GB\", \"CA\"]
* @param {Array<string>} [sort] Sort fields (prefix with - for descending) - eg: [\"name\", \"-population\"]
* @param {number} [page] Page number for pagination - Default: 1
* @param {number} [pageSize] Number of items per page - Default: 20
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1ListCities: async (name, country, sort, page, pageSize, options = {}) => {
const localVarPath = `/v1-list-cities`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
if (name !== undefined) {
localVarQueryParameter.name = name;
}
if (country) {
localVarQueryParameter.country = country;
}
if (sort) {
localVarQueryParameter.sort = sort;
}
if (page !== undefined) {
localVarQueryParameter.page = page;
}
if (pageSize !== undefined) {
localVarQueryParameter.pageSize = pageSize;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* List Countries - Retrieve a searchable list of countries with filtering options
* @param {Array<string>} [code] Filter by country codes (2 or 3 letter ISO codes) - eg: [\"US\", \"GB\", \"FR\"]
* @param {Array<string>} [expand] Fields to include in response - eg: [\"name\", \"capital\", \"currencies\"]
* @param {Array<string>} [exclude] Fields to exclude from response - eg: [\"translations\", \"demonyms\"]
* @param {Array<string>} [sort] Sort fields (prefix with - for descending) - eg: [\"name\", \"-population\"]
* @param {number} [page] Page number for pagination - Default: 1
* @param {number} [pageSize] Number of items per page - Default: 20
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1ListCountries: async (code, expand, exclude, sort, page, pageSize, options = {}) => {
const localVarPath = `/v1-list-countries`;
// 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 = {};
const localVarQueryParameter = {};
// authentication APIKeyQueryParam required
await setApiKeyToObject(localVarQueryParameter, 'x-api-key', configuration);
// authentication APIKeyHeader required
await setApiKeyToObject(localVarHeaderParameter, 'x-api-key', configuration);
if (code) {
localVarQueryParameter.code = code;
}
if (expand) {
localVarQueryParameter.expand = expand;
}
if (exclude) {
localVarQueryParameter.exclude = exclude;
}
if (sort) {
localVarQueryParameter.sort = sort;
}
if (page !== undefined) {
localVarQueryParameter.page = page;
}
if (pageSize !== undefined) {
localVarQueryParameter.pageSize = pageSize;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
});
/**
* CountryApi - functional programming interface
*/
export const CountryApiFp = (configuration) => {
const localVarAxiosParamCreator = CountryApiAxiosParamCreator(configuration);
return {
/**
* Get City Details - Retrieve detailed information about a specific city
* @param {number} [id] City ID
* @param {string} [name] City name (must be exact match)
* @param {string} [countryCode] Country code (2 letter ISO code) - eg: US, GB
* @param {string} [stateCode] State/Province code - eg: CA, NY
* @param {Array<string>} [expand] Fields to include in response - eg: [\"name\", \"countryName\", \"stateName\"]
* @param {Array<string>} [exclude] Fields to exclude from response - eg: [\"countryId\", \"stateId\"]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1GetCityDetails(id, name, countryCode, stateCode, expand, exclude, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetCityDetails(id, name, countryCode, stateCode, expand, exclude, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CountryApi.v1GetCityDetails']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Get Country Details - Retrieve detailed information about a specific country
* @param {string} code Country code (2 or 3 letter ISO code) - eg: US, USA
* @param {Array<string>} [expand] Fields to include in response - eg: [\"name\", \"capital\", \"currencies\", \"languages\"]
* @param {Array<string>} [exclude] Fields to exclude from response - eg: [\"translations\", \"demonyms\"]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1GetCountryDetails(code, expand, exclude, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetCountryDetails(code, expand, exclude, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CountryApi.v1GetCountryDetails']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Get Factbook Details - Retrieve detailed CIA World Factbook information for a country
* @param {string} code Country code (2 or 3 letter ISO code) - eg: US, USA
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1GetFactbookDetails(code, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1GetFactbookDetails(code, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CountryApi.v1GetFactbookDetails']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* List Cities - Search and retrieve cities by name and country
* @param {string} [name] City name to search for (partial match supported)
* @param {Array<string>} [country] Filter by country codes (2 letter ISO codes) - eg: [\"US\", \"GB\", \"CA\"]
* @param {Array<string>} [sort] Sort fields (prefix with - for descending) - eg: [\"name\", \"-population\"]
* @param {number} [page] Page number for pagination - Default: 1
* @param {number} [pageSize] Number of items per page - Default: 20
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async v1ListCities(name, country, sort, page, pageSize, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.v1ListCities(name, country, sort, page, pageSize, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CountryApi.v1ListCities']?.[localVarOperationServerIndex]?.url;
re