@forestvpn/forestvpn_api
Version:
A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)
663 lines (624 loc) • 33.7 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 { Referral } from '../models';
import { ReferralProfile } from '../models';
import { ReferralTransaction } from '../models';
import { ReferralTransactionType } from '../models';
/**
* ReferralApi - axios parameter creator
* @export
*/
export const ReferralApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Apply referral code
* @param {string} referral_code
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
applyReferralCodeForm: async (referral_code: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'referral_code' is not null or undefined
if (referral_code === null || referral_code === undefined) {
throw new RequiredError('referral_code','Required parameter referral_code was null or undefined when calling applyReferralCodeForm.');
}
const localVarPath = `/referral/referrals/apply/`;
// 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;
const localVarFormParams = new FormData();
// 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 (referral_code !== undefined) {
localVarFormParams.append('referral_code', referral_code as any);
}
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
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};
localVarRequestOptions.data = localVarFormParams;
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Claim referral transaction
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
claimReferralTransaction: async (transactionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'transactionID' is not null or undefined
if (transactionID === null || transactionID === undefined) {
throw new RequiredError('transactionID','Required parameter transactionID was null or undefined when calling claimReferralTransaction.');
}
const localVarPath = `/referral/transactions/{transactionID}/claim/`
.replace(`{${"transactionID"}}`, encodeURIComponent(String(transactionID)));
// 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 Get referral transaction detail
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getReferralTransaction: async (transactionID: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'transactionID' is not null or undefined
if (transactionID === null || transactionID === undefined) {
throw new RequiredError('transactionID','Required parameter transactionID was null or undefined when calling getReferralTransaction.');
}
const localVarPath = `/referral/transactions/{transactionID}/`
.replace(`{${"transactionID"}}`, encodeURIComponent(String(transactionID)));
// 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 Get referral transactions
* @param {Array<string>} [sort] Sort by provided field
* @param {Array<string>} [currency] Filter by currency
* @param {Array<ReferralTransactionType>} [type] Transaction type
* @param {Date} [created_at_after]
* @param {Date} [created_at_before]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listReferralTransactions: async (sort?: Array<string>, currency?: Array<string>, type?: Array<ReferralTransactionType>, created_at_after?: Date, created_at_before?: Date, per_page?: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/referral/transactions/`;
// 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 (sort) {
localVarQueryParameter['sort'] = sort.join(COLLECTION_FORMATS.csv);
}
if (currency) {
localVarQueryParameter['currency'] = currency.join(COLLECTION_FORMATS.csv);
}
if (type) {
localVarQueryParameter['type'] = type;
}
if (created_at_after !== undefined) {
localVarQueryParameter['created_at_after'] = (created_at_after as any instanceof Date) ?
(created_at_after as any).toISOString() :
created_at_after;
}
if (created_at_before !== undefined) {
localVarQueryParameter['created_at_before'] = (created_at_before as any instanceof Date) ?
(created_at_before as any).toISOString() :
created_at_before;
}
if (per_page !== undefined) {
localVarQueryParameter['per_page'] = per_page;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
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 Get referrals list
* @param {string} [q] Search query
* @param {string} [sort] Sort by provided field
* @param {Date} [invited_at_after] Filter by invited date-time after provided value
* @param {Date} [invited_at_before] Filter by invited date-time before provided value
* @param {boolean} [is_premium] Filter by invitees is_premium status
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listReferrals: async (q?: string, sort?: string, invited_at_after?: Date, invited_at_before?: Date, is_premium?: boolean, per_page?: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/referral/referrals/`;
// 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 (q !== undefined) {
localVarQueryParameter['q'] = q;
}
if (sort !== undefined) {
localVarQueryParameter['sort'] = sort;
}
if (invited_at_after !== undefined) {
localVarQueryParameter['invited_at_after'] = (invited_at_after as any instanceof Date) ?
(invited_at_after as any).toISOString() :
invited_at_after;
}
if (invited_at_before !== undefined) {
localVarQueryParameter['invited_at_before'] = (invited_at_before as any instanceof Date) ?
(invited_at_before as any).toISOString() :
invited_at_before;
}
if (is_premium !== undefined) {
localVarQueryParameter['is_premium'] = is_premium;
}
if (per_page !== undefined) {
localVarQueryParameter['per_page'] = per_page;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
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 Referral Program. Profile
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
referralProfileDetail: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/referral/profile/`;
// 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,
};
},
}
};
/**
* ReferralApi - functional programming interface
* @export
*/
export const ReferralApiFp = function(configuration?: Configuration) {
return {
/**
*
* @summary Apply referral code
* @param {string} referral_code
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async applyReferralCodeForm(referral_code: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> {
const localVarAxiosArgs = await ReferralApiAxiosParamCreator(configuration).applyReferralCodeForm(referral_code, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Claim referral transaction
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async claimReferralTransaction(transactionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ReferralTransaction>>> {
const localVarAxiosArgs = await ReferralApiAxiosParamCreator(configuration).claimReferralTransaction(transactionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Get referral transaction detail
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getReferralTransaction(transactionID: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ReferralTransaction>>> {
const localVarAxiosArgs = await ReferralApiAxiosParamCreator(configuration).getReferralTransaction(transactionID, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Get referral transactions
* @param {Array<string>} [sort] Sort by provided field
* @param {Array<string>} [currency] Filter by currency
* @param {Array<ReferralTransactionType>} [type] Transaction type
* @param {Date} [created_at_after]
* @param {Date} [created_at_before]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listReferralTransactions(sort?: Array<string>, currency?: Array<string>, type?: Array<ReferralTransactionType>, created_at_after?: Date, created_at_before?: Date, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<ReferralTransaction>>>> {
const localVarAxiosArgs = await ReferralApiAxiosParamCreator(configuration).listReferralTransactions(sort, currency, type, created_at_after, created_at_before, per_page, page, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Get referrals list
* @param {string} [q] Search query
* @param {string} [sort] Sort by provided field
* @param {Date} [invited_at_after] Filter by invited date-time after provided value
* @param {Date} [invited_at_before] Filter by invited date-time before provided value
* @param {boolean} [is_premium] Filter by invitees is_premium status
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listReferrals(q?: string, sort?: string, invited_at_after?: Date, invited_at_before?: Date, is_premium?: boolean, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Referral>>>> {
const localVarAxiosArgs = await ReferralApiAxiosParamCreator(configuration).listReferrals(q, sort, invited_at_after, invited_at_before, is_premium, per_page, page, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Referral Program. Profile
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async referralProfileDetail(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ReferralProfile>>> {
const localVarAxiosArgs = await ReferralApiAxiosParamCreator(configuration).referralProfileDetail(options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
}
};
/**
* ReferralApi - factory interface
* @export
*/
export const ReferralApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
return {
/**
*
* @summary Apply referral code
* @param {string} referral_code
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async applyReferralCodeForm(referral_code: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> {
return ReferralApiFp(configuration).applyReferralCodeForm(referral_code, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Claim referral transaction
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async claimReferralTransaction(transactionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ReferralTransaction>> {
return ReferralApiFp(configuration).claimReferralTransaction(transactionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get referral transaction detail
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getReferralTransaction(transactionID: string, options?: AxiosRequestConfig): Promise<AxiosResponse<ReferralTransaction>> {
return ReferralApiFp(configuration).getReferralTransaction(transactionID, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get referral transactions
* @param {Array<string>} [sort] Sort by provided field
* @param {Array<string>} [currency] Filter by currency
* @param {Array<ReferralTransactionType>} [type] Transaction type
* @param {Date} [created_at_after]
* @param {Date} [created_at_before]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listReferralTransactions(sort?: Array<string>, currency?: Array<string>, type?: Array<ReferralTransactionType>, created_at_after?: Date, created_at_before?: Date, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<ReferralTransaction>>> {
return ReferralApiFp(configuration).listReferralTransactions(sort, currency, type, created_at_after, created_at_before, per_page, page, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get referrals list
* @param {string} [q] Search query
* @param {string} [sort] Sort by provided field
* @param {Date} [invited_at_after] Filter by invited date-time after provided value
* @param {Date} [invited_at_before] Filter by invited date-time before provided value
* @param {boolean} [is_premium] Filter by invitees is_premium status
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listReferrals(q?: string, sort?: string, invited_at_after?: Date, invited_at_before?: Date, is_premium?: boolean, per_page?: number, page?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Referral>>> {
return ReferralApiFp(configuration).listReferrals(q, sort, invited_at_after, invited_at_before, is_premium, per_page, page, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Referral Program. Profile
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async referralProfileDetail(options?: AxiosRequestConfig): Promise<AxiosResponse<ReferralProfile>> {
return ReferralApiFp(configuration).referralProfileDetail(options).then((request) => request(axios, basePath));
},
};
};
/**
* ReferralApi - object-oriented interface
* @export
* @class ReferralApi
* @extends {BaseAPI}
*/
export class ReferralApi extends BaseAPI {
/**
*
* @summary Apply referral code
* @param {string} referral_code
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReferralApi
*/
public async applyReferralCodeForm(referral_code: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> {
return ReferralApiFp(this.configuration).applyReferralCodeForm(referral_code, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Claim referral transaction
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReferralApi
*/
public async claimReferralTransaction(transactionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ReferralTransaction>> {
return ReferralApiFp(this.configuration).claimReferralTransaction(transactionID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get referral transaction detail
* @param {string} transactionID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReferralApi
*/
public async getReferralTransaction(transactionID: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<ReferralTransaction>> {
return ReferralApiFp(this.configuration).getReferralTransaction(transactionID, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get referral transactions
* @param {Array<string>} [sort] Sort by provided field
* @param {Array<string>} [currency] Filter by currency
* @param {Array<ReferralTransactionType>} [type] Transaction type
* @param {Date} [created_at_after]
* @param {Date} [created_at_before]
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReferralApi
*/
public async listReferralTransactions(sort?: Array<string>, currency?: Array<string>, type?: Array<ReferralTransactionType>, created_at_after?: Date, created_at_before?: Date, per_page?: number, page?: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<ReferralTransaction>>> {
return ReferralApiFp(this.configuration).listReferralTransactions(sort, currency, type, created_at_after, created_at_before, per_page, page, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Get referrals list
* @param {string} [q] Search query
* @param {string} [sort] Sort by provided field
* @param {Date} [invited_at_after] Filter by invited date-time after provided value
* @param {Date} [invited_at_before] Filter by invited date-time before provided value
* @param {boolean} [is_premium] Filter by invitees is_premium status
* @param {number} [per_page]
* @param {number} [page]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReferralApi
*/
public async listReferrals(q?: string, sort?: string, invited_at_after?: Date, invited_at_before?: Date, is_premium?: boolean, per_page?: number, page?: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<Referral>>> {
return ReferralApiFp(this.configuration).listReferrals(q, sort, invited_at_after, invited_at_before, is_premium, per_page, page, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Referral Program. Profile
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReferralApi
*/
public async referralProfileDetail(options?: AxiosRequestConfig) : Promise<AxiosResponse<ReferralProfile>> {
return ReferralApiFp(this.configuration).referralProfileDetail(options).then((request) => request(this.axios, this.basePath));
}
}