@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
871 lines (832 loc) • 45.6 kB
text/typescript
/* 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 { 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 const CheckoutApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Apply coupon to session
* @param {CreateCouponCheckoutSession} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
applyCouponCheckoutSession: async (body: CreateCouponCheckoutSession, sessionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new RequiredError('body','Required parameter body was null or undefined when calling applyCouponCheckoutSession.');
}
// verify required parameter 'sessionID' is not null or undefined
if (sessionID === null || sessionID === undefined) {
throw new RequiredError('sessionID','Required parameter sessionID was null or undefined when calling applyCouponCheckoutSession.');
}
const localVarPath = `/checkout/sessions/{sessionID}/apply_coupon/`
.replace(`{${"sessionID"}}`, encodeURIComponent(String(sessionID)));
// 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;
// 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;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
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};
const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Create checkout session
* @param {CreateCheckoutSessionRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCheckoutSession: async (body?: CreateCheckoutSessionRequest, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/checkout/sessions/`;
// 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;
// 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;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
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};
const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Create request to add country in wait list
* @param {string} [X_Country]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createWaitListRequest: async (X_Country?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/checkout/wait-list/`;
// 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;
// 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 (X_Country !== undefined && X_Country !== null) {
localVarHeaderParameter['X-Country'] = String(X_Country);
}
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 Expire checkout session
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
expireCheckoutSession: async (sessionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'sessionID' is not null or undefined
if (sessionID === null || sessionID === undefined) {
throw new RequiredError('sessionID','Required parameter sessionID was null or undefined when calling expireCheckoutSession.');
}
const localVarPath = `/checkout/sessions/{sessionID}/expire/`
.replace(`{${"sessionID"}}`, encodeURIComponent(String(sessionID)));
// 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;
// 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 Checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCheckoutSession: async (sessionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'sessionID' is not null or undefined
if (sessionID === null || sessionID === undefined) {
throw new RequiredError('sessionID','Required parameter sessionID was null or undefined when calling getCheckoutSession.');
}
const localVarPath = `/checkout/sessions/{sessionID}/`
.replace(`{${"sessionID"}}`, encodeURIComponent(String(sessionID)));
// 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 Stripe checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getStripeCheckoutSession: async (sessionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'sessionID' is not null or undefined
if (sessionID === null || sessionID === undefined) {
throw new RequiredError('sessionID','Required parameter sessionID was null or undefined when calling getStripeCheckoutSession.');
}
const localVarPath = `/checkout/sessions/{sessionID}/stripe/checkout/session/`
.replace(`{${"sessionID"}}`, encodeURIComponent(String(sessionID)));
// 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 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: async (sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'sessionID' is not null or undefined
if (sessionID === null || sessionID === undefined) {
throw new RequiredError('sessionID','Required parameter sessionID was null or undefined when calling getStripePaymentIntent.');
}
const localVarPath = `/checkout/sessions/{sessionID}/stripe/payment/intent/`
.replace(`{${"sessionID"}}`, encodeURIComponent(String(sessionID)));
// 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;
}
if (use_stripe_sdk !== undefined) {
localVarQueryParameter['use_stripe_sdk'] = use_stripe_sdk;
}
if (return_url !== undefined) {
localVarQueryParameter['return_url'] = return_url;
}
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 Cloud payments auth
* @param {CreateCloudPaymentsAuth} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
processCloudPaymentsAuth: async (body: CreateCloudPaymentsAuth, sessionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new RequiredError('body','Required parameter body was null or undefined when calling processCloudPaymentsAuth.');
}
// verify required parameter 'sessionID' is not null or undefined
if (sessionID === null || sessionID === undefined) {
throw new RequiredError('sessionID','Required parameter sessionID was null or undefined when calling processCloudPaymentsAuth.');
}
const localVarPath = `/checkout/sessions/{sessionID}/cloud-payments/auth/`
.replace(`{${"sessionID"}}`, encodeURIComponent(String(sessionID)));
// 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;
// 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;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
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};
const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Cloud payments post3ds
* @param {CreateCloudPaymentsPost3ds} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
processCloudPaymentsPost3ds: async (body: CreateCloudPaymentsPost3ds, sessionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new RequiredError('body','Required parameter body was null or undefined when calling processCloudPaymentsPost3ds.');
}
// verify required parameter 'sessionID' is not null or undefined
if (sessionID === null || sessionID === undefined) {
throw new RequiredError('sessionID','Required parameter sessionID was null or undefined when calling processCloudPaymentsPost3ds.');
}
const localVarPath = `/checkout/sessions/{sessionID}/cloud-payments/post3ds/`
.replace(`{${"sessionID"}}`, encodeURIComponent(String(sessionID)));
// 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;
// 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;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
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};
const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || "");
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
}
};
/**
* CheckoutApi - functional programming interface
* @export
*/
export const CheckoutApiFp = function(configuration?: Configuration) {
return {
/**
*
* @summary Apply coupon to session
* @param {CreateCouponCheckoutSession} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async applyCouponCheckoutSession(body: CreateCouponCheckoutSession, sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CouponCheckoutSession>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).applyCouponCheckoutSession(body, sessionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Create checkout session
* @param {CreateCheckoutSessionRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createCheckoutSession(body?: CreateCheckoutSessionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CheckoutSession>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).createCheckoutSession(body, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Create request to add country in wait list
* @param {string} [X_Country]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createWaitListRequest(X_Country?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).createWaitListRequest(X_Country, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Expire checkout session
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async expireCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).expireCheckoutSession(sessionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CheckoutSession>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).getCheckoutSession(sessionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Stripe checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getStripeCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StripeCheckoutSession>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).getStripeCheckoutSession(sessionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @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}
*/
async getStripePaymentIntent(sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StripePaymentIntent>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).getStripePaymentIntent(sessionID, use_stripe_sdk, return_url, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Cloud payments auth
* @param {CreateCloudPaymentsAuth} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async processCloudPaymentsAuth(body: CreateCloudPaymentsAuth, sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CloudPaymentsAuth>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).processCloudPaymentsAuth(body, sessionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Cloud payments post3ds
* @param {CreateCloudPaymentsPost3ds} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async processCloudPaymentsPost3ds(body: CreateCloudPaymentsPost3ds, sessionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CloudPaymentsPost3ds>>> {
const localVarAxiosArgs = await CheckoutApiAxiosParamCreator(configuration).processCloudPaymentsPost3ds(body, sessionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
}
};
/**
* CheckoutApi - factory interface
* @export
*/
export const CheckoutApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
return {
/**
*
* @summary Apply coupon to session
* @param {CreateCouponCheckoutSession} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async applyCouponCheckoutSession(body: CreateCouponCheckoutSession, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CouponCheckoutSession>> {
return CheckoutApiFp(configuration).applyCouponCheckoutSession(body, sessionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Create checkout session
* @param {CreateCheckoutSessionRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createCheckoutSession(body?: CreateCheckoutSessionRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CheckoutSession>> {
return CheckoutApiFp(configuration).createCheckoutSession(body, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Create request to add country in wait list
* @param {string} [X_Country]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async createWaitListRequest(X_Country?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
return CheckoutApiFp(configuration).createWaitListRequest(X_Country, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Expire checkout session
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async expireCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
return CheckoutApiFp(configuration).expireCheckoutSession(sessionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CheckoutSession>> {
return CheckoutApiFp(configuration).getCheckoutSession(sessionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Stripe checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getStripeCheckoutSession(sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripeCheckoutSession>> {
return CheckoutApiFp(configuration).getStripeCheckoutSession(sessionID, options).then((request) => request(axios, basePath));
},
/**
*
* @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}
*/
async getStripePaymentIntent(sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<StripePaymentIntent>> {
return CheckoutApiFp(configuration).getStripePaymentIntent(sessionID, use_stripe_sdk, return_url, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Cloud payments auth
* @param {CreateCloudPaymentsAuth} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async processCloudPaymentsAuth(body: CreateCloudPaymentsAuth, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CloudPaymentsAuth>> {
return CheckoutApiFp(configuration).processCloudPaymentsAuth(body, sessionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Cloud payments post3ds
* @param {CreateCloudPaymentsPost3ds} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async processCloudPaymentsPost3ds(body: CreateCloudPaymentsPost3ds, sessionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<CloudPaymentsPost3ds>> {
return CheckoutApiFp(configuration).processCloudPaymentsPost3ds(body, sessionID, options).then((request) => request(axios, basePath));
},
};
};
/**
* CheckoutApi - object-oriented interface
* @export
* @class CheckoutApi
* @extends {BaseAPI}
*/
export 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
*/
public async applyCouponCheckoutSession(body: CreateCouponCheckoutSession, sessionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CouponCheckoutSession>> {
return CheckoutApiFp(this.configuration).applyCouponCheckoutSession(body, sessionID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Create checkout session
* @param {CreateCheckoutSessionRequest} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CheckoutApi
*/
public async createCheckoutSession(body?: CreateCheckoutSessionRequest, options?: AxiosRequestConfig) : Promise<AxiosResponse<CheckoutSession>> {
return CheckoutApiFp(this.configuration).createCheckoutSession(body, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Create request to add country in wait list
* @param {string} [X_Country]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CheckoutApi
*/
public async createWaitListRequest(X_Country?: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
return CheckoutApiFp(this.configuration).createWaitListRequest(X_Country, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Expire checkout session
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CheckoutApi
*/
public async expireCheckoutSession(sessionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
return CheckoutApiFp(this.configuration).expireCheckoutSession(sessionID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CheckoutApi
*/
public async getCheckoutSession(sessionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CheckoutSession>> {
return CheckoutApiFp(this.configuration).getCheckoutSession(sessionID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Stripe checkout session details
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CheckoutApi
*/
public async getStripeCheckoutSession(sessionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<StripeCheckoutSession>> {
return CheckoutApiFp(this.configuration).getStripeCheckoutSession(sessionID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @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
*/
public async getStripePaymentIntent(sessionID: string, use_stripe_sdk?: boolean, return_url?: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<StripePaymentIntent>> {
return CheckoutApiFp(this.configuration).getStripePaymentIntent(sessionID, use_stripe_sdk, return_url, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Cloud payments auth
* @param {CreateCloudPaymentsAuth} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CheckoutApi
*/
public async processCloudPaymentsAuth(body: CreateCloudPaymentsAuth, sessionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CloudPaymentsAuth>> {
return CheckoutApiFp(this.configuration).processCloudPaymentsAuth(body, sessionID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Cloud payments post3ds
* @param {CreateCloudPaymentsPost3ds} body
* @param {string} sessionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CheckoutApi
*/
public async processCloudPaymentsPost3ds(body: CreateCloudPaymentsPost3ds, sessionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<CloudPaymentsPost3ds>> {
return CheckoutApiFp(this.configuration).processCloudPaymentsPost3ds(body, sessionID, options).then((request) => request(this.axios, this.basePath));
}
}