@forestvpn/forestvpn_api/apis/support-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 { TicketCategory } from '../models';
import { UsageIssue } from '../models';
import { UsageReport } from '../models';
/**
 * SupportApi - axios parameter creator
 * @export
 */
export const SupportApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * 
         * @summary Create support ticket
         * @param {string} text 
         * @param {string} category 
         * @param {Array<Blob>} files 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        createSupportTicketForm: async (text: string, category: string, files: Array<Blob>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'text' is not null or undefined
            if (text === null || text === undefined) {
                throw new RequiredError('text','Required parameter text was null or undefined when calling createSupportTicketForm.');
            }
            // verify required parameter 'category' is not null or undefined
            if (category === null || category === undefined) {
                throw new RequiredError('category','Required parameter category was null or undefined when calling createSupportTicketForm.');
            }
            // verify required parameter 'files' is not null or undefined
            if (files === null || files === undefined) {
                throw new RequiredError('files','Required parameter files was null or undefined when calling createSupportTicketForm.');
            }
            const localVarPath = `/support/tickets/`;
            // 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;
            const localVarFormParams = new FormData();

            // 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 (text !== undefined) { 
                localVarFormParams.append('text', text as any);
            }

            if (category !== undefined) { 
                localVarFormParams.append('category', category as any);
            }
            if (files) {
                files.forEach((element) => {
                    localVarFormParams.append('files', element as any);
                })
            }

            localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
            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};
            localVarRequestOptions.data = localVarFormParams;

            return {
                url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
                options: localVarRequestOptions,
            };
        },
        /**
         * 
         * @summary Create usage report
         * @param {string} text 
         * @param {Array<string>} issues 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        createUsageReportForm: async (text: string, issues: Array<string>, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'text' is not null or undefined
            if (text === null || text === undefined) {
                throw new RequiredError('text','Required parameter text was null or undefined when calling createUsageReportForm.');
            }
            // verify required parameter 'issues' is not null or undefined
            if (issues === null || issues === undefined) {
                throw new RequiredError('issues','Required parameter issues was null or undefined when calling createUsageReportForm.');
            }
            const localVarPath = `/support/reports/`;
            // 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;
            const localVarFormParams = new FormData();

            // 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 (text !== undefined) { 
                localVarFormParams.append('text', text as any);
            }
            if (issues) {
                issues.forEach((element) => {
                    localVarFormParams.append('issues', element as any);
                })
            }

            localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
            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};
            localVarRequestOptions.data = localVarFormParams;

            return {
                url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
                options: localVarRequestOptions,
            };
        },
        /**
         * 
         * @summary Get ticket categories
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        getSupportTicketCategory: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/support/ticket-categories/`;
            // 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 Usage Issue list
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        listUsageIssues: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/support/issue-types/`;
            // 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 Usage Report list
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        listUsageReports: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/support/reports/`;
            // 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,
            };
        },
    }
};

/**
 * SupportApi - functional programming interface
 * @export
 */
export const SupportApiFp = function(configuration?: Configuration) {
    return {
        /**
         * 
         * @summary Create support ticket
         * @param {string} text 
         * @param {string} category 
         * @param {Array<Blob>} files 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async createSupportTicketForm(text: string, category: string, files: Array<Blob>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
            const localVarAxiosArgs = await SupportApiAxiosParamCreator(configuration).createSupportTicketForm(text, category, files, options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
        /**
         * 
         * @summary Create usage report
         * @param {string} text 
         * @param {Array<string>} issues 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async createUsageReportForm(text: string, issues: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
            const localVarAxiosArgs = await SupportApiAxiosParamCreator(configuration).createUsageReportForm(text, issues, options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
        /**
         * 
         * @summary Get ticket categories
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getSupportTicketCategory(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<TicketCategory>>>> {
            const localVarAxiosArgs = await SupportApiAxiosParamCreator(configuration).getSupportTicketCategory(options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
        /**
         * 
         * @summary Usage Issue list
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async listUsageIssues(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UsageIssue>>>> {
            const localVarAxiosArgs = await SupportApiAxiosParamCreator(configuration).listUsageIssues(options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
        /**
         * 
         * @summary Usage Report list
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async listUsageReports(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<UsageReport>>>> {
            const localVarAxiosArgs = await SupportApiAxiosParamCreator(configuration).listUsageReports(options);
            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
                return axios.request(axiosRequestArgs);
            };
        },
    }
};

/**
 * SupportApi - factory interface
 * @export
 */
export const SupportApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    return {
        /**
         * 
         * @summary Create support ticket
         * @param {string} text 
         * @param {string} category 
         * @param {Array<Blob>} files 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async createSupportTicketForm(text: string, category: string, files: Array<Blob>, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
            return SupportApiFp(configuration).createSupportTicketForm(text, category, files, options).then((request) => request(axios, basePath));
        },
        /**
         * 
         * @summary Create usage report
         * @param {string} text 
         * @param {Array<string>} issues 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async createUsageReportForm(text: string, issues: Array<string>, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
            return SupportApiFp(configuration).createUsageReportForm(text, issues, options).then((request) => request(axios, basePath));
        },
        /**
         * 
         * @summary Get ticket categories
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async getSupportTicketCategory(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<TicketCategory>>> {
            return SupportApiFp(configuration).getSupportTicketCategory(options).then((request) => request(axios, basePath));
        },
        /**
         * 
         * @summary Usage Issue list
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async listUsageIssues(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<UsageIssue>>> {
            return SupportApiFp(configuration).listUsageIssues(options).then((request) => request(axios, basePath));
        },
        /**
         * 
         * @summary Usage Report list
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async listUsageReports(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<UsageReport>>> {
            return SupportApiFp(configuration).listUsageReports(options).then((request) => request(axios, basePath));
        },
    };
};

/**
 * SupportApi - object-oriented interface
 * @export
 * @class SupportApi
 * @extends {BaseAPI}
 */
export 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
     */
    public async createSupportTicketForm(text: string, category: string, files: Array<Blob>, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
        return SupportApiFp(this.configuration).createSupportTicketForm(text, category, files, options).then((request) => request(this.axios, this.basePath));
    }
    /**
     * 
     * @summary Create usage report
     * @param {string} text 
     * @param {Array<string>} issues 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    public async createUsageReportForm(text: string, issues: Array<string>, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
        return SupportApiFp(this.configuration).createUsageReportForm(text, issues, options).then((request) => request(this.axios, this.basePath));
    }
    /**
     * 
     * @summary Get ticket categories
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    public async getSupportTicketCategory(options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<TicketCategory>>> {
        return SupportApiFp(this.configuration).getSupportTicketCategory(options).then((request) => request(this.axios, this.basePath));
    }
    /**
     * 
     * @summary Usage Issue list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    public async listUsageIssues(options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<UsageIssue>>> {
        return SupportApiFp(this.configuration).listUsageIssues(options).then((request) => request(this.axios, this.basePath));
    }
    /**
     * 
     * @summary Usage Report list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SupportApi
     */
    public async listUsageReports(options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<UsageReport>>> {
        return SupportApiFp(this.configuration).listUsageReports(options).then((request) => request(this.axios, this.basePath));
    }
}