UNPKG

@forestvpn/forestvpn_api

Version:

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

100 lines (99 loc) 3.27 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 { User } from '../models'; /** * UserApi - axios parameter creator * @export */ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Delete my account permanently * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMyAccount: (options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get my account details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyAccount: (options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * UserApi - functional programming interface * @export */ export declare const UserApiFp: (configuration?: Configuration) => { /** * * @summary Delete my account permanently * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMyAccount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * * @summary Get my account details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyAccount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<User>>>; }; /** * UserApi - factory interface * @export */ export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Delete my account permanently * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMyAccount(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * * @summary Get my account details * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyAccount(options?: AxiosRequestConfig): Promise<AxiosResponse<User>>; }; /** * UserApi - object-oriented interface * @export * @class UserApi * @extends {BaseAPI} */ export declare class UserApi extends BaseAPI { /** * * @summary Delete my account permanently * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ deleteMyAccount(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * * @summary Get my account details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getMyAccount(options?: AxiosRequestConfig): Promise<AxiosResponse<User>>; }