diff options
Diffstat (limited to 'src/api/apis')
| -rw-r--r-- | src/api/apis/dashboard-api.ts | 134 | ||||
| -rw-r--r-- | src/api/apis/leaderboard-api.ts | 301 | ||||
| -rw-r--r-- | src/api/apis/offerwall-api.ts | 2205 | ||||
| -rw-r--r-- | src/api/apis/profiling-questions-api.ts | 504 | ||||
| -rw-r--r-- | src/api/apis/report-api.ts | 144 | ||||
| -rw-r--r-- | src/api/apis/status-api.ts | 274 | ||||
| -rw-r--r-- | src/api/apis/wallet-api.ts | 774 |
7 files changed, 0 insertions, 4336 deletions
diff --git a/src/api/apis/dashboard-api.ts b/src/api/apis/dashboard-api.ts deleted file mode 100644 index f35213a..0000000 --- a/src/api/apis/dashboard-api.ts +++ /dev/null @@ -1,134 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * General Research Full Service Brokerage API - * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - * - * OpenAPI spec version: 1.1.0 - * - * - * 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 { HTTPValidationError } from '../models'; -import { MarketplaceSummary } from '../models'; -/** - * DashboardApi - axios parameter creator - * @export - */ -export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * - * @summary Marketplace Inventory - * @param {any} marketplace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - marketplaceInventoryDashboardInventoryGet: async (marketplace: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'marketplace' is not null or undefined - if (marketplace === null || marketplace === undefined) { - throw new RequiredError('marketplace','Required parameter marketplace was null or undefined when calling marketplaceInventoryDashboardInventoryGet.'); - } - const localVarPath = `/dashboard/inventory/`; - // 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; - - if (marketplace !== undefined) { - localVarQueryParameter['marketplace'] = marketplace; - } - - 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, - }; - }, - } -}; - -/** - * DashboardApi - functional programming interface - * @export - */ -export const DashboardApiFp = function(configuration?: Configuration) { - return { - /** - * - * @summary Marketplace Inventory - * @param {any} marketplace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async marketplaceInventoryDashboardInventoryGet(marketplace: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<MarketplaceSummary>>> { - const localVarAxiosArgs = await DashboardApiAxiosParamCreator(configuration).marketplaceInventoryDashboardInventoryGet(marketplace, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - } -}; - -/** - * DashboardApi - factory interface - * @export - */ -export const DashboardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - return { - /** - * - * @summary Marketplace Inventory - * @param {any} marketplace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async marketplaceInventoryDashboardInventoryGet(marketplace: any, options?: AxiosRequestConfig): Promise<AxiosResponse<MarketplaceSummary>> { - return DashboardApiFp(configuration).marketplaceInventoryDashboardInventoryGet(marketplace, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * DashboardApi - object-oriented interface - * @export - * @class DashboardApi - * @extends {BaseAPI} - */ -export class DashboardApi extends BaseAPI { - /** - * - * @summary Marketplace Inventory - * @param {any} marketplace - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DashboardApi - */ - public async marketplaceInventoryDashboardInventoryGet(marketplace: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<MarketplaceSummary>> { - return DashboardApiFp(this.configuration).marketplaceInventoryDashboardInventoryGet(marketplace, options).then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/api/apis/leaderboard-api.ts b/src/api/apis/leaderboard-api.ts deleted file mode 100644 index 26e8c95..0000000 --- a/src/api/apis/leaderboard-api.ts +++ /dev/null @@ -1,301 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * General Research Full Service Brokerage API - * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - * - * OpenAPI spec version: 1.1.0 - * - * - * 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 { HTTPValidationError } from '../models'; -import { LeaderboardResponse } from '../models'; -import { LeaderboardWinnerResponse } from '../models'; -/** - * LeaderboardApi - axios parameter creator - * @export - */ -export const LeaderboardApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Get the Winners of leaderboard contests - * @summary Leaderboard Winners - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet: async (productId: any, boardCode: any, freq: any, countryIso: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet.'); - } - // verify required parameter 'boardCode' is not null or undefined - if (boardCode === null || boardCode === undefined) { - throw new RequiredError('boardCode','Required parameter boardCode was null or undefined when calling leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet.'); - } - // verify required parameter 'freq' is not null or undefined - if (freq === null || freq === undefined) { - throw new RequiredError('freq','Required parameter freq was null or undefined when calling leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet.'); - } - // verify required parameter 'countryIso' is not null or undefined - if (countryIso === null || countryIso === undefined) { - throw new RequiredError('countryIso','Required parameter countryIso was null or undefined when calling leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet.'); - } - const localVarPath = `/{product_id}/leaderboard/timespan/{board_code}/winners/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) - .replace(`{${"board_code"}}`, encodeURIComponent(String(boardCode))); - // 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; - - if (freq !== undefined) { - localVarQueryParameter['freq'] = freq; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - 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 Timespan Leaderboard - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [bpuid] Brokerage Product User ID. If passed, then the country is not required; the country is determined by this user's latest IP. - * @param {any} [timestamp] The start timestamp for the requested leaderboard. If NULL, uses the current time period. - * @param {any} [scope] If scope is \"user\", then `bp_user_id` must be set. Results in filtering rows to include only this user's row, plus rows above and below in rank (up to `limit` rows). If \"global\", then the top `limit` rows are returned. - * @param {any} [limit] Max number of rows to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet: async (productId: any, boardCode: any, freq: any, countryIso?: any, bpuid?: any, timestamp?: any, scope?: any, limit?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet.'); - } - // verify required parameter 'boardCode' is not null or undefined - if (boardCode === null || boardCode === undefined) { - throw new RequiredError('boardCode','Required parameter boardCode was null or undefined when calling timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet.'); - } - // verify required parameter 'freq' is not null or undefined - if (freq === null || freq === undefined) { - throw new RequiredError('freq','Required parameter freq was null or undefined when calling timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet.'); - } - const localVarPath = `/{product_id}/leaderboard/timespan/{board_code}/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) - .replace(`{${"board_code"}}`, encodeURIComponent(String(boardCode))); - // 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; - - if (freq !== undefined) { - localVarQueryParameter['freq'] = freq; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (scope !== undefined) { - localVarQueryParameter['scope'] = scope; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - 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, - }; - }, - } -}; - -/** - * LeaderboardApi - functional programming interface - * @export - */ -export const LeaderboardApiFp = function(configuration?: Configuration) { - return { - /** - * Get the Winners of leaderboard contests - * @summary Leaderboard Winners - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: any, boardCode: any, freq: any, countryIso: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<LeaderboardWinnerResponse>>> { - const localVarAxiosArgs = await LeaderboardApiAxiosParamCreator(configuration).leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId, boardCode, freq, countryIso, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * - * @summary Timespan Leaderboard - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [bpuid] Brokerage Product User ID. If passed, then the country is not required; the country is determined by this user's latest IP. - * @param {any} [timestamp] The start timestamp for the requested leaderboard. If NULL, uses the current time period. - * @param {any} [scope] If scope is \"user\", then `bp_user_id` must be set. Results in filtering rows to include only this user's row, plus rows above and below in rank (up to `limit` rows). If \"global\", then the top `limit` rows are returned. - * @param {any} [limit] Max number of rows to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: any, boardCode: any, freq: any, countryIso?: any, bpuid?: any, timestamp?: any, scope?: any, limit?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<LeaderboardResponse>>> { - const localVarAxiosArgs = await LeaderboardApiAxiosParamCreator(configuration).timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId, boardCode, freq, countryIso, bpuid, timestamp, scope, limit, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - } -}; - -/** - * LeaderboardApi - factory interface - * @export - */ -export const LeaderboardApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - return { - /** - * Get the Winners of leaderboard contests - * @summary Leaderboard Winners - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: any, boardCode: any, freq: any, countryIso: any, options?: AxiosRequestConfig): Promise<AxiosResponse<LeaderboardWinnerResponse>> { - return LeaderboardApiFp(configuration).leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId, boardCode, freq, countryIso, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary Timespan Leaderboard - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [bpuid] Brokerage Product User ID. If passed, then the country is not required; the country is determined by this user's latest IP. - * @param {any} [timestamp] The start timestamp for the requested leaderboard. If NULL, uses the current time period. - * @param {any} [scope] If scope is \"user\", then `bp_user_id` must be set. Results in filtering rows to include only this user's row, plus rows above and below in rank (up to `limit` rows). If \"global\", then the top `limit` rows are returned. - * @param {any} [limit] Max number of rows to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: any, boardCode: any, freq: any, countryIso?: any, bpuid?: any, timestamp?: any, scope?: any, limit?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<LeaderboardResponse>> { - return LeaderboardApiFp(configuration).timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId, boardCode, freq, countryIso, bpuid, timestamp, scope, limit, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * LeaderboardApi - object-oriented interface - * @export - * @class LeaderboardApi - * @extends {BaseAPI} - */ -export class LeaderboardApi extends BaseAPI { - /** - * Get the Winners of leaderboard contests - * @summary Leaderboard Winners - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LeaderboardApi - */ - public async leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: any, boardCode: any, freq: any, countryIso: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<LeaderboardWinnerResponse>> { - return LeaderboardApiFp(this.configuration).leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId, boardCode, freq, countryIso, options).then((request) => request(this.axios, this.basePath)); - } - /** - * - * @summary Timespan Leaderboard - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} boardCode The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts - * @param {any} freq The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [bpuid] Brokerage Product User ID. If passed, then the country is not required; the country is determined by this user's latest IP. - * @param {any} [timestamp] The start timestamp for the requested leaderboard. If NULL, uses the current time period. - * @param {any} [scope] If scope is \"user\", then `bp_user_id` must be set. Results in filtering rows to include only this user's row, plus rows above and below in rank (up to `limit` rows). If \"global\", then the top `limit` rows are returned. - * @param {any} [limit] Max number of rows to return - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof LeaderboardApi - */ - public async timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: any, boardCode: any, freq: any, countryIso?: any, bpuid?: any, timestamp?: any, scope?: any, limit?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<LeaderboardResponse>> { - return LeaderboardApiFp(this.configuration).timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId, boardCode, freq, countryIso, bpuid, timestamp, scope, limit, options).then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/api/apis/offerwall-api.ts b/src/api/apis/offerwall-api.ts deleted file mode 100644 index a49c613..0000000 --- a/src/api/apis/offerwall-api.ts +++ /dev/null @@ -1,2205 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * General Research Full Service Brokerage API - * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - * - * OpenAPI spec version: 1.1.0 - * - * - * 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 { BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost } from '../models'; -import { HTTPValidationError } from '../models'; -import { MarketplaceOfferwallResponse } from '../models'; -import { OneShotOfferwallResponse } from '../models'; -import { SingleEntryOfferWallResponse } from '../models'; -import { SoftPairOfferwallResponse } from '../models'; -import { StarwallOfferWallResponse } from '../models'; -import { StarwallPlusBlockOfferWallResponse } from '../models'; -import { StarwallPlusBlockRecontactOfferWallResponse } from '../models'; -import { StarwallPlusOfferWallResponse } from '../models'; -import { TopNOfferWallResponse } from '../models'; -import { TopNPlusBlockOfferWallResponse } from '../models'; -import { TopNPlusBlockRecontactOfferWallResponse } from '../models'; -import { TopNPlusOfferWallResponse } from '../models'; -import { WXETOfferwallResponse } from '../models'; -/** - * OfferwallApi - axios parameter creator - * @export - */ -export const OfferwallApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Returns buckets grouped by marketplace, one per marketplace, with the tasks ordered by quality. - * @summary Marketplace Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - marketplaceOfferwallProductIdOfferwall5fa23085Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling marketplaceOfferwallProductIdOfferwall5fa23085Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling marketplaceOfferwallProductIdOfferwall5fa23085Get.'); - } - const localVarPath = `/{product_id}/offerwall/5fa23085/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - 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, - }; - }, - /** - * This is a custom endpoint for a softpair-style offerwall that allows you to update profiling answers and then immediately get back the updated offerwall - * @summary Offerwall Softpair Post - * @param {BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} offerwallId The offerwall ID the user is interacting with - * @param {any} sessionId A session id (uuid4.hex) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost: async (body: BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost, bpuid: any, productId: any, offerwallId: any, sessionId: any, 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 offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.'); - } - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.'); - } - // verify required parameter 'offerwallId' is not null or undefined - if (offerwallId === null || offerwallId === undefined) { - throw new RequiredError('offerwallId','Required parameter offerwallId was null or undefined when calling offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.'); - } - // 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 offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.'); - } - const localVarPath = `/{product_id}/offerwall/37d1da64/{offerwall_id}/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) - .replace(`{${"offerwall_id"}}`, encodeURIComponent(String(offerwallId))) - .replace(`{${"session_id"}}`, 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - 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, - }; - }, - /** - * This offerwall contains tasks for which the user has a conditional eligibility. The questions that a user must answer to determine the eligibility are included within each bucket. Additionally, the question definitions are included for convenience. - * @summary Offerwall Softpair - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [maxOptions] Max number of options an allowed question can have (allowed to be asked) - * @param {any} [maxQuestions] Max number of missing questions on a single bin - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - offerwallSoftpairProductIdOfferwall37d1da64Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, maxOptions?: any, maxQuestions?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling offerwallSoftpairProductIdOfferwall37d1da64Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling offerwallSoftpairProductIdOfferwall37d1da64Get.'); - } - const localVarPath = `/{product_id}/offerwall/37d1da64/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (maxOptions !== undefined) { - localVarQueryParameter['max_options'] = maxOptions; - } - - if (maxQuestions !== undefined) { - localVarQueryParameter['max_questions'] = maxQuestions; - } - - 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, - }; - }, - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary One Shot Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [sources] Restrict tasks to those from these marketplaces only. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - oneShotOfferwallProductIdOfferwall6f27b1aeGet: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, sources?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling oneShotOfferwallProductIdOfferwall6f27b1aeGet.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling oneShotOfferwallProductIdOfferwall6f27b1aeGet.'); - } - const localVarPath = `/{product_id}/offerwall/6f27b1ae/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (sources !== undefined) { - localVarQueryParameter['sources'] = sources; - } - - 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, - }; - }, - /** - * Only returns a single bucket with the top scoring tasks. - * @summary Single Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - singleOfferwallProductIdOfferwall5fl8bpv5Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling singleOfferwallProductIdOfferwall5fl8bpv5Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling singleOfferwallProductIdOfferwall5fl8bpv5Get.'); - } - const localVarPath = `/{product_id}/offerwall/5fl8bpv5/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - 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, - }; - }, - /** - * Returns an offerwall with buckets that are clustered by setting as seeds the highest scoring surveys for each bin, then the rest are distributed according to their Euclidean distance using the bucket's features. - * @summary Starwall Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - starwallOfferwallProductIdOfferwallB59a2d2bGet: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling starwallOfferwallProductIdOfferwallB59a2d2bGet.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling starwallOfferwallProductIdOfferwallB59a2d2bGet.'); - } - const localVarPath = `/{product_id}/offerwall/b59a2d2b/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Starwall Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get.'); - } - const localVarPath = `/{product_id}/offerwall/7fa1b3f4/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Starwall Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get.'); - } - const localVarPath = `/{product_id}/offerwall/630db2a4/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents. - * @summary Starwall Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - starwallPlusOfferwallProductIdOfferwall5481f322Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling starwallPlusOfferwallProductIdOfferwall5481f322Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling starwallPlusOfferwallProductIdOfferwall5481f322Get.'); - } - const localVarPath = `/{product_id}/offerwall/5481f322/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - * @summary Topn Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topNOfferwallProductIdOfferwall45b7228a7Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling topNOfferwallProductIdOfferwall45b7228a7Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling topNOfferwallProductIdOfferwall45b7228a7Get.'); - } - const localVarPath = `/{product_id}/offerwall/45b7228a7/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Same as the TopNOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Topn Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topNPlusBlockOfferwallProductIdOfferwallD48cce47Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling topNPlusBlockOfferwallProductIdOfferwallD48cce47Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling topNPlusBlockOfferwallProductIdOfferwallD48cce47Get.'); - } - const localVarPath = `/{product_id}/offerwall/d48cce47/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Same as the TopNOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Topn Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get.'); - } - const localVarPath = `/{product_id}/offerwall/1e5f0af8/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Same as the TopNOfferWall, but the buckets include contents. - * @summary Topn Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topNPlusOfferwallProductIdOfferwallB145b803Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling topNPlusOfferwallProductIdOfferwallB145b803Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling topNPlusOfferwallProductIdOfferwallB145b803Get.'); - } - const localVarPath = `/{product_id}/offerwall/b145b803/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - if (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - if (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - 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, - }; - }, - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary Wxet Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - wXETOfferwallProductIdOfferwall55a4e1a9Get: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling wXETOfferwallProductIdOfferwall55a4e1a9Get.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling wXETOfferwallProductIdOfferwall55a4e1a9Get.'); - } - const localVarPath = `/{product_id}/offerwall/55a4e1a9/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languages !== undefined) { - localVarQueryParameter['languages'] = languages; - } - - if (behavior !== undefined) { - localVarQueryParameter['behavior'] = behavior; - } - - if (minPayout !== undefined) { - localVarQueryParameter['min_payout'] = minPayout; - } - - if (duration !== undefined) { - localVarQueryParameter['duration'] = duration; - } - - if (nBins !== undefined) { - localVarQueryParameter['n_bins'] = nBins; - } - - 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, - }; - }, - } -}; - -/** - * OfferwallApi - functional programming interface - * @export - */ -export const OfferwallApiFp = function(configuration?: Configuration) { - return { - /** - * Returns buckets grouped by marketplace, one per marketplace, with the tasks ordered by quality. - * @summary Marketplace Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async marketplaceOfferwallProductIdOfferwall5fa23085Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<MarketplaceOfferwallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).marketplaceOfferwallProductIdOfferwall5fa23085Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, minBinSize, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * This is a custom endpoint for a softpair-style offerwall that allows you to update profiling answers and then immediately get back the updated offerwall - * @summary Offerwall Softpair Post - * @param {BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} offerwallId The offerwall ID the user is interacting with - * @param {any} sessionId A session id (uuid4.hex) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost(body: BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost, bpuid: any, productId: any, offerwallId: any, sessionId: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SoftPairOfferwallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost(body, bpuid, productId, offerwallId, sessionId, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * This offerwall contains tasks for which the user has a conditional eligibility. The questions that a user must answer to determine the eligibility are included within each bucket. Additionally, the question definitions are included for convenience. - * @summary Offerwall Softpair - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [maxOptions] Max number of options an allowed question can have (allowed to be asked) - * @param {any} [maxQuestions] Max number of missing questions on a single bin - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async offerwallSoftpairProductIdOfferwall37d1da64Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, maxOptions?: any, maxQuestions?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SoftPairOfferwallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).offerwallSoftpairProductIdOfferwall37d1da64Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, maxOptions, maxQuestions, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary One Shot Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [sources] Restrict tasks to those from these marketplaces only. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async oneShotOfferwallProductIdOfferwall6f27b1aeGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, sources?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OneShotOfferwallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).oneShotOfferwallProductIdOfferwall6f27b1aeGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, sources, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Only returns a single bucket with the top scoring tasks. - * @summary Single Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async singleOfferwallProductIdOfferwall5fl8bpv5Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<SingleEntryOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).singleOfferwallProductIdOfferwall5fl8bpv5Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, minBinSize, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Returns an offerwall with buckets that are clustered by setting as seeds the highest scoring surveys for each bin, then the rest are distributed according to their Euclidean distance using the bucket's features. - * @summary Starwall Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallOfferwallProductIdOfferwallB59a2d2bGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StarwallOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).starwallOfferwallProductIdOfferwallB59a2d2bGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Starwall Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StarwallPlusBlockOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Starwall Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StarwallPlusBlockRecontactOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents. - * @summary Starwall Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallPlusOfferwallProductIdOfferwall5481f322Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StarwallPlusOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).starwallPlusOfferwallProductIdOfferwall5481f322Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - * @summary Topn Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNOfferwallProductIdOfferwall45b7228a7Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TopNOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).topNOfferwallProductIdOfferwall45b7228a7Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Same as the TopNOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Topn Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNPlusBlockOfferwallProductIdOfferwallD48cce47Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TopNPlusBlockOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).topNPlusBlockOfferwallProductIdOfferwallD48cce47Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Same as the TopNOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Topn Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TopNPlusBlockRecontactOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Same as the TopNOfferWall, but the buckets include contents. - * @summary Topn Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNPlusOfferwallProductIdOfferwallB145b803Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TopNPlusOfferWallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).topNPlusOfferwallProductIdOfferwallB145b803Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary Wxet Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async wXETOfferwallProductIdOfferwall55a4e1a9Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<WXETOfferwallResponse>>> { - const localVarAxiosArgs = await OfferwallApiAxiosParamCreator(configuration).wXETOfferwallProductIdOfferwall55a4e1a9Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - } -}; - -/** - * OfferwallApi - factory interface - * @export - */ -export const OfferwallApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - return { - /** - * Returns buckets grouped by marketplace, one per marketplace, with the tasks ordered by quality. - * @summary Marketplace Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async marketplaceOfferwallProductIdOfferwall5fa23085Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<MarketplaceOfferwallResponse>> { - return OfferwallApiFp(configuration).marketplaceOfferwallProductIdOfferwall5fa23085Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, minBinSize, options).then((request) => request(axios, basePath)); - }, - /** - * This is a custom endpoint for a softpair-style offerwall that allows you to update profiling answers and then immediately get back the updated offerwall - * @summary Offerwall Softpair Post - * @param {BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} offerwallId The offerwall ID the user is interacting with - * @param {any} sessionId A session id (uuid4.hex) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost(body: BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost, bpuid: any, productId: any, offerwallId: any, sessionId: any, options?: AxiosRequestConfig): Promise<AxiosResponse<SoftPairOfferwallResponse>> { - return OfferwallApiFp(configuration).offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost(body, bpuid, productId, offerwallId, sessionId, options).then((request) => request(axios, basePath)); - }, - /** - * This offerwall contains tasks for which the user has a conditional eligibility. The questions that a user must answer to determine the eligibility are included within each bucket. Additionally, the question definitions are included for convenience. - * @summary Offerwall Softpair - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [maxOptions] Max number of options an allowed question can have (allowed to be asked) - * @param {any} [maxQuestions] Max number of missing questions on a single bin - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async offerwallSoftpairProductIdOfferwall37d1da64Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, maxOptions?: any, maxQuestions?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<SoftPairOfferwallResponse>> { - return OfferwallApiFp(configuration).offerwallSoftpairProductIdOfferwall37d1da64Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, maxOptions, maxQuestions, options).then((request) => request(axios, basePath)); - }, - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary One Shot Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [sources] Restrict tasks to those from these marketplaces only. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async oneShotOfferwallProductIdOfferwall6f27b1aeGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, sources?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<OneShotOfferwallResponse>> { - return OfferwallApiFp(configuration).oneShotOfferwallProductIdOfferwall6f27b1aeGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, sources, options).then((request) => request(axios, basePath)); - }, - /** - * Only returns a single bucket with the top scoring tasks. - * @summary Single Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async singleOfferwallProductIdOfferwall5fl8bpv5Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<SingleEntryOfferWallResponse>> { - return OfferwallApiFp(configuration).singleOfferwallProductIdOfferwall5fl8bpv5Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, minBinSize, options).then((request) => request(axios, basePath)); - }, - /** - * Returns an offerwall with buckets that are clustered by setting as seeds the highest scoring surveys for each bin, then the rest are distributed according to their Euclidean distance using the bucket's features. - * @summary Starwall Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallOfferwallProductIdOfferwallB59a2d2bGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<StarwallOfferWallResponse>> { - return OfferwallApiFp(configuration).starwallOfferwallProductIdOfferwallB59a2d2bGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Starwall Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<StarwallPlusBlockOfferWallResponse>> { - return OfferwallApiFp(configuration).starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Starwall Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<StarwallPlusBlockRecontactOfferWallResponse>> { - return OfferwallApiFp(configuration).starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Same as the StarwallOfferWall, but the buckets include contents. - * @summary Starwall Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallPlusOfferwallProductIdOfferwall5481f322Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<StarwallPlusOfferWallResponse>> { - return OfferwallApiFp(configuration).starwallPlusOfferwallProductIdOfferwall5481f322Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - * @summary Topn Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNOfferwallProductIdOfferwall45b7228a7Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<TopNOfferWallResponse>> { - return OfferwallApiFp(configuration).topNOfferwallProductIdOfferwall45b7228a7Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Same as the TopNOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Topn Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNPlusBlockOfferwallProductIdOfferwallD48cce47Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<TopNPlusBlockOfferWallResponse>> { - return OfferwallApiFp(configuration).topNPlusBlockOfferwallProductIdOfferwallD48cce47Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Same as the TopNOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Topn Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<TopNPlusBlockRecontactOfferWallResponse>> { - return OfferwallApiFp(configuration).topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Same as the TopNOfferWall, but the buckets include contents. - * @summary Topn Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNPlusOfferwallProductIdOfferwallB145b803Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<TopNPlusOfferWallResponse>> { - return OfferwallApiFp(configuration).topNPlusOfferwallProductIdOfferwallB145b803Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(axios, basePath)); - }, - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary Wxet Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async wXETOfferwallProductIdOfferwall55a4e1a9Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<WXETOfferwallResponse>> { - return OfferwallApiFp(configuration).wXETOfferwallProductIdOfferwall55a4e1a9Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * OfferwallApi - object-oriented interface - * @export - * @class OfferwallApi - * @extends {BaseAPI} - */ -export class OfferwallApi extends BaseAPI { - /** - * Returns buckets grouped by marketplace, one per marketplace, with the tasks ordered by quality. - * @summary Marketplace Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async marketplaceOfferwallProductIdOfferwall5fa23085Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<MarketplaceOfferwallResponse>> { - return OfferwallApiFp(this.configuration).marketplaceOfferwallProductIdOfferwall5fa23085Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, minBinSize, options).then((request) => request(this.axios, this.basePath)); - } - /** - * This is a custom endpoint for a softpair-style offerwall that allows you to update profiling answers and then immediately get back the updated offerwall - * @summary Offerwall Softpair Post - * @param {BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} offerwallId The offerwall ID the user is interacting with - * @param {any} sessionId A session id (uuid4.hex) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost(body: BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost, bpuid: any, productId: any, offerwallId: any, sessionId: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<SoftPairOfferwallResponse>> { - return OfferwallApiFp(this.configuration).offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost(body, bpuid, productId, offerwallId, sessionId, options).then((request) => request(this.axios, this.basePath)); - } - /** - * This offerwall contains tasks for which the user has a conditional eligibility. The questions that a user must answer to determine the eligibility are included within each bucket. Additionally, the question definitions are included for convenience. - * @summary Offerwall Softpair - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [maxOptions] Max number of options an allowed question can have (allowed to be asked) - * @param {any} [maxQuestions] Max number of missing questions on a single bin - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async offerwallSoftpairProductIdOfferwall37d1da64Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, maxOptions?: any, maxQuestions?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<SoftPairOfferwallResponse>> { - return OfferwallApiFp(this.configuration).offerwallSoftpairProductIdOfferwall37d1da64Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, maxOptions, maxQuestions, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary One Shot Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [sources] Restrict tasks to those from these marketplaces only. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async oneShotOfferwallProductIdOfferwall6f27b1aeGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, sources?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<OneShotOfferwallResponse>> { - return OfferwallApiFp(this.configuration).oneShotOfferwallProductIdOfferwall6f27b1aeGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, sources, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Only returns a single bucket with the top scoring tasks. - * @summary Single Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async singleOfferwallProductIdOfferwall5fl8bpv5Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, minBinSize?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<SingleEntryOfferWallResponse>> { - return OfferwallApiFp(this.configuration).singleOfferwallProductIdOfferwall5fl8bpv5Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, minBinSize, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Returns an offerwall with buckets that are clustered by setting as seeds the highest scoring surveys for each bin, then the rest are distributed according to their Euclidean distance using the bucket's features. - * @summary Starwall Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async starwallOfferwallProductIdOfferwallB59a2d2bGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<StarwallOfferWallResponse>> { - return OfferwallApiFp(this.configuration).starwallOfferwallProductIdOfferwallB59a2d2bGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Same as the StarwallOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Starwall Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<StarwallPlusBlockOfferWallResponse>> { - return OfferwallApiFp(this.configuration).starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Same as the StarwallOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Starwall Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<StarwallPlusBlockRecontactOfferWallResponse>> { - return OfferwallApiFp(this.configuration).starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Same as the StarwallOfferWall, but the buckets include contents. - * @summary Starwall Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async starwallPlusOfferwallProductIdOfferwall5481f322Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<StarwallPlusOfferWallResponse>> { - return OfferwallApiFp(this.configuration).starwallPlusOfferwallProductIdOfferwall5481f322Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - * @summary Topn Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async topNOfferwallProductIdOfferwall45b7228a7Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<TopNOfferWallResponse>> { - return OfferwallApiFp(this.configuration).topNOfferwallProductIdOfferwall45b7228a7Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Same as the TopNOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. - * @summary Topn Plus Block Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async topNPlusBlockOfferwallProductIdOfferwallD48cce47Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<TopNPlusBlockOfferWallResponse>> { - return OfferwallApiFp(this.configuration).topNPlusBlockOfferwallProductIdOfferwallD48cce47Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Same as the TopNOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. - * @summary Topn Plus Block Recontact Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<TopNPlusBlockRecontactOfferWallResponse>> { - return OfferwallApiFp(this.configuration).topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Same as the TopNOfferWall, but the buckets include contents. - * @summary Topn Plus Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {any} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {any} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async topNPlusOfferwallProductIdOfferwallB145b803Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, minBinSize?: any, splitBy?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<TopNPlusOfferWallResponse>> { - return OfferwallApiFp(this.configuration).topNPlusOfferwallProductIdOfferwallB145b803Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Each bucket has only 1 single task, and only basic info is returned about each bucket. - * @summary Wxet Offerwall - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languages] Respondent's desired languages (ISO 639-2/B, lowercase) - * @param {any} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. - * @param {any} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay - * @param {any} [duration] Maximum length of desired task (in seconds). - * @param {any} [nBins] Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public async wXETOfferwallProductIdOfferwall55a4e1a9Get(productId: any, bpuid: any, ip?: any, countryIso?: any, languages?: any, behavior?: any, minPayout?: any, duration?: any, nBins?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<WXETOfferwallResponse>> { - return OfferwallApiFp(this.configuration).wXETOfferwallProductIdOfferwall55a4e1a9Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, options).then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/api/apis/profiling-questions-api.ts b/src/api/apis/profiling-questions-api.ts deleted file mode 100644 index cdcdb85..0000000 --- a/src/api/apis/profiling-questions-api.ts +++ /dev/null @@ -1,504 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * General Research Full Service Brokerage API - * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - * - * OpenAPI spec version: 1.1.0 - * - * - * 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 { BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost } from '../models'; -import { HTTPValidationError } from '../models'; -import { ProfilingInfoResponse } from '../models'; -import { StatusResponse } from '../models'; -import { UpkQuestionResponse } from '../models'; -import { UserInfoResponse } from '../models'; -/** - * ProfilingQuestionsApi - axios parameter creator - * @export - */ -export const ProfilingQuestionsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Gets a list of profiling questions to ask this user. These questions are, as of right now, unanswered. Once a question is answered, it (and any other question whose answer is inferred from other answers) is removed from the list. The questions returned are ordered by importance (the key task_score) in descending order. - * @summary Get Profiling Questions - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {any} [limit] Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions' importance. - * @param {any} [isGrs] If it's the GRS system. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getProfilingQuestionsProductIdProfilingQuestionsGet: async (productId: any, bpuid: any, ip?: any, countryIso?: any, languageIso?: any, limit?: any, isGrs?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling getProfilingQuestionsProductIdProfilingQuestionsGet.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling getProfilingQuestionsProductIdProfilingQuestionsGet.'); - } - const localVarPath = `/{product_id}/profiling-questions/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (ip !== undefined) { - localVarQueryParameter['ip'] = ip; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languageIso !== undefined) { - localVarQueryParameter['language_iso'] = languageIso; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (isGrs !== undefined) { - localVarQueryParameter['is_grs'] = isGrs; - } - - 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, - }; - }, - /** - * Get UPK Ontology (list of properties, property info, and allowed values) - * @summary Profiling Info - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - profilingInfoProductIdProfilingInfoGet: async (productId: any, countryIso: any, languageIso?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling profilingInfoProductIdProfilingInfoGet.'); - } - // verify required parameter 'countryIso' is not null or undefined - if (countryIso === null || countryIso === undefined) { - throw new RequiredError('countryIso','Required parameter countryIso was null or undefined when calling profilingInfoProductIdProfilingInfoGet.'); - } - const localVarPath = `/{product_id}/profiling-info/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languageIso !== undefined) { - localVarQueryParameter['language_iso'] = languageIso; - } - - 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, - }; - }, - /** - * Send the answers to one or more of these questions for a user. A question is uniquely specified by the question_id key. The answer is: the choice_id if the question_type is \"MC\" the actual entered text if the question_type is \"TE\" - * @summary Submit Profiling Questions - * @param {BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [sessionId] The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. - * @param {any} [async] For internal use. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitProfilingQuestionsProductIdProfilingQuestionsPost: async (body: BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost, bpuid: any, productId: any, sessionId?: any, async?: any, 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 submitProfilingQuestionsProductIdProfilingQuestionsPost.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling submitProfilingQuestionsProductIdProfilingQuestionsPost.'); - } - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling submitProfilingQuestionsProductIdProfilingQuestionsPost.'); - } - const localVarPath = `/{product_id}/profiling-questions/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (sessionId !== undefined) { - localVarQueryParameter['session_id'] = sessionId; - } - - if (async !== undefined) { - localVarQueryParameter['async'] = async; - } - - 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 User Profile - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - userProfileProductIdUserProfileGet: async (productId: any, bpuid: any, countryIso: any, languageIso?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling userProfileProductIdUserProfileGet.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling userProfileProductIdUserProfileGet.'); - } - // verify required parameter 'countryIso' is not null or undefined - if (countryIso === null || countryIso === undefined) { - throw new RequiredError('countryIso','Required parameter countryIso was null or undefined when calling userProfileProductIdUserProfileGet.'); - } - const localVarPath = `/{product_id}/user-profile/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (countryIso !== undefined) { - localVarQueryParameter['country_iso'] = countryIso; - } - - if (languageIso !== undefined) { - localVarQueryParameter['language_iso'] = languageIso; - } - - 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, - }; - }, - } -}; - -/** - * ProfilingQuestionsApi - functional programming interface - * @export - */ -export const ProfilingQuestionsApiFp = function(configuration?: Configuration) { - return { - /** - * Gets a list of profiling questions to ask this user. These questions are, as of right now, unanswered. Once a question is answered, it (and any other question whose answer is inferred from other answers) is removed from the list. The questions returned are ordered by importance (the key task_score) in descending order. - * @summary Get Profiling Questions - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {any} [limit] Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions' importance. - * @param {any} [isGrs] If it's the GRS system. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getProfilingQuestionsProductIdProfilingQuestionsGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languageIso?: any, limit?: any, isGrs?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UpkQuestionResponse>>> { - const localVarAxiosArgs = await ProfilingQuestionsApiAxiosParamCreator(configuration).getProfilingQuestionsProductIdProfilingQuestionsGet(productId, bpuid, ip, countryIso, languageIso, limit, isGrs, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Get UPK Ontology (list of properties, property info, and allowed values) - * @summary Profiling Info - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async profilingInfoProductIdProfilingInfoGet(productId: any, countryIso: any, languageIso?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ProfilingInfoResponse>>> { - const localVarAxiosArgs = await ProfilingQuestionsApiAxiosParamCreator(configuration).profilingInfoProductIdProfilingInfoGet(productId, countryIso, languageIso, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Send the answers to one or more of these questions for a user. A question is uniquely specified by the question_id key. The answer is: the choice_id if the question_type is \"MC\" the actual entered text if the question_type is \"TE\" - * @summary Submit Profiling Questions - * @param {BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [sessionId] The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. - * @param {any} [async] For internal use. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitProfilingQuestionsProductIdProfilingQuestionsPost(body: BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost, bpuid: any, productId: any, sessionId?: any, async?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StatusResponse>>> { - const localVarAxiosArgs = await ProfilingQuestionsApiAxiosParamCreator(configuration).submitProfilingQuestionsProductIdProfilingQuestionsPost(body, bpuid, productId, sessionId, async, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * - * @summary User Profile - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userProfileProductIdUserProfileGet(productId: any, bpuid: any, countryIso: any, languageIso?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserInfoResponse>>> { - const localVarAxiosArgs = await ProfilingQuestionsApiAxiosParamCreator(configuration).userProfileProductIdUserProfileGet(productId, bpuid, countryIso, languageIso, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - } -}; - -/** - * ProfilingQuestionsApi - factory interface - * @export - */ -export const ProfilingQuestionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - return { - /** - * Gets a list of profiling questions to ask this user. These questions are, as of right now, unanswered. Once a question is answered, it (and any other question whose answer is inferred from other answers) is removed from the list. The questions returned are ordered by importance (the key task_score) in descending order. - * @summary Get Profiling Questions - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {any} [limit] Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions' importance. - * @param {any} [isGrs] If it's the GRS system. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getProfilingQuestionsProductIdProfilingQuestionsGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languageIso?: any, limit?: any, isGrs?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<UpkQuestionResponse>> { - return ProfilingQuestionsApiFp(configuration).getProfilingQuestionsProductIdProfilingQuestionsGet(productId, bpuid, ip, countryIso, languageIso, limit, isGrs, options).then((request) => request(axios, basePath)); - }, - /** - * Get UPK Ontology (list of properties, property info, and allowed values) - * @summary Profiling Info - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async profilingInfoProductIdProfilingInfoGet(productId: any, countryIso: any, languageIso?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<ProfilingInfoResponse>> { - return ProfilingQuestionsApiFp(configuration).profilingInfoProductIdProfilingInfoGet(productId, countryIso, languageIso, options).then((request) => request(axios, basePath)); - }, - /** - * Send the answers to one or more of these questions for a user. A question is uniquely specified by the question_id key. The answer is: the choice_id if the question_type is \"MC\" the actual entered text if the question_type is \"TE\" - * @summary Submit Profiling Questions - * @param {BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [sessionId] The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. - * @param {any} [async] For internal use. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitProfilingQuestionsProductIdProfilingQuestionsPost(body: BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost, bpuid: any, productId: any, sessionId?: any, async?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<StatusResponse>> { - return ProfilingQuestionsApiFp(configuration).submitProfilingQuestionsProductIdProfilingQuestionsPost(body, bpuid, productId, sessionId, async, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary User Profile - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async userProfileProductIdUserProfileGet(productId: any, bpuid: any, countryIso: any, languageIso?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<UserInfoResponse>> { - return ProfilingQuestionsApiFp(configuration).userProfileProductIdUserProfileGet(productId, bpuid, countryIso, languageIso, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * ProfilingQuestionsApi - object-oriented interface - * @export - * @class ProfilingQuestionsApi - * @extends {BaseAPI} - */ -export class ProfilingQuestionsApi extends BaseAPI { - /** - * Gets a list of profiling questions to ask this user. These questions are, as of right now, unanswered. Once a question is answered, it (and any other question whose answer is inferred from other answers) is removed from the list. The questions returned are ordered by importance (the key task_score) in descending order. - * @summary Get Profiling Questions - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} [ip] Respondent's IP address (IPv4 or IPv6). Either 'ip' must be provided, or 'country_iso' must be provided if 'ip' is not provided. - * @param {any} [countryIso] Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {any} [limit] Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions' importance. - * @param {any} [isGrs] If it's the GRS system. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ProfilingQuestionsApi - */ - public async getProfilingQuestionsProductIdProfilingQuestionsGet(productId: any, bpuid: any, ip?: any, countryIso?: any, languageIso?: any, limit?: any, isGrs?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<UpkQuestionResponse>> { - return ProfilingQuestionsApiFp(this.configuration).getProfilingQuestionsProductIdProfilingQuestionsGet(productId, bpuid, ip, countryIso, languageIso, limit, isGrs, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Get UPK Ontology (list of properties, property info, and allowed values) - * @summary Profiling Info - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ProfilingQuestionsApi - */ - public async profilingInfoProductIdProfilingInfoGet(productId: any, countryIso: any, languageIso?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<ProfilingInfoResponse>> { - return ProfilingQuestionsApiFp(this.configuration).profilingInfoProductIdProfilingInfoGet(productId, countryIso, languageIso, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Send the answers to one or more of these questions for a user. A question is uniquely specified by the question_id key. The answer is: the choice_id if the question_type is \"MC\" the actual entered text if the question_type is \"TE\" - * @summary Submit Profiling Questions - * @param {BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost} body - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [sessionId] The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. - * @param {any} [async] For internal use. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ProfilingQuestionsApi - */ - public async submitProfilingQuestionsProductIdProfilingQuestionsPost(body: BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost, bpuid: any, productId: any, sessionId?: any, async?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<StatusResponse>> { - return ProfilingQuestionsApiFp(this.configuration).submitProfilingQuestionsProductIdProfilingQuestionsPost(body, bpuid, productId, sessionId, async, options).then((request) => request(this.axios, this.basePath)); - } - /** - * - * @summary User Profile - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {any} countryIso Respondent's country code (ISO 3166-1 alpha-2, lowercase) - * @param {any} [languageIso] Respondent's desired language (ISO 639-2/B, lowercase) - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ProfilingQuestionsApi - */ - public async userProfileProductIdUserProfileGet(productId: any, bpuid: any, countryIso: any, languageIso?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<UserInfoResponse>> { - return ProfilingQuestionsApiFp(this.configuration).userProfileProductIdUserProfileGet(productId, bpuid, countryIso, languageIso, options).then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/api/apis/report-api.ts b/src/api/apis/report-api.ts deleted file mode 100644 index d3f74b8..0000000 --- a/src/api/apis/report-api.ts +++ /dev/null @@ -1,144 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * General Research Full Service Brokerage API - * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - * - * OpenAPI spec version: 1.1.0 - * - * - * 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 { HTTPValidationError } from '../models'; -import { ReportTask } from '../models'; -import { StatusResponse } from '../models'; -/** - * ReportApi - axios parameter creator - * @export - */ -export const ReportApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Send a \"Task Report\" for a respondent's latest started survey, regardless of the survey's outcome. Task Reports cannot be provided for task attempts by tsid, or through any other method, they must be given immediately after the respondent's task attempt. If a latest attempt can't be found, a ReportTaskResponse is still returned. If multiple reasons want to be provided, they should be done at the same time. If multiple reports are given for the same latest started task, the note attribute will be overwritten, while the new unique reasons will be appended to the task attempt. Task Report system contributions by client applications are immediately leveraged to aid yield management strategies. For those reasons, it's important that the respondent submits a Task Report as soon as possible and applications doesn't offload this request for a later time. Task Report timestamps are a critical component of understanding a Task experience for a respondent. For the BP to tell us about a bad survey they want to report The POSTed data looks like: { 'bpuid': '1234', 'reasons': [2], 'notes': \"This survey was the worst!\" } Returns {'status': 'success', 'msg': error_msg} - * @summary Report Task - * @param {ReportTask} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - reportTaskProductIdReportPost: async (body: ReportTask, productId: any, 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 reportTaskProductIdReportPost.'); - } - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling reportTaskProductIdReportPost.'); - } - const localVarPath = `/{product_id}/report/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - 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, - }; - }, - } -}; - -/** - * ReportApi - functional programming interface - * @export - */ -export const ReportApiFp = function(configuration?: Configuration) { - return { - /** - * Send a \"Task Report\" for a respondent's latest started survey, regardless of the survey's outcome. Task Reports cannot be provided for task attempts by tsid, or through any other method, they must be given immediately after the respondent's task attempt. If a latest attempt can't be found, a ReportTaskResponse is still returned. If multiple reasons want to be provided, they should be done at the same time. If multiple reports are given for the same latest started task, the note attribute will be overwritten, while the new unique reasons will be appended to the task attempt. Task Report system contributions by client applications are immediately leveraged to aid yield management strategies. For those reasons, it's important that the respondent submits a Task Report as soon as possible and applications doesn't offload this request for a later time. Task Report timestamps are a critical component of understanding a Task experience for a respondent. For the BP to tell us about a bad survey they want to report The POSTed data looks like: { 'bpuid': '1234', 'reasons': [2], 'notes': \"This survey was the worst!\" } Returns {'status': 'success', 'msg': error_msg} - * @summary Report Task - * @param {ReportTask} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async reportTaskProductIdReportPost(body: ReportTask, productId: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StatusResponse>>> { - const localVarAxiosArgs = await ReportApiAxiosParamCreator(configuration).reportTaskProductIdReportPost(body, productId, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - } -}; - -/** - * ReportApi - factory interface - * @export - */ -export const ReportApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - return { - /** - * Send a \"Task Report\" for a respondent's latest started survey, regardless of the survey's outcome. Task Reports cannot be provided for task attempts by tsid, or through any other method, they must be given immediately after the respondent's task attempt. If a latest attempt can't be found, a ReportTaskResponse is still returned. If multiple reasons want to be provided, they should be done at the same time. If multiple reports are given for the same latest started task, the note attribute will be overwritten, while the new unique reasons will be appended to the task attempt. Task Report system contributions by client applications are immediately leveraged to aid yield management strategies. For those reasons, it's important that the respondent submits a Task Report as soon as possible and applications doesn't offload this request for a later time. Task Report timestamps are a critical component of understanding a Task experience for a respondent. For the BP to tell us about a bad survey they want to report The POSTed data looks like: { 'bpuid': '1234', 'reasons': [2], 'notes': \"This survey was the worst!\" } Returns {'status': 'success', 'msg': error_msg} - * @summary Report Task - * @param {ReportTask} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async reportTaskProductIdReportPost(body: ReportTask, productId: any, options?: AxiosRequestConfig): Promise<AxiosResponse<StatusResponse>> { - return ReportApiFp(configuration).reportTaskProductIdReportPost(body, productId, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * ReportApi - object-oriented interface - * @export - * @class ReportApi - * @extends {BaseAPI} - */ -export class ReportApi extends BaseAPI { - /** - * Send a \"Task Report\" for a respondent's latest started survey, regardless of the survey's outcome. Task Reports cannot be provided for task attempts by tsid, or through any other method, they must be given immediately after the respondent's task attempt. If a latest attempt can't be found, a ReportTaskResponse is still returned. If multiple reasons want to be provided, they should be done at the same time. If multiple reports are given for the same latest started task, the note attribute will be overwritten, while the new unique reasons will be appended to the task attempt. Task Report system contributions by client applications are immediately leveraged to aid yield management strategies. For those reasons, it's important that the respondent submits a Task Report as soon as possible and applications doesn't offload this request for a later time. Task Report timestamps are a critical component of understanding a Task experience for a respondent. For the BP to tell us about a bad survey they want to report The POSTed data looks like: { 'bpuid': '1234', 'reasons': [2], 'notes': \"This survey was the worst!\" } Returns {'status': 'success', 'msg': error_msg} - * @summary Report Task - * @param {ReportTask} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof ReportApi - */ - public async reportTaskProductIdReportPost(body: ReportTask, productId: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<StatusResponse>> { - return ReportApiFp(this.configuration).reportTaskProductIdReportPost(body, productId, options).then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/api/apis/status-api.ts b/src/api/apis/status-api.ts deleted file mode 100644 index 2a97ffe..0000000 --- a/src/api/apis/status-api.ts +++ /dev/null @@ -1,274 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * General Research Full Service Brokerage API - * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - * - * OpenAPI spec version: 1.1.0 - * - * - * 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 { HTTPValidationError } from '../models'; -import { StatusInfoResponseFail } from '../models'; -import { StatusResponseFailure } from '../models'; -import { TaskStatusResponseOut } from '../models'; -import { TasksStatusResponseOut } from '../models'; -/** - * StatusApi - axios parameter creator - * @export - */ -export const StatusApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Retrieve the status of a session by a specific Task Status ID (`tsid`) that is provided in the redirect. Given a `tsid`, get back the status of the wall event. This endpoint conflates the idea of a wall event and a session, but for these purposes, the status and payout of the last wall event in a session equals the status and payout for the session. - * @summary Get Task Status - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} tsid A unique identifier for the session - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getTaskStatusProductIdStatusTsidGet: async (productId: any, tsid: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling getTaskStatusProductIdStatusTsidGet.'); - } - // verify required parameter 'tsid' is not null or undefined - if (tsid === null || tsid === undefined) { - throw new RequiredError('tsid','Required parameter tsid was null or undefined when calling getTaskStatusProductIdStatusTsidGet.'); - } - const localVarPath = `/{product_id}/status/{tsid}/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) - .replace(`{${"tsid"}}`, encodeURIComponent(String(tsid))); - // 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; - - 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 List Task Statuses - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [bpuid] A unique identifier for each user, which is set by the Supplier. Filters the returned task status to only include those done by this user. - * @param {any} [startedAfter] (unix timestamp) Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. - * @param {any} [startedBefore] (unix timestamp) Retrieve sessions which were started before this timestamp. If `NULL`, default is now. - * @param {any} [status] Filter for sessions with this status. See Task Status for description of status. - * @param {any} [reconciled] Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. - * @param {any} [adjustedAfter] (unix timestamp) Retrieve sessions which were adjusted after this timestamp. - * @param {any} [adjustedBefore] (unix timestamp) Retrieve sessions which were adjusted before this timestamp. Default is now. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listTaskStatusesProductIdStatusGet: async (productId: any, bpuid?: any, startedAfter?: any, startedBefore?: any, status?: any, reconciled?: any, adjustedAfter?: any, adjustedBefore?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling listTaskStatusesProductIdStatusGet.'); - } - const localVarPath = `/{product_id}/status/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - if (startedAfter !== undefined) { - localVarQueryParameter['started_after'] = startedAfter; - } - - if (startedBefore !== undefined) { - localVarQueryParameter['started_before'] = startedBefore; - } - - if (status !== undefined) { - localVarQueryParameter['status'] = status; - } - - if (reconciled !== undefined) { - localVarQueryParameter['reconciled'] = reconciled; - } - - if (adjustedAfter !== undefined) { - localVarQueryParameter['adjusted_after'] = adjustedAfter; - } - - if (adjustedBefore !== undefined) { - localVarQueryParameter['adjusted_before'] = adjustedBefore; - } - - 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, - }; - }, - } -}; - -/** - * StatusApi - functional programming interface - * @export - */ -export const StatusApiFp = function(configuration?: Configuration) { - return { - /** - * Retrieve the status of a session by a specific Task Status ID (`tsid`) that is provided in the redirect. Given a `tsid`, get back the status of the wall event. This endpoint conflates the idea of a wall event and a session, but for these purposes, the status and payout of the last wall event in a session equals the status and payout for the session. - * @summary Get Task Status - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} tsid A unique identifier for the session - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatusProductIdStatusTsidGet(productId: any, tsid: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TaskStatusResponseOut>>> { - const localVarAxiosArgs = await StatusApiAxiosParamCreator(configuration).getTaskStatusProductIdStatusTsidGet(productId, tsid, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * - * @summary List Task Statuses - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [bpuid] A unique identifier for each user, which is set by the Supplier. Filters the returned task status to only include those done by this user. - * @param {any} [startedAfter] (unix timestamp) Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. - * @param {any} [startedBefore] (unix timestamp) Retrieve sessions which were started before this timestamp. If `NULL`, default is now. - * @param {any} [status] Filter for sessions with this status. See Task Status for description of status. - * @param {any} [reconciled] Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. - * @param {any} [adjustedAfter] (unix timestamp) Retrieve sessions which were adjusted after this timestamp. - * @param {any} [adjustedBefore] (unix timestamp) Retrieve sessions which were adjusted before this timestamp. Default is now. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listTaskStatusesProductIdStatusGet(productId: any, bpuid?: any, startedAfter?: any, startedBefore?: any, status?: any, reconciled?: any, adjustedAfter?: any, adjustedBefore?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<TasksStatusResponseOut>>> { - const localVarAxiosArgs = await StatusApiAxiosParamCreator(configuration).listTaskStatusesProductIdStatusGet(productId, bpuid, startedAfter, startedBefore, status, reconciled, adjustedAfter, adjustedBefore, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - } -}; - -/** - * StatusApi - factory interface - * @export - */ -export const StatusApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - return { - /** - * Retrieve the status of a session by a specific Task Status ID (`tsid`) that is provided in the redirect. Given a `tsid`, get back the status of the wall event. This endpoint conflates the idea of a wall event and a session, but for these purposes, the status and payout of the last wall event in a session equals the status and payout for the session. - * @summary Get Task Status - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} tsid A unique identifier for the session - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getTaskStatusProductIdStatusTsidGet(productId: any, tsid: any, options?: AxiosRequestConfig): Promise<AxiosResponse<TaskStatusResponseOut>> { - return StatusApiFp(configuration).getTaskStatusProductIdStatusTsidGet(productId, tsid, options).then((request) => request(axios, basePath)); - }, - /** - * - * @summary List Task Statuses - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [bpuid] A unique identifier for each user, which is set by the Supplier. Filters the returned task status to only include those done by this user. - * @param {any} [startedAfter] (unix timestamp) Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. - * @param {any} [startedBefore] (unix timestamp) Retrieve sessions which were started before this timestamp. If `NULL`, default is now. - * @param {any} [status] Filter for sessions with this status. See Task Status for description of status. - * @param {any} [reconciled] Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. - * @param {any} [adjustedAfter] (unix timestamp) Retrieve sessions which were adjusted after this timestamp. - * @param {any} [adjustedBefore] (unix timestamp) Retrieve sessions which were adjusted before this timestamp. Default is now. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async listTaskStatusesProductIdStatusGet(productId: any, bpuid?: any, startedAfter?: any, startedBefore?: any, status?: any, reconciled?: any, adjustedAfter?: any, adjustedBefore?: any, options?: AxiosRequestConfig): Promise<AxiosResponse<TasksStatusResponseOut>> { - return StatusApiFp(configuration).listTaskStatusesProductIdStatusGet(productId, bpuid, startedAfter, startedBefore, status, reconciled, adjustedAfter, adjustedBefore, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * StatusApi - object-oriented interface - * @export - * @class StatusApi - * @extends {BaseAPI} - */ -export class StatusApi extends BaseAPI { - /** - * Retrieve the status of a session by a specific Task Status ID (`tsid`) that is provided in the redirect. Given a `tsid`, get back the status of the wall event. This endpoint conflates the idea of a wall event and a session, but for these purposes, the status and payout of the last wall event in a session equals the status and payout for the session. - * @summary Get Task Status - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} tsid A unique identifier for the session - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof StatusApi - */ - public async getTaskStatusProductIdStatusTsidGet(productId: any, tsid: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<TaskStatusResponseOut>> { - return StatusApiFp(this.configuration).getTaskStatusProductIdStatusTsidGet(productId, tsid, options).then((request) => request(this.axios, this.basePath)); - } - /** - * - * @summary List Task Statuses - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} [bpuid] A unique identifier for each user, which is set by the Supplier. Filters the returned task status to only include those done by this user. - * @param {any} [startedAfter] (unix timestamp) Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. - * @param {any} [startedBefore] (unix timestamp) Retrieve sessions which were started before this timestamp. If `NULL`, default is now. - * @param {any} [status] Filter for sessions with this status. See Task Status for description of status. - * @param {any} [reconciled] Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. - * @param {any} [adjustedAfter] (unix timestamp) Retrieve sessions which were adjusted after this timestamp. - * @param {any} [adjustedBefore] (unix timestamp) Retrieve sessions which were adjusted before this timestamp. Default is now. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof StatusApi - */ - public async listTaskStatusesProductIdStatusGet(productId: any, bpuid?: any, startedAfter?: any, startedBefore?: any, status?: any, reconciled?: any, adjustedAfter?: any, adjustedBefore?: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<TasksStatusResponseOut>> { - return StatusApiFp(this.configuration).listTaskStatusesProductIdStatusGet(productId, bpuid, startedAfter, startedBefore, status, reconciled, adjustedAfter, adjustedBefore, options).then((request) => request(this.axios, this.basePath)); - } -} diff --git a/src/api/apis/wallet-api.ts b/src/api/apis/wallet-api.ts deleted file mode 100644 index 37a8cee..0000000 --- a/src/api/apis/wallet-api.ts +++ /dev/null @@ -1,774 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * General Research Full Service Brokerage API - * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) - * - * OpenAPI spec version: 1.1.0 - * - * - * 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 { CashoutMethodForeignValueResponse } from '../models'; -import { CashoutMethodResponse } from '../models'; -import { CashoutMethodsResponse } from '../models'; -import { CashoutRequestResponse } from '../models'; -import { CreateCashoutRequest } from '../models'; -import { HTTPValidationError } from '../models'; -import { StatusResponse } from '../models'; -import { UserTransactionHistoryResponse } from '../models'; -import { UserWalletBalanceResponse } from '../models'; -/** - * WalletApi - axios parameter creator - * @export - */ -export const WalletApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * A user can only have 1 unique Cashout Method of any type at a time (eg. they can't create multiple paypal payout methods). Cashout Methods cannot be edited, they can only be created or deleted. Creating different Cashout Methods will require type-dependent request data attributes in order to be successfully created. Currently only creating paypal or Cash in Mail cashout methods are supported - * @summary Create Cashout Method - * @param {any} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - createCashoutMethodProductIdCashoutMethodsPost: async (body: any, productId: any, 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 createCashoutMethodProductIdCashoutMethodsPost.'); - } - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling createCashoutMethodProductIdCashoutMethodsPost.'); - } - const localVarPath = `/{product_id}/cashout_methods/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - 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, - }; - }, - /** - * Delete a cashout method - * @summary Delete Cashout Method - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method to delete - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete: async (productId: any, cashoutMethodId: any, bpuid: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete.'); - } - // verify required parameter 'cashoutMethodId' is not null or undefined - if (cashoutMethodId === null || cashoutMethodId === undefined) { - throw new RequiredError('cashoutMethodId','Required parameter cashoutMethodId was null or undefined when calling deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete.'); - } - const localVarPath = `/{product_id}/cashout_methods/{cashout_method_id}/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) - .replace(`{${"cashout_method_id"}}`, encodeURIComponent(String(cashoutMethodId))); - // 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: 'DELETE', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - 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, - }; - }, - /** - * Retrieve the details for a specific Cashout event - * @summary Get Cashout Detail - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutId The cashout event ID - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCashoutDetailProductIdCashoutCashoutIdGet: async (productId: any, cashoutId: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling getCashoutDetailProductIdCashoutCashoutIdGet.'); - } - // verify required parameter 'cashoutId' is not null or undefined - if (cashoutId === null || cashoutId === undefined) { - throw new RequiredError('cashoutId','Required parameter cashoutId was null or undefined when calling getCashoutDetailProductIdCashoutCashoutIdGet.'); - } - const localVarPath = `/{product_id}/cashout/{cashout_id}/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) - .replace(`{${"cashout_id"}}`, encodeURIComponent(String(cashoutId))); - // 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; - - 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, - }; - }, - /** - * Retrieve the current available mechanisms that a user can use to retrieve funds. - * @summary Get Cashout Methods - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCashoutMethodsProductIdCashoutMethodsGet: async (productId: any, bpuid: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling getCashoutMethodsProductIdCashoutMethodsGet.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling getCashoutMethodsProductIdCashoutMethodsGet.'); - } - const localVarPath = `/{product_id}/cashout_methods/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - 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, - }; - }, - /** - * Use this function to get the \"value\" (in local currency, e.g. CAD, BTC) for this cashout_method, for amount (in USD cents). - * @summary Get Expected Redemption Value - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method - * @param {any} amount (USD cents) The amount to convert - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet: async (productId: any, cashoutMethodId: any, amount: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet.'); - } - // verify required parameter 'cashoutMethodId' is not null or undefined - if (cashoutMethodId === null || cashoutMethodId === undefined) { - throw new RequiredError('cashoutMethodId','Required parameter cashoutMethodId was null or undefined when calling getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet.'); - } - // verify required parameter 'amount' is not null or undefined - if (amount === null || amount === undefined) { - throw new RequiredError('amount','Required parameter amount was null or undefined when calling getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet.'); - } - const localVarPath = `/{product_id}/cashout_method/{cashout_method_id}/value/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) - .replace(`{${"cashout_method_id"}}`, encodeURIComponent(String(cashoutMethodId))); - // 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; - - if (amount !== undefined) { - localVarQueryParameter['amount'] = amount; - } - - 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, - }; - }, - /** - * Return array of user events that altered their wallet balance - * @summary Get User Transaction History - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUserTransactionHistoryProductIdTransactionHistoryGet: async (productId: any, bpuid: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling getUserTransactionHistoryProductIdTransactionHistoryGet.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling getUserTransactionHistoryProductIdTransactionHistoryGet.'); - } - const localVarPath = `/{product_id}/transaction_history/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - 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, - }; - }, - /** - * Retrieve the current balance of a respondent's wallet balance for display - * @summary Get User Wallet Balance - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getUserWalletBalanceProductIdWalletGet: async (productId: any, bpuid: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling getUserWalletBalanceProductIdWalletGet.'); - } - // verify required parameter 'bpuid' is not null or undefined - if (bpuid === null || bpuid === undefined) { - throw new RequiredError('bpuid','Required parameter bpuid was null or undefined when calling getUserWalletBalanceProductIdWalletGet.'); - } - const localVarPath = `/{product_id}/wallet/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - if (bpuid !== undefined) { - localVarQueryParameter['bpuid'] = bpuid; - } - - 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, - }; - }, - /** - * Request a cashout taken from a user's available wallet balance, to be paid via a particular cashout method. - * @summary Submit User Cashout - * @param {CreateCashoutRequest} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitUserCashoutProductIdCashoutPost: async (body: CreateCashoutRequest, productId: any, 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 submitUserCashoutProductIdCashoutPost.'); - } - // verify required parameter 'productId' is not null or undefined - if (productId === null || productId === undefined) { - throw new RequiredError('productId','Required parameter productId was null or undefined when calling submitUserCashoutProductIdCashoutPost.'); - } - const localVarPath = `/{product_id}/cashout/` - .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); - // 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; - - 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, - }; - }, - } -}; - -/** - * WalletApi - functional programming interface - * @export - */ -export const WalletApiFp = function(configuration?: Configuration) { - return { - /** - * A user can only have 1 unique Cashout Method of any type at a time (eg. they can't create multiple paypal payout methods). Cashout Methods cannot be edited, they can only be created or deleted. Creating different Cashout Methods will require type-dependent request data attributes in order to be successfully created. Currently only creating paypal or Cash in Mail cashout methods are supported - * @summary Create Cashout Method - * @param {any} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createCashoutMethodProductIdCashoutMethodsPost(body: any, productId: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CashoutMethodResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).createCashoutMethodProductIdCashoutMethodsPost(body, productId, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Delete a cashout method - * @summary Delete Cashout Method - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method to delete - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(productId: any, cashoutMethodId: any, bpuid: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<StatusResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(productId, cashoutMethodId, bpuid, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Retrieve the details for a specific Cashout event - * @summary Get Cashout Detail - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutId The cashout event ID - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getCashoutDetailProductIdCashoutCashoutIdGet(productId: any, cashoutId: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CashoutRequestResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).getCashoutDetailProductIdCashoutCashoutIdGet(productId, cashoutId, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Retrieve the current available mechanisms that a user can use to retrieve funds. - * @summary Get Cashout Methods - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getCashoutMethodsProductIdCashoutMethodsGet(productId: any, bpuid: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CashoutMethodsResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).getCashoutMethodsProductIdCashoutMethodsGet(productId, bpuid, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Use this function to get the \"value\" (in local currency, e.g. CAD, BTC) for this cashout_method, for amount (in USD cents). - * @summary Get Expected Redemption Value - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method - * @param {any} amount (USD cents) The amount to convert - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet(productId: any, cashoutMethodId: any, amount: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CashoutMethodForeignValueResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet(productId, cashoutMethodId, amount, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Return array of user events that altered their wallet balance - * @summary Get User Transaction History - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUserTransactionHistoryProductIdTransactionHistoryGet(productId: any, bpuid: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserTransactionHistoryResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).getUserTransactionHistoryProductIdTransactionHistoryGet(productId, bpuid, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Retrieve the current balance of a respondent's wallet balance for display - * @summary Get User Wallet Balance - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUserWalletBalanceProductIdWalletGet(productId: any, bpuid: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<UserWalletBalanceResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).getUserWalletBalanceProductIdWalletGet(productId, bpuid, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - /** - * Request a cashout taken from a user's available wallet balance, to be paid via a particular cashout method. - * @summary Submit User Cashout - * @param {CreateCashoutRequest} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitUserCashoutProductIdCashoutPost(body: CreateCashoutRequest, productId: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<CashoutRequestResponse>>> { - const localVarAxiosArgs = await WalletApiAxiosParamCreator(configuration).submitUserCashoutProductIdCashoutPost(body, productId, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; - }, - } -}; - -/** - * WalletApi - factory interface - * @export - */ -export const WalletApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { - return { - /** - * A user can only have 1 unique Cashout Method of any type at a time (eg. they can't create multiple paypal payout methods). Cashout Methods cannot be edited, they can only be created or deleted. Creating different Cashout Methods will require type-dependent request data attributes in order to be successfully created. Currently only creating paypal or Cash in Mail cashout methods are supported - * @summary Create Cashout Method - * @param {any} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async createCashoutMethodProductIdCashoutMethodsPost(body: any, productId: any, options?: AxiosRequestConfig): Promise<AxiosResponse<CashoutMethodResponse>> { - return WalletApiFp(configuration).createCashoutMethodProductIdCashoutMethodsPost(body, productId, options).then((request) => request(axios, basePath)); - }, - /** - * Delete a cashout method - * @summary Delete Cashout Method - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method to delete - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(productId: any, cashoutMethodId: any, bpuid: any, options?: AxiosRequestConfig): Promise<AxiosResponse<StatusResponse>> { - return WalletApiFp(configuration).deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(productId, cashoutMethodId, bpuid, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve the details for a specific Cashout event - * @summary Get Cashout Detail - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutId The cashout event ID - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getCashoutDetailProductIdCashoutCashoutIdGet(productId: any, cashoutId: any, options?: AxiosRequestConfig): Promise<AxiosResponse<CashoutRequestResponse>> { - return WalletApiFp(configuration).getCashoutDetailProductIdCashoutCashoutIdGet(productId, cashoutId, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve the current available mechanisms that a user can use to retrieve funds. - * @summary Get Cashout Methods - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getCashoutMethodsProductIdCashoutMethodsGet(productId: any, bpuid: any, options?: AxiosRequestConfig): Promise<AxiosResponse<CashoutMethodsResponse>> { - return WalletApiFp(configuration).getCashoutMethodsProductIdCashoutMethodsGet(productId, bpuid, options).then((request) => request(axios, basePath)); - }, - /** - * Use this function to get the \"value\" (in local currency, e.g. CAD, BTC) for this cashout_method, for amount (in USD cents). - * @summary Get Expected Redemption Value - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method - * @param {any} amount (USD cents) The amount to convert - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet(productId: any, cashoutMethodId: any, amount: any, options?: AxiosRequestConfig): Promise<AxiosResponse<CashoutMethodForeignValueResponse>> { - return WalletApiFp(configuration).getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet(productId, cashoutMethodId, amount, options).then((request) => request(axios, basePath)); - }, - /** - * Return array of user events that altered their wallet balance - * @summary Get User Transaction History - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUserTransactionHistoryProductIdTransactionHistoryGet(productId: any, bpuid: any, options?: AxiosRequestConfig): Promise<AxiosResponse<UserTransactionHistoryResponse>> { - return WalletApiFp(configuration).getUserTransactionHistoryProductIdTransactionHistoryGet(productId, bpuid, options).then((request) => request(axios, basePath)); - }, - /** - * Retrieve the current balance of a respondent's wallet balance for display - * @summary Get User Wallet Balance - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getUserWalletBalanceProductIdWalletGet(productId: any, bpuid: any, options?: AxiosRequestConfig): Promise<AxiosResponse<UserWalletBalanceResponse>> { - return WalletApiFp(configuration).getUserWalletBalanceProductIdWalletGet(productId, bpuid, options).then((request) => request(axios, basePath)); - }, - /** - * Request a cashout taken from a user's available wallet balance, to be paid via a particular cashout method. - * @summary Submit User Cashout - * @param {CreateCashoutRequest} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitUserCashoutProductIdCashoutPost(body: CreateCashoutRequest, productId: any, options?: AxiosRequestConfig): Promise<AxiosResponse<CashoutRequestResponse>> { - return WalletApiFp(configuration).submitUserCashoutProductIdCashoutPost(body, productId, options).then((request) => request(axios, basePath)); - }, - }; -}; - -/** - * WalletApi - object-oriented interface - * @export - * @class WalletApi - * @extends {BaseAPI} - */ -export class WalletApi extends BaseAPI { - /** - * A user can only have 1 unique Cashout Method of any type at a time (eg. they can't create multiple paypal payout methods). Cashout Methods cannot be edited, they can only be created or deleted. Creating different Cashout Methods will require type-dependent request data attributes in order to be successfully created. Currently only creating paypal or Cash in Mail cashout methods are supported - * @summary Create Cashout Method - * @param {any} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async createCashoutMethodProductIdCashoutMethodsPost(body: any, productId: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<CashoutMethodResponse>> { - return WalletApiFp(this.configuration).createCashoutMethodProductIdCashoutMethodsPost(body, productId, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Delete a cashout method - * @summary Delete Cashout Method - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method to delete - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(productId: any, cashoutMethodId: any, bpuid: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<StatusResponse>> { - return WalletApiFp(this.configuration).deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(productId, cashoutMethodId, bpuid, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Retrieve the details for a specific Cashout event - * @summary Get Cashout Detail - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutId The cashout event ID - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async getCashoutDetailProductIdCashoutCashoutIdGet(productId: any, cashoutId: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<CashoutRequestResponse>> { - return WalletApiFp(this.configuration).getCashoutDetailProductIdCashoutCashoutIdGet(productId, cashoutId, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Retrieve the current available mechanisms that a user can use to retrieve funds. - * @summary Get Cashout Methods - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async getCashoutMethodsProductIdCashoutMethodsGet(productId: any, bpuid: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<CashoutMethodsResponse>> { - return WalletApiFp(this.configuration).getCashoutMethodsProductIdCashoutMethodsGet(productId, bpuid, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Use this function to get the \"value\" (in local currency, e.g. CAD, BTC) for this cashout_method, for amount (in USD cents). - * @summary Get Expected Redemption Value - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} cashoutMethodId The ID of the cashout method - * @param {any} amount (USD cents) The amount to convert - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet(productId: any, cashoutMethodId: any, amount: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<CashoutMethodForeignValueResponse>> { - return WalletApiFp(this.configuration).getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet(productId, cashoutMethodId, amount, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Return array of user events that altered their wallet balance - * @summary Get User Transaction History - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async getUserTransactionHistoryProductIdTransactionHistoryGet(productId: any, bpuid: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<UserTransactionHistoryResponse>> { - return WalletApiFp(this.configuration).getUserTransactionHistoryProductIdTransactionHistoryGet(productId, bpuid, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Retrieve the current balance of a respondent's wallet balance for display - * @summary Get User Wallet Balance - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {any} bpuid A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async getUserWalletBalanceProductIdWalletGet(productId: any, bpuid: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<UserWalletBalanceResponse>> { - return WalletApiFp(this.configuration).getUserWalletBalanceProductIdWalletGet(productId, bpuid, options).then((request) => request(this.axios, this.basePath)); - } - /** - * Request a cashout taken from a user's available wallet balance, to be paid via a particular cashout method. - * @summary Submit User Cashout - * @param {CreateCashoutRequest} body - * @param {any} productId The Brokerage Product ID provided by GRL. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof WalletApi - */ - public async submitUserCashoutProductIdCashoutPost(body: CreateCashoutRequest, productId: any, options?: AxiosRequestConfig) : Promise<AxiosResponse<CashoutRequestResponse>> { - return WalletApiFp(this.configuration).submitUserCashoutProductIdCashoutPost(body, productId, options).then((request) => request(this.axios, this.basePath)); - } -} |