UNPKG

@forestvpn/forestvpn_api

Version:

A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)

135 lines (134 loc) 4.61 kB
/** * 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 { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { Country } from '../models'; import { Currency } from '../models'; import { Location } from '../models'; /** * GeoApi - axios parameter creator * @export */ export declare const GeoApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Countries list * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCountries: (options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Correncies list * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Location list * @param {string} [X_Device_Coordinates] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLocations: (X_Device_Coordinates?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * GeoApi - functional programming interface * @export */ export declare const GeoApiFp: (configuration?: Configuration) => { /** * * @summary Countries list * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCountries(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Country>>>>; /** * * @summary Correncies list * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Currency>>>>; /** * * @summary Location list * @param {string} [X_Device_Coordinates] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLocations(X_Device_Coordinates?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Location>>>>; }; /** * GeoApi - factory interface * @export */ export declare const GeoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Countries list * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCountries(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Country>>>; /** * * @summary Correncies list * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCurrencies(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Currency>>>; /** * * @summary Location list * @param {string} [X_Device_Coordinates] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLocations(X_Device_Coordinates?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Location>>>; }; /** * GeoApi - object-oriented interface * @export * @class GeoApi * @extends {BaseAPI} */ export declare class GeoApi extends BaseAPI { /** * * @summary Countries list * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GeoApi */ listCountries(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Country>>>; /** * * @summary Correncies list * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GeoApi */ listCurrencies(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Currency>>>; /** * * @summary Location list * @param {string} [X_Device_Coordinates] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GeoApi */ listLocations(X_Device_Coordinates?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Location>>>; }