@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
476 lines (454 loc) • 22.5 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 { Friendship } from '../models';
import { FriendshipInvitation } from '../models';
import { FriendshipInvitationList } from '../models';
/**
* FriendshipApi - axios parameter creator
* @export
*/
export const FriendshipApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Delete friend
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteFriend: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
if (id === null || id === undefined) {
throw new RequiredError('id','Required parameter id was null or undefined when calling deleteFriend.');
}
const localVarPath = `/friendship/friends/{id}/`
.replace(`{${"id"}}`, encodeURIComponent(String(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: '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 Friend details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFriend: async (id: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
if (id === null || id === undefined) {
throw new RequiredError('id','Required parameter id was null or undefined when calling getFriend.');
}
const localVarPath = `/friendship/friends/{id}/`
.replace(`{${"id"}}`, encodeURIComponent(String(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;
}
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 Ivitation detail
* @param {string} invitationID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInvitation: async (invitationID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'invitationID' is not null or undefined
if (invitationID === null || invitationID === undefined) {
throw new RequiredError('invitationID','Required parameter invitationID was null or undefined when calling getInvitation.');
}
const localVarPath = `/friendship/invitations/{invitationID}/`
.replace(`{${"invitationID"}}`, encodeURIComponent(String(invitationID)));
// 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 Get friends list
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listFriends: async (per_page?: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/friendship/friends/`;
// 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,
};
},
/**
*
* @summary Friendship invitations list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listFriendshipInvitation: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/friendship/invitations/`;
// 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,
};
},
}
};
/**
* FriendshipApi - functional programming interface
* @export
*/
export const FriendshipApiFp = function(configuration?: Configuration) {
return {
/**
*
* @summary Delete friend
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteFriend(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
const localVarAxiosArgs = await FriendshipApiAxiosParamCreator(configuration).deleteFriend(id, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Friend details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getFriend(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Friendship>>> {
const localVarAxiosArgs = await FriendshipApiAxiosParamCreator(configuration).getFriend(id, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Ivitation detail
* @param {string} invitationID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getInvitation(invitationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FriendshipInvitation>>> {
const localVarAxiosArgs = await FriendshipApiAxiosParamCreator(configuration).getInvitation(invitationID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Get friends list
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listFriends(per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Friendship>>>> {
const localVarAxiosArgs = await FriendshipApiAxiosParamCreator(configuration).listFriends(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);
};
},
/**
*
* @summary Friendship invitations list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listFriendshipInvitation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FriendshipInvitationList>>> {
const localVarAxiosArgs = await FriendshipApiAxiosParamCreator(configuration).listFriendshipInvitation(options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
}
};
/**
* FriendshipApi - factory interface
* @export
*/
export const FriendshipApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
return {
/**
*
* @summary Delete friend
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteFriend(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
return FriendshipApiFp(configuration).deleteFriend(id, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Friend details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getFriend(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Friendship>> {
return FriendshipApiFp(configuration).getFriend(id, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Ivitation detail
* @param {string} invitationID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getInvitation(invitationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FriendshipInvitation>> {
return FriendshipApiFp(configuration).getInvitation(invitationID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get friends list
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listFriends(per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Friendship>>> {
return FriendshipApiFp(configuration).listFriends(per_page, page, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Friendship invitations list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listFriendshipInvitation(options?: AxiosRequestConfig): Promise<AxiosResponse<FriendshipInvitationList>> {
return FriendshipApiFp(configuration).listFriendshipInvitation(options).then((request) => request(axios, basePath));
},
};
};
/**
* FriendshipApi - object-oriented interface
* @export
* @class FriendshipApi
* @extends {BaseAPI}
*/
export class FriendshipApi extends BaseAPI {
/**
*
* @summary Delete friend
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FriendshipApi
*/
public async deleteFriend(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
return FriendshipApiFp(this.configuration).deleteFriend(id, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Friend details
* @param {string} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FriendshipApi
*/
public async getFriend(id: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<Friendship>> {
return FriendshipApiFp(this.configuration).getFriend(id, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Ivitation detail
* @param {string} invitationID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FriendshipApi
*/
public async getInvitation(invitationID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<FriendshipInvitation>> {
return FriendshipApiFp(this.configuration).getInvitation(invitationID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get friends list
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FriendshipApi
*/
public async listFriends(per_page?: number, page?: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<Friendship>>> {
return FriendshipApiFp(this.configuration).listFriends(per_page, page, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Friendship invitations list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FriendshipApi
*/
public async listFriendshipInvitation(options?: AxiosRequestConfig) : Promise<AxiosResponse<FriendshipInvitationList>> {
return FriendshipApiFp(this.configuration).listFriendshipInvitation(options).then((request) => request(this.axios, this.basePath));
}
}