@forestvpn/forestvpn_api/dist/apis/analytics-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 { AggregatedDataUsageStats } from '../models';
/**
 * AnalyticsApi - axios parameter creator
 * @export
 */
export declare const AnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * 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: (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>;
};
/**
 * AnalyticsApi - functional programming interface
 * @export
 */
export declare const AnalyticsApiFp: (configuration?: Configuration) => {
    /**
     * 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(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>>>>;
};
/**
 * AnalyticsApi - factory interface
 * @export
 */
export declare const AnalyticsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * 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(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>>>;
};
/**
 * AnalyticsApi - object-oriented interface
 * @export
 * @class AnalyticsApi
 * @extends {BaseAPI}
 */
export declare 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
     */
    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>>>;
}