@forestvpn/forestvpn_api/apis/analytics-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 { AggregatedDataUsageStats } from '../models';
/**
 * AnalyticsApi - axios parameter creator
 * @export
 */
export const AnalyticsApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * Users data usage statistics for each device 
         * @summary Data Usage Stats
         * @param {string} aggr_interval No more than 3 days for hour aggregation type
         * @param {string} [date_after] No more than 3 months between date_after and date_before
         * @param {string} [date_before] No more than 3 months between date_after and date_before
         * @param {Array<string>} [device_type__in] Filter by device type
         * @param {Array<string>} [device__in] Filter by device
         * @param {string} [sort_by] Sort output by
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getDataUsageStats: async (aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'aggr_interval' is not null or undefined
            if (aggr_interval === null || aggr_interval === undefined) {
                throw new RequiredError('aggr_interval','Required parameter aggr_interval was null or undefined when calling getDataUsageStats.');
            }
            const localVarPath = `/analytics/data-usage/`;
            // 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;
            }

            if (aggr_interval !== undefined) {
                localVarQueryParameter['aggr_interval'] = aggr_interval;
            }

            if (date_after !== undefined) {
                localVarQueryParameter['date_after'] = (date_after as any instanceof Date) ?
                    (date_after as any).toISOString().substr(0,10) :
                    date_after;
            }

            if (date_before !== undefined) {
                localVarQueryParameter['date_before'] = (date_before as any instanceof Date) ?
                    (date_before as any).toISOString().substr(0,10) :
                    date_before;
            }

            if (device_type__in) {
                localVarQueryParameter['device_type__in'] = device_type__in;
            }

            if (device__in) {
                localVarQueryParameter['device__in'] = device__in;
            }

            if (sort_by !== undefined) {
                localVarQueryParameter['sort_by'] = sort_by;
            }

            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,
            };
        },
    }
};

/**
 * AnalyticsApi - functional programming interface
 * @export
 */
export const AnalyticsApiFp = function(configuration?: Configuration) {
    return {
        /**
         * Users data usage statistics for each device 
         * @summary Data Usage Stats
         * @param {string} aggr_interval No more than 3 days for hour aggregation type
         * @param {string} [date_after] No more than 3 months between date_after and date_before
         * @param {string} [date_before] No more than 3 months between date_after and date_before
         * @param {Array<string>} [device_type__in] Filter by device type
         * @param {Array<string>} [device__in] Filter by device
         * @param {string} [sort_by] Sort output by
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>> {
            const localVarAxiosArgs = await AnalyticsApiAxiosParamCreator(configuration).getDataUsageStats(aggr_interval, date_after, date_before, device_type__in, device__in, sort_by, options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
    }
};

/**
 * AnalyticsApi - factory interface
 * @export
 */
export const AnalyticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    return {
        /**
         * Users data usage statistics for each device 
         * @summary Data Usage Stats
         * @param {string} aggr_interval No more than 3 days for hour aggregation type
         * @param {string} [date_after] No more than 3 months between date_after and date_before
         * @param {string} [date_before] No more than 3 months between date_after and date_before
         * @param {Array<string>} [device_type__in] Filter by device type
         * @param {Array<string>} [device__in] Filter by device
         * @param {string} [sort_by] Sort output by
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedDataUsageStats>>> {
            return AnalyticsApiFp(configuration).getDataUsageStats(aggr_interval, date_after, date_before, device_type__in, device__in, sort_by, options).then((request) => request(axios, basePath));
        },
    };
};

/**
 * AnalyticsApi - object-oriented interface
 * @export
 * @class AnalyticsApi
 * @extends {BaseAPI}
 */
export class AnalyticsApi extends BaseAPI {
    /**
     * Users data usage statistics for each device 
     * @summary Data Usage Stats
     * @param {string} aggr_interval No more than 3 days for hour aggregation type
     * @param {string} [date_after] No more than 3 months between date_after and date_before
     * @param {string} [date_before] No more than 3 months between date_after and date_before
     * @param {Array<string>} [device_type__in] Filter by device type
     * @param {Array<string>} [device__in] Filter by device
     * @param {string} [sort_by] Sort output by
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AnalyticsApi
     */
    public async getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<AggregatedDataUsageStats>>> {
        return AnalyticsApiFp(this.configuration).getDataUsageStats(aggr_interval, date_after, date_before, device_type__in, device__in, sort_by, options).then((request) => request(this.axios, this.basePath));
    }
}