/** * ForestVPN Cloud API * ForestVPN Cloud - it's a Google Cloud but for VPN apps. Ready to use VPN Cloud Platform minimizes efforts to build fast, secure, and modern VPN apps. * * 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 { CreateOrUpdateProfileRequest } from '../models'; import { Profile } from '../models'; import { ProfileStats } from '../models'; /** * ProfilesApi - axios parameter creator * @export */ export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create profile * @param {string} X_Project_Id * @param {CreateOrUpdateProfileRequest} [body] * @param {string} [search] Search by ID, profile ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProfile: (X_Project_Id: string, body?: CreateOrUpdateProfileRequest, search?: string, options?: AxiosRequestConfig) => Promise; /** * Deletes profile and all associated resources * @summary Delete profile * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProfile: (X_Project_Id: string, profileId: string, options?: AxiosRequestConfig) => Promise; /** * * @summary Profile details * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProfile: (X_Project_Id: string, profileId: string, options?: AxiosRequestConfig) => Promise; /** * * @summary Profile stats list * @param {string} X_Project_Id * @param {string} profileId * @param {string} [aggregate_by] * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProfileStats: (X_Project_Id: string, profileId: string, aggregate_by?: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise; /** * * @summary Profile list * @param {string} X_Project_Id * @param {string} [external_key] * @param {number} [per_page] * @param {number} [page] * @param {string} [ordering] Sort output by (use \"-\" for desc ordering (i.g \"-first_name\")) * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProfiles: (X_Project_Id: string, external_key?: string, per_page?: number, page?: number, ordering?: string, options?: AxiosRequestConfig) => Promise; /** * * @summary Partial update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ partialUpdateProfile: (body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig) => Promise; /** * * @summary Profile config * @param {string} X_Project_Id * @param {string} profileId * @param {string} [config] Config type (\"wireguard\" by default) * @param {string} [peer] Node Binding ID * @param {boolean} [file] Set true if downloand required * @param {*} [options] Override http request option. * @throws {RequiredError} */ profileConfig: (X_Project_Id: string, profileId: string, config?: string, peer?: string, file?: boolean, options?: AxiosRequestConfig) => Promise; /** * * @summary Update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProfile: (body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig) => Promise; }; /** * ProfilesApi - functional programming interface * @export */ export declare const ProfilesApiFp: (configuration?: Configuration) => { /** * * @summary Create profile * @param {string} X_Project_Id * @param {CreateOrUpdateProfileRequest} [body] * @param {string} [search] Search by ID, profile ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProfile(X_Project_Id: string, body?: CreateOrUpdateProfileRequest, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>; /** * Deletes profile and all associated resources * @summary Delete profile * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProfile(X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>; /** * * @summary Profile details * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProfile(X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>; /** * * @summary Profile stats list * @param {string} X_Project_Id * @param {string} profileId * @param {string} [aggregate_by] * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProfileStats(X_Project_Id: string, profileId: string, aggregate_by?: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>>; /** * * @summary Profile list * @param {string} X_Project_Id * @param {string} [external_key] * @param {number} [per_page] * @param {number} [page] * @param {string} [ordering] Sort output by (use \"-\" for desc ordering (i.g \"-first_name\")) * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProfiles(X_Project_Id: string, external_key?: string, per_page?: number, page?: number, ordering?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>>; /** * * @summary Partial update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ partialUpdateProfile(body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>; /** * * @summary Profile config * @param {string} X_Project_Id * @param {string} profileId * @param {string} [config] Config type (\"wireguard\" by default) * @param {string} [peer] Node Binding ID * @param {boolean} [file] Set true if downloand required * @param {*} [options] Override http request option. * @throws {RequiredError} */ profileConfig(X_Project_Id: string, profileId: string, config?: string, peer?: string, file?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>; /** * * @summary Update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProfile(body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>; }; /** * ProfilesApi - factory interface * @export */ export declare const ProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create profile * @param {string} X_Project_Id * @param {CreateOrUpdateProfileRequest} [body] * @param {string} [search] Search by ID, profile ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createProfile(X_Project_Id: string, body?: CreateOrUpdateProfileRequest, search?: string, options?: AxiosRequestConfig): Promise>; /** * Deletes profile and all associated resources * @summary Delete profile * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteProfile(X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; /** * * @summary Profile details * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProfile(X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; /** * * @summary Profile stats list * @param {string} X_Project_Id * @param {string} profileId * @param {string} [aggregate_by] * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProfileStats(X_Project_Id: string, profileId: string, aggregate_by?: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise>>; /** * * @summary Profile list * @param {string} X_Project_Id * @param {string} [external_key] * @param {number} [per_page] * @param {number} [page] * @param {string} [ordering] Sort output by (use \"-\" for desc ordering (i.g \"-first_name\")) * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProfiles(X_Project_Id: string, external_key?: string, per_page?: number, page?: number, ordering?: string, options?: AxiosRequestConfig): Promise>>; /** * * @summary Partial update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ partialUpdateProfile(body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; /** * * @summary Profile config * @param {string} X_Project_Id * @param {string} profileId * @param {string} [config] Config type (\"wireguard\" by default) * @param {string} [peer] Node Binding ID * @param {boolean} [file] Set true if downloand required * @param {*} [options] Override http request option. * @throws {RequiredError} */ profileConfig(X_Project_Id: string, profileId: string, config?: string, peer?: string, file?: boolean, options?: AxiosRequestConfig): Promise>; /** * * @summary Update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateProfile(body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; }; /** * ProfilesApi - object-oriented interface * @export * @class ProfilesApi * @extends {BaseAPI} */ export declare class ProfilesApi extends BaseAPI { /** * * @summary Create profile * @param {string} X_Project_Id * @param {CreateOrUpdateProfileRequest} [body] * @param {string} [search] Search by ID, profile ID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ createProfile(X_Project_Id: string, body?: CreateOrUpdateProfileRequest, search?: string, options?: AxiosRequestConfig): Promise>; /** * Deletes profile and all associated resources * @summary Delete profile * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ deleteProfile(X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; /** * * @summary Profile details * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ getProfile(X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; /** * * @summary Profile stats list * @param {string} X_Project_Id * @param {string} profileId * @param {string} [aggregate_by] * @param {string} [date_after] * @param {string} [date_before] * @param {number} [per_page] * @param {number} [page] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ listProfileStats(X_Project_Id: string, profileId: string, aggregate_by?: string, date_after?: string, date_before?: string, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise>>; /** * * @summary Profile list * @param {string} X_Project_Id * @param {string} [external_key] * @param {number} [per_page] * @param {number} [page] * @param {string} [ordering] Sort output by (use \"-\" for desc ordering (i.g \"-first_name\")) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ listProfiles(X_Project_Id: string, external_key?: string, per_page?: number, page?: number, ordering?: string, options?: AxiosRequestConfig): Promise>>; /** * * @summary Partial update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ partialUpdateProfile(body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; /** * * @summary Profile config * @param {string} X_Project_Id * @param {string} profileId * @param {string} [config] Config type (\"wireguard\" by default) * @param {string} [peer] Node Binding ID * @param {boolean} [file] Set true if downloand required * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ profileConfig(X_Project_Id: string, profileId: string, config?: string, peer?: string, file?: boolean, options?: AxiosRequestConfig): Promise>; /** * * @summary Update profile details * @param {CreateOrUpdateProfileRequest} body * @param {string} X_Project_Id * @param {string} profileId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProfilesApi */ updateProfile(body: CreateOrUpdateProfileRequest, X_Project_Id: string, profileId: string, options?: AxiosRequestConfig): Promise>; }