@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
184 lines (183 loc) • 6.75 kB
TypeScript
/**
* 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 { AppStoreOfferSignature } from '../models';
import { Offer } from '../models';
import { PlayStoreOffer } from '../models';
/**
* OfferApi - axios parameter creator
* @export
*/
export declare const OfferApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get App Store offer signature
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAppStoreOfferSignatureForm: (product: string, offerID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get offer detail
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOffer: (offerID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get Play Store offer
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPlayStoreOfferForm: (product: string, offerID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get offers
* @param {Array<string>} [product] Filter by product
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listOffers: (product?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* OfferApi - functional programming interface
* @export
*/
export declare const OfferApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get App Store offer signature
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAppStoreOfferSignatureForm(product: string, offerID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<AppStoreOfferSignature>>>;
/**
*
* @summary Get offer detail
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOffer(offerID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Offer>>>;
/**
*
* @summary Get Play Store offer
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPlayStoreOfferForm(product: string, offerID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PlayStoreOffer>>>;
/**
*
* @summary Get offers
* @param {Array<string>} [product] Filter by product
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listOffers(product?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Offer>>>>;
};
/**
* OfferApi - factory interface
* @export
*/
export declare const OfferApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get App Store offer signature
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAppStoreOfferSignatureForm(product: string, offerID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AppStoreOfferSignature>>;
/**
*
* @summary Get offer detail
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOffer(offerID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Offer>>;
/**
*
* @summary Get Play Store offer
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPlayStoreOfferForm(product: string, offerID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayStoreOffer>>;
/**
*
* @summary Get offers
* @param {Array<string>} [product] Filter by product
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listOffers(product?: Array<string>, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Offer>>>;
};
/**
* OfferApi - object-oriented interface
* @export
* @class OfferApi
* @extends {BaseAPI}
*/
export declare class OfferApi extends BaseAPI {
/**
*
* @summary Get App Store offer signature
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OfferApi
*/
getAppStoreOfferSignatureForm(product: string, offerID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<AppStoreOfferSignature>>;
/**
*
* @summary Get offer detail
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OfferApi
*/
getOffer(offerID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Offer>>;
/**
*
* @summary Get Play Store offer
* @param {string} product
* @param {string} offerID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OfferApi
*/
getPlayStoreOfferForm(product: string, offerID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayStoreOffer>>;
/**
*
* @summary Get offers
* @param {Array<string>} [product] Filter by product
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof OfferApi
*/
listOffers(product?: Array<string>, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Offer>>>;
}