@forestvpn/forestvpn_api/dist/apis/friendship-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 { Friendship } from '../models';
import { FriendshipInvitation } from '../models';
import { FriendshipInvitationList } from '../models';
/**
 * FriendshipApi - axios parameter creator
 * @export
 */
export declare const FriendshipApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete friend
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteFriend: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Friend details
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFriend: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Ivitation detail
     * @param {string} invitationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvitation: (invitationID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get friends list
     * @param {number} [per_page]
     * @param {number} [page]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listFriends: (per_page?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Friendship invitations list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listFriendshipInvitation: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FriendshipApi - functional programming interface
 * @export
 */
export declare const FriendshipApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete friend
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteFriend(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Friend details
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFriend(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Friendship>>>;
    /**
     *
     * @summary Ivitation detail
     * @param {string} invitationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvitation(invitationID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FriendshipInvitation>>>;
    /**
     *
     * @summary Get friends list
     * @param {number} [per_page]
     * @param {number} [page]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listFriends(per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Friendship>>>>;
    /**
     *
     * @summary Friendship invitations list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listFriendshipInvitation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FriendshipInvitationList>>>;
};
/**
 * FriendshipApi - factory interface
 * @export
 */
export declare const FriendshipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Delete friend
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteFriend(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Friend details
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFriend(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Friendship>>;
    /**
     *
     * @summary Ivitation detail
     * @param {string} invitationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvitation(invitationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FriendshipInvitation>>;
    /**
     *
     * @summary Get friends list
     * @param {number} [per_page]
     * @param {number} [page]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listFriends(per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Friendship>>>;
    /**
     *
     * @summary Friendship invitations list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listFriendshipInvitation(options?: AxiosRequestConfig): Promise<AxiosResponse<FriendshipInvitationList>>;
};
/**
 * FriendshipApi - object-oriented interface
 * @export
 * @class FriendshipApi
 * @extends {BaseAPI}
 */
export declare class FriendshipApi extends BaseAPI {
    /**
     *
     * @summary Delete friend
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FriendshipApi
     */
    deleteFriend(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Friend details
     * @param {string} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FriendshipApi
     */
    getFriend(id: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Friendship>>;
    /**
     *
     * @summary Ivitation detail
     * @param {string} invitationID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FriendshipApi
     */
    getInvitation(invitationID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FriendshipInvitation>>;
    /**
     *
     * @summary Get friends list
     * @param {number} [per_page]
     * @param {number} [page]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FriendshipApi
     */
    listFriends(per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Friendship>>>;
    /**
     *
     * @summary Friendship invitations list
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FriendshipApi
     */
    listFriendshipInvitation(options?: AxiosRequestConfig): Promise<AxiosResponse<FriendshipInvitationList>>;
}