@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
973 lines (921 loc) • 55.4 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* ForestVPN API
* ForestVPN - Fast, secure, and modern VPN. It offers Distributed Computing, Crypto Mining, P2P, Ad Blocking, TOR over VPN, 30+ locations, and a free version with unlimited data.
*
* OpenAPI spec version: 2.0
* Contact: support@forestvpn.com
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
import globalAxios, { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
// Some imports not used depending on template conditions
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
import { AggregatedFunctionStats } from '../models';
import { ModelFunction } from '../models';
import { Task } from '../models';
/**
* CloudApi - axios parameter creator
* @export
*/
export const CloudApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Create function
* @param {ModelFunction} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createFunction: async (body: ModelFunction, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new RequiredError('body','Required parameter body was null or undefined when calling createFunction.');
}
const localVarPath = `/cloud/functions/`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Delete Function
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteFunction: async (functionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'functionID' is not null or undefined
if (functionID === null || functionID === undefined) {
throw new RequiredError('functionID','Required parameter functionID was null or undefined when calling deleteFunction.');
}
const localVarPath = `/cloud/functions/{functionID}/`
.replace(`{${"functionID"}}`, encodeURIComponent(String(functionID)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Delete Task
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteTask: async (taskID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'taskID' is not null or undefined
if (taskID === null || taskID === undefined) {
throw new RequiredError('taskID','Required parameter taskID was null or undefined when calling deleteTask.');
}
const localVarPath = `/cloud/tasks/{taskID}/`
.replace(`{${"taskID"}}`, encodeURIComponent(String(taskID)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Function Info
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFunction: async (functionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'functionID' is not null or undefined
if (functionID === null || functionID === undefined) {
throw new RequiredError('functionID','Required parameter functionID was null or undefined when calling getFunction.');
}
const localVarPath = `/cloud/functions/{functionID}/`
.replace(`{${"functionID"}}`, encodeURIComponent(String(functionID)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
* Functions stats for each function
* @summary Function Stats
* @param {string} aggr_interval No more than 3 days for hour aggregation type
* @param {string} [assignment_date_after] No more than 3 months between assignment_date_after and assignment_date_before
* @param {string} [assignment_date_before] No more than 3 months between assignment_date_after and assignment_date_before
* @param {Array<string>} [function__in] Filter by function
* @param {string} [sort_by] Sort output by
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFunctionStats: async (aggr_interval: string, assignment_date_after?: string, assignment_date_before?: string, function__in?: Array<string>, sort_by?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'aggr_interval' is not null or undefined
if (aggr_interval === null || aggr_interval === undefined) {
throw new RequiredError('aggr_interval','Required parameter aggr_interval was null or undefined when calling getFunctionStats.');
}
const localVarPath = `/cloud/functions/stats/`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
if (aggr_interval !== undefined) {
localVarQueryParameter['aggr_interval'] = aggr_interval;
}
if (assignment_date_after !== undefined) {
localVarQueryParameter['assignment_date_after'] = (assignment_date_after as any instanceof Date) ?
(assignment_date_after as any).toISOString().substr(0,10) :
assignment_date_after;
}
if (assignment_date_before !== undefined) {
localVarQueryParameter['assignment_date_before'] = (assignment_date_before as any instanceof Date) ?
(assignment_date_before as any).toISOString().substr(0,10) :
assignment_date_before;
}
if (function__in) {
localVarQueryParameter['function__in'] = function__in;
}
if (sort_by !== undefined) {
localVarQueryParameter['sort_by'] = sort_by;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Task Info
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTask: async (taskID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'taskID' is not null or undefined
if (taskID === null || taskID === undefined) {
throw new RequiredError('taskID','Required parameter taskID was null or undefined when calling getTask.');
}
const localVarPath = `/cloud/tasks/{taskID}/`
.replace(`{${"taskID"}}`, encodeURIComponent(String(taskID)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Std data
* @param {string} task_id
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTaskStdDataCache: async (task_id: string, per_page?: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'task_id' is not null or undefined
if (task_id === null || task_id === undefined) {
throw new RequiredError('task_id','Required parameter task_id was null or undefined when calling getTaskStdDataCache.');
}
const localVarPath = `/cloud/functions/stream_data_cache/{task_id}/`
.replace(`{${"task_id"}}`, encodeURIComponent(String(task_id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
if (per_page !== undefined) {
localVarQueryParameter['per_page'] = per_page;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
* Retrieve cloud functions list
* @summary Functions List
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listFunctions: async (per_page?: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/cloud/functions/`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
if (per_page !== undefined) {
localVarQueryParameter['per_page'] = per_page;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
* Retrieve cloud tasks list
* @summary Tasks List
* @param {number} [per_page]
* @param {number} [page]
* @param {Array<string>} [function__in] Filter by function
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
tasksFunctions: async (per_page?: number, page?: number, function__in?: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/cloud/tasks/`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
if (per_page !== undefined) {
localVarQueryParameter['per_page'] = per_page;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (function__in) {
localVarQueryParameter['function__in'] = function__in;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Update function properties
* @param {ModelFunction} body
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateFunction: async (body: ModelFunction, functionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new RequiredError('body','Required parameter body was null or undefined when calling updateFunction.');
}
// verify required parameter 'functionID' is not null or undefined
if (functionID === null || functionID === undefined) {
throw new RequiredError('functionID','Required parameter functionID was null or undefined when calling updateFunction.');
}
const localVarPath = `/cloud/functions/{functionID}/`
.replace(`{${"functionID"}}`, encodeURIComponent(String(functionID)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Update task properties
* @param {Task} body
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateTask: async (body: Task, taskID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new RequiredError('body','Required parameter body was null or undefined when calling updateTask.');
}
// verify required parameter 'taskID' is not null or undefined
if (taskID === null || taskID === undefined) {
throw new RequiredError('taskID','Required parameter taskID was null or undefined when calling updateTask.');
}
const localVarPath = `/cloud/tasks/{taskID}/`
.replace(`{${"taskID"}}`, encodeURIComponent(String(taskID)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication bearerAuth required
// http bearer authentication required
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.params) {
query.set(key, options.params[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
}
};
/**
* CloudApi - functional programming interface
* @export
*/
export const CloudApiFp = function(configuration?: Configuration) {
return {
/**
*
* @summary Create function
* @param {ModelFunction} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createFunction(body: ModelFunction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ModelFunction>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).createFunction(body, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Delete Function
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteFunction(functionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).deleteFunction(functionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Delete Task
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteTask(taskID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).deleteTask(taskID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Function Info
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getFunction(functionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ModelFunction>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).getFunction(functionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
* Functions stats for each function
* @summary Function Stats
* @param {string} aggr_interval No more than 3 days for hour aggregation type
* @param {string} [assignment_date_after] No more than 3 months between assignment_date_after and assignment_date_before
* @param {string} [assignment_date_before] No more than 3 months between assignment_date_after and assignment_date_before
* @param {Array<string>} [function__in] Filter by function
* @param {string} [sort_by] Sort output by
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getFunctionStats(aggr_interval: string, assignment_date_after?: string, assignment_date_before?: string, function__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AggregatedFunctionStats>>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).getFunctionStats(aggr_interval, assignment_date_after, assignment_date_before, function__in, sort_by, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Task Info
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getTask(taskID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Task>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).getTask(taskID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Std data
* @param {string} task_id
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getTaskStdDataCache(task_id: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<string>>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).getTaskStdDataCache(task_id, per_page, page, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
* Retrieve cloud functions list
* @summary Functions List
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listFunctions(per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<ModelFunction>>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).listFunctions(per_page, page, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
* Retrieve cloud tasks list
* @summary Tasks List
* @param {number} [per_page]
* @param {number} [page]
* @param {Array<string>} [function__in] Filter by function
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async tasksFunctions(per_page?: number, page?: number, function__in?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Task>>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).tasksFunctions(per_page, page, function__in, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Update function properties
* @param {ModelFunction} body
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async updateFunction(body: ModelFunction, functionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ModelFunction>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).updateFunction(body, functionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Update task properties
* @param {Task} body
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async updateTask(body: Task, taskID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Task>>> {
const localVarAxiosArgs = await CloudApiAxiosParamCreator(configuration).updateTask(body, taskID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
}
};
/**
* CloudApi - factory interface
* @export
*/
export const CloudApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
return {
/**
*
* @summary Create function
* @param {ModelFunction} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createFunction(body: ModelFunction, options?: AxiosRequestConfig): Promise<AxiosResponse<ModelFunction>> {
return CloudApiFp(configuration).createFunction(body, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Delete Function
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteFunction(functionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
return CloudApiFp(configuration).deleteFunction(functionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Delete Task
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteTask(taskID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
return CloudApiFp(configuration).deleteTask(taskID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Function Info
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getFunction(functionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ModelFunction>> {
return CloudApiFp(configuration).getFunction(functionID, options).then((request) => request(axios, basePath));
},
/**
* Functions stats for each function
* @summary Function Stats
* @param {string} aggr_interval No more than 3 days for hour aggregation type
* @param {string} [assignment_date_after] No more than 3 months between assignment_date_after and assignment_date_before
* @param {string} [assignment_date_before] No more than 3 months between assignment_date_after and assignment_date_before
* @param {Array<string>} [function__in] Filter by function
* @param {string} [sort_by] Sort output by
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getFunctionStats(aggr_interval: string, assignment_date_after?: string, assignment_date_before?: string, function__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedFunctionStats>>> {
return CloudApiFp(configuration).getFunctionStats(aggr_interval, assignment_date_after, assignment_date_before, function__in, sort_by, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Task Info
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getTask(taskID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Task>> {
return CloudApiFp(configuration).getTask(taskID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Std data
* @param {string} task_id
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getTaskStdDataCache(task_id: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<string>>> {
return CloudApiFp(configuration).getTaskStdDataCache(task_id, per_page, page, options).then((request) => request(axios, basePath));
},
/**
* Retrieve cloud functions list
* @summary Functions List
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listFunctions(per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<ModelFunction>>> {
return CloudApiFp(configuration).listFunctions(per_page, page, options).then((request) => request(axios, basePath));
},
/**
* Retrieve cloud tasks list
* @summary Tasks List
* @param {number} [per_page]
* @param {number} [page]
* @param {Array<string>} [function__in] Filter by function
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async tasksFunctions(per_page?: number, page?: number, function__in?: Array<string>, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Task>>> {
return CloudApiFp(configuration).tasksFunctions(per_page, page, function__in, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Update function properties
* @param {ModelFunction} body
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async updateFunction(body: ModelFunction, functionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ModelFunction>> {
return CloudApiFp(configuration).updateFunction(body, functionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Update task properties
* @param {Task} body
* @param {string} taskID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async updateTask(body: Task, taskID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Task>> {
return CloudApiFp(configuration).updateTask(body, taskID, options).then((request) => request(axios, basePath));
},
};
};
/**
* CloudApi - object-oriented interface
* @export
* @class CloudApi
* @extends {BaseAPI}
*/
export class CloudApi extends BaseAPI {
/**
*
* @summary Create function
* @param {ModelFunction} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CloudApi
*/
public async createFunction(body: ModelFunction, options?: AxiosRequestConfig) : Promise<AxiosResponse<ModelFunction>> {
return CloudApiFp(this.configuration).createFunction(body, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Delete Function
* @param {string} functionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CloudApi
*/
public async deleteFunction(functionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
return CloudA