@forestvpn/forestvpn_api

/** * 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 { AdvertisedRoute } from '../models'; import { ConnectionMode } from '../models'; import { CreateOrUpdateDeviceRequest } from '../models'; import { CreateOrUpdatePortForwardingRequest } from '../models'; import { Device } from '../models'; import { DeviceBindings } from '../models'; import { DeviceNodeIPs } from '../models'; import { DeviceStats } from '../models'; import { PortForwarding } from '../models'; import { WireGuard } from '../models'; import { WireGuardPeer } from '../models'; /** * DeviceApi - axios parameter creator * @export */ export declare const DeviceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create new device * @summary Create new device * @param {CreateOrUpdateDeviceRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevice: (body?: CreateOrUpdateDeviceRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Create new device avdertised route * @summary Create new device advertised routes * @param {string} deviceID * @param {AdvertisedRoute} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDeviceAvdertisedRoute: (deviceID: string, body?: AdvertisedRoute, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Create new device port forwarding * @summary Create new device port forwarding * @param {string} deviceID * @param {CreateOrUpdatePortForwardingRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevicePortForwarding: (deviceID: string, body?: CreateOrUpdatePortForwardingRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Delete device by id * @summary Delete Device * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevice: (deviceID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Delete device's port forwarding by id * @summary Delete Device's Port Forwarding * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevicePortForwarding: (deviceID: string, portForwardingID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Retrieve device info * @summary Device Info * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDevice: (deviceID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Device Node IPs * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceNodeIPs: (deviceID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Device's stats detail * @param {string} deviceID * @param {string} statsID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceStats: (deviceID: string, statsID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Device's wireguard profile detail * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceWireGuard: (deviceID: string, wireGuardID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Wireguard conf as plain text * @summary Wireguard conf * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWireGuardConf: (deviceID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Retrieve device's advertised routes list * @summary Device advertised routes List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceAdvertisedRoutes: (deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Each device has bindings to specific servers. This methods returns hostnames where this device binded in a particular time. * @summary Device bindings * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceBindings: (deviceID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * This methods returns list of connection modes are availbale for current device. * @summary Device connection modes * @param {string} deviceID * @param {string} [X_Android_Package] * @param {string} [X_Android_SHA1] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceConnectionModes: (deviceID: string, X_Android_Package?: string, X_Android_SHA1?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Device's detail stats list * @param {string} deviceID * @param {string} [date_time_after] * @param {string} [date_time_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceDetailStats: (deviceID: string, date_time_after?: string, date_time_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Retrieve device's port forwarding lis * @summary Device Port Forwarding List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDevicePortForwardings: (deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Device's stats list * @param {string} deviceID * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceStats: (deviceID: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Device's wireguard peers * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceWireGuardPeers: (deviceID: string, wireGuardID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Device's wireguard profiles list * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceWireGuards: (deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Retrieve devices list * @summary Device List * @param {string} [q] Filter by search query * @param {string} [external_key] Filter by external_key * @param {boolean} [recently_active] Filter by recently active * @param {Date} [last_active_at_after] Filter by last active at date-time after provided value * @param {Date} [last_active_at_before] Filter by last active at date-time before provided value * @param {string} [sort] Sort by provided field * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDevices: (q?: string, external_key?: string, recently_active?: boolean, last_active_at_after?: Date, last_active_at_before?: Date, sort?: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Update device properties * @summary Update device properties * @param {CreateOrUpdateDeviceRequest} body * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDevice: (body: CreateOrUpdateDeviceRequest, deviceID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Update device's port forwarding dst_port * @summary Update device's port forwarding * @param {CreateOrUpdatePortForwardingRequest} body * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDevicePortForwarding: (body: CreateOrUpdatePortForwardingRequest, deviceID: string, portForwardingID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * DeviceApi - functional programming interface * @export */ export declare const DeviceApiFp: (configuration?: Configuration) => { /** * Create new device * @summary Create new device * @param {CreateOrUpdateDeviceRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevice(body?: CreateOrUpdateDeviceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Device>>>; /** * Create new device avdertised route * @summary Create new device advertised routes * @param {string} deviceID * @param {AdvertisedRoute} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDeviceAvdertisedRoute(deviceID: string, body?: AdvertisedRoute, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AdvertisedRoute>>>; /** * Create new device port forwarding * @summary Create new device port forwarding * @param {string} deviceID * @param {CreateOrUpdatePortForwardingRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevicePortForwarding(deviceID: string, body?: CreateOrUpdatePortForwardingRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PortForwarding>>>; /** * Delete device by id * @summary Delete Device * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevice(deviceID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * Delete device's port forwarding by id * @summary Delete Device's Port Forwarding * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevicePortForwarding(deviceID: string, portForwardingID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * Retrieve device info * @summary Device Info * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDevice(deviceID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Device>>>; /** * * @summary Device Node IPs * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceNodeIPs(deviceID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<DeviceNodeIPs>>>; /** * * @summary Device's stats detail * @param {string} deviceID * @param {string} statsID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceStats(deviceID: string, statsID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<DeviceStats>>>; /** * * @summary Device's wireguard profile detail * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceWireGuard(deviceID: string, wireGuardID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<WireGuard>>>; /** * Wireguard conf as plain text * @summary Wireguard conf * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWireGuardConf(deviceID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<string>>>; /** * Retrieve device's advertised routes list * @summary Device advertised routes List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceAdvertisedRoutes(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AdvertisedRoute>>>>; /** * Each device has bindings to specific servers. This methods returns hostnames where this device binded in a particular time. * @summary Device bindings * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceBindings(deviceID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<DeviceBindings>>>; /** * This methods returns list of connection modes are availbale for current device. * @summary Device connection modes * @param {string} deviceID * @param {string} [X_Android_Package] * @param {string} [X_Android_SHA1] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceConnectionModes(deviceID: string, X_Android_Package?: string, X_Android_SHA1?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<ConnectionMode>>>>; /** * * @summary Device's detail stats list * @param {string} deviceID * @param {string} [date_time_after] * @param {string} [date_time_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceDetailStats(deviceID: string, date_time_after?: string, date_time_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<DeviceStats>>>>; /** * Retrieve device's port forwarding lis * @summary Device Port Forwarding List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDevicePortForwardings(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<PortForwarding>>>>; /** * * @summary Device's stats list * @param {string} deviceID * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceStats(deviceID: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<DeviceStats>>>>; /** * * @summary Device's wireguard peers * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceWireGuardPeers(deviceID: string, wireGuardID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<WireGuardPeer>>>>; /** * * @summary Device's wireguard profiles list * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceWireGuards(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<WireGuard>>>>; /** * Retrieve devices list * @summary Device List * @param {string} [q] Filter by search query * @param {string} [external_key] Filter by external_key * @param {boolean} [recently_active] Filter by recently active * @param {Date} [last_active_at_after] Filter by last active at date-time after provided value * @param {Date} [last_active_at_before] Filter by last active at date-time before provided value * @param {string} [sort] Sort by provided field * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDevices(q?: string, external_key?: string, recently_active?: boolean, last_active_at_after?: Date, last_active_at_before?: Date, sort?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Device>>>>; /** * Update device properties * @summary Update device properties * @param {CreateOrUpdateDeviceRequest} body * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDevice(body: CreateOrUpdateDeviceRequest, deviceID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Device>>>; /** * Update device's port forwarding dst_port * @summary Update device's port forwarding * @param {CreateOrUpdatePortForwardingRequest} body * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDevicePortForwarding(body: CreateOrUpdatePortForwardingRequest, deviceID: string, portForwardingID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PortForwarding>>>; }; /** * DeviceApi - factory interface * @export */ export declare const DeviceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create new device * @summary Create new device * @param {CreateOrUpdateDeviceRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevice(body?: CreateOrUpdateDeviceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Device>>; /** * Create new device avdertised route * @summary Create new device advertised routes * @param {string} deviceID * @param {AdvertisedRoute} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDeviceAvdertisedRoute(deviceID: string, body?: AdvertisedRoute, options?: AxiosRequestConfig): Promise<AxiosResponse<AdvertisedRoute>>; /** * Create new device port forwarding * @summary Create new device port forwarding * @param {string} deviceID * @param {CreateOrUpdatePortForwardingRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDevicePortForwarding(deviceID: string, body?: CreateOrUpdatePortForwardingRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PortForwarding>>; /** * Delete device by id * @summary Delete Device * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevice(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * Delete device's port forwarding by id * @summary Delete Device's Port Forwarding * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDevicePortForwarding(deviceID: string, portForwardingID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * Retrieve device info * @summary Device Info * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDevice(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Device>>; /** * * @summary Device Node IPs * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceNodeIPs(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DeviceNodeIPs>>; /** * * @summary Device's stats detail * @param {string} deviceID * @param {string} statsID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceStats(deviceID: string, statsID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DeviceStats>>; /** * * @summary Device's wireguard profile detail * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeviceWireGuard(deviceID: string, wireGuardID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<WireGuard>>; /** * Wireguard conf as plain text * @summary Wireguard conf * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWireGuardConf(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>; /** * Retrieve device's advertised routes list * @summary Device advertised routes List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceAdvertisedRoutes(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AdvertisedRoute>>>; /** * Each device has bindings to specific servers. This methods returns hostnames where this device binded in a particular time. * @summary Device bindings * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceBindings(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DeviceBindings>>; /** * This methods returns list of connection modes are availbale for current device. * @summary Device connection modes * @param {string} deviceID * @param {string} [X_Android_Package] * @param {string} [X_Android_SHA1] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceConnectionModes(deviceID: string, X_Android_Package?: string, X_Android_SHA1?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<ConnectionMode>>>; /** * * @summary Device's detail stats list * @param {string} deviceID * @param {string} [date_time_after] * @param {string} [date_time_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceDetailStats(deviceID: string, date_time_after?: string, date_time_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<DeviceStats>>>; /** * Retrieve device's port forwarding lis * @summary Device Port Forwarding List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDevicePortForwardings(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<PortForwarding>>>; /** * * @summary Device's stats list * @param {string} deviceID * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceStats(deviceID: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<DeviceStats>>>; /** * * @summary Device's wireguard peers * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceWireGuardPeers(deviceID: string, wireGuardID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<WireGuardPeer>>>; /** * * @summary Device's wireguard profiles list * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDeviceWireGuards(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<WireGuard>>>; /** * Retrieve devices list * @summary Device List * @param {string} [q] Filter by search query * @param {string} [external_key] Filter by external_key * @param {boolean} [recently_active] Filter by recently active * @param {Date} [last_active_at_after] Filter by last active at date-time after provided value * @param {Date} [last_active_at_before] Filter by last active at date-time before provided value * @param {string} [sort] Sort by provided field * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDevices(q?: string, external_key?: string, recently_active?: boolean, last_active_at_after?: Date, last_active_at_before?: Date, sort?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Device>>>; /** * Update device properties * @summary Update device properties * @param {CreateOrUpdateDeviceRequest} body * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDevice(body: CreateOrUpdateDeviceRequest, deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Device>>; /** * Update device's port forwarding dst_port * @summary Update device's port forwarding * @param {CreateOrUpdatePortForwardingRequest} body * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDevicePortForwarding(body: CreateOrUpdatePortForwardingRequest, deviceID: string, portForwardingID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PortForwarding>>; }; /** * DeviceApi - object-oriented interface * @export * @class DeviceApi * @extends {BaseAPI} */ export declare class DeviceApi extends BaseAPI { /** * Create new device * @summary Create new device * @param {CreateOrUpdateDeviceRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ createDevice(body?: CreateOrUpdateDeviceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Device>>; /** * Create new device avdertised route * @summary Create new device advertised routes * @param {string} deviceID * @param {AdvertisedRoute} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ createDeviceAvdertisedRoute(deviceID: string, body?: AdvertisedRoute, options?: AxiosRequestConfig): Promise<AxiosResponse<AdvertisedRoute>>; /** * Create new device port forwarding * @summary Create new device port forwarding * @param {string} deviceID * @param {CreateOrUpdatePortForwardingRequest} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ createDevicePortForwarding(deviceID: string, body?: CreateOrUpdatePortForwardingRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PortForwarding>>; /** * Delete device by id * @summary Delete Device * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ deleteDevice(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * Delete device's port forwarding by id * @summary Delete Device's Port Forwarding * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ deleteDevicePortForwarding(deviceID: string, portForwardingID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * Retrieve device info * @summary Device Info * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ getDevice(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Device>>; /** * * @summary Device Node IPs * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ getDeviceNodeIPs(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DeviceNodeIPs>>; /** * * @summary Device's stats detail * @param {string} deviceID * @param {string} statsID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ getDeviceStats(deviceID: string, statsID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DeviceStats>>; /** * * @summary Device's wireguard profile detail * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ getDeviceWireGuard(deviceID: string, wireGuardID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<WireGuard>>; /** * Wireguard conf as plain text * @summary Wireguard conf * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ getWireGuardConf(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>; /** * Retrieve device's advertised routes list * @summary Device advertised routes List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDeviceAdvertisedRoutes(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AdvertisedRoute>>>; /** * Each device has bindings to specific servers. This methods returns hostnames where this device binded in a particular time. * @summary Device bindings * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDeviceBindings(deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DeviceBindings>>; /** * This methods returns list of connection modes are availbale for current device. * @summary Device connection modes * @param {string} deviceID * @param {string} [X_Android_Package] * @param {string} [X_Android_SHA1] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDeviceConnectionModes(deviceID: string, X_Android_Package?: string, X_Android_SHA1?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<ConnectionMode>>>; /** * * @summary Device's detail stats list * @param {string} deviceID * @param {string} [date_time_after] * @param {string} [date_time_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDeviceDetailStats(deviceID: string, date_time_after?: string, date_time_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<DeviceStats>>>; /** * Retrieve device's port forwarding lis * @summary Device Port Forwarding List * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDevicePortForwardings(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<PortForwarding>>>; /** * * @summary Device's stats list * @param {string} deviceID * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDeviceStats(deviceID: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<DeviceStats>>>; /** * * @summary Device's wireguard peers * @param {string} deviceID * @param {string} wireGuardID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDeviceWireGuardPeers(deviceID: string, wireGuardID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<WireGuardPeer>>>; /** * * @summary Device's wireguard profiles list * @param {string} deviceID * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDeviceWireGuards(deviceID: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<WireGuard>>>; /** * Retrieve devices list * @summary Device List * @param {string} [q] Filter by search query * @param {string} [external_key] Filter by external_key * @param {boolean} [recently_active] Filter by recently active * @param {Date} [last_active_at_after] Filter by last active at date-time after provided value * @param {Date} [last_active_at_before] Filter by last active at date-time before provided value * @param {string} [sort] Sort by provided field * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ listDevices(q?: string, external_key?: string, recently_active?: boolean, last_active_at_after?: Date, last_active_at_before?: Date, sort?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Device>>>; /** * Update device properties * @summary Update device properties * @param {CreateOrUpdateDeviceRequest} body * @param {string} deviceID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ updateDevice(body: CreateOrUpdateDeviceRequest, deviceID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Device>>; /** * Update device's port forwarding dst_port * @summary Update device's port forwarding * @param {CreateOrUpdatePortForwardingRequest} body * @param {string} deviceID * @param {string} portForwardingID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DeviceApi */ updateDevicePortForwarding(body: CreateOrUpdatePortForwardingRequest, deviceID: string, portForwardingID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PortForwarding>>; }