@forestvpn/forestvpn_api/dist/apis/support-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 { TicketCategory } from '../models';
import { UsageIssue } from '../models';
import { UsageReport } from '../models';
/**
 * SupportApi - axios parameter creator
 * @export
 */
export declare const SupportApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Create support ticket
     * @param {string} text
     * @param {string} category
     * @param {Array<Blob>} files
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSupportTicketForm: (text: string, category: string, files: Array<Blob>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create usage report
     * @param {string} text
     * @param {Array<string>} issues
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createUsageReportForm: (text: string, issues: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get ticket categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSupportTicketCategory: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Usage Issue list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listUsageIssues: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Usage Report list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listUsageReports: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SupportApi - functional programming interface
 * @export
 */
export declare const SupportApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Create support ticket
     * @param {string} text
     * @param {string} category
     * @param {Array<Blob>} files
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSupportTicketForm(text: string, category: string, files: Array<Blob>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Create usage report
     * @param {string} text
     * @param {Array<string>} issues
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createUsageReportForm(text: string, issues: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Get ticket categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSupportTicketCategory(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<TicketCategory>>>>;
    /**
     *
     * @summary Usage Issue list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listUsageIssues(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UsageIssue>>>>;
    /**
     *
     * @summary Usage Report list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listUsageReports(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UsageReport>>>>;
};
/**
 * SupportApi - factory interface
 * @export
 */
export declare const SupportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Create support ticket
     * @param {string} text
     * @param {string} category
     * @param {Array<Blob>} files
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createSupportTicketForm(text: string, category: string, files: Array<Blob>, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Create usage report
     * @param {string} text
     * @param {Array<string>} issues
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createUsageReportForm(text: string, issues: Array<string>, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get ticket categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSupportTicketCategory(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<TicketCategory>>>;
    /**
     *
     * @summary Usage Issue list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listUsageIssues(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<UsageIssue>>>;
    /**
     *
     * @summary Usage Report list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listUsageReports(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<UsageReport>>>;
};
/**
 * SupportApi - object-oriented interface
 * @export
 * @class SupportApi
 * @extends {BaseAPI}
 */
export declare class SupportApi extends BaseAPI {
    /**
     *
     * @summary Create support ticket
     * @param {string} text
     * @param {string} category
     * @param {Array<Blob>} files
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    createSupportTicketForm(text: string, category: string, files: Array<Blob>, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Create usage report
     * @param {string} text
     * @param {Array<string>} issues
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    createUsageReportForm(text: string, issues: Array<string>, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get ticket categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    getSupportTicketCategory(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<TicketCategory>>>;
    /**
     *
     * @summary Usage Issue list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    listUsageIssues(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<UsageIssue>>>;
    /**
     *
     * @summary Usage Report list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    listUsageReports(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<UsageReport>>>;
}