diff options
| author | Max Nanis | 2025-06-07 04:26:16 +0700 |
|---|---|---|
| committer | Max Nanis | 2025-06-07 04:26:16 +0700 |
| commit | 438585f6e6cdebc3089739ddf77382aebe09fac1 (patch) | |
| tree | f6386e9625e9708396dfab9345171d0e7c7fedd5 /src/api/api.ts | |
| parent | 51b1003d1e0ce43aa6c30f461d710cb09cdfc29f (diff) | |
| download | panel-ui-438585f6e6cdebc3089739ddf77382aebe09fac1.tar.gz panel-ui-438585f6e6cdebc3089739ddf77382aebe09fac1.zip | |
rebuilding API models to new 1.2.0 version
Diffstat (limited to 'src/api/api.ts')
| -rw-r--r-- | src/api/api.ts | 302 |
1 files changed, 299 insertions, 3 deletions
diff --git a/src/api/api.ts b/src/api/api.ts index a1d67ae..3d858c2 100644 --- a/src/api/api.ts +++ b/src/api/api.ts @@ -4,7 +4,7 @@ * General Research Full Service Brokerage API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 1.1.0 + * The version of the OpenAPI document: 1.2.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -52,6 +52,19 @@ export type Body = { type: 'CASH_IN_MAIL' } & CreateCashMailCashoutMethodRequest /** * * @export + * @interface BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost + */ +export interface BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost { + /** + * + * @type {Array<UserQuestionAnswerIn>} + * @memberof BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost + */ + 'answers': Array<UserQuestionAnswerIn>; +} +/** + * + * @export * @interface BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost */ export interface BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost { @@ -3073,6 +3086,12 @@ export interface UpkQuestion { * @memberof UpkQuestion */ 'importance'?: UPKImportance | null; + /** + * Categories associated with this question + * @type {Array<Category>} + * @memberof UpkQuestion + */ + 'categories'?: Array<Category>; } @@ -3293,6 +3312,18 @@ export interface UpkQuestionOut { 'validation'?: UpkQuestionValidation | null; /** * + * @type {UPKImportance} + * @memberof UpkQuestionOut + */ + 'importance'?: UPKImportance | null; + /** + * Categories associated with this question + * @type {Array<Category>} + * @memberof UpkQuestionOut + */ + 'categories'?: Array<Category>; + /** + * * @type {number} * @memberof UpkQuestionOut */ @@ -4538,6 +4569,153 @@ export const OfferwallApiAxiosParamCreator = function (configuration?: Configura }, /** * 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 Block Post + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} offerwallId The offerwall ID the user is interacting with + * @param {string} 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 {BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost} bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost + * @param {string | null} [sessionId] A session id (uuid4.hex) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost: async (productId: string, offerwallId: string, bpuid: string, bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost: BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, sessionId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost', 'productId', productId) + // verify required parameter 'offerwallId' is not null or undefined + assertParamExists('offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost', 'offerwallId', offerwallId) + // verify required parameter 'bpuid' is not null or undefined + assertParamExists('offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost', 'bpuid', bpuid) + // verify required parameter 'bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost' is not null or undefined + assertParamExists('offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost', 'bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost', bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost) + const localVarPath = `/{product_id}/offerwall/7a89dcdb/{offerwall_id}/` + .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))) + .replace(`{${"offerwall_id"}}`, encodeURIComponent(String(offerwallId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { 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; + } + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + 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. No buckets are returned if the user is blocked. + * @summary Offerwall Softpair Block + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} 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 {string} [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 {string} [countryIso] Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) + * @param {Array<string>} [languages] Respondent\'s desired languages (ISO 639-2/B, lowercase) + * @param {string} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. + * @param {string} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay + * @param {number} [duration] Maximum length of desired task (in seconds). + * @param {number} [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 {number} [minBinSize] Minimum number of tasks that need to be in a bucket + * @param {number} [maxOptions] Max number of options an allowed question can have (allowed to be asked) + * @param {number} [maxQuestions] Max number of missing questions on a single bin + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet: async (productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, maxOptions?: number, maxQuestions?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet', 'productId', productId) + // verify required parameter 'bpuid' is not null or undefined + assertParamExists('offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet', 'bpuid', bpuid) + const localVarPath = `/{product_id}/offerwall/7a89dcdb/` + .replace(`{${"product_id"}}`, encodeURIComponent(String(productId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { 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) { + 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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + 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 {string} productId The Brokerage Product ID provided by GRL. * @param {string} offerwallId The offerwall ID the user is interacting with @@ -4558,8 +4736,7 @@ export const OfferwallApiAxiosParamCreator = function (configuration?: Configura assertParamExists('offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost', 'bodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost', bodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost) 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))); + .replace(`{${"offerwall_id"}}`, encodeURIComponent(String(offerwallId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -4575,6 +4752,10 @@ export const OfferwallApiAxiosParamCreator = function (configuration?: Configura localVarQueryParameter['bpuid'] = bpuid; } + if (sessionId !== undefined) { + localVarQueryParameter['session_id'] = sessionId; + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -5634,6 +5815,47 @@ export const OfferwallApiFp = function(configuration?: Configuration) { }, /** * 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 Block Post + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} offerwallId The offerwall ID the user is interacting with + * @param {string} 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 {BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost} bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost + * @param {string | null} [sessionId] A session id (uuid4.hex) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost(productId: string, offerwallId: string, bpuid: string, bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost: BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, sessionId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SoftPairOfferwallResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost(productId, offerwallId, bpuid, bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, sessionId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OfferwallApi.offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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. No buckets are returned if the user is blocked. + * @summary Offerwall Softpair Block + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} 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 {string} [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 {string} [countryIso] Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) + * @param {Array<string>} [languages] Respondent\'s desired languages (ISO 639-2/B, lowercase) + * @param {string} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. + * @param {string} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay + * @param {number} [duration] Maximum length of desired task (in seconds). + * @param {number} [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 {number} [minBinSize] Minimum number of tasks that need to be in a bucket + * @param {number} [maxOptions] Max number of options an allowed question can have (allowed to be asked) + * @param {number} [maxQuestions] Max number of missing questions on a single bin + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, maxOptions?: number, maxQuestions?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SoftPairOfferwallResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, maxOptions, maxQuestions, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['OfferwallApi.offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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 {string} productId The Brokerage Product ID provided by GRL. * @param {string} offerwallId The offerwall ID the user is interacting with @@ -5951,6 +6173,41 @@ export const OfferwallApiFactory = function (configuration?: Configuration, base }, /** * 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 Block Post + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} offerwallId The offerwall ID the user is interacting with + * @param {string} 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 {BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost} bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost + * @param {string | null} [sessionId] A session id (uuid4.hex) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost(productId: string, offerwallId: string, bpuid: string, bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost: BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, sessionId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<SoftPairOfferwallResponse> { + return localVarFp.offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost(productId, offerwallId, bpuid, bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, 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. No buckets are returned if the user is blocked. + * @summary Offerwall Softpair Block + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} 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 {string} [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 {string} [countryIso] Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) + * @param {Array<string>} [languages] Respondent\'s desired languages (ISO 639-2/B, lowercase) + * @param {string} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. + * @param {string} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay + * @param {number} [duration] Maximum length of desired task (in seconds). + * @param {number} [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 {number} [minBinSize] Minimum number of tasks that need to be in a bucket + * @param {number} [maxOptions] Max number of options an allowed question can have (allowed to be asked) + * @param {number} [maxQuestions] Max number of missing questions on a single bin + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, maxOptions?: number, maxQuestions?: number, options?: RawAxiosRequestConfig): AxiosPromise<SoftPairOfferwallResponse> { + return localVarFp.offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, maxOptions, maxQuestions, 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 {string} productId The Brokerage Product ID provided by GRL. * @param {string} offerwallId The offerwall ID the user is interacting with @@ -6231,6 +6488,45 @@ export class OfferwallApi extends BaseAPI { /** * 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 Block Post + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} offerwallId The offerwall ID the user is interacting with + * @param {string} 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 {BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost} bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost + * @param {string | null} [sessionId] A session id (uuid4.hex) + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OfferwallApi + */ + public offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost(productId: string, offerwallId: string, bpuid: string, bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost: BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, sessionId?: string | null, options?: RawAxiosRequestConfig) { + return OfferwallApiFp(this.configuration).offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost(productId, offerwallId, bpuid, bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, 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. No buckets are returned if the user is blocked. + * @summary Offerwall Softpair Block + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} 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 {string} [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 {string} [countryIso] Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) + * @param {Array<string>} [languages] Respondent\'s desired languages (ISO 639-2/B, lowercase) + * @param {string} [behavior] Allows using custom scoring functions. Please discuss directly with GRL. + * @param {string} [minPayout] Decimal representation of the minimum amount of USD that any of the tasks will pay + * @param {number} [duration] Maximum length of desired task (in seconds). + * @param {number} [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 {number} [minBinSize] Minimum number of tasks that need to be in a bucket + * @param {number} [maxOptions] Max number of options an allowed question can have (allowed to be asked) + * @param {number} [maxQuestions] Max number of missing questions on a single bin + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof OfferwallApi + */ + public offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, maxOptions?: number, maxQuestions?: number, options?: RawAxiosRequestConfig) { + return OfferwallApiFp(this.configuration).offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, maxOptions, maxQuestions, 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 {string} productId The Brokerage Product ID provided by GRL. * @param {string} offerwallId The offerwall ID the user is interacting with |
