@forestvpn/forestvpn_api/dist/apis/checkout-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 { CheckoutSession } from '../models';
import { CloudPaymentsAuth } from '../models';
import { CloudPaymentsPost3ds } from '../models';
import { CouponCheckoutSession } from '../models';
import { CreateCheckoutSessionRequest } from '../models';
import { CreateCloudPaymentsAuth } from '../models';
import { CreateCloudPaymentsPost3ds } from '../models';
import { CreateCouponCheckoutSession } from '../models';
import { StripeCheckoutSession } from '../models';
import { StripePaymentIntent } from '../models';
/**
 * CheckoutApi - axios parameter creator
 * @export
 */
export declare const CheckoutApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Apply coupon to session
     * @param {CreateCouponCheckoutSession} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    applyCouponCheckoutSession: (body: CreateCouponCheckoutSession, sessionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create checkout session
     * @param {CreateCheckoutSessionRequest} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCheckoutSession: (body?: CreateCheckoutSessionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create request to add country in wait list
     * @param {string} [X_Country]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWaitListRequest: (X_Country?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Expire checkout session
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    expireCheckoutSession: (sessionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCheckoutSession: (sessionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Stripe checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStripeCheckoutSession: (sessionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Stripe payment intent details
     * @param {string} sessionID
     * @param {boolean} [use_stripe_sdk]
     * @param {string} [return_url]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStripePaymentIntent: (sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Cloud payments auth
     * @param {CreateCloudPaymentsAuth} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    processCloudPaymentsAuth: (body: CreateCloudPaymentsAuth, sessionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Cloud payments post3ds
     * @param {CreateCloudPaymentsPost3ds} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    processCloudPaymentsPost3ds: (body: CreateCloudPaymentsPost3ds, sessionID: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * CheckoutApi - functional programming interface
 * @export
 */
export declare const CheckoutApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Apply coupon to session
     * @param {CreateCouponCheckoutSession} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    applyCouponCheckoutSession(body: CreateCouponCheckoutSession, sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CouponCheckoutSession>>>;
    /**
     *
     * @summary Create checkout session
     * @param {CreateCheckoutSessionRequest} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCheckoutSession(body?: CreateCheckoutSessionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CheckoutSession>>>;
    /**
     *
     * @summary Create request to add country in wait list
     * @param {string} [X_Country]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWaitListRequest(X_Country?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Expire checkout session
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    expireCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CheckoutSession>>>;
    /**
     *
     * @summary Stripe checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStripeCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StripeCheckoutSession>>>;
    /**
     *
     * @summary Stripe payment intent details
     * @param {string} sessionID
     * @param {boolean} [use_stripe_sdk]
     * @param {string} [return_url]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStripePaymentIntent(sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StripePaymentIntent>>>;
    /**
     *
     * @summary Cloud payments auth
     * @param {CreateCloudPaymentsAuth} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    processCloudPaymentsAuth(body: CreateCloudPaymentsAuth, sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CloudPaymentsAuth>>>;
    /**
     *
     * @summary Cloud payments post3ds
     * @param {CreateCloudPaymentsPost3ds} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    processCloudPaymentsPost3ds(body: CreateCloudPaymentsPost3ds, sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CloudPaymentsPost3ds>>>;
};
/**
 * CheckoutApi - factory interface
 * @export
 */
export declare const CheckoutApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Apply coupon to session
     * @param {CreateCouponCheckoutSession} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    applyCouponCheckoutSession(body: CreateCouponCheckoutSession, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CouponCheckoutSession>>;
    /**
     *
     * @summary Create checkout session
     * @param {CreateCheckoutSessionRequest} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCheckoutSession(body?: CreateCheckoutSessionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CheckoutSession>>;
    /**
     *
     * @summary Create request to add country in wait list
     * @param {string} [X_Country]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWaitListRequest(X_Country?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Expire checkout session
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    expireCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CheckoutSession>>;
    /**
     *
     * @summary Stripe checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStripeCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripeCheckoutSession>>;
    /**
     *
     * @summary Stripe payment intent details
     * @param {string} sessionID
     * @param {boolean} [use_stripe_sdk]
     * @param {string} [return_url]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStripePaymentIntent(sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripePaymentIntent>>;
    /**
     *
     * @summary Cloud payments auth
     * @param {CreateCloudPaymentsAuth} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    processCloudPaymentsAuth(body: CreateCloudPaymentsAuth, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CloudPaymentsAuth>>;
    /**
     *
     * @summary Cloud payments post3ds
     * @param {CreateCloudPaymentsPost3ds} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    processCloudPaymentsPost3ds(body: CreateCloudPaymentsPost3ds, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CloudPaymentsPost3ds>>;
};
/**
 * CheckoutApi - object-oriented interface
 * @export
 * @class CheckoutApi
 * @extends {BaseAPI}
 */
export declare class CheckoutApi extends BaseAPI {
    /**
     *
     * @summary Apply coupon to session
     * @param {CreateCouponCheckoutSession} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    applyCouponCheckoutSession(body: CreateCouponCheckoutSession, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CouponCheckoutSession>>;
    /**
     *
     * @summary Create checkout session
     * @param {CreateCheckoutSessionRequest} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    createCheckoutSession(body?: CreateCheckoutSessionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CheckoutSession>>;
    /**
     *
     * @summary Create request to add country in wait list
     * @param {string} [X_Country]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    createWaitListRequest(X_Country?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Expire checkout session
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    expireCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    getCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CheckoutSession>>;
    /**
     *
     * @summary Stripe checkout session details
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    getStripeCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripeCheckoutSession>>;
    /**
     *
     * @summary Stripe payment intent details
     * @param {string} sessionID
     * @param {boolean} [use_stripe_sdk]
     * @param {string} [return_url]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    getStripePaymentIntent(sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripePaymentIntent>>;
    /**
     *
     * @summary Cloud payments auth
     * @param {CreateCloudPaymentsAuth} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    processCloudPaymentsAuth(body: CreateCloudPaymentsAuth, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CloudPaymentsAuth>>;
    /**
     *
     * @summary Cloud payments post3ds
     * @param {CreateCloudPaymentsPost3ds} body
     * @param {string} sessionID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CheckoutApi
     */
    processCloudPaymentsPost3ds(body: CreateCloudPaymentsPost3ds, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CloudPaymentsPost3ds>>;
}