@forestvpn/forestvpn_api/dist/apis/auth-api.d.ts

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

/**
 * 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 { AccessTokenRequest } from '../models';
import { CreateTokenLogin } from '../models';
import { LegacyAuthMigrationToken } from '../models';
import { TokenLogin } from '../models';
import { TokenObtain } from '../models';
import { User } from '../models';
import { UserPhoto } from '../models';
/**
 * AuthApi - axios parameter creator
 * @export
 */
export declare const AuthApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Authorize access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorizeAccessTokenRequest: (requestID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create access token request
     * @param {string} [name]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAccessTokenRequest: (name?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get access token request details
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAccessTokenRequest: (requestID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Login with JWT token
     * @param {CreateTokenLogin} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    loginToken: (body?: CreateTokenLogin, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Legacy auth migration
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    migrateLegacyAuth: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Obtain JWT token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    obtainToken: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Revoke access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    revokeAccessTokenRequest: (requestID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update profile photo
     * @param {UserPhoto} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUserPhoto: (body?: UserPhoto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update profile
     * @param {User} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUserProfile: (body?: User, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Photo
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userPhoto: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Profile
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userProfile: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Who am I
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    whoAmI: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AuthApi - functional programming interface
 * @export
 */
export declare const AuthApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Authorize access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorizeAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccessTokenRequest>>>;
    /**
     *
     * @summary Create access token request
     * @param {string} [name]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAccessTokenRequest(name?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccessTokenRequest>>>;
    /**
     *
     * @summary Get access token request details
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccessTokenRequest>>>;
    /**
     *
     * @summary Login with JWT token
     * @param {CreateTokenLogin} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    loginToken(body?: CreateTokenLogin, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TokenLogin>>>;
    /**
     *
     * @summary Legacy auth migration
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    migrateLegacyAuth(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<LegacyAuthMigrationToken>>>;
    /**
     *
     * @summary Obtain JWT token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    obtainToken(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TokenObtain>>>;
    /**
     *
     * @summary Revoke access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    revokeAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AccessTokenRequest>>>;
    /**
     *
     * @summary Update profile photo
     * @param {UserPhoto} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUserPhoto(body?: UserPhoto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserPhoto>>>;
    /**
     *
     * @summary Update profile
     * @param {User} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUserProfile(body?: User, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<User>>>;
    /**
     *
     * @summary Photo
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userPhoto(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserPhoto>>>;
    /**
     *
     * @summary Profile
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userProfile(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<User>>>;
    /**
     *
     * @summary Who am I
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    whoAmI(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<User>>>;
};
/**
 * AuthApi - factory interface
 * @export
 */
export declare const AuthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Authorize access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorizeAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Create access token request
     * @param {string} [name]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAccessTokenRequest(name?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Get access token request details
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Login with JWT token
     * @param {CreateTokenLogin} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    loginToken(body?: CreateTokenLogin, options?: AxiosRequestConfig): Promise<AxiosResponse<TokenLogin>>;
    /**
     *
     * @summary Legacy auth migration
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    migrateLegacyAuth(options?: AxiosRequestConfig): Promise<AxiosResponse<LegacyAuthMigrationToken>>;
    /**
     *
     * @summary Obtain JWT token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    obtainToken(options?: AxiosRequestConfig): Promise<AxiosResponse<TokenObtain>>;
    /**
     *
     * @summary Revoke access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    revokeAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Update profile photo
     * @param {UserPhoto} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUserPhoto(body?: UserPhoto, options?: AxiosRequestConfig): Promise<AxiosResponse<UserPhoto>>;
    /**
     *
     * @summary Update profile
     * @param {User} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateUserProfile(body?: User, options?: AxiosRequestConfig): Promise<AxiosResponse<User>>;
    /**
     *
     * @summary Photo
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userPhoto(options?: AxiosRequestConfig): Promise<AxiosResponse<UserPhoto>>;
    /**
     *
     * @summary Profile
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    userProfile(options?: AxiosRequestConfig): Promise<AxiosResponse<User>>;
    /**
     *
     * @summary Who am I
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    whoAmI(options?: AxiosRequestConfig): Promise<AxiosResponse<User>>;
};
/**
 * AuthApi - object-oriented interface
 * @export
 * @class AuthApi
 * @extends {BaseAPI}
 */
export declare class AuthApi extends BaseAPI {
    /**
     *
     * @summary Authorize access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    authorizeAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Create access token request
     * @param {string} [name]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    createAccessTokenRequest(name?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Get access token request details
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    getAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Login with JWT token
     * @param {CreateTokenLogin} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    loginToken(body?: CreateTokenLogin, options?: AxiosRequestConfig): Promise<AxiosResponse<TokenLogin>>;
    /**
     *
     * @summary Legacy auth migration
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    migrateLegacyAuth(options?: AxiosRequestConfig): Promise<AxiosResponse<LegacyAuthMigrationToken>>;
    /**
     *
     * @summary Obtain JWT token
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    obtainToken(options?: AxiosRequestConfig): Promise<AxiosResponse<TokenObtain>>;
    /**
     *
     * @summary Revoke access token request
     * @param {string} requestID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    revokeAccessTokenRequest(requestID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AccessTokenRequest>>;
    /**
     *
     * @summary Update profile photo
     * @param {UserPhoto} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    updateUserPhoto(body?: UserPhoto, options?: AxiosRequestConfig): Promise<AxiosResponse<UserPhoto>>;
    /**
     *
     * @summary Update profile
     * @param {User} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    updateUserProfile(body?: User, options?: AxiosRequestConfig): Promise<AxiosResponse<User>>;
    /**
     *
     * @summary Photo
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    userPhoto(options?: AxiosRequestConfig): Promise<AxiosResponse<UserPhoto>>;
    /**
     *
     * @summary Profile
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    userProfile(options?: AxiosRequestConfig): Promise<AxiosResponse<User>>;
    /**
     *
     * @summary Who am I
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthApi
     */
    whoAmI(options?: AxiosRequestConfig): Promise<AxiosResponse<User>>;
}