@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
104 lines (103 loc) • 3.61 kB
TypeScript
/**
* 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 { WireGuardPeerInfo } from '../models';
/**
* WireguardApi - axios parameter creator
* @export
*/
export declare const WireguardApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Wireguard peer info
* @param {string} pubKey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWireGuardPeerInfo: (pubKey: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Wireguard peers list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWireGuardPeers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* WireguardApi - functional programming interface
* @export
*/
export declare const WireguardApiFp: (configuration?: Configuration) => {
/**
*
* @summary Wireguard peer info
* @param {string} pubKey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWireGuardPeerInfo(pubKey: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<WireGuardPeerInfo>>>;
/**
*
* @summary Wireguard peers list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWireGuardPeers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<WireGuardPeerInfo>>>>;
};
/**
* WireguardApi - factory interface
* @export
*/
export declare const WireguardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Wireguard peer info
* @param {string} pubKey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWireGuardPeerInfo(pubKey: string, options?: AxiosRequestConfig): Promise<AxiosResponse<WireGuardPeerInfo>>;
/**
*
* @summary Wireguard peers list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWireGuardPeers(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<WireGuardPeerInfo>>>;
};
/**
* WireguardApi - object-oriented interface
* @export
* @class WireguardApi
* @extends {BaseAPI}
*/
export declare class WireguardApi extends BaseAPI {
/**
*
* @summary Wireguard peer info
* @param {string} pubKey
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WireguardApi
*/
getWireGuardPeerInfo(pubKey: string, options?: AxiosRequestConfig): Promise<AxiosResponse<WireGuardPeerInfo>>;
/**
*
* @summary Wireguard peers list
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WireguardApi
*/
listWireGuardPeers(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<WireGuardPeerInfo>>>;
}