diff options
Diffstat (limited to 'jb-ui/src/api_fsb/api.ts')
| -rw-r--r-- | jb-ui/src/api_fsb/api.ts | 1650 |
1 files changed, 849 insertions, 801 deletions
diff --git a/jb-ui/src/api_fsb/api.ts b/jb-ui/src/api_fsb/api.ts index 6d0acea..d819c9c 100644 --- a/jb-ui/src/api_fsb/api.ts +++ b/jb-ui/src/api_fsb/api.ts @@ -24,6 +24,24 @@ import type { RequestArgs } from './base'; import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** + * How the network is used + * @export + * @enum {string} + */ + +export const AccessType = { + Residential: 'residential', + Mobile: 'mobile', + Satellite: 'satellite', + Datacenter: 'datacenter', + Enterprise: 'enterprise', + Unknown: 'unknown' +} as const; + +export type AccessType = typeof AccessType[keyof typeof AccessType]; + + +/** * * @export * @enum {string} @@ -33,6 +51,7 @@ export const AccountType = { BpCommission: 'bp_commission', BpWallet: 'bp_wallet', UserWallet: 'user_wallet', + UserAttemptCredit: 'user_attempt_credit', Cash: 'cash', Revenue: 'revenue', Expense: 'expense', @@ -109,6 +128,13 @@ export interface AggregateBySource { 'by_source'?: { [key: string]: number; }; } /** + * The amount of the entry in integer counts or USD Cents + * @export + * @interface Amount + */ +export interface Amount { +} +/** * * @export * @interface AmtCashoutMethodData @@ -129,6 +155,32 @@ export const AmtCashoutMethodDataTypeEnum = { export type AmtCashoutMethodDataTypeEnum = typeof AmtCashoutMethodDataTypeEnum[keyof typeof AmtCashoutMethodDataTypeEnum]; /** + * + * @export + * @interface AttemptCreditClaimBody + */ +export interface AttemptCreditClaimBody { + /** + * (product_user_id) The user requesting the claim + * @type {string} + * @memberof AttemptCreditClaimBody + */ + 'bpuid': string; +} +/** + * + * @export + * @interface AttemptCreditClaimResponse + */ +export interface AttemptCreditClaimResponse { + /** + * + * @type {number} + * @memberof AttemptCreditClaimResponse + */ + 'amount': number | null; +} +/** * Table / Model for logging \"actions\" taken by a user or \"events\" that are related to a User * @export * @interface AuditLog @@ -257,17 +309,17 @@ export interface BrokerageProductPayoutEvent { */ 'uuid'?: string; /** - * The LedgerAccount.uuid that money is being requested from. Thie User or Brokerage Product is retrievable through the LedgerAccount.reference_uuid + * * @type {string} * @memberof BrokerageProductPayoutEvent */ - 'debit_account_uuid': string; + 'debit_account_uuid': string | null; /** - * References a row in the account_cashoutmethod table. This is the cashout method that was used to request this payout. (A cashout is the same thing as a payout) + * * @type {string} * @memberof BrokerageProductPayoutEvent */ - 'cashout_method_uuid': string; + 'cashout_method_uuid': string | null; /** * * @type {string} @@ -299,11 +351,11 @@ export interface BrokerageProductPayoutEvent { */ 'payout_type': PayoutType; /** - * Stores payout-type-specific information that is used to request this payout from the external provider. + * * @type {object} * @memberof BrokerageProductPayoutEvent */ - 'request_data'?: object; + 'request_data'?: object | null; /** * * @type {OrderData} @@ -612,7 +664,7 @@ export interface CashoutMethodOut { */ 'name': string; /** - * The method in which the requested payout is delivered. Allowed values: - __PAYPAL__ *(PAYPAL)*: User is paid out to their personal PayPal email address - __TANGO__ *(TANGO)*: User is paid uut via a Tango Gift Card - __DWOLLA__ *(DWOLLA)*: DWOLLA - __ACH__ *(ACH)*: A payment is made to a bank account using ACH - __WIRE__ *(WIRE)*: A payment is made to a bank account using ACH - __CASH_IN_MAIL__ *(CASH_IN_MAIL)*: A payment is made in cash and mailed to the user. - __PRIZE__ *(PRIZE)*: A payment is made as a prize with some monetary value - __AMT__ *(AMT)*: This is used to designate either AMT_BONUS or AMT_HIT - __AMT_BONUS__ *(AMT_BONUS)*: Amazon Mechanical Turk as a Bonus - __AMT_ASSIGNMENT__ *(AMT_HIT)*: Amazon Mechanical Turk for a HIT + * The method in which the requested payout is delivered. Allowed values: - __PAYPAL__ *(PAYPAL)*: User is paid out to their personal PayPal email address - __TANGO__ *(TANGO)*: User is paid out via a Tango Gift Card - __DWOLLA__ *(DWOLLA)*: DWOLLA - __ACH__ *(ACH)*: A payment is made to a bank account using ACH - __WIRE__ *(WIRE)*: A payment is made to a bank account using ACH - __CASH_IN_MAIL__ *(CASH_IN_MAIL)*: A payment is made in cash and mailed to the user. - __PRIZE__ *(PRIZE)*: A payment is made as a prize with some monetary value - __AMT__ *(AMT)*: This is used to designate either AMT_BONUS or AMT_HIT - __AMT_BONUS__ *(AMT_BONUS)*: Amazon Mechanical Turk as a Bonus - __AMT_ASSIGNMENT__ *(AMT_HIT)*: Amazon Mechanical Turk for a HIT * @type {PayoutType} * @memberof CashoutMethodOut */ @@ -916,6 +968,57 @@ export type ContestEndReason = typeof ContestEndReason[keyof typeof ContestEndRe /** + * + * @export + * @interface ContestEntry + */ +export interface ContestEntry { + /** + * + * @type {string} + * @memberof ContestEntry + */ + 'uuid'?: string; + /** + * + * @type {string} + * @memberof ContestEntry + */ + 'created_at'?: string; + /** + * + * @type {string} + * @memberof ContestEntry + */ + 'updated_at'?: string; + /** + * + * @type {ContestEntryType} + * @memberof ContestEntry + */ + 'entry_type': ContestEntryType; + /** + * + * @type {Amount} + * @memberof ContestEntry + */ + 'amount': Amount; + /** + * + * @type {string} + * @memberof ContestEntry + */ + 'amount_str': string; + /** + * + * @type {string} + * @memberof ContestEntry + */ + 'censored_product_user_id': string; +} + + +/** * Defines rules the user must meet to be allowed to enter this contest Only applies if the ContestType is ENTRY! * @export * @interface ContestEntryRule @@ -968,6 +1071,20 @@ export type ContestEntryTrigger = typeof ContestEntryTrigger[keyof typeof Contes /** + * All entries into a contest must be of the same type, and match the entry_type of the Contest itself. + * @export + * @enum {string} + */ + +export const ContestEntryType = { + Count: 'count', + Cash: 'cash' +} as const; + +export type ContestEntryType = typeof ContestEntryType[keyof typeof ContestEntryType]; + + +/** * * @export * @interface ContestPrize @@ -1650,10 +1767,10 @@ export interface GeoIPInformation { 'static_ip_score'?: number | null; /** * - * @type {UserType} + * @type {AccessType} * @memberof GeoIPInformation */ - 'user_type'?: UserType | null; + 'user_type'?: AccessType | null; /** * * @type {string} @@ -1715,17 +1832,17 @@ export type IntegrationMode = typeof IntegrationMode[keyof typeof IntegrationMod */ export interface Leaderboard { /** - * Unique ID for this leaderboard + * * @type {string} * @memberof Leaderboard */ - 'id'?: string; + 'id'?: string | null; /** - * Descriptive name for the leaderboard based on the board_code + * * @type {string} * @memberof Leaderboard */ - 'name'?: string; + 'name'?: string | null; /** * 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 * @type {LeaderboardCode} @@ -1751,11 +1868,11 @@ export interface Leaderboard { */ 'freq': LeaderboardFrequency; /** - * The timezone for the requested country + * * @type {string} * @memberof Leaderboard */ - 'timezone_name'?: string; + 'timezone_name'?: string | null; /** * * @type {string} @@ -1781,11 +1898,11 @@ export interface Leaderboard { */ 'period_start_local': string; /** - * The end of the time period covered by this board in local time, tz-aware + * * @type {string} * @memberof Leaderboard */ - 'period_end_local'?: string; + 'period_end_local'?: string | null; /** * (unix timestamp) The start time of the time range this leaderboard covers. * @type {number} @@ -2063,6 +2180,12 @@ export interface LeaderboardRow { * @memberof LeaderboardRow */ 'value': number; + /** + * + * @type {string} + * @memberof LeaderboardRow + */ + 'display_name'?: string | null; } /** * @@ -2197,7 +2320,7 @@ export interface LedgerAccount { */ 'qualified_name': string; /** - * - `bp_commission` = BP_COMMISSION - `bp_wallet` = BP_WALLET - `user_wallet` = USER_WALLET - `cash` = CASH - `revenue` = REVENUE - `expense` = EXPENSE - `contest_wallet` = CONTEST_WALLET - `credit_line` = CREDIT_LINE - `wa_wallet` = WA_WALLET - `wa_budget_pool` = WA_BUDGET_POOL - `wa_held` = WA_HELD - `wa_credit_line` = WA_CREDIT_LINE + * - `bp_commission` = BP_COMMISSION - `bp_wallet` = BP_WALLET - `user_wallet` = USER_WALLET - `user_attempt_credit` = USER_ATTEMPT_CREDIT - `cash` = CASH - `revenue` = REVENUE - `expense` = EXPENSE - `contest_wallet` = CONTEST_WALLET - `credit_line` = CREDIT_LINE - `wa_wallet` = WA_WALLET - `wa_budget_pool` = WA_BUDGET_POOL - `wa_held` = WA_HELD - `wa_credit_line` = WA_CREDIT_LINE * @type {AccountType} * @memberof LedgerAccount */ @@ -2545,6 +2668,27 @@ export const ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet2 export type ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInnerValidForEventEnum = typeof ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInnerValidForEventEnum[keyof typeof ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInnerValidForEventEnum]; /** + * + * @export + * @interface ManageCashoutBody + */ +export interface ManageCashoutBody { + /** + * + * @type {string} + * @memberof ManageCashoutBody + */ + 'payout_id': string; + /** + * + * @type {PayoutStatus} + * @memberof ManageCashoutBody + */ + 'new_status': PayoutStatus; +} + + +/** * This is used solely in API responses, so it is simplified. * @export * @interface MarketProfileKnowledge @@ -3258,6 +3402,74 @@ export const OrderDataTypeEnum = { export type OrderDataTypeEnum = typeof OrderDataTypeEnum[keyof typeof OrderDataTypeEnum]; /** + * Stores payout-type-specific order information that is returned from the external payout provider. + * @export + * @interface OrderData1 + */ +export interface OrderData1 { + /** + * + * @type {string} + * @memberof OrderData1 + */ + 'type'?: OrderData1TypeEnum; + /** + * + * @type {number} + * @memberof OrderData1 + */ + 'shipping_cost': number; + /** + * + * @type {string} + * @memberof OrderData1 + */ + 'tracking_number'?: string; + /** + * + * @type {ShippingMethod} + * @memberof OrderData1 + */ + 'shipping_method'?: ShippingMethod; + /** + * + * @type {ShippingCarrier} + * @memberof OrderData1 + */ + 'carrier'?: ShippingCarrier; + /** + * + * @type {string} + * @memberof OrderData1 + */ + 'ship_date'?: string; + /** + * + * @type {string} + * @memberof OrderData1 + */ + 'estimated_delivery_date'?: string; + /** + * + * @type {DeliveryStatus} + * @memberof OrderData1 + */ + 'delivery_status'?: DeliveryStatus; + /** + * + * @type {string} + * @memberof OrderData1 + */ + 'last_updated'?: string; +} + +export const OrderData1TypeEnum = { + CashInMail: 'CASH_IN_MAIL' +} as const; + +export type OrderData1TypeEnum = typeof OrderData1TypeEnum[keyof typeof OrderData1TypeEnum]; + +/** * We can\'t use our USDCent class in here because aside from it not supporting negative values for our adjustments, FastAPI also complains because it doesn\'t know how to generate documentation for it. - Max 2024-06-25 * @export * @interface POPFinancial @@ -3430,7 +3642,7 @@ export interface PayoutSummary { 'upper_whisker': number; } /** - * This model describe how the bp_payout is converted to the user_payout. If None, the user_payout is None. If the user_wallet_enabled is `False`, the user_payout is used to 1) know how to transform the expected payouts for offerwall buckets (if min_payout is requested, this is based on the user_payout) 2) show the user (using the payout_format) how much they made (in the Task Status Response). If the user_wallet_enabled is `True`, then in addition to the above, the user_payout is the amount actually paid to the user\'s wallet. + * This model describe how the bp_payout is converted to the user_payout. If None, the user_payout is None. If the user_wallet_enabled is `False`, the user_payout is used to 1) know how to transform the expected payouts for offerwall buckets (if min_payout is requested, this is based on the user_payout) 2) show the user (using the payout_format) how much they made (in the Task Status Response). If the user_wallet_enabled is `True`, then in addition to the above, the user_payout is the amount actually paid to the user\'s wallet. * @export * @interface PayoutTransformation */ @@ -3607,7 +3819,7 @@ export interface Product { */ 'enabled'?: boolean; /** - * This is only to determine if ACH or Wire payments should be made to the Produce. + * This is only to determine if ACH or Wire payments should be made to the Product. * @type {boolean} * @memberof Product */ @@ -3890,7 +4102,7 @@ export interface ProductBalances { */ 'available_balance_usd_str': string; /** - * + * The amount that must be held back to recover a negative Product balance. This is $0.00 when the Product balance is positive or zero; otherwise it is the absolute value of the negative balance. Business-level payout calculations use this amount to offset deficits from one Product against available funds from other Products before issuing Supplier Payments. * @type {number} * @memberof ProductBalances */ @@ -3921,7 +4133,7 @@ export interface ProfilingConfig { */ 'enabled'?: boolean; /** - * If grs_enabled is False, and is_grs is passed in the profiling-questions call, then don\'t actually return any questions. This allows a client to hit the endpoint with no limit and still get questions. In effect, this means that we\'ll redirect the user through the GRS system but won\'t present them any questions. + * If grs_enabled is False, and is_grs is passed in the profiling-questions call, then don\'t actually return any questions. This allows a client to hit the endpoint with no limit and still get questions. In effect, this means that we\'ll redirect the user through the GRS system but won\'t present them any questions. * @type {boolean} * @memberof ProfilingConfig */ @@ -3945,13 +4157,13 @@ export interface ProfilingConfig { */ 'avg_question_count'?: number; /** - * Scale how frequently we inject profiling questions, relative to the default.1 is default, 2 is twice as often. 10 means always. 0.5 half as often + * Scale how frequently we inject profiling questions, relative to the default. 1 is default, 2 is twice as often. 10 means always. 0.5 half as often * @type {number} * @memberof ProfilingConfig */ 'task_injection_freq_mult'?: number; /** - * Non-us multiplier, used to increase freq and length of profilers in all non-us countries.This value is multiplied by task_injection_freq_mult and avg_question_count. + * Non-us multiplier, used to increase freq and length of profilers in all non-us countries. This value is multiplied by task_injection_freq_mult and avg_question_count. * @type {number} * @memberof ProfilingConfig */ @@ -4736,87 +4948,6 @@ export type ShippingMethod = typeof ShippingMethod[keyof typeof ShippingMethod]; /** * * @export - * @interface SingleEntryBucket - */ -export interface SingleEntryBucket { - /** - * Unique identifier this particular bucket - * @type {string} - * @memberof SingleEntryBucket - */ - 'id': string; - /** - * The URL to send a respondent into. Must not edit this URL in any way - * @type {string} - * @memberof SingleEntryBucket - */ - 'uri': string; -} -/** - * Only returns a single bucket with the top scoring tasks. Offerwall code: `5fl8bpv5` - * @export - * @interface SingleEntryOfferWall - */ -export interface SingleEntryOfferWall { - /** - * Unique identifier to reference a generated offerwall - * @type {string} - * @memberof SingleEntryOfferWall - */ - 'id': string; - /** - * Total opportunities available for specific bpuid respondent and parameters. This value changes frequently and can be used to determine if a respondent has potential tasks available, regardless of the offerwall type being requested. If the value is 0, no buckets will be generated. - * @type {number} - * @memberof SingleEntryOfferWall - */ - 'availability_count': number; - /** - * Number of currently live opportunities for which the respondent meets all eligibility criteria but is excluded due to a prior attempt. Only includes surveys that are still live and otherwise eligible; does not include previously attempted surveys that are no longer available. - * @type {number} - * @memberof SingleEntryOfferWall - */ - 'attempted_live_eligible_count'?: number; - /** - * - * @type {Array<SingleEntryBucket>} - * @memberof SingleEntryOfferWall - */ - 'buckets'?: Array<SingleEntryBucket>; - /** - * Explanations describing why so many or few opportunities are available. - * @type {Array<OfferwallReason>} - * @memberof SingleEntryOfferWall - */ - 'offerwall_reasons'?: Array<OfferwallReason>; - /** - * The format describing the str representation of a payout. Typically, this would be displayed to a user. The payout_format is similar to python format string with a subset of functionality supported. Only float with a precision are supported along with an optional comma for a thousands separator. In addition, a mathematical operator can be applied, such as dividing by 100. Examples are shown assuming payout = 100 (one dollar). - \"{payout*10:,.0f} Points\" -> \"1,000 Points\" - \"${payout/100:.2f}\" -> \"$1.00\" - * @type {string} - * @memberof SingleEntryOfferWall - */ - 'payout_format': string; -} -/** - * - * @export - * @interface SingleEntryOfferWallResponse - */ -export interface SingleEntryOfferWallResponse { - /** - * - * @type {OfferWallInfo} - * @memberof SingleEntryOfferWallResponse - */ - 'info': OfferWallInfo; - /** - * - * @type {SingleEntryOfferWall} - * @memberof SingleEntryOfferWallResponse - */ - 'offerwall': SingleEntryOfferWall; -} -/** - * - * @export * @interface SoftPairBucket */ export interface SoftPairBucket { @@ -5066,68 +5197,6 @@ export interface StartedAfter { export interface StartedBefore { } /** - * 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. Offerwall code: `b59a2d2b` - * @export - * @interface StarwallOfferWall - */ -export interface StarwallOfferWall { - /** - * Unique identifier to reference a generated offerwall - * @type {string} - * @memberof StarwallOfferWall - */ - 'id': string; - /** - * Total opportunities available for specific bpuid respondent and parameters. This value changes frequently and can be used to determine if a respondent has potential tasks available, regardless of the offerwall type being requested. If the value is 0, no buckets will be generated. - * @type {number} - * @memberof StarwallOfferWall - */ - 'availability_count': number; - /** - * Number of currently live opportunities for which the respondent meets all eligibility criteria but is excluded due to a prior attempt. Only includes surveys that are still live and otherwise eligible; does not include previously attempted surveys that are no longer available. - * @type {number} - * @memberof StarwallOfferWall - */ - 'attempted_live_eligible_count'?: number; - /** - * - * @type {Array<TopNBucket>} - * @memberof StarwallOfferWall - */ - 'buckets'?: Array<TopNBucket>; - /** - * Explanations describing why so many or few opportunities are available. - * @type {Array<OfferwallReason>} - * @memberof StarwallOfferWall - */ - 'offerwall_reasons'?: Array<OfferwallReason>; - /** - * The format describing the str representation of a payout. Typically, this would be displayed to a user. The payout_format is similar to python format string with a subset of functionality supported. Only float with a precision are supported along with an optional comma for a thousands separator. In addition, a mathematical operator can be applied, such as dividing by 100. Examples are shown assuming payout = 100 (one dollar). - \"{payout*10:,.0f} Points\" -> \"1,000 Points\" - \"${payout/100:.2f}\" -> \"$1.00\" - * @type {string} - * @memberof StarwallOfferWall - */ - 'payout_format': string; -} -/** - * - * @export - * @interface StarwallOfferWallResponse - */ -export interface StarwallOfferWallResponse { - /** - * - * @type {OfferWallInfo} - * @memberof StarwallOfferWallResponse - */ - 'info': OfferWallInfo; - /** - * - * @type {StarwallOfferWall} - * @memberof StarwallOfferWallResponse - */ - 'offerwall': StarwallOfferWall; -} -/** * Same as the StarwallOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. Offerwall code: `7fa1b3f4` * @export * @interface StarwallPlusBlockOfferWall @@ -5781,7 +5850,7 @@ export interface SupplyConfig { 'policies'?: Array<SupplyPolicy>; } /** - * One policy describing how GRL can interact with a marketplaces in a certain way. This is only used on the special \"global product\", and then internally in grpc logic. + * One policy describing how GRL can interact with a marketplaces in a certain way. This is only used on the special \"global product\", and then internally in grpc logic. * @export * @interface SupplyPolicy */ @@ -6299,135 +6368,6 @@ export interface TasksStatusResponse { 'pages': number | null; } /** - * - * @export - * @interface TopNBucket - */ -export interface TopNBucket { - /** - * Unique identifier this particular bucket - * @type {string} - * @memberof TopNBucket - */ - 'id': string; - /** - * The URL to send a respondent into. Must not edit this URL in any way - * @type {string} - * @memberof TopNBucket - */ - 'uri': string; - /** - * For UI. Provides a dimensionality position for the bucket on the x-axis. - * @type {number} - * @memberof TopNBucket - */ - 'x'?: number; - /** - * For UI. Provides a dimensionality position for the bucket on the y-axis. - * @type {number} - * @memberof TopNBucket - */ - 'y'?: number; - /** - * Currently unused. Will always return empty string - * @type {string} - * @memberof TopNBucket - */ - 'name'?: string; - /** - * Currently unused. Will always return empty string - * @type {string} - * @memberof TopNBucket - */ - 'description'?: string; - /** - * - * @type {Array<CategoryAssociation>} - * @memberof TopNBucket - */ - 'category'?: Array<CategoryAssociation>; - /** - * - * @type {DurationSummary} - * @memberof TopNBucket - */ - 'duration': DurationSummary; - /** - * - * @type {PayoutSummary} - * @memberof TopNBucket - */ - 'payout': PayoutSummary; - /** - * A proprietary score to determine the overall quality of the tasks that are within the bucket. Higher is better. - * @type {number} - * @memberof TopNBucket - */ - 'quality_score': number; -} -/** - * An offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. Offerwall code: `45b7228a7` - * @export - * @interface TopNOfferWall - */ -export interface TopNOfferWall { - /** - * Unique identifier to reference a generated offerwall - * @type {string} - * @memberof TopNOfferWall - */ - 'id': string; - /** - * Total opportunities available for specific bpuid respondent and parameters. This value changes frequently and can be used to determine if a respondent has potential tasks available, regardless of the offerwall type being requested. If the value is 0, no buckets will be generated. - * @type {number} - * @memberof TopNOfferWall - */ - 'availability_count': number; - /** - * Number of currently live opportunities for which the respondent meets all eligibility criteria but is excluded due to a prior attempt. Only includes surveys that are still live and otherwise eligible; does not include previously attempted surveys that are no longer available. - * @type {number} - * @memberof TopNOfferWall - */ - 'attempted_live_eligible_count'?: number; - /** - * - * @type {Array<TopNBucket>} - * @memberof TopNOfferWall - */ - 'buckets'?: Array<TopNBucket>; - /** - * Explanations describing why so many or few opportunities are available. - * @type {Array<OfferwallReason>} - * @memberof TopNOfferWall - */ - 'offerwall_reasons'?: Array<OfferwallReason>; - /** - * The format describing the str representation of a payout. Typically, this would be displayed to a user. The payout_format is similar to python format string with a subset of functionality supported. Only float with a precision are supported along with an optional comma for a thousands separator. In addition, a mathematical operator can be applied, such as dividing by 100. Examples are shown assuming payout = 100 (one dollar). - \"{payout*10:,.0f} Points\" -> \"1,000 Points\" - \"${payout/100:.2f}\" -> \"$1.00\" - * @type {string} - * @memberof TopNOfferWall - */ - 'payout_format': string; -} -/** - * - * @export - * @interface TopNOfferWallResponse - */ -export interface TopNOfferWallResponse { - /** - * - * @type {OfferWallInfo} - * @memberof TopNOfferWallResponse - */ - 'info': OfferWallInfo; - /** - * - * @type {TopNOfferWall} - * @memberof TopNOfferWallResponse - */ - 'offerwall': TopNOfferWall; -} -/** * Same as the TopNOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. Offerwall code: `d48cce47` * @export * @interface TopNPlusBlockOfferWall @@ -6986,7 +6926,7 @@ export interface UpkQuestion { * @type {Selector} * @memberof UpkQuestion */ - 'selector'?: Selector; + 'selector': Selector; /** * * @type {UpkQuestionConfiguration} @@ -7234,7 +7174,7 @@ export interface UpkQuestionOut { * @type {Selector} * @memberof UpkQuestionOut */ - 'selector'?: Selector; + 'selector': Selector; /** * * @type {UpkQuestionConfiguration} @@ -7526,6 +7466,13 @@ export interface UserAmount { export interface UserAmountToday { } /** + * The amount the user would earn from completing this task, if the status was a complete. If the BP has no payout xform, the user_cpi is None. This is analogous to the session\'s user_payout. + * @export + * @interface UserCpi + */ +export interface UserCpi { +} +/** * If a payout transformation is configured on this account, this is the amount to display to the user * @export * @interface UserCpiString @@ -7552,6 +7499,31 @@ export interface UserCreateConfig { 'max_hourly_create_limit'?: number | null; } /** + * Combined user-visible balance for one ledger currency. + * @export + * @interface UserDisplayedWalletBalance + */ +export interface UserDisplayedWalletBalance { + /** + * + * @type {string} + * @memberof UserDisplayedWalletBalance + */ + 'currency': string; + /** + * Displayed balance in the currency\'s smallest ledger unit. + * @type {number} + * @memberof UserDisplayedWalletBalance + */ + 'amount': number; + /** + * + * @type {string} + * @memberof UserDisplayedWalletBalance + */ + 'amount_string'?: string | null; +} +/** * * @export * @interface UserHealthConfig @@ -7685,7 +7657,7 @@ export const UserLedgerTransactionTaskAdjustmentTxTypeEnum = { export type UserLedgerTransactionTaskAdjustmentTxTypeEnum = typeof UserLedgerTransactionTaskAdjustmentTxTypeEnum[keyof typeof UserLedgerTransactionTaskAdjustmentTxTypeEnum]; /** - * In a BP with user wallet enabled, the task-complete transaction would have line items for both the credit to the bp_wallet_account and credit to user_account. This is the user-detail, so we\'ve only caring about the user\'s payment. + * In a BP with user wallet enabled, the task-complete transaction would have line items for both the credit to the bp_wallet_account and credit to user_account. This is the user-detail, so we\'ve only caring about the user\'s payment. * @export * @interface UserLedgerTransactionTaskComplete */ @@ -7996,6 +7968,181 @@ export type UserLedgerTransactionsResponseStatusEnum = typeof UserLedgerTransact export type UserLedgerTransactionsResponseTransactionsInner = { tx_type: 'bp_adjustment' } & UserLedgerTransactionTaskAdjustment | { tx_type: 'bp_payment' } & UserLedgerTransactionTaskComplete | { tx_type: 'user_bonus' } & UserLedgerTransactionUserBonus | { tx_type: 'user_payout_request' } & UserLedgerTransactionUserPayout; /** + * A user-owned ledger account exposed by the wallets endpoint. + * @export + * @interface UserLedgerWallet + */ +export interface UserLedgerWallet { + /** + * (USD cents) The amount in the user\'s wallet. + * @type {number} + * @memberof UserLedgerWallet + */ + 'amount': number; + /** + * (USD cents) The amount in the user\'s wallet this is currently redeemable. + * @type {number} + * @memberof UserLedgerWallet + */ + 'redeemable_amount': number; + /** + * + * @type {string} + * @memberof UserLedgerWallet + */ + 'payout_format'?: string | null; + /** + * + * @type {string} + * @memberof UserLedgerWallet + */ + 'amount_string'?: string | null; + /** + * + * @type {string} + * @memberof UserLedgerWallet + */ + 'redeemable_amount_string'?: string | null; + /** + * A unique identifier for this Ledger Account + * @type {string} + * @memberof UserLedgerWallet + */ + 'account_uuid': string; + /** + * + * @type {string} + * @memberof UserLedgerWallet + */ + 'account_type': UserLedgerWalletAccountTypeEnum; + /** + * + * @type {string} + * @memberof UserLedgerWallet + */ + 'currency'?: string; + /** + * Human-readable description of the Ledger Account + * @type {string} + * @memberof UserLedgerWallet + */ + 'display_name': string; +} + +export const UserLedgerWalletAccountTypeEnum = { + UserWallet: 'user_wallet', + UserAttemptCredit: 'user_attempt_credit' +} as const; + +export type UserLedgerWalletAccountTypeEnum = typeof UserLedgerWalletAccountTypeEnum[keyof typeof UserLedgerWalletAccountTypeEnum]; + +/** + * + * @export + * @interface UserLedgerWallets + */ +export interface UserLedgerWallets { + /** + * + * @type {Array<UserLedgerWallet>} + * @memberof UserLedgerWallets + */ + 'wallets'?: Array<UserLedgerWallet>; + /** + * + * @type {Array<UserDisplayedWalletBalance>} + * @memberof UserLedgerWallets + */ + 'displayed_balances'?: Array<UserDisplayedWalletBalance>; +} +/** + * A user has requested to be paid from their wallet balance. + * @export + * @interface UserPayoutEvent + */ +export interface UserPayoutEvent { + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'uuid'?: string; + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'debit_account_uuid': string | null; + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'cashout_method_uuid': string | null; + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'created'?: string; + /** + * The USDCent amount int. This cannot be 0 or negative + * @type {number} + * @memberof UserPayoutEvent + */ + 'amount': number; + /** + * + * @type {PayoutStatus} + * @memberof UserPayoutEvent + */ + 'status'?: PayoutStatus | null; + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'ext_ref_id'?: string | null; + /** + * - `PAYPAL` = PAYPAL - `TANGO` = TANGO - `DWOLLA` = DWOLLA - `ACH` = ACH - `WIRE` = WIRE - `CASH_IN_MAIL` = CASH_IN_MAIL - `PRIZE` = PRIZE - `AMT` = AMT - `AMT_BONUS` = AMT_BONUS - `AMT_ASSIGNMENT` = AMT_HIT + * @type {PayoutType} + * @memberof UserPayoutEvent + */ + 'payout_type': PayoutType; + /** + * + * @type {object} + * @memberof UserPayoutEvent + */ + 'request_data'?: object | null; + /** + * + * @type {OrderData1} + * @memberof UserPayoutEvent + */ + 'order_data'?: OrderData1 | null; + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'account_reference_type'?: string | null; + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'account_reference_uuid'?: string | null; + /** + * + * @type {string} + * @memberof UserPayoutEvent + */ + 'description'?: string | null; +} + + +/** * * @export * @interface UserProfile @@ -8009,6 +8156,12 @@ export interface UserProfile { 'email_address'?: string | null; /** * + * @type {string} + * @memberof UserProfile + */ + 'display_name'?: string | null; + /** + * * @type {User} * @memberof UserProfile */ @@ -8288,33 +8441,6 @@ export interface UserStreak { /** * * @export - * @enum {string} - */ - -export const UserType = { - Business: 'business', - Cafe: 'cafe', - Cellular: 'cellular', - College: 'college', - ContentDeliveryNetwork: 'content_delivery_network', - ConsumerPrivacyNetwork: 'consumer_privacy_network', - Government: 'government', - Hosting: 'hosting', - Library: 'library', - Military: 'military', - Residential: 'residential', - Router: 'router', - School: 'school', - SearchEngineSpider: 'search_engine_spider', - Traveler: 'traveler' -} as const; - -export type UserType = typeof UserType[keyof typeof UserType]; - - -/** - * - * @export * @interface UserWalletBalance */ export interface UserWalletBalance { @@ -8395,6 +8521,12 @@ export interface UserWalletConfig { */ 'enabled'?: boolean; /** + * The balance used as the user\'s displayed balance. + * @type {string} + * @memberof UserWalletConfig + */ + 'balance_type'?: UserWalletConfigBalanceTypeEnum; + /** * Uses Amazon Mechanical Turk * @type {boolean} * @memberof UserWalletConfig @@ -8402,17 +8534,31 @@ export interface UserWalletConfig { 'amt'?: boolean; /** * - * @type {Set<PayoutType>} + * @type {Array<PayoutType>} * @memberof UserWalletConfig */ - 'supported_payout_types'?: Set<PayoutType>; + 'supported_payout_types'?: Array<PayoutType>; /** * * @type {string} * @memberof UserWalletConfig */ 'min_cashout'?: string | null; + /** + * + * @type {string} + * @memberof UserWalletConfig + */ + 'failed_attempt_credit'?: string | null; } + +export const UserWalletConfigBalanceTypeEnum = { + WalletBalance: 'wallet_balance', + RedeemableBalance: 'redeemable_balance' +} as const; + +export type UserWalletConfigBalanceTypeEnum = typeof UserWalletConfigBalanceTypeEnum[keyof typeof UserWalletConfigBalanceTypeEnum]; + /** * * @export @@ -8437,6 +8583,18 @@ export interface ValidationError { * @memberof ValidationError */ 'type': string; + /** + * + * @type {any} + * @memberof ValidationError + */ + 'input'?: any; + /** + * + * @type {object} + * @memberof ValidationError + */ + 'ctx'?: object; } /** * @@ -8659,11 +8817,11 @@ export interface WallOut { */ 'adjusted_timestamp'?: AdjustedTimestamp; /** - * The amount the user would earn from completing this task, if the status was a complete. If the BP has no payout xform, the user_cpi is None. This is analogous to the session\'s user_payout. - * @type {number} + * + * @type {UserCpi} * @memberof WallOut */ - 'user_cpi'?: number; + 'user_cpi'?: UserCpi; /** * * @type {UserCpiString} @@ -9227,11 +9385,11 @@ export const LeaderboardApiAxiosParamCreator = function (configuration?: Configu * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet: async (productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet: async (productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { // verify required parameter 'productId' is not null or undefined assertParamExists('leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet', 'productId', productId) // verify required parameter 'boardCode' is not null or undefined @@ -9277,14 +9435,14 @@ export const LeaderboardApiAxiosParamCreator = function (configuration?: Configu * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {string} [bpuid] Brokerage Product User ID. If passed, this results in the filtering of rows to include this user\'s row, plus rows above and below in rank (up to `limit` rows). Otherwise, the top `limit` rows are returned. * @param {string} [withinTime] Any local timestamp falling within the desired leaderboard\'s period. If not passed, uses the country\'s current time period. * @param {number} [limit] Max number of rows to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ - timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet: async (productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, bpuid?: string, withinTime?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet: async (productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, bpuid?: string, withinTime?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { // verify required parameter 'productId' is not null or undefined assertParamExists('timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet', 'productId', productId) // verify required parameter 'boardCode' is not null or undefined @@ -9354,11 +9512,11 @@ export const LeaderboardApiFp = function(configuration?: Configuration) { * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeaderboardWinnerResponse>> { + async leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeaderboardWinnerResponse>> { const localVarAxiosArgs = await localVarAxiosParamCreator.leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId, boardCode, freq, countryIso, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['LeaderboardApi.leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet']?.[localVarOperationServerIndex]?.url; @@ -9370,14 +9528,14 @@ export const LeaderboardApiFp = function(configuration?: Configuration) { * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {string} [bpuid] Brokerage Product User ID. If passed, this results in the filtering of rows to include this user\'s row, plus rows above and below in rank (up to `limit` rows). Otherwise, the top `limit` rows are returned. * @param {string} [withinTime] Any local timestamp falling within the desired leaderboard\'s period. If not passed, uses the country\'s current time period. * @param {number} [limit] Max number of rows to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, bpuid?: string, withinTime?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeaderboardResponse>> { + async timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, bpuid?: string, withinTime?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LeaderboardResponse>> { const localVarAxiosArgs = await localVarAxiosParamCreator.timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId, boardCode, freq, countryIso, bpuid, withinTime, limit, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['LeaderboardApi.timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet']?.[localVarOperationServerIndex]?.url; @@ -9399,11 +9557,11 @@ export const LeaderboardApiFactory = function (configuration?: Configuration, ba * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, options?: RawAxiosRequestConfig): AxiosPromise<LeaderboardWinnerResponse> { + leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<LeaderboardWinnerResponse> { return localVarFp.leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId, boardCode, freq, countryIso, options).then((request) => request(axios, basePath)); }, /** @@ -9412,14 +9570,14 @@ export const LeaderboardApiFactory = function (configuration?: Configuration, ba * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {string} [bpuid] Brokerage Product User ID. If passed, this results in the filtering of rows to include this user\'s row, plus rows above and below in rank (up to `limit` rows). Otherwise, the top `limit` rows are returned. * @param {string} [withinTime] Any local timestamp falling within the desired leaderboard\'s period. If not passed, uses the country\'s current time period. * @param {number} [limit] Max number of rows to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ - timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, bpuid?: string, withinTime?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<LeaderboardResponse> { + timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, bpuid?: string, withinTime?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<LeaderboardResponse> { return localVarFp.timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId, boardCode, freq, countryIso, bpuid, withinTime, limit, options).then((request) => request(axios, basePath)); }, }; @@ -9438,12 +9596,12 @@ export class LeaderboardApi extends BaseAPI { * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LeaderboardApi */ - public leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, options?: RawAxiosRequestConfig) { + public leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, options?: RawAxiosRequestConfig) { return LeaderboardApiFp(this.configuration).leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet(productId, boardCode, freq, countryIso, options).then((request) => request(this.axios, this.basePath)); } @@ -9453,7 +9611,7 @@ export class LeaderboardApi extends BaseAPI { * @param {string} productId The Brokerage Product ID provided by GRL. * @param {LeaderboardCode} 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 {LeaderboardFrequency} 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 {string} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. + * @param {string | null} [countryIso] Country ISO Code (ISO 3166-1 alpha-2, lowercase) of the requested leaderboard. If not passed, thecountry is determined from the IP address of the HTTP request. * @param {string} [bpuid] Brokerage Product User ID. If passed, this results in the filtering of rows to include this user\'s row, plus rows above and below in rank (up to `limit` rows). Otherwise, the top `limit` rows are returned. * @param {string} [withinTime] Any local timestamp falling within the desired leaderboard\'s period. If not passed, uses the country\'s current time period. * @param {number} [limit] Max number of rows to return @@ -9461,7 +9619,7 @@ export class LeaderboardApi extends BaseAPI { * @throws {RequiredError} * @memberof LeaderboardApi */ - public timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string, bpuid?: string, withinTime?: string, limit?: number, options?: RawAxiosRequestConfig) { + public timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId: string, boardCode: LeaderboardCode, freq: LeaderboardFrequency, countryIso?: string | null, bpuid?: string, withinTime?: string, limit?: number, options?: RawAxiosRequestConfig) { return LeaderboardApiFp(this.configuration).timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet(productId, boardCode, freq, countryIso, bpuid, withinTime, limit, options).then((request) => request(this.axios, this.basePath)); } } @@ -9926,168 +10084,6 @@ export const OfferwallApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Only returns a single bucket with the top scoring tasks. - * @summary Single Offerwall - * @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} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - singleOfferwallProductIdOfferwall5fl8bpv5Get: async (productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, minBinSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - assertParamExists('singleOfferwallProductIdOfferwall5fl8bpv5Get', 'productId', productId) - // verify required parameter 'bpuid' is not null or undefined - assertParamExists('singleOfferwallProductIdOfferwall5fl8bpv5Get', 'bpuid', bpuid) - 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, 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 (minBinSize !== undefined) { - localVarQueryParameter['min_bin_size'] = minBinSize; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - 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 {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 {StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - starwallOfferwallProductIdOfferwallB59a2d2bGet: async (productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - assertParamExists('starwallOfferwallProductIdOfferwallB59a2d2bGet', 'productId', productId) - // verify required parameter 'bpuid' is not null or undefined - assertParamExists('starwallOfferwallProductIdOfferwallB59a2d2bGet', 'bpuid', bpuid) - 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, 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 (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - 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 {string} productId The Brokerage Product ID provided by GRL. @@ -10346,92 +10342,6 @@ export const OfferwallApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - * @summary Topn Offerwall - * @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 {TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topNOfferwallProductIdOfferwall45b7228a7Get: async (productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { - // verify required parameter 'productId' is not null or undefined - assertParamExists('topNOfferwallProductIdOfferwall45b7228a7Get', 'productId', productId) - // verify required parameter 'bpuid' is not null or undefined - assertParamExists('topNOfferwallProductIdOfferwall45b7228a7Get', 'bpuid', bpuid) - 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, 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 (splitBy !== undefined) { - localVarQueryParameter['split_by'] = splitBy; - } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - 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 {string} productId The Brokerage Product ID provided by GRL. @@ -10901,50 +10811,6 @@ export const OfferwallApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Only returns a single bucket with the top scoring tasks. - * @summary Single Offerwall - * @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} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async singleOfferwallProductIdOfferwall5fl8bpv5Get(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, minBinSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SingleEntryOfferWallResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.singleOfferwallProductIdOfferwall5fl8bpv5Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, minBinSize, options); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OfferwallApi.singleOfferwallProductIdOfferwall5fl8bpv5Get']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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 {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 {StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async starwallOfferwallProductIdOfferwallB59a2d2bGet(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StarwallOfferWallResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.starwallOfferwallProductIdOfferwallB59a2d2bGet(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OfferwallApi.starwallOfferwallProductIdOfferwallB59a2d2bGet']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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 {string} productId The Brokerage Product ID provided by GRL. @@ -11014,29 +10880,6 @@ export const OfferwallApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - * @summary Topn Offerwall - * @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 {TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async topNOfferwallProductIdOfferwall45b7228a7Get(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopNOfferWallResponse>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.topNOfferwallProductIdOfferwall45b7228a7Get(productId, bpuid, ip, countryIso, languages, behavior, minPayout, duration, nBins, minBinSize, splitBy, options); - const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['OfferwallApi.topNOfferwallProductIdOfferwall45b7228a7Get']?.[localVarOperationServerIndex]?.url; - return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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 {string} productId The Brokerage Product ID provided by GRL. @@ -11244,44 +11087,6 @@ export const OfferwallApiFactory = function (configuration?: Configuration, base return localVarFp.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 {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} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - singleOfferwallProductIdOfferwall5fl8bpv5Get(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, minBinSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<SingleEntryOfferWallResponse> { - return localVarFp.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 {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 {StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - starwallOfferwallProductIdOfferwallB59a2d2bGet(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum, options?: RawAxiosRequestConfig): AxiosPromise<StarwallOfferWallResponse> { - return localVarFp.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 {string} productId The Brokerage Product ID provided by GRL. @@ -11342,26 +11147,6 @@ export const OfferwallApiFactory = function (configuration?: Configuration, base return localVarFp.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 {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 {TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - topNOfferwallProductIdOfferwall45b7228a7Get(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum, options?: RawAxiosRequestConfig): AxiosPromise<TopNOfferWallResponse> { - return localVarFp.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 {string} productId The Brokerage Product ID provided by GRL. @@ -11569,48 +11354,6 @@ export class OfferwallApi extends BaseAPI { } /** - * Only returns a single bucket with the top scoring tasks. - * @summary Single Offerwall - * @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} [minBinSize] Minimum number of tasks that need to be in a bucket - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public singleOfferwallProductIdOfferwall5fl8bpv5Get(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, minBinSize?: number, options?: RawAxiosRequestConfig) { - 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 {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 {StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public starwallOfferwallProductIdOfferwallB59a2d2bGet(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum, options?: RawAxiosRequestConfig) { - 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 {string} productId The Brokerage Product ID provided by GRL. @@ -11677,28 +11420,6 @@ export class OfferwallApi extends BaseAPI { } /** - * Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - * @summary Topn Offerwall - * @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 {TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum} [splitBy] Cluster tasks by payout or duration - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof OfferwallApi - */ - public topNOfferwallProductIdOfferwall45b7228a7Get(productId: string, bpuid: string, ip?: string, countryIso?: string, languages?: Array<string>, behavior?: string, minPayout?: string, duration?: number, nBins?: number, minBinSize?: number, splitBy?: TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum, options?: RawAxiosRequestConfig) { - 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 {string} productId The Brokerage Product ID provided by GRL. @@ -11788,14 +11509,6 @@ export class OfferwallApi extends BaseAPI { /** * @export */ -export const StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum = { - Payout: 'payout', - Duration: 'duration' -} as const; -export type StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum = typeof StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum[keyof typeof StarwallOfferwallProductIdOfferwallB59a2d2bGetSplitByEnum]; -/** - * @export - */ export const StarwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4GetSplitByEnum = { Payout: 'payout', Duration: 'duration' @@ -11820,14 +11533,6 @@ export type StarwallPlusOfferwallProductIdOfferwall5481f322GetSplitByEnum = type /** * @export */ -export const TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum = { - Payout: 'payout', - Duration: 'duration' -} as const; -export type TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum = typeof TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum[keyof typeof TopNOfferwallProductIdOfferwall45b7228a7GetSplitByEnum]; -/** - * @export - */ export const TopNPlusBlockOfferwallProductIdOfferwallD48cce47GetSplitByEnum = { Payout: 'payout', Duration: 'duration' @@ -13149,12 +12854,162 @@ export class StreamsApi extends BaseAPI { /** + * THLApi - axios parameter creator + * @export + */ +export const THLApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * + * @summary Manage Cashout + * @param {ManageCashoutBody} manageCashoutBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + manageCashoutThlManageCashoutPost: async (manageCashoutBody: ManageCashoutBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'manageCashoutBody' is not null or undefined + assertParamExists('manageCashoutThlManageCashoutPost', 'manageCashoutBody', manageCashoutBody) + const localVarPath = `/thl/manage_cashout/`; + // 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; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(manageCashoutBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + } +}; + +/** + * THLApi - functional programming interface + * @export + */ +export const THLApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = THLApiAxiosParamCreator(configuration) + return { + /** + * + * @summary Manage Cashout + * @param {ManageCashoutBody} manageCashoutBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async manageCashoutThlManageCashoutPost(manageCashoutBody: ManageCashoutBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserPayoutEvent>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.manageCashoutThlManageCashoutPost(manageCashoutBody, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['THLApi.manageCashoutThlManageCashoutPost']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + } +}; + +/** + * THLApi - factory interface + * @export + */ +export const THLApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = THLApiFp(configuration) + return { + /** + * + * @summary Manage Cashout + * @param {ManageCashoutBody} manageCashoutBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + manageCashoutThlManageCashoutPost(manageCashoutBody: ManageCashoutBody, options?: RawAxiosRequestConfig): AxiosPromise<UserPayoutEvent> { + return localVarFp.manageCashoutThlManageCashoutPost(manageCashoutBody, options).then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * THLApi - object-oriented interface + * @export + * @class THLApi + * @extends {BaseAPI} + */ +export class THLApi extends BaseAPI { + /** + * + * @summary Manage Cashout + * @param {ManageCashoutBody} manageCashoutBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof THLApi + */ + public manageCashoutThlManageCashoutPost(manageCashoutBody: ManageCashoutBody, options?: RawAxiosRequestConfig) { + return THLApiFp(this.configuration).manageCashoutThlManageCashoutPost(manageCashoutBody, options).then((request) => request(this.axios, this.basePath)); + } +} + + + +/** * WalletApi - axios parameter creator * @export */ export const WalletApiAxiosParamCreator = function (configuration?: Configuration) { return { /** + * Attempt to claim an Attempt Credit from the user\'s latest Session. + * @summary Claim Latest Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {AttemptCreditClaimBody} attemptCreditClaimBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + claimLatestAttemptCreditProductIdWalletAttemptCreditPost: async (productId: string, attemptCreditClaimBody: AttemptCreditClaimBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('claimLatestAttemptCreditProductIdWalletAttemptCreditPost', 'productId', productId) + // verify required parameter 'attemptCreditClaimBody' is not null or undefined + assertParamExists('claimLatestAttemptCreditProductIdWalletAttemptCreditPost', 'attemptCreditClaimBody', attemptCreditClaimBody) + const localVarPath = `/{product_id}/wallet/attempt-credit/` + .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: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(attemptCreditClaimBody, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** * 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 {string} productId The Brokerage Product ID provided by GRL. @@ -13240,6 +13095,44 @@ export const WalletApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** + * Get an Attempt Credit by a user\'s Session. + * @summary Get Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} tsid A unique identifier for the session + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAttemptCreditProductIdWalletAttemptCreditTsidGet: async (productId: string, tsid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('getAttemptCreditProductIdWalletAttemptCreditTsidGet', 'productId', productId) + // verify required parameter 'tsid' is not null or undefined + assertParamExists('getAttemptCreditProductIdWalletAttemptCreditTsidGet', 'tsid', tsid) + const localVarPath = `/{product_id}/wallet/attempt-credit/{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, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** * Retrieve the details for a specific Cashout event * @summary Get Cashout Detail * @param {string} productId The Brokerage Product ID provided by GRL. @@ -13475,6 +13368,47 @@ export const WalletApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** + * Retrieve a respondent\'s wallets and balances for display + * @summary Get User Wallets + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUserWalletsProductIdWalletsGet: async (productId: string, bpuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => { + // verify required parameter 'productId' is not null or undefined + assertParamExists('getUserWalletsProductIdWalletsGet', 'productId', productId) + // verify required parameter 'bpuid' is not null or undefined + assertParamExists('getUserWalletsProductIdWalletsGet', 'bpuid', bpuid) + const localVarPath = `/{product_id}/wallets/` + .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; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + 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 {string} productId The Brokerage Product ID provided by GRL. @@ -13525,6 +13459,20 @@ export const WalletApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = WalletApiAxiosParamCreator(configuration) return { /** + * Attempt to claim an Attempt Credit from the user\'s latest Session. + * @summary Claim Latest Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {AttemptCreditClaimBody} attemptCreditClaimBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async claimLatestAttemptCreditProductIdWalletAttemptCreditPost(productId: string, attemptCreditClaimBody: AttemptCreditClaimBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AttemptCreditClaimResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.claimLatestAttemptCreditProductIdWalletAttemptCreditPost(productId, attemptCreditClaimBody, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WalletApi.claimLatestAttemptCreditProductIdWalletAttemptCreditPost']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** * 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 {string} productId The Brokerage Product ID provided by GRL. @@ -13554,6 +13502,20 @@ export const WalletApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** + * Get an Attempt Credit by a user\'s Session. + * @summary Get Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} tsid A unique identifier for the session + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getAttemptCreditProductIdWalletAttemptCreditTsidGet(productId: string, tsid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AttemptCreditClaimResponse>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getAttemptCreditProductIdWalletAttemptCreditTsidGet(productId, tsid, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WalletApi.getAttemptCreditProductIdWalletAttemptCreditTsidGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** * Retrieve the details for a specific Cashout event * @summary Get Cashout Detail * @param {string} productId The Brokerage Product ID provided by GRL. @@ -13630,6 +13592,20 @@ export const WalletApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** + * Retrieve a respondent\'s wallets and balances for display + * @summary Get User Wallets + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getUserWalletsProductIdWalletsGet(productId: string, bpuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserLedgerWallets>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getUserWalletsProductIdWalletsGet(productId, bpuid, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['WalletApi.getUserWalletsProductIdWalletsGet']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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 {string} productId The Brokerage Product ID provided by GRL. @@ -13654,6 +13630,17 @@ export const WalletApiFactory = function (configuration?: Configuration, basePat const localVarFp = WalletApiFp(configuration) return { /** + * Attempt to claim an Attempt Credit from the user\'s latest Session. + * @summary Claim Latest Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {AttemptCreditClaimBody} attemptCreditClaimBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + claimLatestAttemptCreditProductIdWalletAttemptCreditPost(productId: string, attemptCreditClaimBody: AttemptCreditClaimBody, options?: RawAxiosRequestConfig): AxiosPromise<AttemptCreditClaimResponse> { + return localVarFp.claimLatestAttemptCreditProductIdWalletAttemptCreditPost(productId, attemptCreditClaimBody, options).then((request) => request(axios, basePath)); + }, + /** * 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 {string} productId The Brokerage Product ID provided by GRL. @@ -13677,6 +13664,17 @@ export const WalletApiFactory = function (configuration?: Configuration, basePat return localVarFp.deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete(productId, cashoutMethodId, bpuid, options).then((request) => request(axios, basePath)); }, /** + * Get an Attempt Credit by a user\'s Session. + * @summary Get Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} tsid A unique identifier for the session + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getAttemptCreditProductIdWalletAttemptCreditTsidGet(productId: string, tsid: string, options?: RawAxiosRequestConfig): AxiosPromise<AttemptCreditClaimResponse> { + return localVarFp.getAttemptCreditProductIdWalletAttemptCreditTsidGet(productId, tsid, options).then((request) => request(axios, basePath)); + }, + /** * Retrieve the details for a specific Cashout event * @summary Get Cashout Detail * @param {string} productId The Brokerage Product ID provided by GRL. @@ -13738,6 +13736,17 @@ export const WalletApiFactory = function (configuration?: Configuration, basePat return localVarFp.getUserWalletBalanceProductIdWalletGet(productId, bpuid, options).then((request) => request(axios, basePath)); }, /** + * Retrieve a respondent\'s wallets and balances for display + * @summary Get User Wallets + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + */ + getUserWalletsProductIdWalletsGet(productId: string, bpuid: string, options?: RawAxiosRequestConfig): AxiosPromise<UserLedgerWallets> { + return localVarFp.getUserWalletsProductIdWalletsGet(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 {string} productId The Brokerage Product ID provided by GRL. @@ -13759,6 +13768,19 @@ export const WalletApiFactory = function (configuration?: Configuration, basePat */ export class WalletApi extends BaseAPI { /** + * Attempt to claim an Attempt Credit from the user\'s latest Session. + * @summary Claim Latest Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {AttemptCreditClaimBody} attemptCreditClaimBody + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletApi + */ + public claimLatestAttemptCreditProductIdWalletAttemptCreditPost(productId: string, attemptCreditClaimBody: AttemptCreditClaimBody, options?: RawAxiosRequestConfig) { + return WalletApiFp(this.configuration).claimLatestAttemptCreditProductIdWalletAttemptCreditPost(productId, attemptCreditClaimBody, options).then((request) => request(this.axios, this.basePath)); + } + + /** * 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 {string} productId The Brokerage Product ID provided by GRL. @@ -13786,6 +13808,19 @@ export class WalletApi extends BaseAPI { } /** + * Get an Attempt Credit by a user\'s Session. + * @summary Get Attempt Credit + * @param {string} productId The Brokerage Product ID provided by GRL. + * @param {string} tsid A unique identifier for the session + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletApi + */ + public getAttemptCreditProductIdWalletAttemptCreditTsidGet(productId: string, tsid: string, options?: RawAxiosRequestConfig) { + return WalletApiFp(this.configuration).getAttemptCreditProductIdWalletAttemptCreditTsidGet(productId, tsid, options).then((request) => request(this.axios, this.basePath)); + } + + /** * Retrieve the details for a specific Cashout event * @summary Get Cashout Detail * @param {string} productId The Brokerage Product ID provided by GRL. @@ -13857,6 +13892,19 @@ export class WalletApi extends BaseAPI { } /** + * Retrieve a respondent\'s wallets and balances for display + * @summary Get User Wallets + * @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 {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof WalletApi + */ + public getUserWalletsProductIdWalletsGet(productId: string, bpuid: string, options?: RawAxiosRequestConfig) { + return WalletApiFp(this.configuration).getUserWalletsProductIdWalletsGet(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 {string} productId The Brokerage Product ID provided by GRL. |