@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
175 lines (174 loc) • 6.57 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 { NotificationAllList } from '../models';
import { NotificationUnreadCount } from '../models';
/**
* NotificationsApi - axios parameter creator
* @export
*/
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get unread notifications count
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getNotificationsUnreadCount: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get notifications list
* @param {number} [limit]
* @param {number} [offset]
* @param {string} [type]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listNotifications: (limit?: number, offset?: number, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Mark notification as read by user
* @param {number} slug
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNotificationMarkRead: (slug: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Mark all notifications as read by user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNotificationMarkReadAll: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* NotificationsApi - functional programming interface
* @export
*/
export declare const NotificationsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get unread notifications count
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<NotificationUnreadCount>>>;
/**
*
* @summary Get notifications list
* @param {number} [limit]
* @param {number} [offset]
* @param {string} [type]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listNotifications(limit?: number, offset?: number, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<NotificationAllList>>>;
/**
*
* @summary Mark notification as read by user
* @param {number} slug
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNotificationMarkRead(slug: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
/**
*
* @summary Mark all notifications as read by user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
};
/**
* NotificationsApi - factory interface
* @export
*/
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get unread notifications count
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationUnreadCount>>;
/**
*
* @summary Get notifications list
* @param {number} [limit]
* @param {number} [offset]
* @param {string} [type]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listNotifications(limit?: number, offset?: number, type?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationAllList>>;
/**
*
* @summary Mark notification as read by user
* @param {number} slug
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNotificationMarkRead(slug: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
/**
*
* @summary Mark all notifications as read by user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
};
/**
* NotificationsApi - object-oriented interface
* @export
* @class NotificationsApi
* @extends {BaseAPI}
*/
export declare class NotificationsApi extends BaseAPI {
/**
*
* @summary Get unread notifications count
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationUnreadCount>>;
/**
*
* @summary Get notifications list
* @param {number} [limit]
* @param {number} [offset]
* @param {string} [type]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
listNotifications(limit?: number, offset?: number, type?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationAllList>>;
/**
*
* @summary Mark notification as read by user
* @param {number} slug
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
updateNotificationMarkRead(slug: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
/**
*
* @summary Mark all notifications as read by user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
}