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

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

/**
 * ForestVPN API
 * ForestVPN defeats content restrictions and censorship to deliver unlimited access to video, music, social media, and more, from anywhere in the world.
 *
 * 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 { Notification } from '../models';
import { NotificationDetail } from '../models';
import { NotificationUnreadCount } from '../models';
/**
 * NewsApi - axios parameter creator
 * @export
 */
export declare const NewsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get notification content
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNotification: (notificationID: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get unread notifications count
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNotificationsUnreadCount: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get notifications list
     * @param {boolean} [is_published]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listNotifications: (is_published?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Mark notification as read by user
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNotificationMarkRead: (notificationID: 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>;
};
/**
 * NewsApi - functional programming interface
 * @export
 */
export declare const NewsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get notification content
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<NotificationDetail>>>;
    /**
     *
     * @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 {boolean} [is_published]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Notification>>>>;
    /**
     *
     * @summary Mark notification as read by user
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNotificationMarkRead(notificationID: 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>>>;
};
/**
 * NewsApi - factory interface
 * @export
 */
export declare const NewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get notification content
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationDetail>>;
    /**
     *
     * @summary Get unread notifications count
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationUnreadCount>>;
    /**
     *
     * @summary Get notifications list
     * @param {boolean} [is_published]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>;
    /**
     *
     * @summary Mark notification as read by user
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateNotificationMarkRead(notificationID: 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>>;
};
/**
 * NewsApi - object-oriented interface
 * @export
 * @class NewsApi
 * @extends {BaseAPI}
 */
export declare class NewsApi extends BaseAPI {
    /**
     *
     * @summary Get notification content
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NewsApi
     */
    getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationDetail>>;
    /**
     *
     * @summary Get unread notifications count
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NewsApi
     */
    getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationUnreadCount>>;
    /**
     *
     * @summary Get notifications list
     * @param {boolean} [is_published]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NewsApi
     */
    listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>;
    /**
     *
     * @summary Mark notification as read by user
     * @param {number} notificationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NewsApi
     */
    updateNotificationMarkRead(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Mark all notifications as read by user
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NewsApi
     */
    updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
}