@forestvpn/forestvpn_api/apis/fcm-api.ts

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

/* tslint:disable */
/* eslint-disable */
/**
 * 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 globalAxios, { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
// Some imports not used depending on template conditions
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
import { CreateFCMDeviceRequest } from '../models';
import { FCMDevice } from '../models';
import { UpdateFCMDeviceRequest } from '../models';
/**
 * FcmApi - axios parameter creator
 * @export
 */
export const FcmApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * 
         * @summary Device registration for push notification through out Firebase Cloud Messaging
         * @param {CreateFCMDeviceRequest} body 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        createFCMDevice: async (body: CreateFCMDeviceRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'body' is not null or undefined
            if (body === null || body === undefined) {
                throw new RequiredError('body','Required parameter body was null or undefined when calling createFCMDevice.');
            }
            const localVarPath = `/notification/fcm/`;
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, 'https://example.com');
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }
            const localVarRequestOptions :AxiosRequestConfig = { method: 'POST', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication bearerAuth required
            // http bearer authentication required
            if (configuration && configuration.accessToken) {
                const accessToken = typeof configuration.accessToken === 'function'
                    ? await configuration.accessToken()
                    : await configuration.accessToken;
                localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
            }

            localVarHeaderParameter['Content-Type'] = 'application/json';

            const query = new URLSearchParams(localVarUrlObj.search);
            for (const key in localVarQueryParameter) {
                query.set(key, localVarQueryParameter[key]);
            }
            for (const key in options.params) {
                query.set(key, options.params[key]);
            }
            localVarUrlObj.search = (new URLSearchParams(query)).toString();
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
            const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
            localVarRequestOptions.data =  needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");

            return {
                url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
                options: localVarRequestOptions,
            };
        },
        /**
         * 
         * @summary Delete fcm device
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        deleteFCMDevice: async (registrationID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'registrationID' is not null or undefined
            if (registrationID === null || registrationID === undefined) {
                throw new RequiredError('registrationID','Required parameter registrationID was null or undefined when calling deleteFCMDevice.');
            }
            const localVarPath = `/notification/fcm/{registrationID}/`
                .replace(`{${"registrationID"}}`, encodeURIComponent(String(registrationID)));
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, 'https://example.com');
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }
            const localVarRequestOptions :AxiosRequestConfig = { method: 'DELETE', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication bearerAuth required
            // http bearer authentication required
            if (configuration && configuration.accessToken) {
                const accessToken = typeof configuration.accessToken === 'function'
                    ? await configuration.accessToken()
                    : await configuration.accessToken;
                localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
            }

            const query = new URLSearchParams(localVarUrlObj.search);
            for (const key in localVarQueryParameter) {
                query.set(key, localVarQueryParameter[key]);
            }
            for (const key in options.params) {
                query.set(key, options.params[key]);
            }
            localVarUrlObj.search = (new URLSearchParams(query)).toString();
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
                options: localVarRequestOptions,
            };
        },
        /**
         * 
         * @summary Device info
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getFCMDevice: async (registrationID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'registrationID' is not null or undefined
            if (registrationID === null || registrationID === undefined) {
                throw new RequiredError('registrationID','Required parameter registrationID was null or undefined when calling getFCMDevice.');
            }
            const localVarPath = `/notification/fcm/{registrationID}/`
                .replace(`{${"registrationID"}}`, encodeURIComponent(String(registrationID)));
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, 'https://example.com');
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }
            const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication bearerAuth required
            // http bearer authentication required
            if (configuration && configuration.accessToken) {
                const accessToken = typeof configuration.accessToken === 'function'
                    ? await configuration.accessToken()
                    : await configuration.accessToken;
                localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
            }

            const query = new URLSearchParams(localVarUrlObj.search);
            for (const key in localVarQueryParameter) {
                query.set(key, localVarQueryParameter[key]);
            }
            for (const key in options.params) {
                query.set(key, options.params[key]);
            }
            localVarUrlObj.search = (new URLSearchParams(query)).toString();
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
                options: localVarRequestOptions,
            };
        },
        /**
         * 
         * @summary Update device fcm properties
         * @param {UpdateFCMDeviceRequest} body 
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        updateFCMDevice: async (body: UpdateFCMDeviceRequest, registrationID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'body' is not null or undefined
            if (body === null || body === undefined) {
                throw new RequiredError('body','Required parameter body was null or undefined when calling updateFCMDevice.');
            }
            // verify required parameter 'registrationID' is not null or undefined
            if (registrationID === null || registrationID === undefined) {
                throw new RequiredError('registrationID','Required parameter registrationID was null or undefined when calling updateFCMDevice.');
            }
            const localVarPath = `/notification/fcm/{registrationID}/`
                .replace(`{${"registrationID"}}`, encodeURIComponent(String(registrationID)));
            // use dummy base URL string because the URL constructor only accepts absolute URLs.
            const localVarUrlObj = new URL(localVarPath, 'https://example.com');
            let baseOptions;
            if (configuration) {
                baseOptions = configuration.baseOptions;
            }
            const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options};
            const localVarHeaderParameter = {} as any;
            const localVarQueryParameter = {} as any;

            // authentication bearerAuth required
            // http bearer authentication required
            if (configuration && configuration.accessToken) {
                const accessToken = typeof configuration.accessToken === 'function'
                    ? await configuration.accessToken()
                    : await configuration.accessToken;
                localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
            }

            localVarHeaderParameter['Content-Type'] = 'application/json';

            const query = new URLSearchParams(localVarUrlObj.search);
            for (const key in localVarQueryParameter) {
                query.set(key, localVarQueryParameter[key]);
            }
            for (const key in options.params) {
                query.set(key, options.params[key]);
            }
            localVarUrlObj.search = (new URLSearchParams(query)).toString();
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
            const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
            localVarRequestOptions.data =  needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");

            return {
                url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
                options: localVarRequestOptions,
            };
        },
    }
};

/**
 * FcmApi - functional programming interface
 * @export
 */
export const FcmApiFp = function(configuration?: Configuration) {
    return {
        /**
         * 
         * @summary Device registration for push notification through out Firebase Cloud Messaging
         * @param {CreateFCMDeviceRequest} body 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async createFCMDevice(body: CreateFCMDeviceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FCMDevice>>> {
            const localVarAxiosArgs = await FcmApiAxiosParamCreator(configuration).createFCMDevice(body, options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
        /**
         * 
         * @summary Delete fcm device
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async deleteFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
            const localVarAxiosArgs = await FcmApiAxiosParamCreator(configuration).deleteFCMDevice(registrationID, options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
        /**
         * 
         * @summary Device info
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FCMDevice>>> {
            const localVarAxiosArgs = await FcmApiAxiosParamCreator(configuration).getFCMDevice(registrationID, options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
        /**
         * 
         * @summary Update device fcm properties
         * @param {UpdateFCMDeviceRequest} body 
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async updateFCMDevice(body: UpdateFCMDeviceRequest, registrationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FCMDevice>>> {
            const localVarAxiosArgs = await FcmApiAxiosParamCreator(configuration).updateFCMDevice(body, registrationID, options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
    }
};

/**
 * FcmApi - factory interface
 * @export
 */
export const FcmApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    return {
        /**
         * 
         * @summary Device registration for push notification through out Firebase Cloud Messaging
         * @param {CreateFCMDeviceRequest} body 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async createFCMDevice(body: CreateFCMDeviceRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>> {
            return FcmApiFp(configuration).createFCMDevice(body, options).then((request) => request(axios, basePath));
        },
        /**
         * 
         * @summary Delete fcm device
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async deleteFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
            return FcmApiFp(configuration).deleteFCMDevice(registrationID, options).then((request) => request(axios, basePath));
        },
        /**
         * 
         * @summary Device info
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getFCMDevice(registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>> {
            return FcmApiFp(configuration).getFCMDevice(registrationID, options).then((request) => request(axios, basePath));
        },
        /**
         * 
         * @summary Update device fcm properties
         * @param {UpdateFCMDeviceRequest} body 
         * @param {string} registrationID 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async updateFCMDevice(body: UpdateFCMDeviceRequest, registrationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FCMDevice>> {
            return FcmApiFp(configuration).updateFCMDevice(body, registrationID, options).then((request) => request(axios, basePath));
        },
    };
};

/**
 * FcmApi - object-oriented interface
 * @export
 * @class FcmApi
 * @extends {BaseAPI}
 */
export 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
     */
    public async createFCMDevice(body: CreateFCMDeviceRequest, options?: AxiosRequestConfig) : Promise<AxiosResponse<FCMDevice>> {
        return FcmApiFp(this.configuration).createFCMDevice(body, options).then((request) => request(this.axios, this.basePath));
    }
    /**
     * 
     * @summary Delete fcm device
     * @param {string} registrationID 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FcmApi
     */
    public async deleteFCMDevice(registrationID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
        return FcmApiFp(this.configuration).deleteFCMDevice(registrationID, options).then((request) => request(this.axios, this.basePath));
    }
    /**
     * 
     * @summary Device info
     * @param {string} registrationID 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FcmApi
     */
    public async getFCMDevice(registrationID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<FCMDevice>> {
        return FcmApiFp(this.configuration).getFCMDevice(registrationID, options).then((request) => request(this.axios, this.basePath));
    }
    /**
     * 
     * @summary Update device fcm properties
     * @param {UpdateFCMDeviceRequest} body 
     * @param {string} registrationID 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FcmApi
     */
    public async updateFCMDevice(body: UpdateFCMDeviceRequest, registrationID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<FCMDevice>> {
        return FcmApiFp(this.configuration).updateFCMDevice(body, registrationID, options).then((request) => request(this.axios, this.basePath));
    }
}