@forestvpn/forestvpn_api/dist/apis/fcm-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 { CreateFCMDeviceRequest } from '../models';
import { FCMDevice } from '../models';
import { UpdateFCMDeviceRequest } from '../models';
/**
 * FcmApi - axios parameter creator
 * @export
 */
export declare const FcmApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Device registration for push notification through out Firebase Cloud Messaging
     * @param {CreateFCMDeviceRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createFCMDevice: (body: CreateFCMDeviceRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete fcm device
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteFCMDevice: (registrationID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Device info
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFCMDevice: (registrationID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update device fcm properties
     * @param {UpdateFCMDeviceRequest} body
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateFCMDevice: (body: UpdateFCMDeviceRequest, registrationID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FcmApi - functional programming interface
 * @export
 */
export declare const FcmApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Device registration for push notification through out Firebase Cloud Messaging
     * @param {CreateFCMDeviceRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createFCMDevice(body: CreateFCMDeviceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FCMDevice>>>;
    /**
     *
     * @summary Delete fcm device
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Device info
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FCMDevice>>>;
    /**
     *
     * @summary Update device fcm properties
     * @param {UpdateFCMDeviceRequest} body
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateFCMDevice(body: UpdateFCMDeviceRequest, registrationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FCMDevice>>>;
};
/**
 * FcmApi - factory interface
 * @export
 */
export declare const FcmApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Device registration for push notification through out Firebase Cloud Messaging
     * @param {CreateFCMDeviceRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createFCMDevice(body: CreateFCMDeviceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>>;
    /**
     *
     * @summary Delete fcm device
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Device info
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>>;
    /**
     *
     * @summary Update device fcm properties
     * @param {UpdateFCMDeviceRequest} body
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateFCMDevice(body: UpdateFCMDeviceRequest, registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>>;
};
/**
 * FcmApi - object-oriented interface
 * @export
 * @class FcmApi
 * @extends {BaseAPI}
 */
export declare class FcmApi extends BaseAPI {
    /**
     *
     * @summary Device registration for push notification through out Firebase Cloud Messaging
     * @param {CreateFCMDeviceRequest} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FcmApi
     */
    createFCMDevice(body: CreateFCMDeviceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>>;
    /**
     *
     * @summary Delete fcm device
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FcmApi
     */
    deleteFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Device info
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FcmApi
     */
    getFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>>;
    /**
     *
     * @summary Update device fcm properties
     * @param {UpdateFCMDeviceRequest} body
     * @param {string} registrationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FcmApi
     */
    updateFCMDevice(body: UpdateFCMDeviceRequest, registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>>;
}