diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs')
248 files changed, 9579 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/AccountType.md b/jb-ui/src/api_fsb/docs/AccountType.md new file mode 100644 index 0000000..6d2e246 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AccountType.md @@ -0,0 +1,30 @@ +# AccountType + + +## Enum + +* `BpCommission` (value: `'bp_commission'`) + +* `BpWallet` (value: `'bp_wallet'`) + +* `UserWallet` (value: `'user_wallet'`) + +* `Cash` (value: `'cash'`) + +* `Revenue` (value: `'revenue'`) + +* `Expense` (value: `'expense'`) + +* `ContestWallet` (value: `'contest_wallet'`) + +* `CreditLine` (value: `'credit_line'`) + +* `WaWallet` (value: `'wa_wallet'`) + +* `WaBudgetPool` (value: `'wa_budget_pool'`) + +* `WaHeld` (value: `'wa_held'`) + +* `WaCreditLine` (value: `'wa_credit_line'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AdjustedAfter.md b/jb-ui/src/api_fsb/docs/AdjustedAfter.md new file mode 100644 index 0000000..e506770 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AdjustedAfter.md @@ -0,0 +1,19 @@ +# AdjustedAfter + +Retrieve sessions which were adjusted after this timestamp. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { AdjustedAfter } from './api'; + +const instance: AdjustedAfter = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AdjustedBefore.md b/jb-ui/src/api_fsb/docs/AdjustedBefore.md new file mode 100644 index 0000000..b54b9f0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AdjustedBefore.md @@ -0,0 +1,19 @@ +# AdjustedBefore + +Retrieve sessions which were adjusted before this timestamp. Default is now. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { AdjustedBefore } from './api'; + +const instance: AdjustedBefore = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AdjustedTimestamp.md b/jb-ui/src/api_fsb/docs/AdjustedTimestamp.md new file mode 100644 index 0000000..6a843d1 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AdjustedTimestamp.md @@ -0,0 +1,18 @@ +# AdjustedTimestamp + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { AdjustedTimestamp } from './api'; + +const instance: AdjustedTimestamp = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AdjustmentType.md b/jb-ui/src/api_fsb/docs/AdjustmentType.md new file mode 100644 index 0000000..bb7aad0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AdjustmentType.md @@ -0,0 +1,22 @@ +# AdjustmentType + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **number** | The total amount (in USD cents) that the Brokerage Producthas earned within a respective time period from a specificSource of Tasks. | [default to undefined] +**adjustment** | [**SessionAdjustedStatus**](SessionAdjustedStatus.md) | - `ac` = ADJUSTED_TO_COMPLETE - `af` = ADJUSTED_TO_FAIL - `pa` = PAYOUT_ADJUSTMENT | [default to undefined] + +## Example + +```typescript +import { AdjustmentType } from './api'; + +const instance: AdjustmentType = { + amount, + adjustment, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AggregateBySource.md b/jb-ui/src/api_fsb/docs/AggregateBySource.md new file mode 100644 index 0000000..af8ea60 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AggregateBySource.md @@ -0,0 +1,22 @@ +# AggregateBySource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **number** | | [optional] [default to 0] +**by_source** | **{ [key: string]: number; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { AggregateBySource } from './api'; + +const instance: AggregateBySource = { + total, + by_source, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AmtCashoutMethodData.md b/jb-ui/src/api_fsb/docs/AmtCashoutMethodData.md new file mode 100644 index 0000000..c9161cc --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AmtCashoutMethodData.md @@ -0,0 +1,20 @@ +# AmtCashoutMethodData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to TypeEnum_Amt] + +## Example + +```typescript +import { AmtCashoutMethodData } from './api'; + +const instance: AmtCashoutMethodData = { + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AuditLog.md b/jb-ui/src/api_fsb/docs/AuditLog.md new file mode 100644 index 0000000..3d47457 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AuditLog.md @@ -0,0 +1,33 @@ +# AuditLog + +Table / Model for logging \"actions\" taken by a user or \"events\" that are related to a User + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | | [optional] [default to undefined] +**user_id** | **number** | | [default to undefined] +**created** | **string** | When did this event occur | [optional] [default to undefined] +**level** | [**AuditLogLevel**](AuditLogLevel.md) | The level of importance for this event. Works the same as python logging levels. It is an integer 0 - 50, and implementers of this field could map it to the predefined levels: (`CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG`).This is NOT the same concept as the \'strength\' of whatever event happened; it is just for sorting, filtering and display purposes. For e.g. multiple level 20 events != the \'importance\' of one level 40 event. | [default to undefined] +**event_type** | **string** | | [default to undefined] +**event_msg** | **string** | | [optional] [default to undefined] +**event_value** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { AuditLog } from './api'; + +const instance: AuditLog = { + id, + user_id, + created, + level, + event_type, + event_msg, + event_value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/AuditLogLevel.md b/jb-ui/src/api_fsb/docs/AuditLogLevel.md new file mode 100644 index 0000000..6a61270 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AuditLogLevel.md @@ -0,0 +1,22 @@ +# AuditLogLevel + + +## Enum + +* `NUMBER_50` (value: `50`) + +* `NUMBER_502` (value: `50`) + +* `NUMBER_40` (value: `40`) + +* `NUMBER_30` (value: `30`) + +* `NUMBER_302` (value: `30`) + +* `NUMBER_20` (value: `20`) + +* `NUMBER_10` (value: `10`) + +* `NUMBER_0` (value: `0`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Body.md b/jb-ui/src/api_fsb/docs/Body.md new file mode 100644 index 0000000..34407b7 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Body.md @@ -0,0 +1,26 @@ +# Body + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bpuid** | **string** | (product_user_id) The user to create this cashout method for. | [default to undefined] +**type** | **string** | | [optional] [default to TypeEnum_Paypal] +**email** | **string** | Email address of the paypal user | [default to undefined] +**delivery_address** | [**USDeliveryAddress**](USDeliveryAddress.md) | Delivery address where payment should be sent | [default to undefined] + +## Example + +```typescript +import { Body } from './api'; + +const instance: Body = { + bpuid, + type, + email, + delivery_address, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost.md b/jb-ui/src/api_fsb/docs/BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost.md new file mode 100644 index 0000000..c409376 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost.md @@ -0,0 +1,20 @@ +# BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**answers** | [**Array<UserQuestionAnswerIn>**](UserQuestionAnswerIn.md) | | [default to undefined] + +## Example + +```typescript +import { BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost } from './api'; + +const instance: BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost = { + answers, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.md b/jb-ui/src/api_fsb/docs/BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.md new file mode 100644 index 0000000..6947ba6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost.md @@ -0,0 +1,20 @@ +# BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**answers** | [**Array<UserQuestionAnswerIn>**](UserQuestionAnswerIn.md) | | [default to undefined] + +## Example + +```typescript +import { BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost } from './api'; + +const instance: BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost = { + answers, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost.md b/jb-ui/src/api_fsb/docs/BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost.md new file mode 100644 index 0000000..90dd292 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost.md @@ -0,0 +1,20 @@ +# BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**answers** | [**Array<UserQuestionAnswerIn>**](UserQuestionAnswerIn.md) | | [default to undefined] + +## Example + +```typescript +import { BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost } from './api'; + +const instance: BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost = { + answers, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md b/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md new file mode 100644 index 0000000..c2d2ca6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md @@ -0,0 +1,47 @@ +# BrokerageProductPayoutEvent + +The amount - created: When the Brokerage Product was paid out + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**debit_account_uuid** | **string** | The LedgerAccount.uuid that money is being requested from. Thie User or Brokerage Product is retrievable through the LedgerAccount.reference_uuid | [default to undefined] +**cashout_method_uuid** | **string** | 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) | [default to undefined] +**created** | **string** | | [optional] [default to undefined] +**amount** | **number** | The USDCent amount int. This cannot be 0 or negative | [default to undefined] +**status** | [**PayoutStatus**](PayoutStatus.md) | | [optional] [default to undefined] +**ext_ref_id** | **string** | | [optional] [default to undefined] +**payout_type** | [**PayoutType**](PayoutType.md) | - `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 | [default to undefined] +**request_data** | **object** | Stores payout-type-specific information that is used to request this payout from the external provider. | [optional] [default to undefined] +**order_data** | [**OrderData**](OrderData.md) | | [optional] [default to undefined] +**product_id** | **string** | The Brokerage Product that was paid out | [default to undefined] +**method** | [**PayoutType**](PayoutType.md) | - `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 | [readonly] [default to undefined] +**amount_usd** | **number** | | [readonly] [default to undefined] +**amount_usd_str** | **string** | | [readonly] [default to undefined] + +## Example + +```typescript +import { BrokerageProductPayoutEvent } from './api'; + +const instance: BrokerageProductPayoutEvent = { + uuid, + debit_account_uuid, + cashout_method_uuid, + created, + amount, + status, + ext_ref_id, + payout_type, + request_data, + order_data, + product_id, + method, + amount_usd, + amount_usd_str, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/BucketTask.md b/jb-ui/src/api_fsb/docs/BucketTask.md new file mode 100644 index 0000000..0990789 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/BucketTask.md @@ -0,0 +1,29 @@ +# BucketTask + +This represents one of the \"tasks\" within a bucket\'s ordered list of tasks. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The internal task id for this task within the marketplace | [default to undefined] +**id_code** | **string** | The namespaced task id for this task within the marketplace | [default to undefined] +**source** | [**Source**](Source.md) | | [default to undefined] +**loi** | **number** | expected loi in seconds | [default to undefined] +**payout** | **number** | integer cents | [default to undefined] + +## Example + +```typescript +import { BucketTask } from './api'; + +const instance: BucketTask = { + id, + id_code, + source, + loi, + payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/BuyerId.md b/jb-ui/src/api_fsb/docs/BuyerId.md new file mode 100644 index 0000000..ac5ff74 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/BuyerId.md @@ -0,0 +1,18 @@ +# BuyerId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { BuyerId } from './api'; + +const instance: BuyerId = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Cardinality.md b/jb-ui/src/api_fsb/docs/Cardinality.md new file mode 100644 index 0000000..e9e940b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Cardinality.md @@ -0,0 +1,10 @@ +# Cardinality + + +## Enum + +* `Star` (value: `'*'`) + +* `QuestionMark` (value: `'?'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashMailCashoutMethodData.md b/jb-ui/src/api_fsb/docs/CashMailCashoutMethodData.md new file mode 100644 index 0000000..2951a64 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashMailCashoutMethodData.md @@ -0,0 +1,22 @@ +# CashMailCashoutMethodData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to TypeEnum_CashInMail] +**delivery_address** | [**USDeliveryAddress**](USDeliveryAddress.md) | Delivery address where payment should be sent | [default to undefined] + +## Example + +```typescript +import { CashMailCashoutMethodData } from './api'; + +const instance: CashMailCashoutMethodData = { + type, + delivery_address, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashMailOrderData.md b/jb-ui/src/api_fsb/docs/CashMailOrderData.md new file mode 100644 index 0000000..9679337 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashMailOrderData.md @@ -0,0 +1,36 @@ +# CashMailOrderData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to TypeEnum_CashInMail] +**shipping_cost** | **number** | | [default to undefined] +**tracking_number** | **string** | | [optional] [default to undefined] +**shipping_method** | [**ShippingMethod**](ShippingMethod.md) | | [optional] [default to undefined] +**carrier** | [**ShippingCarrier**](ShippingCarrier.md) | | [optional] [default to undefined] +**ship_date** | **string** | | [optional] [default to undefined] +**estimated_delivery_date** | **string** | | [optional] [default to undefined] +**delivery_status** | [**DeliveryStatus**](DeliveryStatus.md) | | [optional] [default to undefined] +**last_updated** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CashMailOrderData } from './api'; + +const instance: CashMailOrderData = { + type, + shipping_cost, + tracking_number, + shipping_method, + carrier, + ship_date, + estimated_delivery_date, + delivery_status, + last_updated, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodForeignValue.md b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValue.md new file mode 100644 index 0000000..e9e4ae4 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValue.md @@ -0,0 +1,25 @@ +# CashoutMethodForeignValue + +Shows the expected value of a redemption in a foreign currency. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **number** | Value of the redemption in the currency\'s smallest unit. | [default to undefined] +**currency** | [**RedemptionCurrency**](RedemptionCurrency.md) | Supported Currencies for Foreign Redemptions Allowed values: - __USD__ *(USD)*: US Dollars. Smallest Unit: Cents. - __CAD__ *(CAD)*: Canadian Dollars. Smallest Unit: Cents. - __GBP__ *(GBP)*: British Pounds. Smallest Unit: Pence. - __EUR__ *(EUR)*: Euros. Smallest Unit: Cents. - __INR__ *(INR)*: Indian Rupees. Smallest Unit: Paise. - __AUD__ *(AUD)*: Australian Dollars. Smallest Unit: Cents. - __PLN__ *(PLN)*: Polish Zloty. Smallest Unit: Grosz. - __SEK__ *(SEK)*: Swedish Krona. Smallest Unit: Öre. - __SGD__ *(SGD)*: Singapore Dollars. Smallest Unit: Cents. - __MXN__ *(MXN)*: Mexican Pesos. Smallest Unit: Centavos. | [default to undefined] +**value_string** | **string** | A string representation of the value in the currency. | [default to undefined] + +## Example + +```typescript +import { CashoutMethodForeignValue } from './api'; + +const instance: CashoutMethodForeignValue = { + value, + currency, + value_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodForeignValueResponse.md b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValueResponse.md new file mode 100644 index 0000000..5d7345b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValueResponse.md @@ -0,0 +1,24 @@ +# CashoutMethodForeignValueResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**cashout_method_value** | [**CashoutMethodForeignValue**](CashoutMethodForeignValue.md) | | [default to undefined] + +## Example + +```typescript +import { CashoutMethodForeignValueResponse } from './api'; + +const instance: CashoutMethodForeignValueResponse = { + status, + msg, + cashout_method_value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodOut.md b/jb-ui/src/api_fsb/docs/CashoutMethodOut.md new file mode 100644 index 0000000..c4e4832 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutMethodOut.md @@ -0,0 +1,50 @@ +# CashoutMethodOut + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique ID for this cashout method | [default to undefined] +**currency** | **string** | The currency of the cashout. Only USD is supported. | [optional] [default to CurrencyEnum_Usd] +**original_currency** | [**Currency**](Currency.md) | | [optional] [default to undefined] +**data** | [**Data**](Data.md) | | [default to undefined] +**description** | **string** | The description of the cashout method. | [optional] [default to ''] +**image_url** | **string** | | [optional] [default to undefined] +**max_value** | **number** | (In lowest unit of the original_currency), The maximum amount that can be cashed out in one transaction. | [default to undefined] +**min_value** | **number** | (In lowest unit of the original_currency), The minimum amount that can be cashed out in one transaction. | [default to undefined] +**name** | **string** | A descriptive name for the cashout method. | [default to undefined] +**type** | [**PayoutType**](PayoutType.md) | 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 | [default to undefined] +**ext_id** | **string** | | [optional] [default to undefined] +**usd_exchange_rate** | **number** | | [optional] [default to undefined] +**max_value_usd** | **number** | | [optional] [default to undefined] +**min_value_usd** | **number** | | [optional] [default to undefined] +**product_id** | **string** | | [optional] [default to undefined] +**product_user_id** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CashoutMethodOut } from './api'; + +const instance: CashoutMethodOut = { + id, + currency, + original_currency, + data, + description, + image_url, + max_value, + min_value, + name, + type, + ext_id, + usd_exchange_rate, + max_value_usd, + min_value_usd, + product_id, + product_user_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodResponse.md b/jb-ui/src/api_fsb/docs/CashoutMethodResponse.md new file mode 100644 index 0000000..4775d15 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutMethodResponse.md @@ -0,0 +1,24 @@ +# CashoutMethodResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**cashout_method** | [**CashoutMethodOut**](CashoutMethodOut.md) | | [default to undefined] + +## Example + +```typescript +import { CashoutMethodResponse } from './api'; + +const instance: CashoutMethodResponse = { + status, + msg, + cashout_method, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodsResponse.md b/jb-ui/src/api_fsb/docs/CashoutMethodsResponse.md new file mode 100644 index 0000000..b90d887 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutMethodsResponse.md @@ -0,0 +1,24 @@ +# CashoutMethodsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**cashout_methods** | [**Array<CashoutMethodOut>**](CashoutMethodOut.md) | | [default to undefined] + +## Example + +```typescript +import { CashoutMethodsResponse } from './api'; + +const instance: CashoutMethodsResponse = { + status, + msg, + cashout_methods, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashoutRequestInfo.md b/jb-ui/src/api_fsb/docs/CashoutRequestInfo.md new file mode 100644 index 0000000..b008871 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutRequestInfo.md @@ -0,0 +1,29 @@ +# CashoutRequestInfo + +See models.thl.payout: PayoutEvent. We\'ve confused a CashOut and a Payout. This is used only in the API response. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**description** | **string** | This is the name of the cashout method. | [default to undefined] +**message** | **string** | | [optional] [default to undefined] +**status** | [**PayoutStatus**](PayoutStatus.md) | | [optional] [default to undefined] +**transaction_info** | **object** | | [optional] [default to undefined] + +## Example + +```typescript +import { CashoutRequestInfo } from './api'; + +const instance: CashoutRequestInfo = { + id, + description, + message, + status, + transaction_info, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CashoutRequestResponse.md b/jb-ui/src/api_fsb/docs/CashoutRequestResponse.md new file mode 100644 index 0000000..a91d277 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutRequestResponse.md @@ -0,0 +1,24 @@ +# CashoutRequestResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**cashout** | [**CashoutRequestInfo**](CashoutRequestInfo.md) | | [default to undefined] + +## Example + +```typescript +import { CashoutRequestResponse } from './api'; + +const instance: CashoutRequestResponse = { + status, + msg, + cashout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Category.md b/jb-ui/src/api_fsb/docs/Category.md new file mode 100644 index 0000000..c59cf77 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Category.md @@ -0,0 +1,28 @@ +# Category + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [default to undefined] +**adwords_vertical_id** | **string** | | [optional] [default to undefined] +**label** | **string** | | [default to undefined] +**path** | **string** | | [default to undefined] +**parent_uuid** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { Category } from './api'; + +const instance: Category = { + uuid, + adwords_vertical_id, + label, + path, + parent_uuid, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CategoryAssociation.md b/jb-ui/src/api_fsb/docs/CategoryAssociation.md new file mode 100644 index 0000000..8dea3cb --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CategoryAssociation.md @@ -0,0 +1,29 @@ +# CategoryAssociation + +Used in an offerwall. Stores the association between a category and a bucket, with a score. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The category ID | [default to undefined] +**label** | **string** | The category label | [default to undefined] +**adwords_id** | **string** | | [optional] [default to undefined] +**adwords_label** | **string** | | [optional] [default to undefined] +**p** | **number** | The strength of the association of this bucketwith this category. Will sum to 1 within a bucket. | [default to undefined] + +## Example + +```typescript +import { CategoryAssociation } from './api'; + +const instance: CategoryAssociation = { + id, + label, + adwords_id, + adwords_label, + p, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestApi.md b/jb-ui/src/api_fsb/docs/ContestApi.md new file mode 100644 index 0000000..57b11f4 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestApi.md @@ -0,0 +1,234 @@ +# ContestApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getContestUserViewProductIdContestContestUuidUserProductUserIdGet**](#getcontestuserviewproductidcontestcontestuuiduserproductuseridget) | **GET** /{product_id}/contest/{contest_uuid}/user/{product_user_id}/ | Get Contest User View| +|[**listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet**](#listcontestsusereligibleproductidcontestuserproductuserideligibleget) | **GET** /{product_id}/contest/user/{product_user_id}/eligible/ | List Contests User Eligible| +|[**listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet**](#listcontestsuserenteredproductidcontestuserproductuseridenteredget) | **GET** /{product_id}/contest/user/{product_user_id}/entered/ | List Contests User Entered| +|[**listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet**](#listcontestsuserwinnerproductidcontestuserproductuseridwinnerget) | **GET** /{product_id}/contest/user/{product_user_id}/winner/ | List Contests User Winner| + +# **getContestUserViewProductIdContestContestUuidUserProductUserIdGet** +> ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet getContestUserViewProductIdContestContestUuidUserProductUserIdGet() + +Gets a Contest. Includes several keys that are specific to the requesting user: e.g. user_winnings, user_amount. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let contestUuid: string; // (default to undefined) +let productUserId: string; //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. (default to undefined) + +const { status, data } = await apiInstance.getContestUserViewProductIdContestContestUuidUserProductUserIdGet( + productId, + contestUuid, + productUserId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **contestUuid** | [**string**] | | defaults to undefined| +| **productUserId** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet** +> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet() + +Get contests the requesting user is eligible for. Contest eligibility may involve the user\'s country, which is determined by the ip address of THIS request. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let productUserId: string; //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. (default to undefined) + +const { status, data } = await apiInstance.listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet( + productId, + productUserId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **productUserId** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet** +> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet() + +Get contests the requesting user has entered. This includes contests such as milestone contests where the user was automatically entered by having a complete for instance. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let productUserId: string; //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. (default to undefined) + +const { status, data } = await apiInstance.listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet( + productId, + productUserId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **productUserId** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet** +> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet() + +Get contests the requesting user has won a prize for. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let productUserId: string; //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. (default to undefined) + +const { status, data } = await apiInstance.listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet( + productId, + productUserId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **productUserId** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/ContestEndCondition.md b/jb-ui/src/api_fsb/docs/ContestEndCondition.md new file mode 100644 index 0000000..095a519 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestEndCondition.md @@ -0,0 +1,23 @@ +# ContestEndCondition + +Defines the conditions to evaluate to determine when the contest is over. Multiple conditions can be set. The contest is over once ANY conditions are met. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target_entry_amount** | [**ContestEndConditionTargetEntryAmount**](ContestEndConditionTargetEntryAmount.md) | | [optional] [default to undefined] +**ends_at** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { ContestEndCondition } from './api'; + +const instance: ContestEndCondition = { + target_entry_amount, + ends_at, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestEndConditionTargetEntryAmount.md b/jb-ui/src/api_fsb/docs/ContestEndConditionTargetEntryAmount.md new file mode 100644 index 0000000..247fd40 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestEndConditionTargetEntryAmount.md @@ -0,0 +1,18 @@ +# ContestEndConditionTargetEntryAmount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { ContestEndConditionTargetEntryAmount } from './api'; + +const instance: ContestEndConditionTargetEntryAmount = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestEndReason.md b/jb-ui/src/api_fsb/docs/ContestEndReason.md new file mode 100644 index 0000000..c85eba5 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestEndReason.md @@ -0,0 +1,15 @@ +# ContestEndReason + +Defines why a contest ended + +## Enum + +* `Cancelled` (value: `'cancelled'`) + +* `TargetEntryAmount` (value: `'target_entry_amount'`) + +* `EndsAt` (value: `'ends_at'`) + +* `MaxWinners` (value: `'max_winners'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestEntryRule.md b/jb-ui/src/api_fsb/docs/ContestEntryRule.md new file mode 100644 index 0000000..c6ec370 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestEntryRule.md @@ -0,0 +1,29 @@ +# ContestEntryRule + +Defines rules the user must meet to be allowed to enter this contest Only applies if the ContestType is ENTRY! + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_entry_amount_per_user** | [**MaxEntryAmountPerUser**](MaxEntryAmountPerUser.md) | | [optional] [default to undefined] +**max_daily_entries_per_user** | **number** | | [optional] [default to undefined] +**min_completes** | **number** | | [optional] [default to undefined] +**min_membership_level** | **number** | | [optional] [default to undefined] +**id_verified** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { ContestEntryRule } from './api'; + +const instance: ContestEntryRule = { + max_entry_amount_per_user, + max_daily_entries_per_user, + min_completes, + min_membership_level, + id_verified, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestEntryTrigger.md b/jb-ui/src/api_fsb/docs/ContestEntryTrigger.md new file mode 100644 index 0000000..f66f142 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestEntryTrigger.md @@ -0,0 +1,13 @@ +# ContestEntryTrigger + +Defines what action/event triggers a (possible) entry into the contest (automatically). This only is valid on milestone contests + +## Enum + +* `TaskComplete` (value: `'task_complete'`) + +* `TaskAttempt` (value: `'task_attempt'`) + +* `Referral` (value: `'referral'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestPrize.md b/jb-ui/src/api_fsb/docs/ContestPrize.md new file mode 100644 index 0000000..03483a6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestPrize.md @@ -0,0 +1,32 @@ +# ContestPrize + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | [**ContestPrizeKind**](ContestPrizeKind.md) | Allowed values: - __physical__ *(PHYSICAL)*: A physical prize (e.g. a iPhone, cash in the mail, dinner with Max) - __promotion__ *(PROMOTION)*: A promotion is a temporary or special offer that provides extra value or benefits (e.g. 20% bonus on completes for the next 7 days) - __cash__ *(CASH)*: Money is deposited into user\'s virtual wallet | [default to undefined] +**name** | **string** | | [optional] [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**estimated_cash_value** | **number** | Estimated cash value of prize in USDCents | [default to undefined] +**cash_amount** | **number** | | [optional] [default to undefined] +**promotion_id** | **string** | | [optional] [default to undefined] +**leaderboard_rank** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { ContestPrize } from './api'; + +const instance: ContestPrize = { + kind, + name, + description, + estimated_cash_value, + cash_amount, + promotion_id, + leaderboard_rank, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestPrizeKind.md b/jb-ui/src/api_fsb/docs/ContestPrizeKind.md new file mode 100644 index 0000000..2246597 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestPrizeKind.md @@ -0,0 +1,12 @@ +# ContestPrizeKind + + +## Enum + +* `Physical` (value: `'physical'`) + +* `Promotion` (value: `'promotion'`) + +* `Cash` (value: `'cash'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestStatus.md b/jb-ui/src/api_fsb/docs/ContestStatus.md new file mode 100644 index 0000000..8d856ee --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestStatus.md @@ -0,0 +1,12 @@ +# ContestStatus + + +## Enum + +* `Active` (value: `'active'`) + +* `Completed` (value: `'completed'`) + +* `Cancelled` (value: `'cancelled'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ContestWinner.md b/jb-ui/src/api_fsb/docs/ContestWinner.md new file mode 100644 index 0000000..22a4aa5 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestWinner.md @@ -0,0 +1,29 @@ +# ContestWinner + +In a Raffle, the ContestEntryType can be COUNT or CASH. In the CASH type, the unit of entry is 1 USDCent (one penny). Implicitly, each penny entered buys 1 entry into the raffle, and one entry is randomly selected for each prize. A contest should have as many winners as there are prizes special case 1: there are fewer entries than prizes special case 2: leaderboard contest with ties + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**created_at** | **string** | When this user won this prize | [optional] [default to undefined] +**prize** | [**ContestPrize**](ContestPrize.md) | | [default to undefined] +**awarded_cash_amount** | **number** | | [optional] [default to undefined] +**product_user_id** | **string** | | [default to undefined] + +## Example + +```typescript +import { ContestWinner } from './api'; + +const instance: ContestWinner = { + uuid, + created_at, + prize, + awarded_cash_amount, + product_user_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CountStat.md b/jb-ui/src/api_fsb/docs/CountStat.md new file mode 100644 index 0000000..4baad8f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CountStat.md @@ -0,0 +1,22 @@ +# CountStat + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**facet** | [**{ [key: string]: FacetValue; }**](FacetValue.md) | The grouping criteria | [default to undefined] +**count** | **number** | The count value for the given metric and facet | [default to undefined] + +## Example + +```typescript +import { CountStat } from './api'; + +const instance: CountStat = { + facet, + count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CreateCashMailCashoutMethodRequest.md b/jb-ui/src/api_fsb/docs/CreateCashMailCashoutMethodRequest.md new file mode 100644 index 0000000..da377c0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CreateCashMailCashoutMethodRequest.md @@ -0,0 +1,24 @@ +# CreateCashMailCashoutMethodRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bpuid** | **string** | (product_user_id) The user to create this cashout method for. | [default to undefined] +**type** | **string** | | [optional] [default to TypeEnum_CashInMail] +**delivery_address** | [**USDeliveryAddress**](USDeliveryAddress.md) | Delivery address where payment should be sent | [default to undefined] + +## Example + +```typescript +import { CreateCashMailCashoutMethodRequest } from './api'; + +const instance: CreateCashMailCashoutMethodRequest = { + bpuid, + type, + delivery_address, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CreateCashoutRequest.md b/jb-ui/src/api_fsb/docs/CreateCashoutRequest.md new file mode 100644 index 0000000..9744756 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CreateCashoutRequest.md @@ -0,0 +1,24 @@ +# CreateCashoutRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bpuid** | **string** | (product_user_id) The user requesting a cashout. | [default to undefined] +**amount** | **number** | (USD cents) The amount requested for the cashout. | [default to undefined] +**cashout_method_id** | **string** | Unique ID for the cashout method the cashout is being requested with. | [default to undefined] + +## Example + +```typescript +import { CreateCashoutRequest } from './api'; + +const instance: CreateCashoutRequest = { + bpuid, + amount, + cashout_method_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CreatePayPalCashoutMethodRequest.md b/jb-ui/src/api_fsb/docs/CreatePayPalCashoutMethodRequest.md new file mode 100644 index 0000000..3d63341 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CreatePayPalCashoutMethodRequest.md @@ -0,0 +1,24 @@ +# CreatePayPalCashoutMethodRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bpuid** | **string** | (product_user_id) The user to create this cashout method for. | [default to undefined] +**type** | **string** | | [optional] [default to TypeEnum_Paypal] +**email** | **string** | Email address of the paypal user | [default to undefined] + +## Example + +```typescript +import { CreatePayPalCashoutMethodRequest } from './api'; + +const instance: CreatePayPalCashoutMethodRequest = { + bpuid, + type, + email, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Currency.md b/jb-ui/src/api_fsb/docs/Currency.md new file mode 100644 index 0000000..a24afe8 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Currency.md @@ -0,0 +1,26 @@ +# Currency + + +## Enum + +* `Usd` (value: `'USD'`) + +* `Cad` (value: `'CAD'`) + +* `Gbp` (value: `'GBP'`) + +* `Eur` (value: `'EUR'`) + +* `Inr` (value: `'INR'`) + +* `Aud` (value: `'AUD'`) + +* `Pln` (value: `'PLN'`) + +* `Sek` (value: `'SEK'`) + +* `Sgd` (value: `'SGD'`) + +* `Mxn` (value: `'MXN'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/CurrentAmount.md b/jb-ui/src/api_fsb/docs/CurrentAmount.md new file mode 100644 index 0000000..f9bffdb --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CurrentAmount.md @@ -0,0 +1,19 @@ +# CurrentAmount + +Sum of all entry amounts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { CurrentAmount } from './api'; + +const instance: CurrentAmount = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/DashboardApi.md b/jb-ui/src/api_fsb/docs/DashboardApi.md new file mode 100644 index 0000000..aa109a1 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/DashboardApi.md @@ -0,0 +1,59 @@ +# DashboardApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**marketplaceInventoryDashboardInventoryGet**](#marketplaceinventorydashboardinventoryget) | **GET** /dashboard/inventory/ | Marketplace Inventory| + +# **marketplaceInventoryDashboardInventoryGet** +> MarketplaceSummary marketplaceInventoryDashboardInventoryGet() + + +### Example + +```typescript +import { + DashboardApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DashboardApi(configuration); + +let marketplace: 'WXET'; // (default to undefined) + +const { status, data } = await apiInstance.marketplaceInventoryDashboardInventoryGet( + marketplace +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **marketplace** | [**'WXET'**]**Array<'WXET'>** | | defaults to undefined| + + +### Return type + +**MarketplaceSummary** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/Data.md b/jb-ui/src/api_fsb/docs/Data.md new file mode 100644 index 0000000..60f716f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Data.md @@ -0,0 +1,34 @@ +# Data + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to TypeEnum_Paypal] +**email** | **string** | Email address of the paypal user | [default to undefined] +**utid** | **string** | tango utid | [default to undefined] +**countries** | **Array<string>** | | [default to undefined] +**value_type** | **string** | | [default to undefined] +**disclaimer** | **string** | | [optional] [default to ''] +**terms** | **string** | | [optional] [default to ''] +**delivery_address** | [**USDeliveryAddress**](USDeliveryAddress.md) | Delivery address where payment should be sent | [default to undefined] + +## Example + +```typescript +import { Data } from './api'; + +const instance: Data = { + type, + email, + utid, + countries, + value_type, + disclaimer, + terms, + delivery_address, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/DefaultApi.md b/jb-ui/src/api_fsb/docs/DefaultApi.md new file mode 100644 index 0000000..5d70a4b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/DefaultApi.md @@ -0,0 +1,139 @@ +# DefaultApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**returnNothingFaviconIcoGet**](#returnnothingfaviconicoget) | **GET** /favicon.ico | Return Nothing| +|[**returnNothingRobotsTxtGet**](#returnnothingrobotstxtget) | **GET** /robots.txt | Return Nothing| +|[**returnNothingSitemapXmlGet**](#returnnothingsitemapxmlget) | **GET** /sitemap.xml | Return Nothing| + +# **returnNothingFaviconIcoGet** +> any returnNothingFaviconIcoGet() + + +### Example + +```typescript +import { + DefaultApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DefaultApi(configuration); + +const { status, data } = await apiInstance.returnNothingFaviconIcoGet(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**any** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **returnNothingRobotsTxtGet** +> any returnNothingRobotsTxtGet() + + +### Example + +```typescript +import { + DefaultApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DefaultApi(configuration); + +const { status, data } = await apiInstance.returnNothingRobotsTxtGet(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**any** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **returnNothingSitemapXmlGet** +> any returnNothingSitemapXmlGet() + + +### Example + +```typescript +import { + DefaultApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DefaultApi(configuration); + +const { status, data } = await apiInstance.returnNothingSitemapXmlGet(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**any** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/DeliveryStatus.md b/jb-ui/src/api_fsb/docs/DeliveryStatus.md new file mode 100644 index 0000000..8d79d1c --- /dev/null +++ b/jb-ui/src/api_fsb/docs/DeliveryStatus.md @@ -0,0 +1,24 @@ +# DeliveryStatus + + +## Enum + +* `Pending` (value: `'Pending'`) + +* `Shipped` (value: `'Shipped'`) + +* `InTransit` (value: `'In Transit'`) + +* `OutForDelivery` (value: `'Out for Delivery'`) + +* `Delivered` (value: `'Delivered'`) + +* `Returned` (value: `'Returned'`) + +* `Canceled` (value: `'Canceled'`) + +* `FailedAttempt` (value: `'Failed Attempt'`) + +* `Lost` (value: `'Lost'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Direction.md b/jb-ui/src/api_fsb/docs/Direction.md new file mode 100644 index 0000000..70e2183 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Direction.md @@ -0,0 +1,11 @@ +# Direction + +Entries on the debit side will increase debit normal accounts, while entries on the credit side will decrease them. Conversely, entries on the credit side will increase credit normal accounts, while entries on the debit side will decrease them. By convention (?), the db will store transactions as debit-normal. For a credit-normal account, we should flip the signs. + +## Enum + +* `NUMBER_MINUS_1` (value: `-1`) + +* `NUMBER_1` (value: `1`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/DurationSummary.md b/jb-ui/src/api_fsb/docs/DurationSummary.md new file mode 100644 index 0000000..d865013 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/DurationSummary.md @@ -0,0 +1,35 @@ +# DurationSummary + +Durations are in integer seconds. Describes the statistical distribution of expected durations of tasks within this bucket. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min** | **number** | | [default to undefined] +**max** | **number** | | [default to undefined] +**mean** | **number** | | [optional] [default to undefined] +**q1** | **number** | | [default to undefined] +**q2** | **number** | | [default to undefined] +**q3** | **number** | | [default to undefined] +**lower_whisker** | **number** | | [readonly] [default to undefined] +**upper_whisker** | **number** | | [readonly] [default to undefined] + +## Example + +```typescript +import { DurationSummary } from './api'; + +const instance: DurationSummary = { + min, + max, + mean, + q1, + q2, + q3, + lower_whisker, + upper_whisker, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/EventEnvelope.md b/jb-ui/src/api_fsb/docs/EventEnvelope.md new file mode 100644 index 0000000..8da827d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/EventEnvelope.md @@ -0,0 +1,32 @@ +# EventEnvelope + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_uuid** | **string** | | [optional] [default to undefined] +**event_type** | [**EventType**](EventType.md) | | [default to undefined] +**timestamp** | **string** | | [optional] [default to undefined] +**version** | **number** | | [optional] [default to 1] +**product_user_id** | **string** | | [optional] [default to undefined] +**product_id** | **string** | | [default to undefined] +**payload** | [**Payload**](Payload.md) | | [default to undefined] + +## Example + +```typescript +import { EventEnvelope } from './api'; + +const instance: EventEnvelope = { + event_uuid, + event_type, + timestamp, + version, + product_user_id, + product_id, + payload, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/EventMessage.md b/jb-ui/src/api_fsb/docs/EventMessage.md new file mode 100644 index 0000000..4895dee --- /dev/null +++ b/jb-ui/src/api_fsb/docs/EventMessage.md @@ -0,0 +1,24 @@ +# EventMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **string** | | [optional] [default to KindEnum_Event] +**timestamp** | **string** | | [optional] [default to undefined] +**data** | [**EventEnvelope**](EventEnvelope.md) | | [default to undefined] + +## Example + +```typescript +import { EventMessage } from './api'; + +const instance: EventMessage = { + kind, + timestamp, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/EventType.md b/jb-ui/src/api_fsb/docs/EventType.md new file mode 100644 index 0000000..37dc081 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/EventType.md @@ -0,0 +1,22 @@ +# EventType + + +## Enum + +* `TaskEnter` (value: `'task.enter'`) + +* `TaskFinish` (value: `'task.finish'`) + +* `SessionEnter` (value: `'session.enter'`) + +* `SessionFinish` (value: `'session.finish'`) + +* `WalletCredit` (value: `'wallet.credit'`) + +* `WalletDebit` (value: `'wallet.debit'`) + +* `UserCreated` (value: `'user.created'`) + +* `UserActive` (value: `'user.active'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ExtStatusCode1.md b/jb-ui/src/api_fsb/docs/ExtStatusCode1.md new file mode 100644 index 0000000..6cb32d9 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ExtStatusCode1.md @@ -0,0 +1,18 @@ +# ExtStatusCode1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { ExtStatusCode1 } from './api'; + +const instance: ExtStatusCode1 = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ExtStatusCode2.md b/jb-ui/src/api_fsb/docs/ExtStatusCode2.md new file mode 100644 index 0000000..b8531d1 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ExtStatusCode2.md @@ -0,0 +1,18 @@ +# ExtStatusCode2 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { ExtStatusCode2 } from './api'; + +const instance: ExtStatusCode2 = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ExtStatusCode3.md b/jb-ui/src/api_fsb/docs/ExtStatusCode3.md new file mode 100644 index 0000000..e2e31ef --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ExtStatusCode3.md @@ -0,0 +1,18 @@ +# ExtStatusCode3 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { ExtStatusCode3 } from './api'; + +const instance: ExtStatusCode3 = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/FacetValue.md b/jb-ui/src/api_fsb/docs/FacetValue.md new file mode 100644 index 0000000..f06f26c --- /dev/null +++ b/jb-ui/src/api_fsb/docs/FacetValue.md @@ -0,0 +1,18 @@ +# FacetValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { FacetValue } from './api'; + +const instance: FacetValue = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Finished.md b/jb-ui/src/api_fsb/docs/Finished.md new file mode 100644 index 0000000..e9b7cde --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Finished.md @@ -0,0 +1,18 @@ +# Finished + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { Finished } from './api'; + +const instance: Finished = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/GeoIPInformation.md b/jb-ui/src/api_fsb/docs/GeoIPInformation.md new file mode 100644 index 0000000..5df598e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/GeoIPInformation.md @@ -0,0 +1,90 @@ +# GeoIPInformation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**geoname_id** | **number** | | [optional] [default to undefined] +**continent_code** | **string** | | [optional] [default to undefined] +**continent_name** | **string** | | [optional] [default to undefined] +**country_iso** | **string** | The ISO code of the country associated with the IP address. | [default to undefined] +**country_name** | **string** | | [optional] [default to undefined] +**subdivision_1_iso** | **string** | | [optional] [default to undefined] +**subdivision_1_name** | **string** | | [optional] [default to undefined] +**subdivision_2_iso** | **string** | | [optional] [default to undefined] +**subdivision_2_name** | **string** | | [optional] [default to undefined] +**city_name** | **string** | | [optional] [default to undefined] +**metro_code** | **number** | | [optional] [default to undefined] +**time_zone** | **string** | | [optional] [default to undefined] +**is_in_european_union** | **boolean** | | [optional] [default to undefined] +**updated** | **string** | | [optional] [default to undefined] +**ip** | **string** | | [default to undefined] +**registered_country_iso** | **string** | | [optional] [default to undefined] +**is_anonymous** | **boolean** | | [optional] [default to undefined] +**is_anonymous_vpn** | **boolean** | | [optional] [default to undefined] +**is_hosting_provider** | **boolean** | | [optional] [default to undefined] +**is_public_proxy** | **boolean** | | [optional] [default to undefined] +**is_tor_exit_node** | **boolean** | | [optional] [default to undefined] +**is_residential_proxy** | **boolean** | | [optional] [default to undefined] +**autonomous_system_number** | **number** | | [optional] [default to undefined] +**autonomous_system_organization** | **string** | | [optional] [default to undefined] +**domain** | **string** | | [optional] [default to undefined] +**isp** | **string** | | [optional] [default to undefined] +**mobile_country_code** | **string** | | [optional] [default to undefined] +**mobile_network_code** | **string** | | [optional] [default to undefined] +**network** | **string** | | [optional] [default to undefined] +**organization** | **string** | | [optional] [default to undefined] +**static_ip_score** | **number** | | [optional] [default to undefined] +**user_type** | [**UserType**](UserType.md) | | [optional] [default to undefined] +**postal_code** | **string** | | [optional] [default to undefined] +**latitude** | **number** | | [optional] [default to undefined] +**longitude** | **number** | | [optional] [default to undefined] +**accuracy_radius** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { GeoIPInformation } from './api'; + +const instance: GeoIPInformation = { + geoname_id, + continent_code, + continent_name, + country_iso, + country_name, + subdivision_1_iso, + subdivision_1_name, + subdivision_2_iso, + subdivision_2_name, + city_name, + metro_code, + time_zone, + is_in_european_union, + updated, + ip, + registered_country_iso, + is_anonymous, + is_anonymous_vpn, + is_hosting_provider, + is_public_proxy, + is_tor_exit_node, + is_residential_proxy, + autonomous_system_number, + autonomous_system_organization, + domain, + isp, + mobile_country_code, + mobile_network_code, + network, + organization, + static_ip_score, + user_type, + postal_code, + latitude, + longitude, + accuracy_radius, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/HTTPValidationError.md b/jb-ui/src/api_fsb/docs/HTTPValidationError.md new file mode 100644 index 0000000..7fe160d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/HTTPValidationError.md @@ -0,0 +1,20 @@ +# HTTPValidationError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail** | [**Array<ValidationError>**](ValidationError.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { HTTPValidationError } from './api'; + +const instance: HTTPValidationError = { + detail, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/IntegrationMode.md b/jb-ui/src/api_fsb/docs/IntegrationMode.md new file mode 100644 index 0000000..cafd829 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/IntegrationMode.md @@ -0,0 +1,10 @@ +# IntegrationMode + + +## Enum + +* `Platform` (value: `'platform'`) + +* `PassThrough` (value: `'pass_through'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Leaderboard.md b/jb-ui/src/api_fsb/docs/Leaderboard.md new file mode 100644 index 0000000..adae56c --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Leaderboard.md @@ -0,0 +1,55 @@ +# Leaderboard + +A leaderboard exists independently for each product_id in each country. Each country is associated with a single timezone. There is a daily, weekly, and monthly leaderboard. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique ID for this leaderboard | [optional] [default to undefined] +**name** | **string** | Descriptive name for the leaderboard based on the board_code | [optional] [default to undefined] +**board_code** | [**LeaderboardCode**](LeaderboardCode.md) | 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 | [default to undefined] +**bpid** | **string** | product_id | [default to undefined] +**country_iso** | **string** | The country this leaderboard is for. | [default to undefined] +**freq** | [**LeaderboardFrequency**](LeaderboardFrequency.md) | 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 | [default to undefined] +**timezone_name** | **string** | The timezone for the requested country | [optional] [default to undefined] +**sort_order** | **string** | | [optional] [default to SortOrderEnum_Descending] +**row_count** | **number** | The total number of rows in the leaderboard. | [default to undefined] +**rows** | [**Array<LeaderboardRow>**](LeaderboardRow.md) | | [optional] [default to undefined] +**period_start_local** | **string** | The start of the time period covered by this board in local time, tz-aware | [default to undefined] +**period_end_local** | **string** | The end of the time period covered by this board in local time, tz-aware | [optional] [default to undefined] +**start_timestamp** | **number** | (unix timestamp) The start time of the time range this leaderboard covers. | [readonly] [default to undefined] +**end_timestamp** | **number** | (unix timestamp) The end time of the time range this leaderboard covers. | [readonly] [default to undefined] +**utc_offset** | **string** | The UTC offset for the timezone | [readonly] [default to undefined] +**local_start_time** | **string** | The start time of the time range this leaderboard covers (local time, in the leaderboard\'s timezone). | [readonly] [default to undefined] +**local_end_time** | **string** | The end time of the time range this leaderboard covers (local time, in the leaderboard\'s timezone). | [readonly] [default to undefined] +**start_end_str** | **string** | A formatted string for time period covered by this leaderboard. Can be used to display to users. | [readonly] [default to undefined] + +## Example + +```typescript +import { Leaderboard } from './api'; + +const instance: Leaderboard = { + id, + name, + board_code, + bpid, + country_iso, + freq, + timezone_name, + sort_order, + row_count, + rows, + period_start_local, + period_end_local, + start_timestamp, + end_timestamp, + utc_offset, + local_start_time, + local_end_time, + start_end_str, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LeaderboardApi.md b/jb-ui/src/api_fsb/docs/LeaderboardApi.md new file mode 100644 index 0000000..a54a22a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardApi.md @@ -0,0 +1,139 @@ +# LeaderboardApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet**](#leaderboardwinnersproductidleaderboardtimespanboardcodewinnersget) | **GET** /{product_id}/leaderboard/timespan/{board_code}/winners/ | Leaderboard Winners| +|[**timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet**](#timespanleaderboardproductidleaderboardtimespanboardcodeget) | **GET** /{product_id}/leaderboard/timespan/{board_code}/ | Timespan Leaderboard| + +# **leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet** +> LeaderboardWinnerResponse leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet() + +Get the Winners of leaderboard contests + +### Example + +```typescript +import { + LeaderboardApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new LeaderboardApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let boardCode: LeaderboardCode; //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 (default to undefined) +let freq: LeaderboardFrequency; //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 (default to undefined) +let countryIso: string; //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. (optional) (default to undefined) + +const { status, data } = await apiInstance.leaderboardWinnersProductIdLeaderboardTimespanBoardCodeWinnersGet( + productId, + boardCode, + freq, + countryIso +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **boardCode** | **LeaderboardCode** | 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 | defaults to undefined| +| **freq** | **LeaderboardFrequency** | 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 | defaults to undefined| +| **countryIso** | [**string**] | 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. | (optional) defaults to undefined| + + +### Return type + +**LeaderboardWinnerResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet** +> LeaderboardResponse timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet() + + +### Example + +```typescript +import { + LeaderboardApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new LeaderboardApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let boardCode: LeaderboardCode; //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 (default to undefined) +let freq: LeaderboardFrequency; //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 (default to undefined) +let countryIso: string; //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. (optional) (default to undefined) +let bpuid: string; //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. (optional) (default to undefined) +let withinTime: string; //Any local timestamp falling within the desired leaderboard\'s period. If not passed, uses the country\'s current time period. (optional) (default to undefined) +let limit: number; //Max number of rows to return (optional) (default to 50) + +const { status, data } = await apiInstance.timespanLeaderboardProductIdLeaderboardTimespanBoardCodeGet( + productId, + boardCode, + freq, + countryIso, + bpuid, + withinTime, + limit +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **boardCode** | **LeaderboardCode** | 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 | defaults to undefined| +| **freq** | **LeaderboardFrequency** | 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 | defaults to undefined| +| **countryIso** | [**string**] | 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. | (optional) defaults to undefined| +| **bpuid** | [**string**] | 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. | (optional) defaults to undefined| +| **withinTime** | [**string**] | Any local timestamp falling within the desired leaderboard\'s period. If not passed, uses the country\'s current time period. | (optional) defaults to undefined| +| **limit** | [**number**] | Max number of rows to return | (optional) defaults to 50| + + +### Return type + +**LeaderboardResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/LeaderboardCode.md b/jb-ui/src/api_fsb/docs/LeaderboardCode.md new file mode 100644 index 0000000..7f3ba72 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardCode.md @@ -0,0 +1,13 @@ +# LeaderboardCode + +The type of leaderboard. What the \"values\" represent. + +## Enum + +* `CompleteCount` (value: `'complete_count'`) + +* `LargestUserPayout` (value: `'largest_user_payout'`) + +* `SumUserPayout` (value: `'sum_user_payout'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md b/jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md new file mode 100644 index 0000000..609f69d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md @@ -0,0 +1,60 @@ +# LeaderboardContestUserView + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of contest. Can be displayed to user. | [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**contest_type** | **string** | | [optional] [default to ContestTypeEnum_Leaderboard] +**end_condition** | [**ContestEndCondition**](ContestEndCondition.md) | | [optional] [default to undefined] +**prizes** | [**Array<ContestPrize>**](ContestPrize.md) | | [optional] [default to undefined] +**starts_at** | **string** | When the contest starts | [optional] [default to undefined] +**terms_and_conditions** | **string** | | [optional] [default to undefined] +**status** | [**ContestStatus**](ContestStatus.md) | | [optional] [default to undefined] +**country_isos** | **string** | | [optional] [default to undefined] +**uuid** | **string** | | [optional] [default to undefined] +**product_id** | **string** | Contest applies only to a single BP | [default to undefined] +**created_at** | **string** | When this contest was created | [optional] [default to undefined] +**updated_at** | **string** | When this contest was last modified. Does not include entries being created/modified | [optional] [default to undefined] +**ended_at** | **string** | | [optional] [default to undefined] +**end_reason** | [**ContestEndReason**](ContestEndReason.md) | | [optional] [default to undefined] +**product_user_id** | **string** | | [default to undefined] +**user_winnings** | [**Array<ContestWinner>**](ContestWinner.md) | The prizes won in this contest by the requested user | [optional] [default to undefined] +**leaderboard_key** | **string** | The specific leaderboard instance this contest is connected to | [default to undefined] +**tie_break_strategy** | **string** | | [optional] [default to TieBreakStrategyEnum_SplitPrizePool] +**country_iso** | **string** | | [readonly] [default to undefined] +**user_rank** | **number** | | [default to undefined] + +## Example + +```typescript +import { LeaderboardContestUserView } from './api'; + +const instance: LeaderboardContestUserView = { + name, + description, + contest_type, + end_condition, + prizes, + starts_at, + terms_and_conditions, + status, + country_isos, + uuid, + product_id, + created_at, + updated_at, + ended_at, + end_reason, + product_user_id, + user_winnings, + leaderboard_key, + tie_break_strategy, + country_iso, + user_rank, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LeaderboardFrequency.md b/jb-ui/src/api_fsb/docs/LeaderboardFrequency.md new file mode 100644 index 0000000..3e8728c --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardFrequency.md @@ -0,0 +1,13 @@ +# LeaderboardFrequency + +The time period range for the leaderboard. + +## Enum + +* `Daily` (value: `'daily'`) + +* `Weekly` (value: `'weekly'`) + +* `Monthly` (value: `'monthly'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LeaderboardResponse.md b/jb-ui/src/api_fsb/docs/LeaderboardResponse.md new file mode 100644 index 0000000..11d4559 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardResponse.md @@ -0,0 +1,24 @@ +# LeaderboardResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**leaderboard** | [**Leaderboard**](Leaderboard.md) | | [default to undefined] + +## Example + +```typescript +import { LeaderboardResponse } from './api'; + +const instance: LeaderboardResponse = { + status, + msg, + leaderboard, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LeaderboardRow.md b/jb-ui/src/api_fsb/docs/LeaderboardRow.md new file mode 100644 index 0000000..23ad7ab --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardRow.md @@ -0,0 +1,24 @@ +# LeaderboardRow + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bpuid** | **string** | product_user_id | [default to undefined] +**rank** | **number** | The numerical data ranks (1 through n) of the values. Ties are ranked using the lowest rank in the group. | [default to undefined] +**value** | **number** | The value. The meaning of the value is dependent on the LeaderboardCode. | [default to undefined] + +## Example + +```typescript +import { LeaderboardRow } from './api'; + +const instance: LeaderboardRow = { + bpuid, + rank, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LeaderboardWinner.md b/jb-ui/src/api_fsb/docs/LeaderboardWinner.md new file mode 100644 index 0000000..1abfaba --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardWinner.md @@ -0,0 +1,40 @@ +# LeaderboardWinner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rank** | **number** | The user\'s final rank in the leaderboard | [default to undefined] +**freq** | [**LeaderboardFrequency**](LeaderboardFrequency.md) | 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 | [default to undefined] +**board_code** | [**LeaderboardCode**](LeaderboardCode.md) | 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 | [default to undefined] +**country_iso** | **string** | The country this leaderboard is for. | [default to undefined] +**issued** | **string** | When the prize was issued. | [default to undefined] +**bpuid** | **string** | product_user_id | [default to undefined] +**description** | **string** | | [default to undefined] +**amount** | **number** | (USD cents) The reward amount | [default to undefined] +**amount_str** | **string** | The amount as a formatted string in USD. Can be displayed to the user. | [default to undefined] +**contest_start** | **string** | When the leaderboard started | [default to undefined] +**contest_end** | **string** | When the leaderboard ended | [default to undefined] + +## Example + +```typescript +import { LeaderboardWinner } from './api'; + +const instance: LeaderboardWinner = { + rank, + freq, + board_code, + country_iso, + issued, + bpuid, + description, + amount, + amount_str, + contest_start, + contest_end, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LeaderboardWinnerResponse.md b/jb-ui/src/api_fsb/docs/LeaderboardWinnerResponse.md new file mode 100644 index 0000000..1b89707 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardWinnerResponse.md @@ -0,0 +1,24 @@ +# LeaderboardWinnerResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**winners** | [**Array<LeaderboardWinner>**](LeaderboardWinner.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { LeaderboardWinnerResponse } from './api'; + +const instance: LeaderboardWinnerResponse = { + status, + msg, + winners, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LedgerAccount.md b/jb-ui/src/api_fsb/docs/LedgerAccount.md new file mode 100644 index 0000000..f9b1ffa --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LedgerAccount.md @@ -0,0 +1,34 @@ +# LedgerAccount + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | A unique identifier for this Ledger Account | [optional] [default to undefined] +**display_name** | **string** | Human-readable description of the Ledger Account | [default to undefined] +**qualified_name** | **string** | | [default to undefined] +**account_type** | [**AccountType**](AccountType.md) | - `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 | [default to undefined] +**normal_balance** | [**Direction**](Direction.md) | - `-1` = CREDIT - `1` = DEBIT | [default to undefined] +**reference_type** | **string** | | [optional] [default to undefined] +**reference_uuid** | **string** | | [optional] [default to undefined] +**currency** | **string** | GRL\'s Ledger system allows tracking of transactions inany currency possible. This is useful for trackingpoints, stars, coins, or any other currency that may beused in a Supplier\'s platform. | [optional] [default to 'USD'] + +## Example + +```typescript +import { LedgerAccount } from './api'; + +const instance: LedgerAccount = { + uuid, + display_name, + qualified_name, + account_type, + normal_balance, + reference_type, + reference_uuid, + currency, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LedgerEntry.md b/jb-ui/src/api_fsb/docs/LedgerEntry.md new file mode 100644 index 0000000..12f44b8 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LedgerEntry.md @@ -0,0 +1,28 @@ +# LedgerEntry + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | | [optional] [default to undefined] +**direction** | [**Direction**](Direction.md) | | [default to undefined] +**account_uuid** | **string** | | [default to undefined] +**amount** | **number** | The USDCent amount. A LedgerEntry cannot be made for0 USDCent and it cannot be negative. | [default to undefined] +**transaction_id** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { LedgerEntry } from './api'; + +const instance: LedgerEntry = { + id, + direction, + account_uuid, + amount, + transaction_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/LedgerTransaction.md b/jb-ui/src/api_fsb/docs/LedgerTransaction.md new file mode 100644 index 0000000..edf5abc --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LedgerTransaction.md @@ -0,0 +1,30 @@ +# LedgerTransaction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | | [optional] [default to undefined] +**created** | **string** | When the Transaction (TX) was created into the database.This does not represent the exact time for any actionwhich may be responsible for this Transaction (TX), and TX timestamps will likely be a few milliseconds delayed | [optional] [default to undefined] +**ext_description** | **string** | | [optional] [default to undefined] +**tag** | **string** | | [optional] [default to undefined] +**metadata** | **{ [key: string]: string; }** | | [optional] [default to undefined] +**entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | A Transaction (TX) is composed of multiple Entry events. | [optional] [default to undefined] + +## Example + +```typescript +import { LedgerTransaction } from './api'; + +const instance: LedgerTransaction = { + id, + created, + ext_description, + tag, + metadata, + entries, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner.md b/jb-ui/src/api_fsb/docs/ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner.md new file mode 100644 index 0000000..efb1f80 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner.md @@ -0,0 +1,86 @@ +# ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of contest. Can be displayed to user. | [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**contest_type** | **string** | | [optional] [default to ContestTypeEnum_Milestone] +**end_condition** | [**MilestoneContestEndCondition**](MilestoneContestEndCondition.md) | | [default to undefined] +**prizes** | [**Array<ContestPrize>**](ContestPrize.md) | | [optional] [default to undefined] +**starts_at** | **string** | When the contest starts | [optional] [default to undefined] +**terms_and_conditions** | **string** | | [optional] [default to undefined] +**status** | [**ContestStatus**](ContestStatus.md) | | [optional] [default to undefined] +**country_isos** | **string** | | [optional] [default to undefined] +**uuid** | **string** | | [optional] [default to undefined] +**product_id** | **string** | Contest applies only to a single BP | [default to undefined] +**created_at** | **string** | When this contest was created | [optional] [default to undefined] +**updated_at** | **string** | When this contest was last modified. Does not include entries being created/modified | [optional] [default to undefined] +**ended_at** | **string** | | [optional] [default to undefined] +**end_reason** | [**ContestEndReason**](ContestEndReason.md) | | [optional] [default to undefined] +**product_user_id** | **string** | | [default to undefined] +**user_winnings** | [**Array<ContestWinner>**](ContestWinner.md) | The prizes won in this contest by the requested user | [optional] [default to undefined] +**entry_type** | **string** | | [optional] [default to EntryTypeEnum_Count] +**entry_rule** | [**ContestEntryRule**](ContestEntryRule.md) | | [optional] [default to undefined] +**current_amount** | [**CurrentAmount**](CurrentAmount.md) | | [optional] [default to undefined] +**current_participants** | **number** | Count of unique participants | [optional] [default to 0] +**user_amount** | **number** | The total amount for this user for this contest | [default to undefined] +**user_amount_today** | [**UserAmountToday**](UserAmountToday.md) | | [default to undefined] +**current_win_probability** | **number** | Probability of this user winning 1 or more prizes, if the contestended right now | [readonly] [default to undefined] +**projected_win_probability** | **number** | | [default to undefined] +**leaderboard_key** | **string** | The specific leaderboard instance this contest is connected to | [default to undefined] +**tie_break_strategy** | **string** | | [optional] [default to TieBreakStrategyEnum_SplitPrizePool] +**country_iso** | **string** | | [readonly] [default to undefined] +**user_rank** | **number** | | [default to undefined] +**target_amount** | **number** | Each user \'wins\' (receives prizes) once this target amount is reached. | [default to undefined] +**entry_trigger** | [**ContestEntryTrigger**](ContestEntryTrigger.md) | | [optional] [default to undefined] +**valid_for** | **string** | | [optional] [default to undefined] +**valid_for_event** | **string** | | [optional] [default to undefined] +**win_count** | **number** | The number of times the milestone has been reached. | [optional] [default to 0] + +## Example + +```typescript +import { ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner } from './api'; + +const instance: ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner = { + name, + description, + contest_type, + end_condition, + prizes, + starts_at, + terms_and_conditions, + status, + country_isos, + uuid, + product_id, + created_at, + updated_at, + ended_at, + end_reason, + product_user_id, + user_winnings, + entry_type, + entry_rule, + current_amount, + current_participants, + user_amount, + user_amount_today, + current_win_probability, + projected_win_probability, + leaderboard_key, + tie_break_strategy, + country_iso, + user_rank, + target_amount, + entry_trigger, + valid_for, + valid_for_event, + win_count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MarketProfileKnowledge.md b/jb-ui/src/api_fsb/docs/MarketProfileKnowledge.md new file mode 100644 index 0000000..0e6e36a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MarketProfileKnowledge.md @@ -0,0 +1,27 @@ +# MarketProfileKnowledge + +This is used solely in API responses, so it is simplified. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**Source**](Source.md) | Marketplace this question is from | [default to undefined] +**question_id** | **string** | | [default to undefined] +**answer** | **Array<string>** | | [optional] [default to undefined] +**created** | **string** | When the User submitted this Profiling data | [default to undefined] + +## Example + +```typescript +import { MarketProfileKnowledge } from './api'; + +const instance: MarketProfileKnowledge = { + source, + question_id, + answer, + created, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MarketplaceBucket.md b/jb-ui/src/api_fsb/docs/MarketplaceBucket.md new file mode 100644 index 0000000..568db7b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MarketplaceBucket.md @@ -0,0 +1,40 @@ +# MarketplaceBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] +**x** | **number** | For UI. Provides a dimensionality position for the bucket on the x-axis. | [optional] [default to 0] +**y** | **number** | For UI. Provides a dimensionality position for the bucket on the y-axis. | [optional] [default to 0] +**name** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**description** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**category** | [**Array<CategoryAssociation>**](CategoryAssociation.md) | | [optional] [default to undefined] +**contents** | [**Array<BucketTask>**](BucketTask.md) | | [default to undefined] +**duration** | [**DurationSummary**](DurationSummary.md) | | [default to undefined] +**payout** | [**PayoutSummary**](PayoutSummary.md) | | [default to undefined] +**source** | **string** | this is the source of the contents | [default to undefined] + +## Example + +```typescript +import { MarketplaceBucket } from './api'; + +const instance: MarketplaceBucket = { + id, + uri, + x, + y, + name, + description, + category, + contents, + duration, + payout, + source, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MarketplaceInventorySummary.md b/jb-ui/src/api_fsb/docs/MarketplaceInventorySummary.md new file mode 100644 index 0000000..a5cb21d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MarketplaceInventorySummary.md @@ -0,0 +1,32 @@ +# MarketplaceInventorySummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**live_tasks** | [**Array<CountStat>**](CountStat.md) | The count of tasks that are currently live | [optional] [default to undefined] +**live_gen_pop_tasks** | [**Array<CountStat>**](CountStat.md) | The count of gen-pop tasks that are currently live | [optional] [default to undefined] +**tasks_created** | [**Array<CountStat>**](CountStat.md) | The count of tasks created | [optional] [default to undefined] +**required_finishes** | [**Array<CountStat>**](CountStat.md) | Number of finishes needed across all live tasks | [optional] [default to undefined] +**payout** | [**Array<StatisticalSummaryStat>**](StatisticalSummaryStat.md) | The distribution of payouts for all live tasks | [optional] [default to undefined] +**expected_duration** | [**Array<StatisticalSummaryStat>**](StatisticalSummaryStat.md) | The distribution of expected durations for all live tasks | [optional] [default to undefined] +**required_finishes_per_task** | [**Array<StatisticalSummaryStat>**](StatisticalSummaryStat.md) | The distribution of required finishes on all live tasks | [optional] [default to undefined] + +## Example + +```typescript +import { MarketplaceInventorySummary } from './api'; + +const instance: MarketplaceInventorySummary = { + live_tasks, + live_gen_pop_tasks, + tasks_created, + required_finishes, + payout, + expected_duration, + required_finishes_per_task, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md b/jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md new file mode 100644 index 0000000..9216bbf --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MarketplaceOfferwall.md @@ -0,0 +1,29 @@ +# MarketplaceOfferwall + +Returns buckets grouped by marketplace, one per marketplace, with the tasks ordered by quality. Offerwall code: `5fa23085` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<MarketplaceBucket>**](MarketplaceBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { MarketplaceOfferwall } from './api'; + +const instance: MarketplaceOfferwall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MarketplaceOfferwallResponse.md b/jb-ui/src/api_fsb/docs/MarketplaceOfferwallResponse.md new file mode 100644 index 0000000..897750a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MarketplaceOfferwallResponse.md @@ -0,0 +1,22 @@ +# MarketplaceOfferwallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**MarketplaceOfferwall**](MarketplaceOfferwall.md) | | [default to undefined] + +## Example + +```typescript +import { MarketplaceOfferwallResponse } from './api'; + +const instance: MarketplaceOfferwallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MarketplaceSummary.md b/jb-ui/src/api_fsb/docs/MarketplaceSummary.md new file mode 100644 index 0000000..4a9c430 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MarketplaceSummary.md @@ -0,0 +1,22 @@ +# MarketplaceSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inventory** | [**MarketplaceInventorySummary**](MarketplaceInventorySummary.md) | Inventory of the marketplace | [default to undefined] +**user_activity** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { MarketplaceSummary } from './api'; + +const instance: MarketplaceSummary = { + inventory, + user_activity, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MaxEntryAmountPerUser.md b/jb-ui/src/api_fsb/docs/MaxEntryAmountPerUser.md new file mode 100644 index 0000000..005ef6a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MaxEntryAmountPerUser.md @@ -0,0 +1,19 @@ +# MaxEntryAmountPerUser + +Maximum total value of entries per user + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { MaxEntryAmountPerUser } from './api'; + +const instance: MaxEntryAmountPerUser = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MaxGaugeBySource.md b/jb-ui/src/api_fsb/docs/MaxGaugeBySource.md new file mode 100644 index 0000000..53def64 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MaxGaugeBySource.md @@ -0,0 +1,22 @@ +# MaxGaugeBySource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **number** | | [optional] [default to undefined] +**by_source** | **{ [key: string]: number; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { MaxGaugeBySource } from './api'; + +const instance: MaxGaugeBySource = { + value, + by_source, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MilestoneContestEndCondition.md b/jb-ui/src/api_fsb/docs/MilestoneContestEndCondition.md new file mode 100644 index 0000000..f1d632d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MilestoneContestEndCondition.md @@ -0,0 +1,23 @@ +# MilestoneContestEndCondition + +Defines the conditions to evaluate to determine when the contest is over. Multiple conditions can be set. The contest is over once ANY conditions are met. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_winners** | **number** | | [optional] [default to undefined] +**ends_at** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { MilestoneContestEndCondition } from './api'; + +const instance: MilestoneContestEndCondition = { + max_winners, + ends_at, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/MilestoneUserView.md b/jb-ui/src/api_fsb/docs/MilestoneUserView.md new file mode 100644 index 0000000..2836ff3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/MilestoneUserView.md @@ -0,0 +1,66 @@ +# MilestoneUserView + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target_amount** | **number** | Each user \'wins\' (receives prizes) once this target amount is reached. | [default to undefined] +**entry_trigger** | [**ContestEntryTrigger**](ContestEntryTrigger.md) | | [optional] [default to undefined] +**valid_for** | **string** | | [optional] [default to undefined] +**valid_for_event** | **string** | | [optional] [default to undefined] +**name** | **string** | Name of contest. Can be displayed to user. | [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**contest_type** | **string** | | [optional] [default to ContestTypeEnum_Milestone] +**end_condition** | [**MilestoneContestEndCondition**](MilestoneContestEndCondition.md) | | [default to undefined] +**prizes** | [**Array<ContestPrize>**](ContestPrize.md) | | [optional] [default to undefined] +**starts_at** | **string** | When the contest starts | [optional] [default to undefined] +**terms_and_conditions** | **string** | | [optional] [default to undefined] +**status** | [**ContestStatus**](ContestStatus.md) | | [optional] [default to undefined] +**country_isos** | **string** | | [optional] [default to undefined] +**uuid** | **string** | | [optional] [default to undefined] +**product_id** | **string** | Contest applies only to a single BP | [default to undefined] +**created_at** | **string** | When this contest was created | [optional] [default to undefined] +**updated_at** | **string** | When this contest was last modified. Does not include entries being created/modified | [optional] [default to undefined] +**ended_at** | **string** | | [optional] [default to undefined] +**end_reason** | [**ContestEndReason**](ContestEndReason.md) | | [optional] [default to undefined] +**product_user_id** | **string** | | [default to undefined] +**user_winnings** | [**Array<ContestWinner>**](ContestWinner.md) | The prizes won in this contest by the requested user | [optional] [default to undefined] +**entry_type** | **string** | | [optional] [default to EntryTypeEnum_Count] +**win_count** | **number** | The number of times the milestone has been reached. | [optional] [default to 0] +**user_amount** | **number** | The total amount for this user for this contest | [default to undefined] + +## Example + +```typescript +import { MilestoneUserView } from './api'; + +const instance: MilestoneUserView = { + target_amount, + entry_trigger, + valid_for, + valid_for_event, + name, + description, + contest_type, + end_condition, + prizes, + starts_at, + terms_and_conditions, + status, + country_isos, + uuid, + product_id, + created_at, + updated_at, + ended_at, + end_reason, + product_user_id, + user_winnings, + entry_type, + win_count, + user_amount, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OfferWallCategoryRequest.md b/jb-ui/src/api_fsb/docs/OfferWallCategoryRequest.md new file mode 100644 index 0000000..0121f7f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OfferWallCategoryRequest.md @@ -0,0 +1,26 @@ +# OfferWallCategoryRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**adwords_category** | **Array<string>** | | [optional] [default to undefined] +**category** | **Array<string>** | | [optional] [default to undefined] +**exclude_adwords_category** | **Array<string>** | | [optional] [default to undefined] +**exclude_category** | **Array<string>** | | [optional] [default to undefined] + +## Example + +```typescript +import { OfferWallCategoryRequest } from './api'; + +const instance: OfferWallCategoryRequest = { + adwords_category, + category, + exclude_adwords_category, + exclude_category, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OfferWallInfo.md b/jb-ui/src/api_fsb/docs/OfferWallInfo.md new file mode 100644 index 0000000..755b939 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OfferWallInfo.md @@ -0,0 +1,20 @@ +# OfferWallInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **boolean** | | [default to undefined] + +## Example + +```typescript +import { OfferWallInfo } from './api'; + +const instance: OfferWallInfo = { + success, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OfferWallRequestYieldmanParams.md b/jb-ui/src/api_fsb/docs/OfferWallRequestYieldmanParams.md new file mode 100644 index 0000000..2bad5cf --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OfferWallRequestYieldmanParams.md @@ -0,0 +1,28 @@ +# OfferWallRequestYieldmanParams + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conversion_factor_adj** | **number** | Centered around 0. Higher results in higher weight given to conversion (in the scoring function) | [optional] [default to 0.0] +**dropoffrate_factor_adj** | **number** | Centered around 0. Higher results in higher penalty given to dropoffs (in the scoring function) | [optional] [default to 0.0] +**longfail_factor_adj** | **number** | Centered around 0. Higher results in higher penalty given to long fail (in the scoring function) | [optional] [default to 0.0] +**recon_factor_adj** | **number** | Centered around 0. Higher results in higher penalty given to recons (in the scoring function) | [optional] [default to 0.0] +**recon_likelihood_max** | **number** | Tolerance for recon likelihood (0 to 1) | [optional] [default to 0.8] + +## Example + +```typescript +import { OfferWallRequestYieldmanParams } from './api'; + +const instance: OfferWallRequestYieldmanParams = { + conversion_factor_adj, + dropoffrate_factor_adj, + longfail_factor_adj, + recon_factor_adj, + recon_likelihood_max, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OfferwallApi.md b/jb-ui/src/api_fsb/docs/OfferwallApi.md new file mode 100644 index 0000000..8e7591d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OfferwallApi.md @@ -0,0 +1,1286 @@ +# OfferwallApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**marketplaceOfferwallProductIdOfferwall5fa23085Get**](#marketplaceofferwallproductidofferwall5fa23085get) | **GET** /{product_id}/offerwall/5fa23085/ | Marketplace Offerwall| +|[**offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost**](#offerwallsoftpairblockpostproductidofferwall7a89dcdbofferwallidpost) | **POST** /{product_id}/offerwall/7a89dcdb/{offerwall_id}/ | Offerwall Softpair Block Post| +|[**offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet**](#offerwallsoftpairblockproductidofferwall7a89dcdbget) | **GET** /{product_id}/offerwall/7a89dcdb/ | Offerwall Softpair Block| +|[**offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost**](#offerwallsoftpairpostproductidofferwall37d1da64offerwallidpost) | **POST** /{product_id}/offerwall/37d1da64/{offerwall_id}/ | Offerwall Softpair Post| +|[**offerwallSoftpairProductIdOfferwall37d1da64Get**](#offerwallsoftpairproductidofferwall37d1da64get) | **GET** /{product_id}/offerwall/37d1da64/ | Offerwall Softpair| +|[**oneShotOfferwallProductIdOfferwall6f27b1aeGet**](#oneshotofferwallproductidofferwall6f27b1aeget) | **GET** /{product_id}/offerwall/6f27b1ae/ | One Shot Offerwall| +|[**singleOfferwallProductIdOfferwall5fl8bpv5Get**](#singleofferwallproductidofferwall5fl8bpv5get) | **GET** /{product_id}/offerwall/5fl8bpv5/ | Single Offerwall| +|[**starwallOfferwallProductIdOfferwallB59a2d2bGet**](#starwallofferwallproductidofferwallb59a2d2bget) | **GET** /{product_id}/offerwall/b59a2d2b/ | Starwall Offerwall| +|[**starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get**](#starwallplusblockofferwallproductidofferwall7fa1b3f4get) | **GET** /{product_id}/offerwall/7fa1b3f4/ | Starwall Plus Block Offerwall| +|[**starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get**](#starwallplusblockrecontactofferwallproductidofferwall630db2a4get) | **GET** /{product_id}/offerwall/630db2a4/ | Starwall Plus Block Recontact Offerwall| +|[**starwallPlusOfferwallProductIdOfferwall5481f322Get**](#starwallplusofferwallproductidofferwall5481f322get) | **GET** /{product_id}/offerwall/5481f322/ | Starwall Plus Offerwall| +|[**topNOfferwallProductIdOfferwall45b7228a7Get**](#topnofferwallproductidofferwall45b7228a7get) | **GET** /{product_id}/offerwall/45b7228a7/ | Topn Offerwall| +|[**topNPlusBlockOfferwallProductIdOfferwallD48cce47Get**](#topnplusblockofferwallproductidofferwalld48cce47get) | **GET** /{product_id}/offerwall/d48cce47/ | Topn Plus Block Offerwall| +|[**topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get**](#topnplusblockrecontactofferwallproductidofferwall1e5f0af8get) | **GET** /{product_id}/offerwall/1e5f0af8/ | Topn Plus Block Recontact Offerwall| +|[**topNPlusOfferwallProductIdOfferwallB145b803Get**](#topnplusofferwallproductidofferwallb145b803get) | **GET** /{product_id}/offerwall/b145b803/ | Topn Plus Offerwall| +|[**wXETOfferwallProductIdOfferwall55a4e1a9Get**](#wxetofferwallproductidofferwall55a4e1a9get) | **GET** /{product_id}/offerwall/55a4e1a9/ | Wxet Offerwall| + +# **marketplaceOfferwallProductIdOfferwall5fa23085Get** +> MarketplaceOfferwallResponse marketplaceOfferwallProductIdOfferwall5fa23085Get() + +Returns buckets grouped by marketplace, one per marketplace, with the tasks ordered by quality. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) + +const { status, data } = await apiInstance.marketplaceOfferwallProductIdOfferwall5fa23085Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + minBinSize +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| + + +### Return type + +**MarketplaceOfferwallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost** +> SoftPairOfferwallResponse offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost(bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost) + +This is a custom endpoint for a softpair-style offerwall that allows you to update profiling answers and then immediately get back the updated offerwall + +### Example + +```typescript +import { + OfferwallApi, + Configuration, + BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let offerwallId: string; //The offerwall ID the user is interacting with (default to undefined) +let bpuid: string; //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. (default to undefined) +let bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost: BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost; // +let sessionId: string; //A session id (uuid4.hex) (optional) (default to undefined) + +const { status, data } = await apiInstance.offerwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost( + productId, + offerwallId, + bpuid, + bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost, + sessionId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **bodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost** | **BodyOfferwallSoftpairBlockPostProductIdOfferwall7a89dcdbOfferwallIdPost**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **offerwallId** | [**string**] | The offerwall ID the user is interacting with | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **sessionId** | [**string**] | A session id (uuid4.hex) | (optional) defaults to undefined| + + +### Return type + +**SoftPairOfferwallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet** +> SoftPairOfferwallResponse offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet() + +This offerwall contains tasks for which the user has a conditional eligibility. The questions that a user must answer to determine the eligibility are included within each bucket. Additionally, the question definitions are included for convenience. No buckets are returned if the user is blocked. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 12) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 1) +let maxOptions: number; //Max number of options an allowed question can have (allowed to be asked) (optional) (default to 40) +let maxQuestions: number; //Max number of missing questions on a single bin (optional) (default to 3) + +const { status, data } = await apiInstance.offerwallSoftpairBlockProductIdOfferwall7a89dcdbGet( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + maxOptions, + maxQuestions +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 12| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 1| +| **maxOptions** | [**number**] | Max number of options an allowed question can have (allowed to be asked) | (optional) defaults to 40| +| **maxQuestions** | [**number**] | Max number of missing questions on a single bin | (optional) defaults to 3| + + +### Return type + +**SoftPairOfferwallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost** +> SoftPairOfferwallResponse offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost(bodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost) + +This is a custom endpoint for a softpair-style offerwall that allows you to update profiling answers and then immediately get back the updated offerwall + +### Example + +```typescript +import { + OfferwallApi, + Configuration, + BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let offerwallId: string; //The offerwall ID the user is interacting with (default to undefined) +let bpuid: string; //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. (default to undefined) +let bodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost: BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost; // +let sessionId: string; //A session id (uuid4.hex) (optional) (default to undefined) + +const { status, data } = await apiInstance.offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost( + productId, + offerwallId, + bpuid, + bodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost, + sessionId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **bodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost** | **BodyOfferwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **offerwallId** | [**string**] | The offerwall ID the user is interacting with | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **sessionId** | [**string**] | A session id (uuid4.hex) | (optional) defaults to undefined| + + +### Return type + +**SoftPairOfferwallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **offerwallSoftpairProductIdOfferwall37d1da64Get** +> SoftPairOfferwallResponse offerwallSoftpairProductIdOfferwall37d1da64Get() + +This offerwall contains tasks for which the user has a conditional eligibility. The questions that a user must answer to determine the eligibility are included within each bucket. Additionally, the question definitions are included for convenience. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 12) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 1) +let maxOptions: number; //Max number of options an allowed question can have (allowed to be asked) (optional) (default to 40) +let maxQuestions: number; //Max number of missing questions on a single bin (optional) (default to 3) + +const { status, data } = await apiInstance.offerwallSoftpairProductIdOfferwall37d1da64Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + maxOptions, + maxQuestions +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 12| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 1| +| **maxOptions** | [**number**] | Max number of options an allowed question can have (allowed to be asked) | (optional) defaults to 40| +| **maxQuestions** | [**number**] | Max number of missing questions on a single bin | (optional) defaults to 3| + + +### Return type + +**SoftPairOfferwallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **oneShotOfferwallProductIdOfferwall6f27b1aeGet** +> OneShotOfferwallResponse oneShotOfferwallProductIdOfferwall6f27b1aeGet() + +Each bucket has only 1 single task, and only basic info is returned about each bucket. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 8) +let sources: Set<Source>; //Restrict tasks to those from these marketplaces only. (optional) (default to undefined) + +const { status, data } = await apiInstance.oneShotOfferwallProductIdOfferwall6f27b1aeGet( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + sources +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 8| +| **sources** | **Set<Source>** | Restrict tasks to those from these marketplaces only. | (optional) defaults to undefined| + + +### Return type + +**OneShotOfferwallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **singleOfferwallProductIdOfferwall5fl8bpv5Get** +> SingleEntryOfferWallResponse singleOfferwallProductIdOfferwall5fl8bpv5Get() + +Only returns a single bucket with the top scoring tasks. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) + +const { status, data } = await apiInstance.singleOfferwallProductIdOfferwall5fl8bpv5Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + minBinSize +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| + + +### Return type + +**SingleEntryOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **starwallOfferwallProductIdOfferwallB59a2d2bGet** +> StarwallOfferWallResponse starwallOfferwallProductIdOfferwallB59a2d2bGet() + +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. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 1) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.starwallOfferwallProductIdOfferwallB59a2d2bGet( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 1| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**StarwallOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get** +> StarwallPlusBlockOfferWallResponse starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get() + +Same as the StarwallOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 3) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 3| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**StarwallPlusBlockOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get** +> StarwallPlusBlockRecontactOfferWallResponse starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get() + +Same as the StarwallOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 3) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 3| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**StarwallPlusBlockRecontactOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **starwallPlusOfferwallProductIdOfferwall5481f322Get** +> StarwallPlusOfferWallResponse starwallPlusOfferwallProductIdOfferwall5481f322Get() + +Same as the StarwallOfferWall, but the buckets include contents. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 3) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.starwallPlusOfferwallProductIdOfferwall5481f322Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 3| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**StarwallPlusOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **topNOfferwallProductIdOfferwall45b7228a7Get** +> TopNOfferWallResponse topNOfferwallProductIdOfferwall45b7228a7Get() + +Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 1) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.topNOfferwallProductIdOfferwall45b7228a7Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 1| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**TopNOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **topNPlusBlockOfferwallProductIdOfferwallD48cce47Get** +> TopNPlusBlockOfferWallResponse topNPlusBlockOfferwallProductIdOfferwallD48cce47Get() + +Same as the TopNOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 3) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.topNPlusBlockOfferwallProductIdOfferwallD48cce47Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 3| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**TopNPlusBlockOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get** +> TopNPlusBlockRecontactOfferWallResponse topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get() + +Same as the TopNOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 3) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 3| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**TopNPlusBlockRecontactOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **topNPlusOfferwallProductIdOfferwallB145b803Get** +> TopNPlusOfferWallResponse topNPlusOfferwallProductIdOfferwallB145b803Get() + +Same as the TopNOfferWall, but the buckets include contents. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 3) +let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) +let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') + +const { status, data } = await apiInstance.topNPlusOfferwallProductIdOfferwallB145b803Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins, + minBinSize, + splitBy +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 3| +| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| +| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| + + +### Return type + +**TopNPlusOfferWallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **wXETOfferwallProductIdOfferwall55a4e1a9Get** +> WXETOfferwallResponse wXETOfferwallProductIdOfferwall55a4e1a9Get() + +Each bucket has only 1 single task, and only basic info is returned about each bucket. + +### Example + +```typescript +import { + OfferwallApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new OfferwallApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languages: Array<string>; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) +let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) +let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) +let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) +let nBins: number; //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. (optional) (default to 8) + +const { status, data } = await apiInstance.wXETOfferwallProductIdOfferwall55a4e1a9Get( + productId, + bpuid, + ip, + countryIso, + languages, + behavior, + minPayout, + duration, + nBins +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| +| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| +| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| +| **nBins** | [**number**] | 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. | (optional) defaults to 8| + + +### Return type + +**WXETOfferwallResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/OfferwallReason.md b/jb-ui/src/api_fsb/docs/OfferwallReason.md new file mode 100644 index 0000000..84ca3ce --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OfferwallReason.md @@ -0,0 +1,20 @@ +# OfferwallReason + + +## Enum + +* `UserBlocked` (value: `'USER_BLOCKED'`) + +* `HighReconRate` (value: `'HIGH_RECON_RATE'`) + +* `UncommonDemographics` (value: `'UNCOMMON_DEMOGRAPHICS'`) + +* `UnderMinimumAge` (value: `'UNDER_MINIMUM_AGE'`) + +* `ExhaustedHighValueSupply` (value: `'EXHAUSTED_HIGH_VALUE_SUPPLY'`) + +* `AllEligibleAttempted` (value: `'ALL_ELIGIBLE_ATTEMPTED'`) + +* `LowCurrentSupply` (value: `'LOW_CURRENT_SUPPLY'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OneShotOfferwall.md b/jb-ui/src/api_fsb/docs/OneShotOfferwall.md new file mode 100644 index 0000000..d15b740 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OneShotOfferwall.md @@ -0,0 +1,29 @@ +# OneShotOfferwall + +Each bucket has only 1 single task, and only basic info is returned about each bucket. Offerwall code: `6f27b1ae` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<OneShotOfferwallBucket>**](OneShotOfferwallBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { OneShotOfferwall } from './api'; + +const instance: OneShotOfferwall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OneShotOfferwallBucket.md b/jb-ui/src/api_fsb/docs/OneShotOfferwallBucket.md new file mode 100644 index 0000000..2531d91 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OneShotOfferwallBucket.md @@ -0,0 +1,26 @@ +# OneShotOfferwallBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] +**duration** | **number** | The bucket\'s expected duration, in seconds | [default to undefined] +**min_payout** | **number** | The bucket\'s min payout, in usd cents | [default to undefined] + +## Example + +```typescript +import { OneShotOfferwallBucket } from './api'; + +const instance: OneShotOfferwallBucket = { + id, + uri, + duration, + min_payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OneShotOfferwallResponse.md b/jb-ui/src/api_fsb/docs/OneShotOfferwallResponse.md new file mode 100644 index 0000000..66216f6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OneShotOfferwallResponse.md @@ -0,0 +1,22 @@ +# OneShotOfferwallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**OneShotOfferwall**](OneShotOfferwall.md) | | [default to undefined] + +## Example + +```typescript +import { OneShotOfferwallResponse } from './api'; + +const instance: OneShotOfferwallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/OrderData.md b/jb-ui/src/api_fsb/docs/OrderData.md new file mode 100644 index 0000000..56c21c3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OrderData.md @@ -0,0 +1,37 @@ +# OrderData + +Stores payout-type-specific order information that is returned from the external payout provider. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to TypeEnum_CashInMail] +**shipping_cost** | **number** | | [default to undefined] +**tracking_number** | **string** | | [optional] [default to undefined] +**shipping_method** | [**ShippingMethod**](ShippingMethod.md) | | [optional] [default to undefined] +**carrier** | [**ShippingCarrier**](ShippingCarrier.md) | | [optional] [default to undefined] +**ship_date** | **string** | | [optional] [default to undefined] +**estimated_delivery_date** | **string** | | [optional] [default to undefined] +**delivery_status** | [**DeliveryStatus**](DeliveryStatus.md) | | [optional] [default to undefined] +**last_updated** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { OrderData } from './api'; + +const instance: OrderData = { + type, + shipping_cost, + tracking_number, + shipping_method, + carrier, + ship_date, + estimated_delivery_date, + delivery_status, + last_updated, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/POPFinancial.md b/jb-ui/src/api_fsb/docs/POPFinancial.md new file mode 100644 index 0000000..a262efc --- /dev/null +++ b/jb-ui/src/api_fsb/docs/POPFinancial.md @@ -0,0 +1,35 @@ +# POPFinancial + +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 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**product_id** | **string** | | [optional] [default to undefined] +**time** | **string** | The starting time block for the respective \'Period\' thatthis grouping is on. The `time` could be the start of a 1 minute or 1 hour block for example. | [default to undefined] +**payout** | **number** | The total amount (in USD cents) that the Brokerage Producthas earned within a respective time period. | [optional] [default to 0] +**adjustment** | **number** | The total amount (in USD cents) that the Brokerage Producthas had adjusted within a respective time period. Most ofthe time, this will be negative due to Complete to Incomplete reconciliations. However, it can also be positive due to Incomplete to Complete adjustments. | [default to undefined] +**adjustment_types** | [**Array<AdjustmentType>**](AdjustmentType.md) | | [default to undefined] +**expense** | **number** | For Product accounts that are setup with Respondent payouts,competitions, user bonuses, or other associated \'costs\', thoseexpenses are accounted for here. This will be negative forthose types of costs. | [default to undefined] +**net** | **number** | This is the sum of the Payout total, Adjustment and any Expenses total. It can be positive or negative for any specific time period. | [default to undefined] +**payment** | **number** | Any ACH or Wire amount that was issued between GRL and the Supplier. | [default to undefined] + +## Example + +```typescript +import { POPFinancial } from './api'; + +const instance: POPFinancial = { + product_id, + time, + payout, + adjustment, + adjustment_types, + expense, + net, + payment, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PatternValidation.md b/jb-ui/src/api_fsb/docs/PatternValidation.md new file mode 100644 index 0000000..98f79d8 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PatternValidation.md @@ -0,0 +1,22 @@ +# PatternValidation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | Message to display if validation fails | [default to undefined] +**pattern** | **string** | Regex string to validate. min_length and max_length are checked separately, even if they are part of the regex. | [default to undefined] + +## Example + +```typescript +import { PatternValidation } from './api'; + +const instance: PatternValidation = { + message, + pattern, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Payload.md b/jb-ui/src/api_fsb/docs/Payload.md new file mode 100644 index 0000000..69a37f8 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Payload.md @@ -0,0 +1,40 @@ +# Payload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **string** | | [optional] [default to EventTypeEnum_SessionFinish] +**source** | [**Source**](Source.md) | | [default to undefined] +**survey_id** | **string** | | [default to undefined] +**quota_id** | **string** | | [optional] [default to undefined] +**country_iso** | **string** | | [default to undefined] +**duration_sec** | **number** | | [default to undefined] +**status** | [**Status**](Status.md) | | [default to undefined] +**status_code_1** | [**StatusCode1**](StatusCode1.md) | | [optional] [default to undefined] +**status_code_2** | [**SessionStatusCode2**](SessionStatusCode2.md) | | [optional] [default to undefined] +**cpi** | **number** | | [optional] [default to undefined] +**user_payout** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { Payload } from './api'; + +const instance: Payload = { + event_type, + source, + survey_id, + quota_id, + country_iso, + duration_sec, + status, + status_code_1, + status_code_2, + cpi, + user_payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PayoutConfig.md b/jb-ui/src/api_fsb/docs/PayoutConfig.md new file mode 100644 index 0000000..84a2fd3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutConfig.md @@ -0,0 +1,23 @@ +# PayoutConfig + +Store configuration related to payouts, payout transformation, and user payout formatting. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payout_format** | **string** | | [optional] [default to undefined] +**payout_transformation** | [**PayoutTransformation**](PayoutTransformation.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { PayoutConfig } from './api'; + +const instance: PayoutConfig = { + payout_format, + payout_transformation, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PayoutStatus.md b/jb-ui/src/api_fsb/docs/PayoutStatus.md new file mode 100644 index 0000000..c3259a6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutStatus.md @@ -0,0 +1,19 @@ +# PayoutStatus + +The max size of the db field that holds this value is 20, so please don\'t add new values longer than that! + +## Enum + +* `Pending` (value: `'PENDING'`) + +* `Approved` (value: `'APPROVED'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Cancelled` (value: `'CANCELLED'`) + +* `Failed` (value: `'FAILED'`) + +* `Complete` (value: `'COMPLETE'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PayoutSummary.md b/jb-ui/src/api_fsb/docs/PayoutSummary.md new file mode 100644 index 0000000..391e51e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutSummary.md @@ -0,0 +1,35 @@ +# PayoutSummary + +Payouts are in Integer USD Cents + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min** | **number** | | [default to undefined] +**max** | **number** | | [default to undefined] +**mean** | **number** | | [optional] [default to undefined] +**q1** | **number** | | [default to undefined] +**q2** | **number** | | [default to undefined] +**q3** | **number** | | [default to undefined] +**lower_whisker** | **number** | | [readonly] [default to undefined] +**upper_whisker** | **number** | | [readonly] [default to undefined] + +## Example + +```typescript +import { PayoutSummary } from './api'; + +const instance: PayoutSummary = { + min, + max, + mean, + q1, + q2, + q3, + lower_whisker, + upper_whisker, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PayoutTransformation.md b/jb-ui/src/api_fsb/docs/PayoutTransformation.md new file mode 100644 index 0000000..378fde0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutTransformation.md @@ -0,0 +1,23 @@ +# PayoutTransformation + +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. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**f** | **string** | The name of the transformation function to use. | [default to undefined] +**kwargs** | [**PayoutTransformationPercentArgs**](PayoutTransformationPercentArgs.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { PayoutTransformation } from './api'; + +const instance: PayoutTransformation = { + f, + kwargs, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PayoutTransformationPercentArgs.md b/jb-ui/src/api_fsb/docs/PayoutTransformationPercentArgs.md new file mode 100644 index 0000000..93e7331 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutTransformationPercentArgs.md @@ -0,0 +1,24 @@ +# PayoutTransformationPercentArgs + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pct** | **number** | The percentage of the bp_payout to pay the user | [default to undefined] +**min_payout** | **string** | | [optional] [default to undefined] +**max_payout** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { PayoutTransformationPercentArgs } from './api'; + +const instance: PayoutTransformationPercentArgs = { + pct, + min_payout, + max_payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PayoutType.md b/jb-ui/src/api_fsb/docs/PayoutType.md new file mode 100644 index 0000000..a918be1 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutType.md @@ -0,0 +1,29 @@ +# PayoutType + +The method in which the requested payout is delivered. + +## Enum + +* `Paypal` (value: `'PAYPAL'`) + +* `Tango` (value: `'TANGO'`) + +* `Dwolla` (value: `'DWOLLA'`) + +* `Ach` (value: `'ACH'`) + +* `Wire` (value: `'WIRE'`) + +* `CashInMail` (value: `'CASH_IN_MAIL'`) + +* `Prize` (value: `'PRIZE'`) + +* `Amt` (value: `'AMT'`) + +* `AmtBonus` (value: `'AMT_BONUS'`) + +* `AmtAssignment` (value: `'AMT_ASSIGNMENT'`) + +* `AmtAssignment2` (value: `'AMT_ASSIGNMENT'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PaypalCashoutMethodData.md b/jb-ui/src/api_fsb/docs/PaypalCashoutMethodData.md new file mode 100644 index 0000000..c347537 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PaypalCashoutMethodData.md @@ -0,0 +1,22 @@ +# PaypalCashoutMethodData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to TypeEnum_Paypal] +**email** | **string** | Email address of the paypal user | [default to undefined] + +## Example + +```typescript +import { PaypalCashoutMethodData } from './api'; + +const instance: PaypalCashoutMethodData = { + type, + email, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PingMessage.md b/jb-ui/src/api_fsb/docs/PingMessage.md new file mode 100644 index 0000000..3b0bb4d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PingMessage.md @@ -0,0 +1,22 @@ +# PingMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **string** | | [optional] [default to KindEnum_Ping] +**timestamp** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { PingMessage } from './api'; + +const instance: PingMessage = { + kind, + timestamp, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/PongMessage.md b/jb-ui/src/api_fsb/docs/PongMessage.md new file mode 100644 index 0000000..60fdd37 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PongMessage.md @@ -0,0 +1,22 @@ +# PongMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **string** | | [optional] [default to KindEnum_Pong] +**timestamp** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { PongMessage } from './api'; + +const instance: PongMessage = { + kind, + timestamp, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Product.md b/jb-ui/src/api_fsb/docs/Product.md new file mode 100644 index 0000000..3dfe1d3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Product.md @@ -0,0 +1,72 @@ +# Product + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier of the Brokerage Product | [optional] [default to undefined] +**name** | **string** | Name of the Brokerage Product. Must be unique within a Team | [default to undefined] +**enabled** | **boolean** | This is only used to hard block a Product in order to immediately & safely protect against fraud entrances. | [optional] [default to true] +**payments_enabled** | **boolean** | This is only to determine if ACH or Wire payments should be made to the Produce. | [optional] [default to true] +**created** | **string** | | [optional] [default to undefined] +**team_id** | **string** | | [optional] [default to undefined] +**business_id** | **string** | | [optional] [default to undefined] +**tags** | [**Set<SupplierTag>**](SupplierTag.md) | Tags which are used to annotate supplier traffic | [optional] [default to undefined] +**commission_pct** | **string** | | [optional] [default to '0.05'] +**redirect_url** | **string** | Where to redirect the user after finishing a session. When a user get redirected back to the supplier, a query param will be added with the name \'tsid\', and the value of the TSID for the session. For example: callback_uri: \'https://www.example.com/test/?a=1&b=2\' might result in the user getting redirected to: \'https://www.example.com/grl-callback/?a=1&b=2&tsid=c6ab6ba1e75b44e2bf5aab00fc68e3b7\'. | [default to undefined] +**harmonizer_domain** | **string** | This is the domain that is used for the GRS (General Research Survey) platform. This is a simple javascript application which may profile the respondent for anyprofiling questions, along with collecting any browserbased security information. The value is a scheme+domain only (no path). | [optional] [default to 'https://profile.generalresearch.com/'] +**sources_config** | [**SourcesConfig**](SourcesConfig.md) | | [optional] [default to undefined] +**session_config** | [**SessionConfig**](SessionConfig.md) | | [optional] [default to undefined] +**payout_config** | [**PayoutConfig**](PayoutConfig.md) | | [optional] [default to undefined] +**user_wallet_config** | [**UserWalletConfig**](UserWalletConfig.md) | | [optional] [default to undefined] +**user_create_config** | [**UserCreateConfig**](UserCreateConfig.md) | | [optional] [default to undefined] +**offerwall_config** | **object** | | [optional] [default to undefined] +**profiling_config** | [**ProfilingConfig**](ProfilingConfig.md) | | [optional] [default to undefined] +**user_health_config** | [**UserHealthConfig**](UserHealthConfig.md) | | [optional] [default to undefined] +**yield_man_config** | [**YieldManConfig**](YieldManConfig.md) | | [optional] [default to undefined] +**balance** | [**ProductBalances**](ProductBalances.md) | | [optional] [default to undefined] +**payouts_total_str** | **string** | | [optional] [default to undefined] +**payouts_total** | **number** | | [optional] [default to undefined] +**payouts** | [**Array<BrokerageProductPayoutEvent>**](BrokerageProductPayoutEvent.md) | | [optional] [default to undefined] +**pop_financial** | [**Array<POPFinancial>**](POPFinancial.md) | | [optional] [default to undefined] +**bp_account** | [**LedgerAccount**](LedgerAccount.md) | | [optional] [default to undefined] +**user_wallet** | [**UserWalletConfig**](UserWalletConfig.md) | | [readonly] [default to undefined] + +## Example + +```typescript +import { Product } from './api'; + +const instance: Product = { + id, + name, + enabled, + payments_enabled, + created, + team_id, + business_id, + tags, + commission_pct, + redirect_url, + harmonizer_domain, + sources_config, + session_config, + payout_config, + user_wallet_config, + user_create_config, + offerwall_config, + profiling_config, + user_health_config, + yield_man_config, + balance, + payouts_total_str, + payouts_total, + payouts, + pop_financial, + bp_account, + user_wallet, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ProductBalances.md b/jb-ui/src/api_fsb/docs/ProductBalances.md new file mode 100644 index 0000000..92a9170 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ProductBalances.md @@ -0,0 +1,68 @@ +# ProductBalances + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**product_id** | **string** | | [optional] [default to undefined] +**last_event** | **string** | | [optional] [default to undefined] +**bp_payment_credit** | **number** | The total amount that has been earned by the Task completes, for this Brokerage Product account. | [optional] [default to 0] +**adjustment_credit** | **number** | Positive reconciliations issued back to the Brokerage Product account. | [optional] [default to 0] +**adjustment_debit** | **number** | Negative reconciliations for any Task completes | [optional] [default to 0] +**supplier_credit** | **number** | ACH or Wire amounts issued to GRL from a Supplier to recoup for a negative Brokerage Product balance | [optional] [default to 0] +**supplier_debit** | **number** | ACH or Wire amounts sent to a Supplier | [optional] [default to 0] +**user_bonus_credit** | **number** | If a respondent ever pays back an product account. | [optional] [default to 0] +**user_bonus_debit** | **number** | Pay a user into their wallet balance. There is no fee here. There is only a fee when the user requests a payout.The bonus could be as a bribe, winnings for a contest, leaderboard, etc. | [optional] [default to 0] +**issued_payment** | **number** | This is the amount that we decide to credit as havingtaken from this Product. If there is any amount not issuedit is summed up over the Business to offset any negativebalances elsewhere. | [optional] [default to 0] +**payout** | **number** | The sum amount of all Task payouts | [readonly] [default to undefined] +**payout_usd_str** | **string** | | [readonly] [default to undefined] +**adjustment** | **number** | The sum amount of all Task Adjustments | [readonly] [default to undefined] +**expense** | **number** | The sum amount of any associated Product Expenses (eg: user bonuses) | [readonly] [default to undefined] +**net** | **number** | The Product\'s Net Earnings which is equal to the totalamount of Task Payouts, with Task Adjustments and anyProduct Expenses deducted. This can be positive ornegative. | [readonly] [default to undefined] +**payment** | **number** | The sum amount of all Supplier Payments (eg ACH or Wire transfers) | [readonly] [default to undefined] +**payment_usd_str** | **string** | | [readonly] [default to undefined] +**balance** | **number** | The Product\'s Balance which is equal to the Product\'s Netamount with already issued Supplier Payments deducted. This can be positive or negative. | [readonly] [default to undefined] +**retainer** | **number** | The Smart Retainer is an about of money that is held byGRL to account for any Task Adjustments that may occurin the future. The amount will always be positive, andif the Product\'s balance is negative, the retainer will be $0.00 as the Product is not eligible for any SupplierPayments either way. | [readonly] [default to undefined] +**retainer_usd_str** | **string** | | [readonly] [default to undefined] +**available_balance** | **number** | The Available Balance is the amount that is currently, andimmediately available for withdraw from the Supplier\'sbalance. Supplier Payments are made every Friday for Businesses with an ACH connected Bank Account to GRL, while a Business that requires an International Wire are issued on the last Friday of every Month. | [readonly] [default to undefined] +**available_balance_usd_str** | **string** | | [readonly] [default to undefined] +**recoup** | **number** | | [readonly] [default to undefined] +**recoup_usd_str** | **string** | | [readonly] [default to undefined] +**adjustment_percent** | **number** | The percentage of USDCent value that has been adjustedover all time for this Product. | [readonly] [default to undefined] + +## Example + +```typescript +import { ProductBalances } from './api'; + +const instance: ProductBalances = { + product_id, + last_event, + bp_payment_credit, + adjustment_credit, + adjustment_debit, + supplier_credit, + supplier_debit, + user_bonus_credit, + user_bonus_debit, + issued_payment, + payout, + payout_usd_str, + adjustment, + expense, + net, + payment, + payment_usd_str, + balance, + retainer, + retainer_usd_str, + available_balance, + available_balance_usd_str, + recoup, + recoup_usd_str, + adjustment_percent, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ProductUserApi.md b/jb-ui/src/api_fsb/docs/ProductUserApi.md new file mode 100644 index 0000000..be0f30e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ProductUserApi.md @@ -0,0 +1,179 @@ +# ProductUserApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet**](#userprofilefilterbymarketplacepidproductiduserbymarketplacepidget) | **GET** /{product_id}/user/by-marketplace-pid/ | User Profile Filter By Marketplace Pid| +|[**userProfileProductIdUserProductUserIdProfileGet**](#userprofileproductiduserproductuseridprofileget) | **GET** /{product_id}/user/{product_user_id}/profile/ | User Profile| +|[**userProfileUpdateProductIdUserProductUserIdProfilePatch**](#userprofileupdateproductiduserproductuseridprofilepatch) | **PATCH** /{product_id}/user/{product_user_id}/profile/ | User Profile Update| + +# **userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet** +> UserProfilesResponse userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet() + + +### Example + +```typescript +import { + ProductUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProductUserApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let source: Source; //The marketplace to search (default to undefined) +let pid: Array<string>; //The user\'s marketplace PID. Supports multiple params (default to undefined) + +const { status, data } = await apiInstance.userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet( + productId, + source, + pid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **source** | **Source** | The marketplace to search | defaults to undefined| +| **pid** | **Array<string>** | The user\'s marketplace PID. Supports multiple params | defaults to undefined| + + +### Return type + +**UserProfilesResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **userProfileProductIdUserProductUserIdProfileGet** +> UserProfileResponse userProfileProductIdUserProductUserIdProfileGet() + + +### Example + +```typescript +import { + ProductUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProductUserApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let productUserId: string; //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. (default to undefined) + +const { status, data } = await apiInstance.userProfileProductIdUserProductUserIdProfileGet( + productId, + productUserId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **productUserId** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**UserProfileResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **userProfileUpdateProductIdUserProductUserIdProfilePatch** +> StatusResponse userProfileUpdateProductIdUserProductUserIdProfilePatch(userProfileUpdateRequest) + + +### Example + +```typescript +import { + ProductUserApi, + Configuration, + UserProfileUpdateRequest +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProductUserApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let productUserId: string; //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. (default to undefined) +let userProfileUpdateRequest: UserProfileUpdateRequest; // + +const { status, data } = await apiInstance.userProfileUpdateProductIdUserProductUserIdProfilePatch( + productId, + productUserId, + userProfileUpdateRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userProfileUpdateRequest** | **UserProfileUpdateRequest**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **productUserId** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**StatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/ProfilingConfig.md b/jb-ui/src/api_fsb/docs/ProfilingConfig.md new file mode 100644 index 0000000..22d329d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ProfilingConfig.md @@ -0,0 +1,34 @@ +# ProfilingConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **boolean** | If False, the harmonizer/profiling system is not used at all. This should never be False unless special circumstances | [optional] [default to true] +**grs_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. | [optional] [default to true] +**n_questions** | **number** | | [optional] [default to undefined] +**max_questions** | **number** | The max number of questions we would ask in a session | [optional] [default to 10] +**avg_question_count** | **number** | The average number of questions to ask in a session | [optional] [default to 5] +**task_injection_freq_mult** | **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 | [optional] [default to 1] +**non_us_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. | [optional] [default to 2] +**hidden_questions_expiration_hours** | **number** | How frequently we should refresh hidden questions | [optional] [default to 168] + +## Example + +```typescript +import { ProfilingConfig } from './api'; + +const instance: ProfilingConfig = { + enabled, + grs_enabled, + n_questions, + max_questions, + avg_question_count, + task_injection_freq_mult, + non_us_mult, + hidden_questions_expiration_hours, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ProfilingInfoResponse.md b/jb-ui/src/api_fsb/docs/ProfilingInfoResponse.md new file mode 100644 index 0000000..598f68b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ProfilingInfoResponse.md @@ -0,0 +1,24 @@ +# ProfilingInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**profiling_info** | [**Array<UpkProperty>**](UpkProperty.md) | | [default to undefined] + +## Example + +```typescript +import { ProfilingInfoResponse } from './api'; + +const instance: ProfilingInfoResponse = { + status, + msg, + profiling_info, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md b/jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md new file mode 100644 index 0000000..384011a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ProfilingQuestionsApi.md @@ -0,0 +1,264 @@ +# ProfilingQuestionsApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getProfilingQuestionsProductIdProfilingQuestionsGet**](#getprofilingquestionsproductidprofilingquestionsget) | **GET** /{product_id}/profiling-questions/ | Get Profiling Questions| +|[**profilingInfoProductIdProfilingInfoGet**](#profilinginfoproductidprofilinginfoget) | **GET** /{product_id}/profiling-info/ | Profiling Info| +|[**submitProfilingQuestionsProductIdProfilingQuestionsPost**](#submitprofilingquestionsproductidprofilingquestionspost) | **POST** /{product_id}/profiling-questions/ | Submit Profiling Questions| +|[**userProfileProductIdUserProfileGet**](#userprofileproductiduserprofileget) | **GET** /{product_id}/user-profile/ | User Profile| + +# **getProfilingQuestionsProductIdProfilingQuestionsGet** +> UpkQuestionResponse getProfilingQuestionsProductIdProfilingQuestionsGet() + +Gets a list of profiling questions to ask this user. These questions are, as of right now, unanswered. Once a question is answered, it (and any other question whose answer is inferred from other answers) is removed from the list. The questions returned are ordered by importance (the key task_score) in descending order. + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) +let languageIso: string; //Respondent\'s desired language (ISO 639-2/B, lowercase) (optional) (default to undefined) +let limit: number; //Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions\' importance. (optional) (default to undefined) +let isGrs: boolean; //If it\'s the GRS system. (optional) (default to false) + +const { status, data } = await apiInstance.getProfilingQuestionsProductIdProfilingQuestionsGet( + productId, + bpuid, + ip, + countryIso, + languageIso, + limit, + isGrs +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| +| **languageIso** | [**string**] | Respondent\'s desired language (ISO 639-2/B, lowercase) | (optional) defaults to undefined| +| **limit** | [**number**] | Number of questions to return. Questions are ordered, so, selects the N most important. If no limit is passed, then the number of questions returned is dynamically calculated by the questions\' importance. | (optional) defaults to undefined| +| **isGrs** | [**boolean**] | If it\'s the GRS system. | (optional) defaults to false| + + +### Return type + +**UpkQuestionResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **profilingInfoProductIdProfilingInfoGet** +> ProfilingInfoResponse profilingInfoProductIdProfilingInfoGet() + +Get UPK Ontology (list of properties, property info, and allowed values) + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (default to undefined) +let languageIso: string; //Respondent\'s desired language (ISO 639-2/B, lowercase) (optional) (default to undefined) + +const { status, data } = await apiInstance.profilingInfoProductIdProfilingInfoGet( + productId, + countryIso, + languageIso +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | defaults to undefined| +| **languageIso** | [**string**] | Respondent\'s desired language (ISO 639-2/B, lowercase) | (optional) defaults to undefined| + + +### Return type + +**ProfilingInfoResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **submitProfilingQuestionsProductIdProfilingQuestionsPost** +> StatusResponse submitProfilingQuestionsProductIdProfilingQuestionsPost(bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost) + +Send the answers to one or more of these questions for a user. A question is uniquely specified by the question_id key. The answer is: the choice_id if the question_type is \"MC\" the actual entered text if the question_type is \"TE\" + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration, + BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost: BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost; // +let sessionId: string; //The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. (optional) (default to undefined) +let async: boolean; //For internal use. (optional) (default to true) + +const { status, data } = await apiInstance.submitProfilingQuestionsProductIdProfilingQuestionsPost( + productId, + bpuid, + bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost, + sessionId, + async +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **bodySubmitProfilingQuestionsProductIdProfilingQuestionsPost** | **BodySubmitProfilingQuestionsProductIdProfilingQuestionsPost**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **sessionId** | [**string**] | The unique identifier for a session in which these questions were asked. Must be a valid UUID. Optional. | (optional) defaults to undefined| +| **async** | [**boolean**] | For internal use. | (optional) defaults to true| + + +### Return type + +**StatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **userProfileProductIdUserProfileGet** +> UserInfoResponse userProfileProductIdUserProfileGet() + + +### Example + +```typescript +import { + ProfilingQuestionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProfilingQuestionsApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (default to undefined) +let languageIso: string; //Respondent\'s desired language (ISO 639-2/B, lowercase) (optional) (default to undefined) + +const { status, data } = await apiInstance.userProfileProductIdUserProfileGet( + productId, + bpuid, + countryIso, + languageIso +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | defaults to undefined| +| **languageIso** | [**string**] | Respondent\'s desired language (ISO 639-2/B, lowercase) | (optional) defaults to undefined| + + +### Return type + +**UserInfoResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/PropertyType.md b/jb-ui/src/api_fsb/docs/PropertyType.md new file mode 100644 index 0000000..9e64b49 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PropertyType.md @@ -0,0 +1,12 @@ +# PropertyType + + +## Enum + +* `I` (value: `'i'`) + +* `N` (value: `'n'`) + +* `X` (value: `'x'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/RaffleUserView.md b/jb-ui/src/api_fsb/docs/RaffleUserView.md new file mode 100644 index 0000000..f73f055 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/RaffleUserView.md @@ -0,0 +1,68 @@ +# RaffleUserView + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of contest. Can be displayed to user. | [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**contest_type** | **string** | | [optional] [default to ContestTypeEnum_Raffle] +**end_condition** | [**ContestEndCondition**](ContestEndCondition.md) | | [default to undefined] +**prizes** | [**Array<ContestPrize>**](ContestPrize.md) | | [optional] [default to undefined] +**starts_at** | **string** | When the contest starts | [optional] [default to undefined] +**terms_and_conditions** | **string** | | [optional] [default to undefined] +**status** | [**ContestStatus**](ContestStatus.md) | | [optional] [default to undefined] +**country_isos** | **string** | | [optional] [default to undefined] +**uuid** | **string** | | [optional] [default to undefined] +**product_id** | **string** | Contest applies only to a single BP | [default to undefined] +**created_at** | **string** | When this contest was created | [optional] [default to undefined] +**updated_at** | **string** | When this contest was last modified. Does not include entries being created/modified | [optional] [default to undefined] +**ended_at** | **string** | | [optional] [default to undefined] +**end_reason** | [**ContestEndReason**](ContestEndReason.md) | | [optional] [default to undefined] +**product_user_id** | **string** | | [default to undefined] +**user_winnings** | [**Array<ContestWinner>**](ContestWinner.md) | The prizes won in this contest by the requested user | [optional] [default to undefined] +**entry_type** | **string** | | [optional] [default to EntryTypeEnum_Cash] +**entry_rule** | [**ContestEntryRule**](ContestEntryRule.md) | | [optional] [default to undefined] +**current_amount** | [**CurrentAmount**](CurrentAmount.md) | | [optional] [default to undefined] +**current_participants** | **number** | Count of unique participants | [optional] [default to 0] +**user_amount** | [**UserAmount**](UserAmount.md) | | [default to undefined] +**user_amount_today** | [**UserAmountToday**](UserAmountToday.md) | | [default to undefined] +**current_win_probability** | **number** | Probability of this user winning 1 or more prizes, if the contestended right now | [readonly] [default to undefined] +**projected_win_probability** | **number** | | [default to undefined] + +## Example + +```typescript +import { RaffleUserView } from './api'; + +const instance: RaffleUserView = { + name, + description, + contest_type, + end_condition, + prizes, + starts_at, + terms_and_conditions, + status, + country_isos, + uuid, + product_id, + created_at, + updated_at, + ended_at, + end_reason, + product_user_id, + user_winnings, + entry_type, + entry_rule, + current_amount, + current_participants, + user_amount, + user_amount_today, + current_win_probability, + projected_win_probability, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/RedemptionCurrency.md b/jb-ui/src/api_fsb/docs/RedemptionCurrency.md new file mode 100644 index 0000000..cd6f179 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/RedemptionCurrency.md @@ -0,0 +1,27 @@ +# RedemptionCurrency + +Supported Currencies for Foreign Redemptions + +## Enum + +* `Usd` (value: `'USD'`) + +* `Cad` (value: `'CAD'`) + +* `Gbp` (value: `'GBP'`) + +* `Eur` (value: `'EUR'`) + +* `Inr` (value: `'INR'`) + +* `Aud` (value: `'AUD'`) + +* `Pln` (value: `'PLN'`) + +* `Sek` (value: `'SEK'`) + +* `Sgd` (value: `'SGD'`) + +* `Mxn` (value: `'MXN'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ReportApi.md b/jb-ui/src/api_fsb/docs/ReportApi.md new file mode 100644 index 0000000..daaca43 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ReportApi.md @@ -0,0 +1,64 @@ +# ReportApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**reportTaskProductIdReportPost**](#reporttaskproductidreportpost) | **POST** /{product_id}/report/ | Report Task| + +# **reportTaskProductIdReportPost** +> StatusResponse reportTaskProductIdReportPost(reportTask) + +Send a \"Task Report\" for a respondent\'s latest started survey, regardless of the survey\'s outcome. Task Reports cannot be provided for task attempts by tsid, or through any other method, they must be given immediately after the respondent\'s task attempt. If a latest attempt can\'t be found, a ReportTaskResponse is still returned. If multiple reasons want to be provided, they should be done at the same time. If multiple reports are given for the same latest started task, the note attribute will be overwritten, while the new unique reasons will be appended to the task attempt. Task Report system contributions by client applications are immediately leveraged to aid yield management strategies. For those reasons, it\'s important that the respondent submits a Task Report as soon as possible and applications doesn\'t offload this request for a later time. Task Report timestamps are a critical component of understanding a Task experience for a respondent. For the BP to tell us about a bad survey they want to report The POSTed data looks like: { \'bpuid\': \'1234\', \'reasons\': [2], \'notes\': \"This survey was the worst!\" } Returns {\'status\': \'success\', \'msg\': error_msg} + +### Example + +```typescript +import { + ReportApi, + Configuration, + ReportTask +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ReportApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let reportTask: ReportTask; // + +const { status, data } = await apiInstance.reportTaskProductIdReportPost( + productId, + reportTask +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **reportTask** | **ReportTask**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| + + +### Return type + +**StatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/ReportNotes.md b/jb-ui/src/api_fsb/docs/ReportNotes.md new file mode 100644 index 0000000..cee38cb --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ReportNotes.md @@ -0,0 +1,18 @@ +# ReportNotes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { ReportNotes } from './api'; + +const instance: ReportNotes = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ReportTask.md b/jb-ui/src/api_fsb/docs/ReportTask.md new file mode 100644 index 0000000..8f5560b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ReportTask.md @@ -0,0 +1,24 @@ +# ReportTask + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bpuid** | **string** | The unique identifier for the user, which is set by the Supplier. | [default to undefined] +**reasons** | [**Array<ReportValue>**](ReportValue.md) | The reason a user reported a task. Allowed values: - __0__ *(REASON_UNKNOWN)*: Used to indicate the user exited the task without giving feedback - __1__ *(TECHNICAL_ERROR)*: Task is in the wrong language/country, unanswerable question, won\'t proceed to next question, loading forever, error message - __2__ *(NO_REDIRECT)*: Task ended (completed or failed, and showed the user some dialog indicating the task was over), but failed to redirect - __3__ *(PRIVACY_INVASION)*: Asked for full name, home address, identity on another site, cc - __4__ *(UNCOMFORTABLE_TOPICS)*: Asked about children, employer, medical issues, drug use, STDs, etc. - __5__ *(ASKED_FOR_NOT_ALLOWED_ACTION)*: Asked to install software, signup/login to external site, access webcam, promise to pay using external site, etc. - __6__ *(BAD_ON_MOBILE)*: Task doesn\'t work well on a mobile device - __7__ *(DIDNT_LIKE)*: Too long, too boring, confusing, complicated, too many open-ended/free-response questions | [optional] [default to undefined] +**notes** | **string** | | [optional] [default to ''] + +## Example + +```typescript +import { ReportTask } from './api'; + +const instance: ReportTask = { + bpuid, + reasons, + notes, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ReportValue.md b/jb-ui/src/api_fsb/docs/ReportValue.md new file mode 100644 index 0000000..a9c773d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ReportValue.md @@ -0,0 +1,23 @@ +# ReportValue + +The reason a user reported a task. + +## Enum + +* `NUMBER_0` (value: `0`) + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +* `NUMBER_3` (value: `3`) + +* `NUMBER_4` (value: `4`) + +* `NUMBER_5` (value: `5`) + +* `NUMBER_6` (value: `6`) + +* `NUMBER_7` (value: `7`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md b/jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md new file mode 100644 index 0000000..36fab3a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md @@ -0,0 +1,86 @@ +# ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of contest. Can be displayed to user. | [default to undefined] +**description** | **string** | | [optional] [default to undefined] +**contest_type** | **string** | | [optional] [default to ContestTypeEnum_Milestone] +**end_condition** | [**MilestoneContestEndCondition**](MilestoneContestEndCondition.md) | | [default to undefined] +**prizes** | [**Array<ContestPrize>**](ContestPrize.md) | | [optional] [default to undefined] +**starts_at** | **string** | When the contest starts | [optional] [default to undefined] +**terms_and_conditions** | **string** | | [optional] [default to undefined] +**status** | [**ContestStatus**](ContestStatus.md) | | [optional] [default to undefined] +**country_isos** | **string** | | [optional] [default to undefined] +**uuid** | **string** | | [optional] [default to undefined] +**product_id** | **string** | Contest applies only to a single BP | [default to undefined] +**created_at** | **string** | When this contest was created | [optional] [default to undefined] +**updated_at** | **string** | When this contest was last modified. Does not include entries being created/modified | [optional] [default to undefined] +**ended_at** | **string** | | [optional] [default to undefined] +**end_reason** | [**ContestEndReason**](ContestEndReason.md) | | [optional] [default to undefined] +**product_user_id** | **string** | | [default to undefined] +**user_winnings** | [**Array<ContestWinner>**](ContestWinner.md) | The prizes won in this contest by the requested user | [optional] [default to undefined] +**entry_type** | **string** | | [optional] [default to EntryTypeEnum_Count] +**entry_rule** | [**ContestEntryRule**](ContestEntryRule.md) | | [optional] [default to undefined] +**current_amount** | [**CurrentAmount**](CurrentAmount.md) | | [optional] [default to undefined] +**current_participants** | **number** | Count of unique participants | [optional] [default to 0] +**user_amount** | **number** | The total amount for this user for this contest | [default to undefined] +**user_amount_today** | [**UserAmountToday**](UserAmountToday.md) | | [default to undefined] +**current_win_probability** | **number** | Probability of this user winning 1 or more prizes, if the contestended right now | [readonly] [default to undefined] +**projected_win_probability** | **number** | | [default to undefined] +**leaderboard_key** | **string** | The specific leaderboard instance this contest is connected to | [default to undefined] +**tie_break_strategy** | **string** | | [optional] [default to TieBreakStrategyEnum_SplitPrizePool] +**country_iso** | **string** | | [readonly] [default to undefined] +**user_rank** | **number** | | [default to undefined] +**target_amount** | **number** | Each user \'wins\' (receives prizes) once this target amount is reached. | [default to undefined] +**entry_trigger** | [**ContestEntryTrigger**](ContestEntryTrigger.md) | | [optional] [default to undefined] +**valid_for** | **string** | | [optional] [default to undefined] +**valid_for_event** | **string** | | [optional] [default to undefined] +**win_count** | **number** | The number of times the milestone has been reached. | [optional] [default to 0] + +## Example + +```typescript +import { ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet } from './api'; + +const instance: ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet = { + name, + description, + contest_type, + end_condition, + prizes, + starts_at, + terms_and_conditions, + status, + country_isos, + uuid, + product_id, + created_at, + updated_at, + ended_at, + end_reason, + product_user_id, + user_winnings, + entry_type, + entry_rule, + current_amount, + current_participants, + user_amount, + user_amount_today, + current_win_probability, + projected_win_probability, + leaderboard_key, + tie_break_strategy, + country_iso, + user_rank, + target_amount, + entry_trigger, + valid_for, + valid_for_event, + win_count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ResponseWebsocketEventsDocsWsEventsDocsGet.md b/jb-ui/src/api_fsb/docs/ResponseWebsocketEventsDocsWsEventsDocsGet.md new file mode 100644 index 0000000..363292a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ResponseWebsocketEventsDocsWsEventsDocsGet.md @@ -0,0 +1,28 @@ +# ResponseWebsocketEventsDocsWsEventsDocsGet + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **string** | | [optional] [default to KindEnum_Pong] +**timestamp** | **string** | | [optional] [default to undefined] +**data** | [**StatsSnapshot**](StatsSnapshot.md) | | [default to undefined] +**country_iso** | **string** | | [optional] [default to undefined] +**product_id** | **string** | | [default to undefined] + +## Example + +```typescript +import { ResponseWebsocketEventsDocsWsEventsDocsGet } from './api'; + +const instance: ResponseWebsocketEventsDocsWsEventsDocsGet = { + kind, + timestamp, + data, + country_iso, + product_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Scope.md b/jb-ui/src/api_fsb/docs/Scope.md new file mode 100644 index 0000000..be4ca97 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Scope.md @@ -0,0 +1,12 @@ +# Scope + + +## Enum + +* `Global` (value: `'global'`) + +* `Team` (value: `'team'`) + +* `Product` (value: `'product'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Selector.md b/jb-ui/src/api_fsb/docs/Selector.md new file mode 100644 index 0000000..a123850 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Selector.md @@ -0,0 +1,18 @@ +# Selector + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { Selector } from './api'; + +const instance: Selector = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SessionAdjustedStatus.md b/jb-ui/src/api_fsb/docs/SessionAdjustedStatus.md new file mode 100644 index 0000000..0df7434 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SessionAdjustedStatus.md @@ -0,0 +1,13 @@ +# SessionAdjustedStatus + +An adjusted_status is set if a session is adjusted by the marketplace after the original return. A session can be adjusted multiple times. This is the most recent status. If a session was originally a complete, was adjusted to incomplete, then back to complete, the adjusted_status will be None, but the adjusted_timestamp will be set to the most recent change. + +## Enum + +* `Ac` (value: `'ac'`) + +* `Af` (value: `'af'`) + +* `Pa` (value: `'pa'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SessionConfig.md b/jb-ui/src/api_fsb/docs/SessionConfig.md new file mode 100644 index 0000000..1df61d8 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SessionConfig.md @@ -0,0 +1,25 @@ +# SessionConfig + +Stores configuration related to the Session, a session being a users experience attempting to do work. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_session_len** | **number** | The amount of time (in seconds) that a respondent may spend attempting to get into a survey within a session.If NULL, there is no limit. | [optional] [default to 600] +**max_session_hard_retry** | **number** | The number of surveys that a respondent may attempt within a session before the session is terminated. | [optional] [default to 5] +**min_payout** | **string** | The minimum amount the user should be paid for a complete. If no payout transformation is defined, the value is based on the BP\'s payout. If a payout transformation is defined, the min_payout is applied on the user\'s payout. Note, this is separate and distinct from the payout transformation\'s min payout. The payout transformation\'s min_payout does not care what the task\'s actual payout was. This min_payout will prevent the user from being show any tasks that would pay below this amount. | [optional] [default to '0.14'] + +## Example + +```typescript +import { SessionConfig } from './api'; + +const instance: SessionConfig = { + max_session_len, + max_session_hard_retry, + min_payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SessionEnterPayload.md b/jb-ui/src/api_fsb/docs/SessionEnterPayload.md new file mode 100644 index 0000000..e70afbb --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SessionEnterPayload.md @@ -0,0 +1,22 @@ +# SessionEnterPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **string** | | [optional] [default to EventTypeEnum_SessionEnter] +**country_iso** | **string** | | [default to undefined] + +## Example + +```typescript +import { SessionEnterPayload } from './api'; + +const instance: SessionEnterPayload = { + event_type, + country_iso, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SessionFinishPayload.md b/jb-ui/src/api_fsb/docs/SessionFinishPayload.md new file mode 100644 index 0000000..86572b1 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SessionFinishPayload.md @@ -0,0 +1,32 @@ +# SessionFinishPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **string** | | [optional] [default to EventTypeEnum_SessionFinish] +**country_iso** | **string** | | [default to undefined] +**duration_sec** | **number** | | [default to undefined] +**status** | [**Status**](Status.md) | | [default to undefined] +**status_code_1** | [**StatusCode1**](StatusCode1.md) | | [optional] [default to undefined] +**status_code_2** | [**SessionStatusCode2**](SessionStatusCode2.md) | | [optional] [default to undefined] +**user_payout** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { SessionFinishPayload } from './api'; + +const instance: SessionFinishPayload = { + event_type, + country_iso, + duration_sec, + status, + status_code_1, + status_code_2, + user_payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SessionStatusCode2.md b/jb-ui/src/api_fsb/docs/SessionStatusCode2.md new file mode 100644 index 0000000..a47905a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SessionStatusCode2.md @@ -0,0 +1,33 @@ +# SessionStatusCode2 + +__Status Detail__ This should be set if the Session.status_code_1 is SESSION_XXX_FAIL + +## Enum + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +* `NUMBER_3` (value: `3`) + +* `NUMBER_4` (value: `4`) + +* `NUMBER_5` (value: `5`) + +* `NUMBER_6` (value: `6`) + +* `NUMBER_7` (value: `7`) + +* `NUMBER_8` (value: `8`) + +* `NUMBER_9` (value: `9`) + +* `NUMBER_10` (value: `10`) + +* `NUMBER_11` (value: `11`) + +* `NUMBER_12` (value: `12`) + +* `NUMBER_13` (value: `13`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ShippingCarrier.md b/jb-ui/src/api_fsb/docs/ShippingCarrier.md new file mode 100644 index 0000000..4a6bb7f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ShippingCarrier.md @@ -0,0 +1,14 @@ +# ShippingCarrier + + +## Enum + +* `Usps` (value: `'USPS'`) + +* `FedEx` (value: `'FedEx'`) + +* `Ups` (value: `'UPS'`) + +* `Dhl` (value: `'DHL'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ShippingMethod.md b/jb-ui/src/api_fsb/docs/ShippingMethod.md new file mode 100644 index 0000000..d83a40f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ShippingMethod.md @@ -0,0 +1,16 @@ +# ShippingMethod + + +## Enum + +* `Standard` (value: `'Standard'`) + +* `Express` (value: `'Express'`) + +* `TwoDay` (value: `'Two-Day'`) + +* `Overnight` (value: `'Overnight'`) + +* `SameDay` (value: `'Same Day'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SingleEntryBucket.md b/jb-ui/src/api_fsb/docs/SingleEntryBucket.md new file mode 100644 index 0000000..fa9b6ff --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SingleEntryBucket.md @@ -0,0 +1,22 @@ +# SingleEntryBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] + +## Example + +```typescript +import { SingleEntryBucket } from './api'; + +const instance: SingleEntryBucket = { + id, + uri, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SingleEntryOfferWall.md b/jb-ui/src/api_fsb/docs/SingleEntryOfferWall.md new file mode 100644 index 0000000..c22a834 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SingleEntryOfferWall.md @@ -0,0 +1,31 @@ +# SingleEntryOfferWall + +Only returns a single bucket with the top scoring tasks. Offerwall code: `5fl8bpv5` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<SingleEntryBucket>**](SingleEntryBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] +**payout_format** | **string** | 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\" | [default to undefined] + +## Example + +```typescript +import { SingleEntryOfferWall } from './api'; + +const instance: SingleEntryOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, + payout_format, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SingleEntryOfferWallResponse.md b/jb-ui/src/api_fsb/docs/SingleEntryOfferWallResponse.md new file mode 100644 index 0000000..01812ae --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SingleEntryOfferWallResponse.md @@ -0,0 +1,22 @@ +# SingleEntryOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**SingleEntryOfferWall**](SingleEntryOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { SingleEntryOfferWallResponse } from './api'; + +const instance: SingleEntryOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SoftPairBucket.md b/jb-ui/src/api_fsb/docs/SoftPairBucket.md new file mode 100644 index 0000000..07278cf --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SoftPairBucket.md @@ -0,0 +1,34 @@ +# SoftPairBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | [**Uri**](Uri.md) | | [default to undefined] +**category** | [**Array<CategoryAssociation>**](CategoryAssociation.md) | | [optional] [default to undefined] +**contents** | [**Array<BucketTask>**](BucketTask.md) | | [default to undefined] +**eligibility** | **string** | | [default to undefined] +**missing_questions** | **Array<string | null>** | | [optional] [default to undefined] +**loi** | **number** | this is the max loi of the contents | [default to undefined] +**payout** | **number** | this is the min payout of the contents | [default to undefined] + +## Example + +```typescript +import { SoftPairBucket } from './api'; + +const instance: SoftPairBucket = { + id, + uri, + category, + contents, + eligibility, + missing_questions, + loi, + payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SoftPairOfferwall.md b/jb-ui/src/api_fsb/docs/SoftPairOfferwall.md new file mode 100644 index 0000000..e2a5319 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SoftPairOfferwall.md @@ -0,0 +1,31 @@ +# SoftPairOfferwall + +This offerwall contains tasks for which the user has a conditional eligibility. The questions that a user must answer to determine the eligibility are included within each bucket. Additionally, the question definitions are included for convenience. Offerwall code: `37d1da64` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<SoftPairBucket>**](SoftPairBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] +**question_info** | [**{ [key: string]: UpkQuestion; }**](UpkQuestion.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { SoftPairOfferwall } from './api'; + +const instance: SoftPairOfferwall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, + question_info, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SoftPairOfferwallResponse.md b/jb-ui/src/api_fsb/docs/SoftPairOfferwallResponse.md new file mode 100644 index 0000000..20e86e8 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SoftPairOfferwallResponse.md @@ -0,0 +1,22 @@ +# SoftPairOfferwallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**SoftPairOfferwall**](SoftPairOfferwall.md) | | [default to undefined] + +## Example + +```typescript +import { SoftPairOfferwallResponse } from './api'; + +const instance: SoftPairOfferwallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Source.md b/jb-ui/src/api_fsb/docs/Source.md new file mode 100644 index 0000000..b715bfc --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Source.md @@ -0,0 +1,48 @@ +# Source + + +## Enum + +* `G` (value: `'g'`) + +* `C` (value: `'c'`) + +* `A` (value: `'a'`) + +* `D` (value: `'d'`) + +* `Et` (value: `'et'`) + +* `F` (value: `'f'`) + +* `I` (value: `'i'`) + +* `L` (value: `'l'`) + +* `M` (value: `'m'`) + +* `N` (value: `'n'`) + +* `O` (value: `'o'`) + +* `E` (value: `'e'`) + +* `R` (value: `'r'`) + +* `Pr` (value: `'pr'`) + +* `P` (value: `'p'`) + +* `Rd` (value: `'rd'`) + +* `H` (value: `'h'`) + +* `S` (value: `'s'`) + +* `T` (value: `'t'`) + +* `U` (value: `'u'`) + +* `W` (value: `'w'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SourceConfig.md b/jb-ui/src/api_fsb/docs/SourceConfig.md new file mode 100644 index 0000000..6ce0707 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SourceConfig.md @@ -0,0 +1,35 @@ +# SourceConfig + +This could also be named \"BP:Marketplace Config\", as it describes the config for a BP on a single marketplace. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**Source**](Source.md) | | [default to undefined] +**active** | **boolean** | | [optional] [default to true] +**banned_countries** | **Array<string>** | | [optional] [default to undefined] +**allow_mobile_ip** | **boolean** | | [optional] [default to true] +**allow_pii_only_buyers** | **boolean** | Allow Tasks from Buyers that want traffic that comes from Suppliers that can identify their users. Only supported on Pure Spectrum. | [optional] [default to false] +**allow_unhashed_buyers** | **boolean** | Return Tasks from Buyers that don\'t have URL hashing enabled. Only supported on Pure Spectrum. | [optional] [default to false] +**withhold_profiling** | **boolean** | For some Products, we may have privacy agreements prohibiting us from sharing information with the inventorySource. If True, don\'t add MRPQ (Market Research ProfilingQuestion) onto the entry link. | [optional] [default to false] +**pass_unconditional_eligible_unknowns** | **boolean** | Not used at the moment | [optional] [default to true] + +## Example + +```typescript +import { SourceConfig } from './api'; + +const instance: SourceConfig = { + name, + active, + banned_countries, + allow_mobile_ip, + allow_pii_only_buyers, + allow_unhashed_buyers, + withhold_profiling, + pass_unconditional_eligible_unknowns, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SourcesConfig.md b/jb-ui/src/api_fsb/docs/SourcesConfig.md new file mode 100644 index 0000000..9622fff --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SourcesConfig.md @@ -0,0 +1,22 @@ +# SourcesConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_defined** | [**Array<SourceConfig>**](SourceConfig.md) | | [optional] [default to undefined] +**policies** | [**Array<SupplyPolicy>**](SupplyPolicy.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { SourcesConfig } from './api'; + +const instance: SourcesConfig = { + user_defined, + policies, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StartedAfter.md b/jb-ui/src/api_fsb/docs/StartedAfter.md new file mode 100644 index 0000000..9424a4b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StartedAfter.md @@ -0,0 +1,19 @@ +# StartedAfter + +Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { StartedAfter } from './api'; + +const instance: StartedAfter = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StartedBefore.md b/jb-ui/src/api_fsb/docs/StartedBefore.md new file mode 100644 index 0000000..8fba612 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StartedBefore.md @@ -0,0 +1,19 @@ +# StartedBefore + +Retrieve sessions which were started before this timestamp. If `NULL`, default is now. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { StartedBefore } from './api'; + +const instance: StartedBefore = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallOfferWall.md b/jb-ui/src/api_fsb/docs/StarwallOfferWall.md new file mode 100644 index 0000000..eef2276 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallOfferWall.md @@ -0,0 +1,31 @@ +# StarwallOfferWall + +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` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNBucket>**](TopNBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] +**payout_format** | **string** | 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\" | [default to undefined] + +## Example + +```typescript +import { StarwallOfferWall } from './api'; + +const instance: StarwallOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, + payout_format, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallOfferWallResponse.md b/jb-ui/src/api_fsb/docs/StarwallOfferWallResponse.md new file mode 100644 index 0000000..68c4f58 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallOfferWallResponse.md @@ -0,0 +1,22 @@ +# StarwallOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**StarwallOfferWall**](StarwallOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { StarwallOfferWallResponse } from './api'; + +const instance: StarwallOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallPlusBlockOfferWall.md b/jb-ui/src/api_fsb/docs/StarwallPlusBlockOfferWall.md new file mode 100644 index 0000000..6f9a4f4 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallPlusBlockOfferWall.md @@ -0,0 +1,29 @@ +# StarwallPlusBlockOfferWall + +Same as the StarwallOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. Offerwall code: `7fa1b3f4` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNPlusBucket>**](TopNPlusBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { StarwallPlusBlockOfferWall } from './api'; + +const instance: StarwallPlusBlockOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallPlusBlockOfferWallResponse.md b/jb-ui/src/api_fsb/docs/StarwallPlusBlockOfferWallResponse.md new file mode 100644 index 0000000..3716364 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallPlusBlockOfferWallResponse.md @@ -0,0 +1,22 @@ +# StarwallPlusBlockOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**StarwallPlusBlockOfferWall**](StarwallPlusBlockOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { StarwallPlusBlockOfferWallResponse } from './api'; + +const instance: StarwallPlusBlockOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallPlusBlockRecontactOfferWall.md b/jb-ui/src/api_fsb/docs/StarwallPlusBlockRecontactOfferWall.md new file mode 100644 index 0000000..0781263 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallPlusBlockRecontactOfferWall.md @@ -0,0 +1,29 @@ +# StarwallPlusBlockRecontactOfferWall + +Same as the StarwallOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a recontact key. Offerwall code: `630db2a4` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNPlusRecontactBucket>**](TopNPlusRecontactBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { StarwallPlusBlockRecontactOfferWall } from './api'; + +const instance: StarwallPlusBlockRecontactOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallPlusBlockRecontactOfferWallResponse.md b/jb-ui/src/api_fsb/docs/StarwallPlusBlockRecontactOfferWallResponse.md new file mode 100644 index 0000000..52467ef --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallPlusBlockRecontactOfferWallResponse.md @@ -0,0 +1,22 @@ +# StarwallPlusBlockRecontactOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**StarwallPlusBlockRecontactOfferWall**](StarwallPlusBlockRecontactOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { StarwallPlusBlockRecontactOfferWallResponse } from './api'; + +const instance: StarwallPlusBlockRecontactOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallPlusOfferWall.md b/jb-ui/src/api_fsb/docs/StarwallPlusOfferWall.md new file mode 100644 index 0000000..b5eac96 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallPlusOfferWall.md @@ -0,0 +1,29 @@ +# StarwallPlusOfferWall + +Same as the StarwallOfferWall, but the buckets include contents. Offerwall code: `5481f322` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNPlusBucket>**](TopNPlusBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { StarwallPlusOfferWall } from './api'; + +const instance: StarwallPlusOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StarwallPlusOfferWallResponse.md b/jb-ui/src/api_fsb/docs/StarwallPlusOfferWallResponse.md new file mode 100644 index 0000000..ad87b7a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StarwallPlusOfferWallResponse.md @@ -0,0 +1,22 @@ +# StarwallPlusOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**StarwallPlusOfferWall**](StarwallPlusOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { StarwallPlusOfferWallResponse } from './api'; + +const instance: StarwallPlusOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatisticalSummaryStat.md b/jb-ui/src/api_fsb/docs/StatisticalSummaryStat.md new file mode 100644 index 0000000..feb5b94 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatisticalSummaryStat.md @@ -0,0 +1,22 @@ +# StatisticalSummaryStat + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**facet** | [**{ [key: string]: FacetValue; }**](FacetValue.md) | The grouping criteria | [default to undefined] +**value** | [**StatisticalSummaryValue**](StatisticalSummaryValue.md) | Statistical Summary for the given metric and facet | [default to undefined] + +## Example + +```typescript +import { StatisticalSummaryStat } from './api'; + +const instance: StatisticalSummaryStat = { + facet, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatisticalSummaryValue.md b/jb-ui/src/api_fsb/docs/StatisticalSummaryValue.md new file mode 100644 index 0000000..4eeb595 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatisticalSummaryValue.md @@ -0,0 +1,34 @@ +# StatisticalSummaryValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min** | **number** | | [default to undefined] +**max** | **number** | | [default to undefined] +**mean** | **number** | | [default to undefined] +**q1** | **number** | | [default to undefined] +**q2** | **number** | equal to the median | [default to undefined] +**q3** | **number** | | [default to undefined] +**lower_whisker** | **number** | | [readonly] [default to undefined] +**upper_whisker** | **number** | | [readonly] [default to undefined] + +## Example + +```typescript +import { StatisticalSummaryValue } from './api'; + +const instance: StatisticalSummaryValue = { + min, + max, + mean, + q1, + q2, + q3, + lower_whisker, + upper_whisker, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatsMessage.md b/jb-ui/src/api_fsb/docs/StatsMessage.md new file mode 100644 index 0000000..92c4a22 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatsMessage.md @@ -0,0 +1,26 @@ +# StatsMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **string** | | [optional] [default to KindEnum_Stats] +**timestamp** | **string** | | [optional] [default to undefined] +**country_iso** | **string** | | [optional] [default to undefined] +**data** | [**StatsSnapshot**](StatsSnapshot.md) | | [default to undefined] + +## Example + +```typescript +import { StatsMessage } from './api'; + +const instance: StatsMessage = { + kind, + timestamp, + country_iso, + data, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatsSnapshot.md b/jb-ui/src/api_fsb/docs/StatsSnapshot.md new file mode 100644 index 0000000..f041af4 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatsSnapshot.md @@ -0,0 +1,62 @@ +# StatsSnapshot + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**live_task_count** | [**AggregateBySource**](AggregateBySource.md) | | [optional] [default to undefined] +**task_created_count_last_1h** | [**AggregateBySource**](AggregateBySource.md) | | [optional] [default to undefined] +**task_created_count_last_24h** | [**AggregateBySource**](AggregateBySource.md) | | [optional] [default to undefined] +**live_tasks_max_payout** | [**MaxGaugeBySource**](MaxGaugeBySource.md) | In integer USDCents | [optional] [default to undefined] +**country_iso** | **string** | | [optional] [default to undefined] +**timestamp** | **string** | | [optional] [default to undefined] +**active_users_last_1h** | **number** | Count of users (in this product_id) that were active in the past 60 minutes. Behaviors that trigger active: - Request an offerwall - Enter an offerwall bucket - Request profiling questions - Submit profiling answers - Update user profile | [optional] [default to 0] +**active_users_last_24h** | **number** | Count of users (in this product_id) that were active in the past 24 hours. | [optional] [default to 0] +**in_progress_users** | **number** | Count of users that are currently doing work at this moment | [default to undefined] +**signups_last_24h** | **number** | Count of users created | [default to undefined] +**session_enters_last_1h** | **number** | | [default to undefined] +**session_enters_last_24h** | **number** | | [default to undefined] +**session_fails_last_1h** | **number** | | [default to undefined] +**session_fails_last_24h** | **number** | | [default to undefined] +**session_completes_last_1h** | **number** | | [default to undefined] +**session_completes_last_24h** | **number** | | [default to undefined] +**sum_payouts_last_1h** | **number** | In integer USDCents | [default to undefined] +**sum_payouts_last_24h** | **number** | In integer USDCents | [default to undefined] +**session_avg_payout_last_24h** | **number** | | [default to undefined] +**session_avg_user_payout_last_24h** | **number** | | [default to undefined] +**session_fail_avg_loi_last_24h** | **number** | | [default to undefined] +**session_complete_avg_loi_last_24h** | **number** | | [default to undefined] + +## Example + +```typescript +import { StatsSnapshot } from './api'; + +const instance: StatsSnapshot = { + live_task_count, + task_created_count_last_1h, + task_created_count_last_24h, + live_tasks_max_payout, + country_iso, + timestamp, + active_users_last_1h, + active_users_last_24h, + in_progress_users, + signups_last_24h, + session_enters_last_1h, + session_enters_last_24h, + session_fails_last_1h, + session_fails_last_24h, + session_completes_last_1h, + session_completes_last_24h, + sum_payouts_last_1h, + sum_payouts_last_24h, + session_avg_payout_last_24h, + session_avg_user_payout_last_24h, + session_fail_avg_loi_last_24h, + session_complete_avg_loi_last_24h, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Status.md b/jb-ui/src/api_fsb/docs/Status.md new file mode 100644 index 0000000..52fe6b9 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Status.md @@ -0,0 +1,15 @@ +# Status + +The outcome of a session or wall event. If the session is still in progress, the status will be NULL. + +## Enum + +* `C` (value: `'c'`) + +* `F` (value: `'f'`) + +* `A` (value: `'a'`) + +* `T` (value: `'t'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatusApi.md b/jb-ui/src/api_fsb/docs/StatusApi.md new file mode 100644 index 0000000..4ddde8d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatusApi.md @@ -0,0 +1,155 @@ +# StatusApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getTaskStatusProductIdStatusTsidGet**](#gettaskstatusproductidstatustsidget) | **GET** /{product_id}/status/{tsid}/ | Get Task Status| +|[**listTaskStatusesProductIdStatusGet**](#listtaskstatusesproductidstatusget) | **GET** /{product_id}/status/ | List Task Statuses| + +# **getTaskStatusProductIdStatusTsidGet** +> TaskStatusResponse getTaskStatusProductIdStatusTsidGet() + +Retrieve the status of a session by a specific Task Status ID (`tsid`) that is provided in the redirect. Given a `tsid`, get back the status of the wall event. This endpoint conflates the idea of a wall event and a session, but for these purposes, the status and payout of the last wall event in a session equals the status and payout for the session. + +### Example + +```typescript +import { + StatusApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new StatusApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let tsid: string; //A unique identifier for the session (default to undefined) + +const { status, data } = await apiInstance.getTaskStatusProductIdStatusTsidGet( + productId, + tsid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **tsid** | [**string**] | A unique identifier for the session | defaults to undefined| + + +### Return type + +**TaskStatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**500** | Internal Server Error | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listTaskStatusesProductIdStatusGet** +> TasksStatusResponse listTaskStatusesProductIdStatusGet() + + +### Example + +```typescript +import { + StatusApi, + Configuration, + StartedAfter, + StartedBefore, + AdjustedAfter, + AdjustedBefore +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new StatusApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Filters the returned task status to only include those done by this user. (optional) (default to undefined) +let startedAfter: StartedAfter; //Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. (optional) (default to undefined) +let startedBefore: StartedBefore; //Retrieve sessions which were started before this timestamp. If `NULL`, default is now. (optional) (default to undefined) +let status: number; //Filter for sessions with this status. See Task Status for description of status. (optional) (default to undefined) +let reconciled: boolean; //Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. (optional) (default to false) +let adjustedAfter: AdjustedAfter; //Retrieve sessions which were adjusted after this timestamp. (optional) (default to undefined) +let adjustedBefore: AdjustedBefore; //Retrieve sessions which were adjusted before this timestamp. Default is now. (optional) (default to undefined) +let orderBy: string; //Comma-separated fields to order by (optional) (default to '-started') +let page: number; // (optional) (default to 1) +let size: number; // (optional) (default to 50) + +const { status, data } = await apiInstance.listTaskStatusesProductIdStatusGet( + productId, + bpuid, + startedAfter, + startedBefore, + status, + reconciled, + adjustedAfter, + adjustedBefore, + orderBy, + page, + size +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Filters the returned task status to only include those done by this user. | (optional) defaults to undefined| +| **startedAfter** | **StartedAfter** | Retrieve sessions which were started after this timestamp. If `NULL`, default is 10 days ago. | (optional) defaults to undefined| +| **startedBefore** | **StartedBefore** | Retrieve sessions which were started before this timestamp. If `NULL`, default is now. | (optional) defaults to undefined| +| **status** | [**number**] | Filter for sessions with this status. See Task Status for description of status. | (optional) defaults to undefined| +| **reconciled** | [**boolean**] | Only retrieve sessions that have been adjusted. If `reconciled` is True, `adjusted_after` is required. | (optional) defaults to false| +| **adjustedAfter** | **AdjustedAfter** | Retrieve sessions which were adjusted after this timestamp. | (optional) defaults to undefined| +| **adjustedBefore** | **AdjustedBefore** | Retrieve sessions which were adjusted before this timestamp. Default is now. | (optional) defaults to undefined| +| **orderBy** | [**string**] | Comma-separated fields to order by | (optional) defaults to '-started'| +| **page** | [**number**] | | (optional) defaults to 1| +| **size** | [**number**] | | (optional) defaults to 50| + + +### Return type + +**TasksStatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**400** | Bad Request | - | +|**401** | Unauthorized | - | +|**500** | Internal Server Error | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/StatusCode1.md b/jb-ui/src/api_fsb/docs/StatusCode1.md new file mode 100644 index 0000000..4b34f57 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatusCode1.md @@ -0,0 +1,45 @@ +# StatusCode1 + +__High level status code for outcome of the session.__ This should only be NULL if the Status is ABANDON or TIMEOUT + +## Enum + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +* `NUMBER_3` (value: `3`) + +* `NUMBER_4` (value: `4`) + +* `NUMBER_5` (value: `5`) + +* `NUMBER_6` (value: `6`) + +* `NUMBER_7` (value: `7`) + +* `NUMBER_8` (value: `8`) + +* `NUMBER_9` (value: `9`) + +* `NUMBER_10` (value: `10`) + +* `NUMBER_11` (value: `11`) + +* `NUMBER_12` (value: `12`) + +* `NUMBER_13` (value: `13`) + +* `NUMBER_14` (value: `14`) + +* `NUMBER_15` (value: `15`) + +* `NUMBER_16` (value: `16`) + +* `NUMBER_17` (value: `17`) + +* `NUMBER_18` (value: `18`) + +* `NUMBER_19` (value: `19`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatusInfoResponseFail.md b/jb-ui/src/api_fsb/docs/StatusInfoResponseFail.md new file mode 100644 index 0000000..9f977c3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatusInfoResponseFail.md @@ -0,0 +1,22 @@ +# StatusInfoResponseFail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**StatusSuccessFail**](StatusSuccessFail.md) | | [default to undefined] +**msg** | **string** | An optional message, if success is False | [default to undefined] + +## Example + +```typescript +import { StatusInfoResponseFail } from './api'; + +const instance: StatusInfoResponseFail = { + info, + msg, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatusResponse.md b/jb-ui/src/api_fsb/docs/StatusResponse.md new file mode 100644 index 0000000..4a9dd73 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatusResponse.md @@ -0,0 +1,22 @@ +# StatusResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { StatusResponse } from './api'; + +const instance: StatusResponse = { + status, + msg, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatusResponseFailure.md b/jb-ui/src/api_fsb/docs/StatusResponseFailure.md new file mode 100644 index 0000000..1967042 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatusResponseFailure.md @@ -0,0 +1,22 @@ +# StatusResponseFailure + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | An optional message, if the status is failure. | [default to undefined] + +## Example + +```typescript +import { StatusResponseFailure } from './api'; + +const instance: StatusResponseFailure = { + status, + msg, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StatusSuccessFail.md b/jb-ui/src/api_fsb/docs/StatusSuccessFail.md new file mode 100644 index 0000000..562f7e6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StatusSuccessFail.md @@ -0,0 +1,20 @@ +# StatusSuccessFail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **boolean** | Whether the API response is successful. | [optional] [default to false] + +## Example + +```typescript +import { StatusSuccessFail } from './api'; + +const instance: StatusSuccessFail = { + success, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StreakFulfillment.md b/jb-ui/src/api_fsb/docs/StreakFulfillment.md new file mode 100644 index 0000000..95fd01b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StreakFulfillment.md @@ -0,0 +1,11 @@ +# StreakFulfillment + +What has to happen for a user to fulfill a period for a streak + +## Enum + +* `Active` (value: `'active'`) + +* `Complete` (value: `'complete'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StreakPeriod.md b/jb-ui/src/api_fsb/docs/StreakPeriod.md new file mode 100644 index 0000000..6fc98a1 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StreakPeriod.md @@ -0,0 +1,12 @@ +# StreakPeriod + + +## Enum + +* `Day` (value: `'day'`) + +* `Week` (value: `'week'`) + +* `Month` (value: `'month'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StreakState.md b/jb-ui/src/api_fsb/docs/StreakState.md new file mode 100644 index 0000000..68c0e6d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StreakState.md @@ -0,0 +1,12 @@ +# StreakState + + +## Enum + +* `Active` (value: `'active'`) + +* `AtRisk` (value: `'at_risk'`) + +* `Broken` (value: `'broken'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/StreamsApi.md b/jb-ui/src/api_fsb/docs/StreamsApi.md new file mode 100644 index 0000000..77826e6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/StreamsApi.md @@ -0,0 +1,104 @@ +# StreamsApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**websocketDebugPageWsDebugGet**](#websocketdebugpagewsdebugget) | **GET** /ws/debug/ | Websocket Debug Page| +|[**websocketEventsDocsWsEventsDocsGet**](#websocketeventsdocswseventsdocsget) | **GET** /ws/events/docs/ | Websocket Events Docs| + +# **websocketDebugPageWsDebugGet** +> string websocketDebugPageWsDebugGet() + + +### Example + +```typescript +import { + StreamsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new StreamsApi(configuration); + +let productId: string; // (default to undefined) + +const { status, data } = await apiInstance.websocketDebugPageWsDebugGet( + productId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | | defaults to undefined| + + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/html, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **websocketEventsDocsWsEventsDocsGet** +> ResponseWebsocketEventsDocsWsEventsDocsGet websocketEventsDocsWsEventsDocsGet() + +WebSocket endpoint: `/ws/events/` Protocol: - Client connects - Client sends a SubscribeMessage `{ kind: \"subscribe\", product_id: \"{product_id}\" }` - Server sends a PingMessage `{ kind: \"ping\" }` - Client must reply a PongMessage: `{ kind: \"pong\" }` - Other messages are EventMessage or StatsMessage Close on missing pong after 20s. + +### Example + +```typescript +import { + StreamsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new StreamsApi(configuration); + +const { status, data } = await apiInstance.websocketEventsDocsWsEventsDocsGet(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**ResponseWebsocketEventsDocsWsEventsDocsGet** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/SubscribeMessage.md b/jb-ui/src/api_fsb/docs/SubscribeMessage.md new file mode 100644 index 0000000..42ba908 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SubscribeMessage.md @@ -0,0 +1,22 @@ +# SubscribeMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **string** | | [optional] [default to KindEnum_Subscribe] +**product_id** | **string** | | [default to undefined] + +## Example + +```typescript +import { SubscribeMessage } from './api'; + +const instance: SubscribeMessage = { + kind, + product_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SupplierTag.md b/jb-ui/src/api_fsb/docs/SupplierTag.md new file mode 100644 index 0000000..85133bc --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SupplierTag.md @@ -0,0 +1,21 @@ +# SupplierTag + +Available tags which can be used to annotate supplier traffic Note: should not include commas! + +## Enum + +* `Mobile` (value: `'mobile'`) + +* `JsOfferwall` (value: `'js-offerwall'`) + +* `DoubleOptIn` (value: `'double-opt-in'`) + +* `SingleSignOn` (value: `'single-sign-on'`) + +* `PhoneNumberVerified` (value: `'phone-number-verified'`) + +* `TestA` (value: `'test-a'`) + +* `TestB` (value: `'test-b'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SupplyConfig.md b/jb-ui/src/api_fsb/docs/SupplyConfig.md new file mode 100644 index 0000000..8323b70 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SupplyConfig.md @@ -0,0 +1,21 @@ +# SupplyConfig + +Describes the set of policies for how GRL can interact with marketplaces. This is only used on the special \"global product\". + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policies** | [**Array<SupplyPolicy>**](SupplyPolicy.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { SupplyConfig } from './api'; + +const instance: SupplyConfig = { + policies, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SupplyPolicy.md b/jb-ui/src/api_fsb/docs/SupplyPolicy.md new file mode 100644 index 0000000..6d72fa9 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SupplyPolicy.md @@ -0,0 +1,51 @@ +# 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. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**Source**](Source.md) | | [default to undefined] +**active** | **boolean** | | [optional] [default to true] +**banned_countries** | **Array<string>** | | [optional] [default to undefined] +**allow_mobile_ip** | **boolean** | | [optional] [default to true] +**allow_pii_only_buyers** | **boolean** | Allow Tasks from Buyers that want traffic that comes from Suppliers that can identify their users. Only supported on Pure Spectrum. | [optional] [default to false] +**allow_unhashed_buyers** | **boolean** | Return Tasks from Buyers that don\'t have URL hashing enabled. Only supported on Pure Spectrum. | [optional] [default to false] +**withhold_profiling** | **boolean** | For some Products, we may have privacy agreements prohibiting us from sharing information with the inventorySource. If True, don\'t add MRPQ (Market Research ProfilingQuestion) onto the entry link. | [optional] [default to false] +**pass_unconditional_eligible_unknowns** | **boolean** | Not used at the moment | [optional] [default to true] +**address** | **Array<string>** | address for the grpc GetOpps call | [default to undefined] +**allow_vpn** | **boolean** | | [optional] [default to false] +**distribute_harmonizer_active** | **boolean** | | [optional] [default to true] +**supplier_id** | **string** | | [optional] [default to undefined] +**team_ids** | **Array<string>** | | [optional] [default to undefined] +**product_ids** | **Array<string>** | | [optional] [default to undefined] +**integration_mode** | [**IntegrationMode**](IntegrationMode.md) | | [optional] [default to undefined] +**scope** | [**Scope**](Scope.md) | There must be only 1 GLOBAL config per Source. We can have more than one TEAM/PRODUCT config per Source. | [readonly] [default to undefined] + +## Example + +```typescript +import { SupplyPolicy } from './api'; + +const instance: SupplyPolicy = { + name, + active, + banned_countries, + allow_mobile_ip, + allow_pii_only_buyers, + allow_unhashed_buyers, + withhold_profiling, + pass_unconditional_eligible_unknowns, + address, + allow_vpn, + distribute_harmonizer_active, + supplier_id, + team_ids, + product_ids, + integration_mode, + scope, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md b/jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md new file mode 100644 index 0000000..167e557 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SurveyEligibilityCriterion.md @@ -0,0 +1,33 @@ +# SurveyEligibilityCriterion + +Explanatory record of which question answers contributed to a user\'s eligibility for a survey. This is INSUFFICIENT for determining eligibility to a task as it IGNORES logical operators, dependencies between criteria, and other requirements. It is only intended for the UI. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question_id** | **string** | | [default to undefined] +**property_code** | **string** | | [default to undefined] +**question_text** | **string** | | [default to undefined] +**qualifying_answer** | **Array<string>** | User answer(s) that satisfied at least one eligibility rule | [default to undefined] +**qualifying_answer_label** | **Array<string>** | | [default to undefined] +**explanation** | **string** | | [optional] [default to undefined] +**rank** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { SurveyEligibilityCriterion } from './api'; + +const instance: SurveyEligibilityCriterion = { + question_id, + property_code, + question_text, + qualifying_answer, + qualifying_answer_label, + explanation, + rank, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/SurveyId.md b/jb-ui/src/api_fsb/docs/SurveyId.md new file mode 100644 index 0000000..ecd95c6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/SurveyId.md @@ -0,0 +1,18 @@ +# SurveyId + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { SurveyId } from './api'; + +const instance: SurveyId = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TangoCashoutMethodData.md b/jb-ui/src/api_fsb/docs/TangoCashoutMethodData.md new file mode 100644 index 0000000..50766ff --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TangoCashoutMethodData.md @@ -0,0 +1,30 @@ +# TangoCashoutMethodData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to TypeEnum_Tango] +**utid** | **string** | tango utid | [default to undefined] +**countries** | **Array<string>** | | [default to undefined] +**value_type** | **string** | | [default to undefined] +**disclaimer** | **string** | | [optional] [default to ''] +**terms** | **string** | | [optional] [default to ''] + +## Example + +```typescript +import { TangoCashoutMethodData } from './api'; + +const instance: TangoCashoutMethodData = { + type, + utid, + countries, + value_type, + disclaimer, + terms, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TaskEnterPayload.md b/jb-ui/src/api_fsb/docs/TaskEnterPayload.md new file mode 100644 index 0000000..00927a7 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TaskEnterPayload.md @@ -0,0 +1,28 @@ +# TaskEnterPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **string** | | [optional] [default to EventTypeEnum_TaskEnter] +**source** | [**Source**](Source.md) | | [default to undefined] +**survey_id** | **string** | | [default to undefined] +**quota_id** | **string** | | [optional] [default to undefined] +**country_iso** | **string** | | [default to undefined] + +## Example + +```typescript +import { TaskEnterPayload } from './api'; + +const instance: TaskEnterPayload = { + event_type, + source, + survey_id, + quota_id, + country_iso, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TaskFinishPayload.md b/jb-ui/src/api_fsb/docs/TaskFinishPayload.md new file mode 100644 index 0000000..5ed04d2 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TaskFinishPayload.md @@ -0,0 +1,38 @@ +# TaskFinishPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **string** | | [optional] [default to EventTypeEnum_TaskFinish] +**source** | [**Source**](Source.md) | | [default to undefined] +**survey_id** | **string** | | [default to undefined] +**quota_id** | **string** | | [optional] [default to undefined] +**country_iso** | **string** | | [default to undefined] +**duration_sec** | **number** | | [default to undefined] +**status** | [**Status**](Status.md) | | [default to undefined] +**status_code_1** | [**StatusCode1**](StatusCode1.md) | | [optional] [default to undefined] +**status_code_2** | [**WallStatusCode2**](WallStatusCode2.md) | | [optional] [default to undefined] +**cpi** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { TaskFinishPayload } from './api'; + +const instance: TaskFinishPayload = { + event_type, + source, + survey_id, + quota_id, + country_iso, + duration_sec, + status, + status_code_1, + status_code_2, + cpi, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TaskStatusResponse.md b/jb-ui/src/api_fsb/docs/TaskStatusResponse.md new file mode 100644 index 0000000..68baace --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TaskStatusResponse.md @@ -0,0 +1,63 @@ +# TaskStatusResponse + +The status of a session + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tsid** | **string** | A unique identifier for the session | [default to undefined] +**product_id** | **string** | The BP ID of the associated respondent | [default to undefined] +**product_user_id** | **string** | A unique identifier for each user, which is set by the Supplier | [default to undefined] +**started** | **string** | When the session was started | [default to undefined] +**finished** | **string** | | [optional] [default to undefined] +**status** | **number** | The outcome of a session. - 0 - UNKNOWN - 1 - ENTER (the user has not yet returned) - 2 - INCOMPLETE (the user failed) - 3 - COMPLETE (the user completed the task) | [optional] [default to undefined] +**payout** | **number** | | [optional] [default to undefined] +**user_payout** | **number** | | [optional] [default to undefined] +**payout_format** | **string** | | [optional] [default to undefined] +**user_payout_string** | **string** | | [optional] [default to undefined] +**kwargs** | **{ [key: string]: string; }** | Any extra url params used in the offerwall request will be passed back here | [optional] [default to undefined] +**status_code_1** | **string** | | [optional] [default to undefined] +**status_code_2** | **string** | | [optional] [default to undefined] +**adjusted_status** | [**SessionAdjustedStatus**](SessionAdjustedStatus.md) | | [optional] [default to undefined] +**adjusted_timestamp** | **string** | | [optional] [default to undefined] +**adjusted_payout** | **number** | | [optional] [default to undefined] +**adjusted_user_payout** | **number** | | [optional] [default to undefined] +**adjusted_user_payout_string** | **string** | | [optional] [default to undefined] +**wall_events** | [**Array<WallOut>**](WallOut.md) | | [optional] [default to undefined] +**currency** | **string** | | [optional] [default to CurrencyEnum_Usd] +**final_status** | **number** | This is deprecated | [optional] [default to 0] +**bpuid** | **string** | | [readonly] [default to undefined] + +## Example + +```typescript +import { TaskStatusResponse } from './api'; + +const instance: TaskStatusResponse = { + tsid, + product_id, + product_user_id, + started, + finished, + status, + payout, + user_payout, + payout_format, + user_payout_string, + kwargs, + status_code_1, + status_code_2, + adjusted_status, + adjusted_timestamp, + adjusted_payout, + adjusted_user_payout, + adjusted_user_payout_string, + wall_events, + currency, + final_status, + bpuid, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TasksStatusResponse.md b/jb-ui/src/api_fsb/docs/TasksStatusResponse.md new file mode 100644 index 0000000..2d38b93 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TasksStatusResponse.md @@ -0,0 +1,28 @@ +# TasksStatusResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **number** | Page number | [optional] [default to 1] +**size** | **number** | Page size | [optional] [default to 50] +**total** | **number** | | [optional] [default to undefined] +**tasks_status** | [**Array<TaskStatusResponse>**](TaskStatusResponse.md) | | [optional] [default to undefined] +**pages** | **number** | | [default to undefined] + +## Example + +```typescript +import { TasksStatusResponse } from './api'; + +const instance: TasksStatusResponse = { + page, + size, + total, + tasks_status, + pages, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNBucket.md b/jb-ui/src/api_fsb/docs/TopNBucket.md new file mode 100644 index 0000000..e65619b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNBucket.md @@ -0,0 +1,38 @@ +# TopNBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] +**x** | **number** | For UI. Provides a dimensionality position for the bucket on the x-axis. | [optional] [default to 0] +**y** | **number** | For UI. Provides a dimensionality position for the bucket on the y-axis. | [optional] [default to 0] +**name** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**description** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**category** | [**Array<CategoryAssociation>**](CategoryAssociation.md) | | [optional] [default to undefined] +**duration** | [**DurationSummary**](DurationSummary.md) | | [default to undefined] +**payout** | [**PayoutSummary**](PayoutSummary.md) | | [default to undefined] +**quality_score** | **number** | A proprietary score to determine the overall quality of the tasks that are within the bucket. Higher is better. | [default to undefined] + +## Example + +```typescript +import { TopNBucket } from './api'; + +const instance: TopNBucket = { + id, + uri, + x, + y, + name, + description, + category, + duration, + payout, + quality_score, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNOfferWall.md b/jb-ui/src/api_fsb/docs/TopNOfferWall.md new file mode 100644 index 0000000..5652aa0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNOfferWall.md @@ -0,0 +1,31 @@ +# TopNOfferWall + +An offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. Offerwall code: `45b7228a7` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNBucket>**](TopNBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] +**payout_format** | **string** | 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\" | [default to undefined] + +## Example + +```typescript +import { TopNOfferWall } from './api'; + +const instance: TopNOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, + payout_format, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNOfferWallResponse.md b/jb-ui/src/api_fsb/docs/TopNOfferWallResponse.md new file mode 100644 index 0000000..3d20278 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNOfferWallResponse.md @@ -0,0 +1,22 @@ +# TopNOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**TopNOfferWall**](TopNOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { TopNOfferWallResponse } from './api'; + +const instance: TopNOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusBlockOfferWall.md b/jb-ui/src/api_fsb/docs/TopNPlusBlockOfferWall.md new file mode 100644 index 0000000..a99b19e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusBlockOfferWall.md @@ -0,0 +1,29 @@ +# TopNPlusBlockOfferWall + +Same as the TopNOfferWall, but the buckets include contents and no buckets are returned if the user is blocked. Offerwall code: `d48cce47` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNPlusBucket>**](TopNPlusBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { TopNPlusBlockOfferWall } from './api'; + +const instance: TopNPlusBlockOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusBlockOfferWallResponse.md b/jb-ui/src/api_fsb/docs/TopNPlusBlockOfferWallResponse.md new file mode 100644 index 0000000..12d1273 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusBlockOfferWallResponse.md @@ -0,0 +1,22 @@ +# TopNPlusBlockOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**TopNPlusBlockOfferWall**](TopNPlusBlockOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { TopNPlusBlockOfferWallResponse } from './api'; + +const instance: TopNPlusBlockOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusBlockRecontactOfferWall.md b/jb-ui/src/api_fsb/docs/TopNPlusBlockRecontactOfferWall.md new file mode 100644 index 0000000..7931c6f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusBlockRecontactOfferWall.md @@ -0,0 +1,29 @@ +# TopNPlusBlockRecontactOfferWall + +Same as the TopNOfferWall, but the buckets include contents, no buckets are returned if the user is blocked, and each bucket includes a `is_recontact` key. Offerwall code: `1e5f0af8` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNPlusRecontactBucket>**](TopNPlusRecontactBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { TopNPlusBlockRecontactOfferWall } from './api'; + +const instance: TopNPlusBlockRecontactOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusBlockRecontactOfferWallResponse.md b/jb-ui/src/api_fsb/docs/TopNPlusBlockRecontactOfferWallResponse.md new file mode 100644 index 0000000..39ecc4f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusBlockRecontactOfferWallResponse.md @@ -0,0 +1,22 @@ +# TopNPlusBlockRecontactOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**TopNPlusBlockRecontactOfferWall**](TopNPlusBlockRecontactOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { TopNPlusBlockRecontactOfferWallResponse } from './api'; + +const instance: TopNPlusBlockRecontactOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusBucket.md b/jb-ui/src/api_fsb/docs/TopNPlusBucket.md new file mode 100644 index 0000000..a50e140 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusBucket.md @@ -0,0 +1,46 @@ +# TopNPlusBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] +**x** | **number** | For UI. Provides a dimensionality position for the bucket on the x-axis. | [optional] [default to 0] +**y** | **number** | For UI. Provides a dimensionality position for the bucket on the y-axis. | [optional] [default to 0] +**name** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**description** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**category** | [**Array<CategoryAssociation>**](CategoryAssociation.md) | | [optional] [default to undefined] +**contents** | [**Array<BucketTask>**](BucketTask.md) | | [default to undefined] +**duration** | [**DurationSummary**](DurationSummary.md) | | [default to undefined] +**payout** | [**PayoutSummary**](PayoutSummary.md) | | [default to undefined] +**quality_score** | **number** | | [default to undefined] +**currency** | **string** | This will always be \'USD\' | [optional] [default to 'USD'] +**eligibility_criteria** | [**Array<SurveyEligibilityCriterion>**](SurveyEligibilityCriterion.md) | The reasons the user is eligible for tasks in this bucket | [optional] [default to undefined] +**eligibility_explanation** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { TopNPlusBucket } from './api'; + +const instance: TopNPlusBucket = { + id, + uri, + x, + y, + name, + description, + category, + contents, + duration, + payout, + quality_score, + currency, + eligibility_criteria, + eligibility_explanation, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusOfferWall.md b/jb-ui/src/api_fsb/docs/TopNPlusOfferWall.md new file mode 100644 index 0000000..6514ef0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusOfferWall.md @@ -0,0 +1,29 @@ +# TopNPlusOfferWall + +Same as the TopNOfferWall, but the buckets include contents. Offerwall code: `b145b803` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<TopNPlusBucket>**](TopNPlusBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { TopNPlusOfferWall } from './api'; + +const instance: TopNPlusOfferWall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusOfferWallResponse.md b/jb-ui/src/api_fsb/docs/TopNPlusOfferWallResponse.md new file mode 100644 index 0000000..f14a777 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusOfferWallResponse.md @@ -0,0 +1,22 @@ +# TopNPlusOfferWallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**TopNPlusOfferWall**](TopNPlusOfferWall.md) | | [default to undefined] + +## Example + +```typescript +import { TopNPlusOfferWallResponse } from './api'; + +const instance: TopNPlusOfferWallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/TopNPlusRecontactBucket.md b/jb-ui/src/api_fsb/docs/TopNPlusRecontactBucket.md new file mode 100644 index 0000000..ec392a7 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNPlusRecontactBucket.md @@ -0,0 +1,44 @@ +# TopNPlusRecontactBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] +**x** | **number** | For UI. Provides a dimensionality position for the bucket on the x-axis. | [optional] [default to 0] +**y** | **number** | For UI. Provides a dimensionality position for the bucket on the y-axis. | [optional] [default to 0] +**name** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**description** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**category** | [**Array<CategoryAssociation>**](CategoryAssociation.md) | | [optional] [default to undefined] +**contents** | [**Array<BucketTask>**](BucketTask.md) | | [default to undefined] +**duration** | [**DurationSummary**](DurationSummary.md) | | [default to undefined] +**payout** | [**PayoutSummary**](PayoutSummary.md) | | [default to undefined] +**quality_score** | **number** | | [default to undefined] +**is_recontact** | **boolean** | | [default to undefined] +**currency** | **string** | This will always be \'USD\' | [optional] [default to 'USD'] + +## Example + +```typescript +import { TopNPlusRecontactBucket } from './api'; + +const instance: TopNPlusRecontactBucket = { + id, + uri, + x, + y, + name, + description, + category, + contents, + duration, + payout, + quality_score, + is_recontact, + currency, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UPKImportance.md b/jb-ui/src/api_fsb/docs/UPKImportance.md new file mode 100644 index 0000000..1d2e583 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UPKImportance.md @@ -0,0 +1,24 @@ +# UPKImportance + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**task_count** | **number** | | [optional] [default to undefined] +**task_score** | **number** | | [optional] [default to undefined] +**marketplace_task_count** | **{ [key: string]: number; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { UPKImportance } from './api'; + +const instance: UPKImportance = { + task_count, + task_score, + marketplace_task_count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/USDeliveryAddress.md b/jb-ui/src/api_fsb/docs/USDeliveryAddress.md new file mode 100644 index 0000000..02963a0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/USDeliveryAddress.md @@ -0,0 +1,34 @@ +# USDeliveryAddress + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name_or_attn** | **string** | | [default to undefined] +**company** | **string** | | [optional] [default to undefined] +**phone_number** | **string** | | [optional] [default to undefined] +**address** | **string** | | [default to undefined] +**city** | **string** | | [default to undefined] +**state** | **string** | | [default to undefined] +**postal_code** | **string** | | [default to undefined] +**country** | **string** | | [optional] [default to 'us'] + +## Example + +```typescript +import { USDeliveryAddress } from './api'; + +const instance: USDeliveryAddress = { + name_or_attn, + company, + phone_number, + address, + city, + state, + postal_code, + country, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkItem.md b/jb-ui/src/api_fsb/docs/UpkItem.md new file mode 100644 index 0000000..ee6f1ae --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkItem.md @@ -0,0 +1,24 @@ +# UpkItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [default to undefined] +**label** | **string** | | [default to undefined] +**description** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkItem } from './api'; + +const instance: UpkItem = { + id, + label, + description, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkProperty.md b/jb-ui/src/api_fsb/docs/UpkProperty.md new file mode 100644 index 0000000..8ab4b6e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkProperty.md @@ -0,0 +1,35 @@ +# UpkProperty + +This used to be called \"QuestionInfo\", which is a bad name, as this describes a UPK Property, like \"educational_attainment\", not the question that asks for your education. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**property_id** | **string** | | [default to undefined] +**property_label** | **string** | | [default to undefined] +**prop_type** | [**PropertyType**](PropertyType.md) | Allowed values: - __i__ *(UPK_ITEM)*: UserProfileKnowledge Item - __n__ *(UPK_NUMERICAL)*: UserProfileKnowledge Numerical - __x__ *(UPK_TEXT)*: UserProfileKnowledge Text | [optional] [default to undefined] +**cardinality** | [**Cardinality**](Cardinality.md) | Allowed values: - __*__ *(ZERO_OR_MORE)*: Zero or More - __?__ *(ZERO_OR_ONE)*: Zero or One | [optional] [default to undefined] +**country_iso** | **string** | | [default to undefined] +**gold_standard** | **boolean** | A Gold-Standard question has been enumerated for all possible values (per country) as best as possible by GRL,allowing it to be mapped across inventory sources. A property not marked as Gold-Standard may have: 1) marketplace qid associations & 2) category associations, but doesn\'t have a defined \'range\' (list of allowed itemsin a multiple choice question). This is used for exposing a user\'s profiling data & forthe Nudge API. | [optional] [default to false] +**allowed_items** | [**Array<UpkItem>**](UpkItem.md) | | [optional] [default to undefined] +**categories** | [**Array<Category>**](Category.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkProperty } from './api'; + +const instance: UpkProperty = { + property_id, + property_label, + prop_type, + cardinality, + country_iso, + gold_standard, + allowed_items, + categories, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestion.md b/jb-ui/src/api_fsb/docs/UpkQuestion.md new file mode 100644 index 0000000..332d09f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestion.md @@ -0,0 +1,46 @@ +# UpkQuestion + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question_id** | **string** | | [optional] [default to undefined] +**ext_question_id** | **string** | | [optional] [default to undefined] +**question_type** | [**UpkQuestionType**](UpkQuestionType.md) | | [default to undefined] +**country_iso** | **string** | | [default to undefined] +**language_iso** | **string** | | [default to undefined] +**question_text** | **string** | The text shown to respondents | [default to undefined] +**choices** | [**Array<UpkQuestionChoice>**](UpkQuestionChoice.md) | | [optional] [default to undefined] +**selector** | [**Selector**](Selector.md) | | [optional] [default to undefined] +**configuration** | [**UpkQuestionConfiguration**](UpkQuestionConfiguration.md) | | [optional] [default to undefined] +**validation** | [**UpkQuestionValidation**](UpkQuestionValidation.md) | | [optional] [default to undefined] +**importance** | [**UPKImportance**](UPKImportance.md) | | [optional] [default to undefined] +**categories** | [**Array<Category>**](Category.md) | Categories associated with this question | [optional] [default to undefined] +**explanation_template** | **string** | | [optional] [default to undefined] +**explanation_fragment_template** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestion } from './api'; + +const instance: UpkQuestion = { + question_id, + ext_question_id, + question_type, + country_iso, + language_iso, + question_text, + choices, + selector, + configuration, + validation, + importance, + categories, + explanation_template, + explanation_fragment_template, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionChoice.md b/jb-ui/src/api_fsb/docs/UpkQuestionChoice.md new file mode 100644 index 0000000..5aae99a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionChoice.md @@ -0,0 +1,30 @@ +# UpkQuestionChoice + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**choice_id** | **string** | The unique identifier for a response to a qualification | [default to undefined] +**choice_text** | **string** | The response text shown to respondents | [default to undefined] +**order** | **number** | | [default to undefined] +**group** | **number** | | [optional] [default to undefined] +**exclusive** | **boolean** | If answer is exclusive, it can be the only option selected | [optional] [default to false] +**importance** | [**UPKImportance**](UPKImportance.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestionChoice } from './api'; + +const instance: UpkQuestionChoice = { + choice_id, + choice_text, + order, + group, + exclusive, + importance, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionChoiceOut.md b/jb-ui/src/api_fsb/docs/UpkQuestionChoiceOut.md new file mode 100644 index 0000000..5ba523b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionChoiceOut.md @@ -0,0 +1,30 @@ +# UpkQuestionChoiceOut + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**choice_id** | **string** | The unique identifier for a response to a qualification | [default to undefined] +**choice_text** | **string** | The response text shown to respondents | [default to undefined] +**order** | **number** | | [default to undefined] +**group** | **number** | | [optional] [default to undefined] +**exclusive** | **boolean** | If answer is exclusive, it can be the only option selected | [optional] [default to false] +**importance** | [**UPKImportance**](UPKImportance.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestionChoiceOut } from './api'; + +const instance: UpkQuestionChoiceOut = { + choice_id, + choice_text, + order, + group, + exclusive, + importance, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionConfiguration.md b/jb-ui/src/api_fsb/docs/UpkQuestionConfiguration.md new file mode 100644 index 0000000..ebcd1f0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionConfiguration.md @@ -0,0 +1,32 @@ +# UpkQuestionConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_select** | **number** | | [optional] [default to undefined] +**max_length** | **number** | | [optional] [default to undefined] +**min_length** | **number** | | [optional] [default to undefined] +**slider_min** | **number** | | [optional] [default to undefined] +**slider_max** | **number** | | [optional] [default to undefined] +**slider_start** | **number** | | [optional] [default to undefined] +**slider_step** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestionConfiguration } from './api'; + +const instance: UpkQuestionConfiguration = { + max_select, + max_length, + min_length, + slider_min, + slider_max, + slider_start, + slider_step, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationMC.md b/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationMC.md new file mode 100644 index 0000000..2a256ee --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationMC.md @@ -0,0 +1,20 @@ +# UpkQuestionConfigurationMC + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_select** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestionConfigurationMC } from './api'; + +const instance: UpkQuestionConfigurationMC = { + max_select, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationSLIDER.md b/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationSLIDER.md new file mode 100644 index 0000000..4e0102e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationSLIDER.md @@ -0,0 +1,26 @@ +# UpkQuestionConfigurationSLIDER + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**slider_min** | **number** | | [optional] [default to undefined] +**slider_max** | **number** | | [optional] [default to undefined] +**slider_start** | **number** | | [optional] [default to undefined] +**slider_step** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestionConfigurationSLIDER } from './api'; + +const instance: UpkQuestionConfigurationSLIDER = { + slider_min, + slider_max, + slider_start, + slider_step, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationTE.md b/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationTE.md new file mode 100644 index 0000000..76d3eab --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionConfigurationTE.md @@ -0,0 +1,22 @@ +# UpkQuestionConfigurationTE + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_length** | **number** | | [optional] [default to undefined] +**min_length** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestionConfigurationTE } from './api'; + +const instance: UpkQuestionConfigurationTE = { + max_length, + min_length, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionOut.md b/jb-ui/src/api_fsb/docs/UpkQuestionOut.md new file mode 100644 index 0000000..351ffaf --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionOut.md @@ -0,0 +1,52 @@ +# UpkQuestionOut + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question_id** | **string** | | [optional] [default to undefined] +**ext_question_id** | **string** | | [optional] [default to undefined] +**question_type** | [**UpkQuestionType**](UpkQuestionType.md) | | [default to undefined] +**country_iso** | **string** | | [default to undefined] +**language_iso** | **string** | | [default to undefined] +**question_text** | **string** | The text shown to respondents | [default to undefined] +**choices** | [**Array<UpkQuestionChoiceOut>**](UpkQuestionChoiceOut.md) | | [optional] [default to undefined] +**selector** | [**Selector**](Selector.md) | | [optional] [default to undefined] +**configuration** | [**UpkQuestionConfiguration**](UpkQuestionConfiguration.md) | | [optional] [default to undefined] +**validation** | [**UpkQuestionValidation**](UpkQuestionValidation.md) | | [optional] [default to undefined] +**importance** | [**UPKImportance**](UPKImportance.md) | | [optional] [default to undefined] +**categories** | [**Array<Category>**](Category.md) | Categories associated with this question | [optional] [default to undefined] +**explanation_template** | **string** | | [optional] [default to undefined] +**explanation_fragment_template** | **string** | | [optional] [default to undefined] +**task_count** | **number** | | [optional] [default to undefined] +**task_score** | **number** | | [optional] [default to undefined] +**marketplace_task_count** | **{ [key: string]: number; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { UpkQuestionOut } from './api'; + +const instance: UpkQuestionOut = { + question_id, + ext_question_id, + question_type, + country_iso, + language_iso, + question_text, + choices, + selector, + configuration, + validation, + importance, + categories, + explanation_template, + explanation_fragment_template, + task_count, + task_score, + marketplace_task_count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionResponse.md b/jb-ui/src/api_fsb/docs/UpkQuestionResponse.md new file mode 100644 index 0000000..455d59f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionResponse.md @@ -0,0 +1,30 @@ +# UpkQuestionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**questions** | [**Array<UpkQuestionOut>**](UpkQuestionOut.md) | | [default to undefined] +**consent_questions** | **Array<object | null>** | For internal use | [optional] [default to undefined] +**special_questions** | **Array<object | null>** | For internal use | [optional] [default to undefined] +**count** | **number** | The number of questions returned | [default to undefined] + +## Example + +```typescript +import { UpkQuestionResponse } from './api'; + +const instance: UpkQuestionResponse = { + status, + msg, + questions, + consent_questions, + special_questions, + count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionSelectorHIDDEN.md b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorHIDDEN.md new file mode 100644 index 0000000..51ee35d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorHIDDEN.md @@ -0,0 +1,8 @@ +# UpkQuestionSelectorHIDDEN + + +## Enum + +* `Hidden` (value: `'HIDDEN'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionSelectorMC.md b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorMC.md new file mode 100644 index 0000000..94c72d7 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorMC.md @@ -0,0 +1,16 @@ +# UpkQuestionSelectorMC + + +## Enum + +* `Sa` (value: `'SA'`) + +* `Ma` (value: `'MA'`) + +* `Dl` (value: `'DL'`) + +* `Sb` (value: `'SB'`) + +* `Msb` (value: `'MSB'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionSelectorSLIDER.md b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorSLIDER.md new file mode 100644 index 0000000..cfc5daf --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorSLIDER.md @@ -0,0 +1,10 @@ +# UpkQuestionSelectorSLIDER + + +## Enum + +* `Hslider` (value: `'HSLIDER'`) + +* `Vslider` (value: `'VSLIDER'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionSelectorTE.md b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorTE.md new file mode 100644 index 0000000..0efddc9 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionSelectorTE.md @@ -0,0 +1,12 @@ +# UpkQuestionSelectorTE + + +## Enum + +* `Sl` (value: `'SL'`) + +* `Ml` (value: `'ML'`) + +* `Etb` (value: `'ETB'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionType.md b/jb-ui/src/api_fsb/docs/UpkQuestionType.md new file mode 100644 index 0000000..784e4eb --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionType.md @@ -0,0 +1,14 @@ +# UpkQuestionType + + +## Enum + +* `Mc` (value: `'MC'`) + +* `Te` (value: `'TE'`) + +* `Slider` (value: `'SLIDER'`) + +* `Hidden` (value: `'HIDDEN'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionValidation.md b/jb-ui/src/api_fsb/docs/UpkQuestionValidation.md new file mode 100644 index 0000000..d3db1b5 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UpkQuestionValidation.md @@ -0,0 +1,20 @@ +# UpkQuestionValidation + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**patterns** | [**Array<PatternValidation>**](PatternValidation.md) | | [default to undefined] + +## Example + +```typescript +import { UpkQuestionValidation } from './api'; + +const instance: UpkQuestionValidation = { + patterns, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/Uri.md b/jb-ui/src/api_fsb/docs/Uri.md new file mode 100644 index 0000000..e472620 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Uri.md @@ -0,0 +1,19 @@ +# Uri + +The URL to send a respondent into. Must not edit this URL in any way. If the eligibility is conditional or ineligible, the uri will be null. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { Uri } from './api'; + +const instance: Uri = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/User.md b/jb-ui/src/api_fsb/docs/User.md new file mode 100644 index 0000000..702c746 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/User.md @@ -0,0 +1,40 @@ +# User + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **number** | | [optional] [default to undefined] +**uuid** | **string** | | [optional] [default to undefined] +**product** | [**Product**](Product.md) | | [optional] [default to undefined] +**product_id** | **string** | | [optional] [default to undefined] +**product_user_id** | **string** | | [optional] [default to undefined] +**blocked** | **boolean** | | [optional] [default to undefined] +**created** | **string** | | [optional] [default to undefined] +**last_seen** | **string** | | [optional] [default to undefined] +**audit_log** | [**Array<AuditLog>**](AuditLog.md) | | [optional] [default to undefined] +**transactions** | [**Array<LedgerTransaction>**](LedgerTransaction.md) | | [optional] [default to undefined] +**location_history** | [**Array<GeoIPInformation>**](GeoIPInformation.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { User } from './api'; + +const instance: User = { + id, + uuid, + product, + product_id, + product_user_id, + blocked, + created, + last_seen, + audit_log, + transactions, + location_history, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserAmount.md b/jb-ui/src/api_fsb/docs/UserAmount.md new file mode 100644 index 0000000..3dbc7db --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserAmount.md @@ -0,0 +1,19 @@ +# UserAmount + +The total amount this user has entered + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { UserAmount } from './api'; + +const instance: UserAmount = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserAmountToday.md b/jb-ui/src/api_fsb/docs/UserAmountToday.md new file mode 100644 index 0000000..b2af95a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserAmountToday.md @@ -0,0 +1,19 @@ +# UserAmountToday + +The total amount this user has entered in the past 24 hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { UserAmountToday } from './api'; + +const instance: UserAmountToday = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserCpiString.md b/jb-ui/src/api_fsb/docs/UserCpiString.md new file mode 100644 index 0000000..5d405c4 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserCpiString.md @@ -0,0 +1,19 @@ +# UserCpiString + +If a payout transformation is configured on this account, this is the amount to display to the user + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { UserCpiString } from './api'; + +const instance: UserCpiString = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserCreateConfig.md b/jb-ui/src/api_fsb/docs/UserCreateConfig.md new file mode 100644 index 0000000..ff71db7 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserCreateConfig.md @@ -0,0 +1,23 @@ +# UserCreateConfig + +Stores configuration for the user creation experience. The user creation limit is determined dynamically based on the median daily completion rate. min_hourly_create_limit & max_hourly_create_limit can be used to constrain the dynamically determined rate limit within set values. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min_hourly_create_limit** | **number** | The smallest allowed value for the hourly user create limit. | [optional] [default to 0] +**max_hourly_create_limit** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { UserCreateConfig } from './api'; + +const instance: UserCreateConfig = { + min_hourly_create_limit, + max_hourly_create_limit, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserHealthConfig.md b/jb-ui/src/api_fsb/docs/UserHealthConfig.md new file mode 100644 index 0000000..3adf304 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserHealthConfig.md @@ -0,0 +1,22 @@ +# UserHealthConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**banned_countries** | **Array<string>** | | [optional] [default to undefined] +**allow_ban_iphist** | **boolean** | | [optional] [default to true] + +## Example + +```typescript +import { UserHealthConfig } from './api'; + +const instance: UserHealthConfig = { + banned_countries, + allow_ban_iphist, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserInfo.md b/jb-ui/src/api_fsb/docs/UserInfo.md new file mode 100644 index 0000000..3d90334 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserInfo.md @@ -0,0 +1,22 @@ +# UserInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_profile_knowledge** | [**Array<UserProfileKnowledge>**](UserProfileKnowledge.md) | | [optional] [default to undefined] +**marketplace_profile_knowledge** | [**Array<MarketProfileKnowledge>**](MarketProfileKnowledge.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { UserInfo } from './api'; + +const instance: UserInfo = { + user_profile_knowledge, + marketplace_profile_knowledge, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserInfoResponse.md b/jb-ui/src/api_fsb/docs/UserInfoResponse.md new file mode 100644 index 0000000..9185d35 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserInfoResponse.md @@ -0,0 +1,24 @@ +# UserInfoResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**user_profile** | [**UserInfo**](UserInfo.md) | | [default to undefined] + +## Example + +```typescript +import { UserInfoResponse } from './api'; + +const instance: UserInfoResponse = { + status, + msg, + user_profile, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskAdjustment.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskAdjustment.md new file mode 100644 index 0000000..a63d22c --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskAdjustment.md @@ -0,0 +1,34 @@ +# UserLedgerTransactionTaskAdjustment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | When the Transaction was created | [default to undefined] +**description** | **string** | External description suitable for UI | [optional] [default to 'Task Adjustment'] +**amount** | **number** | The net amount affecting the user\'s wallet, in USDCents. Positive means the user\'s balance increased; negative means it decreased. | [default to undefined] +**balance_after** | **number** | | [optional] [default to undefined] +**tx_type** | **string** | | [optional] [default to TxTypeEnum_BpAdjustment] +**tsid** | **string** | A unique identifier for the session | [default to undefined] +**url** | **string** | | [default to undefined] +**amount_string** | **string** | | [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionTaskAdjustment } from './api'; + +const instance: UserLedgerTransactionTaskAdjustment = { + created, + description, + amount, + balance_after, + tx_type, + tsid, + url, + amount_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskComplete.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskComplete.md new file mode 100644 index 0000000..f513148 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskComplete.md @@ -0,0 +1,35 @@ +# UserLedgerTransactionTaskComplete + +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. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | When the Transaction was created | [default to undefined] +**description** | **string** | External description suitable for UI | [optional] [default to 'Task Complete'] +**amount** | **number** | The net amount affecting the user\'s wallet, in USDCents. Positive means the user\'s balance increased; negative means it decreased. | [default to undefined] +**balance_after** | **number** | | [optional] [default to undefined] +**tx_type** | **string** | | [optional] [default to TxTypeEnum_BpPayment] +**tsid** | **string** | A unique identifier for the session | [default to undefined] +**url** | **string** | | [default to undefined] +**amount_string** | **string** | | [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionTaskComplete } from './api'; + +const instance: UserLedgerTransactionTaskComplete = { + created, + description, + amount, + balance_after, + tx_type, + tsid, + url, + amount_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypeSummary.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypeSummary.md new file mode 100644 index 0000000..ca2306f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypeSummary.md @@ -0,0 +1,26 @@ +# UserLedgerTransactionTypeSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entry_count** | **number** | | [optional] [default to 0] +**min_amount** | **number** | | [optional] [default to undefined] +**max_amount** | **number** | | [optional] [default to undefined] +**total_amount** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionTypeSummary } from './api'; + +const instance: UserLedgerTransactionTypeSummary = { + entry_count, + min_amount, + max_amount, + total_amount, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypesSummary.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypesSummary.md new file mode 100644 index 0000000..7a946a3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypesSummary.md @@ -0,0 +1,26 @@ +# UserLedgerTransactionTypesSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bp_adjustment** | [**UserLedgerTransactionTypeSummary**](UserLedgerTransactionTypeSummary.md) | | [optional] [default to undefined] +**bp_payment** | [**UserLedgerTransactionTypeSummary**](UserLedgerTransactionTypeSummary.md) | | [optional] [default to undefined] +**user_bonus** | [**UserLedgerTransactionTypeSummary**](UserLedgerTransactionTypeSummary.md) | | [optional] [default to undefined] +**user_payout_request** | [**UserLedgerTransactionTypeSummary**](UserLedgerTransactionTypeSummary.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionTypesSummary } from './api'; + +const instance: UserLedgerTransactionTypesSummary = { + bp_adjustment, + bp_payment, + user_bonus, + user_payout_request, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserBonus.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserBonus.md new file mode 100644 index 0000000..d858bf3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserBonus.md @@ -0,0 +1,32 @@ +# UserLedgerTransactionUserBonus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | When the Transaction was created | [default to undefined] +**description** | **string** | External description suitable for UI | [optional] [default to 'Compensation Bonus'] +**amount** | **number** | The net amount affecting the user\'s wallet, in USDCents. Positive means the user\'s balance increased; negative means it decreased. | [default to undefined] +**balance_after** | **number** | | [optional] [default to undefined] +**tx_type** | **string** | | [optional] [default to TxTypeEnum_UserBonus] +**url** | **string** | | [default to undefined] +**amount_string** | **string** | | [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionUserBonus } from './api'; + +const instance: UserLedgerTransactionUserBonus = { + created, + description, + amount, + balance_after, + tx_type, + url, + amount_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserPayout.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserPayout.md new file mode 100644 index 0000000..9c9342e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserPayout.md @@ -0,0 +1,34 @@ +# UserLedgerTransactionUserPayout + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | When the Transaction was created | [default to undefined] +**description** | **string** | External description suitable for UI | [default to undefined] +**amount** | **number** | The net amount affecting the user\'s wallet, in USDCents. Positive means the user\'s balance increased; negative means it decreased. | [default to undefined] +**balance_after** | **number** | | [optional] [default to undefined] +**tx_type** | **string** | | [optional] [default to TxTypeEnum_UserPayoutRequest] +**payout_id** | **string** | A unique identifier for the payout | [default to undefined] +**url** | **string** | | [default to undefined] +**amount_string** | **string** | | [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionUserPayout } from './api'; + +const instance: UserLedgerTransactionUserPayout = { + created, + description, + amount, + balance_after, + tx_type, + payout_id, + url, + amount_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponse.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponse.md new file mode 100644 index 0000000..52925b0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponse.md @@ -0,0 +1,34 @@ +# UserLedgerTransactionsResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page** | **number** | Page number | [optional] [default to 1] +**size** | **number** | Page size | [optional] [default to 50] +**total** | **number** | | [optional] [default to undefined] +**transactions** | [**Array<UserLedgerTransactionsResponseTransactionsInner>**](UserLedgerTransactionsResponseTransactionsInner.md) | | [optional] [default to undefined] +**summary** | [**UserLedgerTransactionTypesSummary**](UserLedgerTransactionTypesSummary.md) | | [default to undefined] +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**pages** | **number** | | [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionsResponse } from './api'; + +const instance: UserLedgerTransactionsResponse = { + page, + size, + total, + transactions, + summary, + status, + msg, + pages, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponseTransactionsInner.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponseTransactionsInner.md new file mode 100644 index 0000000..236b56e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponseTransactionsInner.md @@ -0,0 +1,36 @@ +# UserLedgerTransactionsResponseTransactionsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | When the Transaction was created | [default to undefined] +**description** | **string** | External description suitable for UI | [default to 'Task Complete'] +**amount** | **number** | The net amount affecting the user\'s wallet, in USDCents. Positive means the user\'s balance increased; negative means it decreased. | [default to undefined] +**balance_after** | **number** | | [optional] [default to undefined] +**tx_type** | **string** | | [optional] [default to TxTypeEnum_BpPayment] +**payout_id** | **string** | A unique identifier for the payout | [default to undefined] +**url** | **string** | | [default to undefined] +**amount_string** | **string** | | [default to undefined] +**tsid** | **string** | A unique identifier for the session | [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionsResponseTransactionsInner } from './api'; + +const instance: UserLedgerTransactionsResponseTransactionsInner = { + created, + description, + amount, + balance_after, + tx_type, + payout_id, + url, + amount_string, + tsid, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserProfile.md b/jb-ui/src/api_fsb/docs/UserProfile.md new file mode 100644 index 0000000..7bacbdf --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserProfile.md @@ -0,0 +1,32 @@ +# UserProfile + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email_address** | **string** | | [optional] [default to undefined] +**user** | [**User**](User.md) | | [default to undefined] +**marketplace_pids** | **{ [key: string]: string; }** | User\'s PID in marketplaces | [optional] [default to undefined] +**streaks** | [**Array<UserStreak>**](UserStreak.md) | | [optional] [default to undefined] +**email_md5** | **string** | | [default to undefined] +**email_sha1** | **string** | | [default to undefined] +**email_sha256** | **string** | | [default to undefined] + +## Example + +```typescript +import { UserProfile } from './api'; + +const instance: UserProfile = { + email_address, + user, + marketplace_pids, + streaks, + email_md5, + email_sha1, + email_sha256, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserProfileKnowledge.md b/jb-ui/src/api_fsb/docs/UserProfileKnowledge.md new file mode 100644 index 0000000..1bf2812 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserProfileKnowledge.md @@ -0,0 +1,28 @@ +# UserProfileKnowledge + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**property_id** | **string** | | [default to undefined] +**property_label** | **string** | | [default to undefined] +**translation** | **string** | | [default to undefined] +**answer** | [**Array<UserProfileKnowledgeAnswer>**](UserProfileKnowledgeAnswer.md) | | [optional] [default to undefined] +**created** | **string** | When the User submitted this Profiling data | [default to undefined] + +## Example + +```typescript +import { UserProfileKnowledge } from './api'; + +const instance: UserProfileKnowledge = { + property_id, + property_label, + translation, + answer, + created, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserProfileKnowledgeAnswer.md b/jb-ui/src/api_fsb/docs/UserProfileKnowledgeAnswer.md new file mode 100644 index 0000000..a88cbe4 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserProfileKnowledgeAnswer.md @@ -0,0 +1,26 @@ +# UserProfileKnowledgeAnswer + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | | [optional] [default to undefined] +**label** | **string** | | [optional] [default to undefined] +**translation** | **string** | | [optional] [default to undefined] +**value** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { UserProfileKnowledgeAnswer } from './api'; + +const instance: UserProfileKnowledgeAnswer = { + id, + label, + translation, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserProfileResponse.md b/jb-ui/src/api_fsb/docs/UserProfileResponse.md new file mode 100644 index 0000000..af39b22 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserProfileResponse.md @@ -0,0 +1,24 @@ +# UserProfileResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**user_profile** | [**UserProfile**](UserProfile.md) | | [default to undefined] + +## Example + +```typescript +import { UserProfileResponse } from './api'; + +const instance: UserProfileResponse = { + status, + msg, + user_profile, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserProfileUpdateRequest.md b/jb-ui/src/api_fsb/docs/UserProfileUpdateRequest.md new file mode 100644 index 0000000..6527d91 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserProfileUpdateRequest.md @@ -0,0 +1,20 @@ +# UserProfileUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email_address** | **string** | | [default to undefined] + +## Example + +```typescript +import { UserProfileUpdateRequest } from './api'; + +const instance: UserProfileUpdateRequest = { + email_address, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserProfilesResponse.md b/jb-ui/src/api_fsb/docs/UserProfilesResponse.md new file mode 100644 index 0000000..1b8bfad --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserProfilesResponse.md @@ -0,0 +1,24 @@ +# UserProfilesResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**user_profiles** | [**Array<UserProfile>**](UserProfile.md) | | [default to undefined] + +## Example + +```typescript +import { UserProfilesResponse } from './api'; + +const instance: UserProfilesResponse = { + status, + msg, + user_profiles, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserQuestionAnswerIn.md b/jb-ui/src/api_fsb/docs/UserQuestionAnswerIn.md new file mode 100644 index 0000000..38e306a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserQuestionAnswerIn.md @@ -0,0 +1,23 @@ +# UserQuestionAnswerIn + +Send the answers to one or more questions for a user. A question is uniquely specified by the question_id key. The answer is: the choice_id if the question_type is \"MC\" the actual entered text if the question_type is \"TE\" TODO: look up the question_type from the question_id to apply MC or TE specific validation on the answer(s) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**question_id** | **string** | | [default to undefined] +**answer** | **Array<string>** | The user\'s answers to this question. Must pass the choice_id if the question is a Multiple Choice, or the actual text if the question is Text Entry | [default to undefined] + +## Example + +```typescript +import { UserQuestionAnswerIn } from './api'; + +const instance: UserQuestionAnswerIn = { + question_id, + answer, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserStreak.md b/jb-ui/src/api_fsb/docs/UserStreak.md new file mode 100644 index 0000000..19a1574 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserStreak.md @@ -0,0 +1,40 @@ +# UserStreak + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**country_iso** | **string** | | [default to undefined] +**period** | [**StreakPeriod**](StreakPeriod.md) | | [default to undefined] +**fulfillment** | [**StreakFulfillment**](StreakFulfillment.md) | | [default to undefined] +**current_streak** | **number** | | [default to undefined] +**longest_streak** | **number** | | [default to undefined] +**state** | [**StreakState**](StreakState.md) | | [default to undefined] +**last_fulfilled_period_start** | **string** | | [optional] [default to undefined] +**timezone_name** | **string** | | [readonly] [default to undefined] +**current_period_bounds** | **Array<any>** | | [default to undefined] +**last_fulfilled_period_bounds** | **Array<any>** | | [default to undefined] +**time_remaining_in_period** | **number** | | [default to undefined] + +## Example + +```typescript +import { UserStreak } from './api'; + +const instance: UserStreak = { + country_iso, + period, + fulfillment, + current_streak, + longest_streak, + state, + last_fulfilled_period_start, + timezone_name, + current_period_bounds, + last_fulfilled_period_bounds, + time_remaining_in_period, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserType.md b/jb-ui/src/api_fsb/docs/UserType.md new file mode 100644 index 0000000..43cbcca --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserType.md @@ -0,0 +1,36 @@ +# UserType + + +## Enum + +* `Business` (value: `'business'`) + +* `Cafe` (value: `'cafe'`) + +* `Cellular` (value: `'cellular'`) + +* `College` (value: `'college'`) + +* `ContentDeliveryNetwork` (value: `'content_delivery_network'`) + +* `ConsumerPrivacyNetwork` (value: `'consumer_privacy_network'`) + +* `Government` (value: `'government'`) + +* `Hosting` (value: `'hosting'`) + +* `Library` (value: `'library'`) + +* `Military` (value: `'military'`) + +* `Residential` (value: `'residential'`) + +* `Router` (value: `'router'`) + +* `School` (value: `'school'`) + +* `SearchEngineSpider` (value: `'search_engine_spider'`) + +* `Traveler` (value: `'traveler'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserWalletBalance.md b/jb-ui/src/api_fsb/docs/UserWalletBalance.md new file mode 100644 index 0000000..dbfc71c --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserWalletBalance.md @@ -0,0 +1,28 @@ +# UserWalletBalance + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **number** | (USD cents) The amount in the user\'s wallet. | [default to undefined] +**redeemable_amount** | **number** | (USD cents) The amount in the user\'s wallet this is currently redeemable. | [default to undefined] +**payout_format** | **string** | 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\" | [default to undefined] +**amount_string** | **string** | The \'amount\' with the payout_format applied. Can be displayed to the user. | [default to undefined] +**redeemable_amount_string** | **string** | The \'redeemable_amount\' with the payout_format applied. Can be displayed to the user. | [default to undefined] + +## Example + +```typescript +import { UserWalletBalance } from './api'; + +const instance: UserWalletBalance = { + amount, + redeemable_amount, + payout_format, + amount_string, + redeemable_amount_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserWalletBalanceResponse.md b/jb-ui/src/api_fsb/docs/UserWalletBalanceResponse.md new file mode 100644 index 0000000..f9cdc80 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserWalletBalanceResponse.md @@ -0,0 +1,24 @@ +# UserWalletBalanceResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **string** | The status of the API response. | [default to undefined] +**msg** | **string** | | [optional] [default to undefined] +**wallet** | [**UserWalletBalance**](UserWalletBalance.md) | | [default to undefined] + +## Example + +```typescript +import { UserWalletBalanceResponse } from './api'; + +const instance: UserWalletBalanceResponse = { + status, + msg, + wallet, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/UserWalletConfig.md b/jb-ui/src/api_fsb/docs/UserWalletConfig.md new file mode 100644 index 0000000..96d9587 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserWalletConfig.md @@ -0,0 +1,27 @@ +# UserWalletConfig + +Stores configuration for the user wallet handling + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **boolean** | If enabled, the users\' wallets are managed. | [optional] [default to false] +**amt** | **boolean** | Uses Amazon Mechanical Turk | [optional] [default to false] +**supported_payout_types** | [**Set<PayoutType>**](PayoutType.md) | | [optional] [default to undefined] +**min_cashout** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { UserWalletConfig } from './api'; + +const instance: UserWalletConfig = { + enabled, + amt, + supported_payout_types, + min_cashout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ValidationError.md b/jb-ui/src/api_fsb/docs/ValidationError.md new file mode 100644 index 0000000..d2e7ec1 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ValidationError.md @@ -0,0 +1,24 @@ +# ValidationError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**loc** | [**Array<ValidationErrorLocInner>**](ValidationErrorLocInner.md) | | [default to undefined] +**msg** | **string** | | [default to undefined] +**type** | **string** | | [default to undefined] + +## Example + +```typescript +import { ValidationError } from './api'; + +const instance: ValidationError = { + loc, + msg, + type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/ValidationErrorLocInner.md b/jb-ui/src/api_fsb/docs/ValidationErrorLocInner.md new file mode 100644 index 0000000..8d54b45 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ValidationErrorLocInner.md @@ -0,0 +1,18 @@ +# ValidationErrorLocInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { ValidationErrorLocInner } from './api'; + +const instance: ValidationErrorLocInner = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WXETOfferwall.md b/jb-ui/src/api_fsb/docs/WXETOfferwall.md new file mode 100644 index 0000000..5dbdb16 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WXETOfferwall.md @@ -0,0 +1,29 @@ +# WXETOfferwall + +Returns buckets from WXET as single tasks Offerwall code: `55a4e1a9` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier to reference a generated offerwall | [default to undefined] +**availability_count** | **number** | 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. | [default to undefined] +**attempted_live_eligible_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. | [optional] [default to 0] +**buckets** | [**Array<WXETOfferwallBucket>**](WXETOfferwallBucket.md) | | [optional] [default to undefined] +**offerwall_reasons** | [**Array<OfferwallReason>**](OfferwallReason.md) | Explanations describing why so many or few opportunities are available. | [optional] [default to undefined] + +## Example + +```typescript +import { WXETOfferwall } from './api'; + +const instance: WXETOfferwall = { + id, + availability_count, + attempted_live_eligible_count, + buckets, + offerwall_reasons, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WXETOfferwallBucket.md b/jb-ui/src/api_fsb/docs/WXETOfferwallBucket.md new file mode 100644 index 0000000..0e006bf --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WXETOfferwallBucket.md @@ -0,0 +1,26 @@ +# WXETOfferwallBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] +**duration** | **number** | The bucket\'s expected duration, in seconds | [default to undefined] +**min_payout** | **number** | The bucket\'s min payout, in usd cents | [default to undefined] + +## Example + +```typescript +import { WXETOfferwallBucket } from './api'; + +const instance: WXETOfferwallBucket = { + id, + uri, + duration, + min_payout, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WXETOfferwallResponse.md b/jb-ui/src/api_fsb/docs/WXETOfferwallResponse.md new file mode 100644 index 0000000..5ad22e2 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WXETOfferwallResponse.md @@ -0,0 +1,22 @@ +# WXETOfferwallResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info** | [**OfferWallInfo**](OfferWallInfo.md) | | [default to undefined] +**offerwall** | [**WXETOfferwall**](WXETOfferwall.md) | | [default to undefined] + +## Example + +```typescript +import { WXETOfferwallResponse } from './api'; + +const instance: WXETOfferwallResponse = { + info, + offerwall, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallAdjustedStatus.md b/jb-ui/src/api_fsb/docs/WallAdjustedStatus.md new file mode 100644 index 0000000..787482e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallAdjustedStatus.md @@ -0,0 +1,14 @@ +# WallAdjustedStatus + + +## Enum + +* `Ac` (value: `'ac'`) + +* `Af` (value: `'af'`) + +* `Ca` (value: `'ca'`) + +* `Cc` (value: `'cc'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallOut.md b/jb-ui/src/api_fsb/docs/WallOut.md new file mode 100644 index 0000000..aca3aef --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallOut.md @@ -0,0 +1,56 @@ +# WallOut + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**source** | [**Source**](Source.md) | | [default to undefined] +**buyer_id** | [**BuyerId**](BuyerId.md) | | [optional] [default to undefined] +**req_survey_id** | **string** | | [default to undefined] +**started** | **string** | | [optional] [default to undefined] +**survey_id** | [**SurveyId**](SurveyId.md) | | [optional] [default to undefined] +**finished** | [**Finished**](Finished.md) | | [optional] [default to undefined] +**status** | [**WallOutStatus**](WallOutStatus.md) | | [optional] [default to undefined] +**status_code_1** | [**WallOutStatusCode1**](WallOutStatusCode1.md) | | [optional] [default to undefined] +**status_code_2** | [**WallOutStatusCode2**](WallOutStatusCode2.md) | | [optional] [default to undefined] +**ext_status_code_1** | [**ExtStatusCode1**](ExtStatusCode1.md) | | [optional] [default to undefined] +**ext_status_code_2** | [**ExtStatusCode2**](ExtStatusCode2.md) | | [optional] [default to undefined] +**ext_status_code_3** | [**ExtStatusCode3**](ExtStatusCode3.md) | | [optional] [default to undefined] +**report_value** | [**WallOutReportValue**](WallOutReportValue.md) | | [optional] [default to undefined] +**report_notes** | [**ReportNotes**](ReportNotes.md) | | [optional] [default to undefined] +**adjusted_status** | [**WallOutAdjustedStatus**](WallOutAdjustedStatus.md) | | [optional] [default to undefined] +**adjusted_timestamp** | [**AdjustedTimestamp**](AdjustedTimestamp.md) | | [optional] [default to undefined] +**user_cpi** | **number** | 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. | [optional] [default to undefined] +**user_cpi_string** | [**UserCpiString**](UserCpiString.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { WallOut } from './api'; + +const instance: WallOut = { + uuid, + source, + buyer_id, + req_survey_id, + started, + survey_id, + finished, + status, + status_code_1, + status_code_2, + ext_status_code_1, + ext_status_code_2, + ext_status_code_3, + report_value, + report_notes, + adjusted_status, + adjusted_timestamp, + user_cpi, + user_cpi_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallOutAdjustedStatus.md b/jb-ui/src/api_fsb/docs/WallOutAdjustedStatus.md new file mode 100644 index 0000000..d7cff7d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallOutAdjustedStatus.md @@ -0,0 +1,18 @@ +# WallOutAdjustedStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { WallOutAdjustedStatus } from './api'; + +const instance: WallOutAdjustedStatus = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallOutReportValue.md b/jb-ui/src/api_fsb/docs/WallOutReportValue.md new file mode 100644 index 0000000..8687a8f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallOutReportValue.md @@ -0,0 +1,18 @@ +# WallOutReportValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { WallOutReportValue } from './api'; + +const instance: WallOutReportValue = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallOutStatus.md b/jb-ui/src/api_fsb/docs/WallOutStatus.md new file mode 100644 index 0000000..40ad387 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallOutStatus.md @@ -0,0 +1,18 @@ +# WallOutStatus + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { WallOutStatus } from './api'; + +const instance: WallOutStatus = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallOutStatusCode1.md b/jb-ui/src/api_fsb/docs/WallOutStatusCode1.md new file mode 100644 index 0000000..b6e707e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallOutStatusCode1.md @@ -0,0 +1,19 @@ +# WallOutStatusCode1 + +__High level status code for outcome of the session.__ This should only be NULL if the Status is ABANDON or TIMEOUT Allowed values: - __BUYER_FAIL__: User terminated in buyer survey - __BUYER_QUALITY_FAIL__: User terminated in buyer survey for quality reasons - __PS_FAIL__: User failed in marketplace\'s prescreener - __PS_QUALITY__: User rejected by marketplace for quality reasons - __PS_BLOCKED__: User is explicitly blocked by the marketplace. Note: on some marketplaces, users can have multiple PS_QUALITY terminations and still complete surveys. - __PS_OVERQUOTA__: User rejected by marketplace for over quota - __PS_DUPLICATE__: User rejected by marketplace for duplicate - __GRS_FAIL__: The user failed within the GRS Platform - __GRS_QUALITY_FAIL__: The user failed within the GRS Platform for quality reasons - __GRS_ABANDON__: The user abandoned/timed out within the GRS Platform - __PS_ABANDON__: The user abandoned/timed out within the marketplace\'s pre-screen system. Note: On most marketplaces, we have no way of distinguishing between this and BUYER_ABANDON. BUYER_ABANDON is used as the default, unless we know it is PS_ABANDON. - __BUYER_ABANDON__: The user abandoned/timed out within the client survey - __UNKNOWN__: The status code is not documented - __COMPLETE__: The user completed the task successfully - __MARKETPLACE_FAIL__: Something was wrong upon the user redirecting from the marketplace, e.g. no postback received, or url hashing failures. - __SESSION_START_FAIL__: User failed before being sent into a marketplace - __SESSION_CONTINUE_FAIL__: User failed between attempts - __SESSION_START_QUALITY_FAIL__: User failed before being sent into a marketplace for \"security\" reasons - __SESSION_CONTINUE_QUALITY_FAIL__: User failed between attempts for \"security\" reasons + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { WallOutStatusCode1 } from './api'; + +const instance: WallOutStatusCode1 = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallOutStatusCode2.md b/jb-ui/src/api_fsb/docs/WallOutStatusCode2.md new file mode 100644 index 0000000..d7f4a71 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallOutStatusCode2.md @@ -0,0 +1,19 @@ +# WallOutStatusCode2 + +This should be set if the Wall.status_code_1 is MARKETPLACE_FAIL Allowed values: - __URL_HASHING_CHECK_FAILED__: The redirect URL (coming back from the marketplace) failed hashing checks - __BROKEN_REDIRECT__: The redirect URL was missing required query params or was unparseable - __INVALID_REDIRECT__: The redirect URL was invalid or inconsistent in some way and as a result we could not determine the outcome. This could be if a redirect received did not match the user\'s most recent attempt. - __INVALID_MARKETPLACE_POSTBACK__: The redirect indicated a complete, but no/invalid Postback was received from the marketplace - __NO_MARKETPLACE_POSTBACK__: No/invalid Postback was received from the marketplace. Used in cases where the redirect does not contain a status. - __COMPLETE_TOO_FAST__: The marketplace indicates the user completed the survey, but we don\'t think this is valid due to speeding. Generally this cutoff is the 95th percentile of our calculated CompletionTime survey stat. - __INTERNAL_ERROR__: Something happened during the handling of this redirect (on our side) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { WallOutStatusCode2 } from './api'; + +const instance: WallOutStatusCode2 = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WallStatusCode2.md b/jb-ui/src/api_fsb/docs/WallStatusCode2.md new file mode 100644 index 0000000..4962f2b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WallStatusCode2.md @@ -0,0 +1,21 @@ +# WallStatusCode2 + +This should be set if the Wall.status_code_1 is MARKETPLACE_FAIL + +## Enum + +* `NUMBER_12` (value: `12`) + +* `NUMBER_16` (value: `16`) + +* `NUMBER_17` (value: `17`) + +* `NUMBER_13` (value: `13`) + +* `NUMBER_18` (value: `18`) + +* `NUMBER_14` (value: `14`) + +* `NUMBER_15` (value: `15`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/jb-ui/src/api_fsb/docs/WalletApi.md b/jb-ui/src/api_fsb/docs/WalletApi.md new file mode 100644 index 0000000..80bd3ed --- /dev/null +++ b/jb-ui/src/api_fsb/docs/WalletApi.md @@ -0,0 +1,478 @@ +# WalletApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createCashoutMethodProductIdCashoutMethodsPost**](#createcashoutmethodproductidcashoutmethodspost) | **POST** /{product_id}/cashout_methods/ | Create Cashout Method| +|[**deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete**](#deletecashoutmethodproductidcashoutmethodscashoutmethodiddelete) | **DELETE** /{product_id}/cashout_methods/{cashout_method_id}/ | Delete Cashout Method| +|[**getCashoutDetailProductIdCashoutCashoutIdGet**](#getcashoutdetailproductidcashoutcashoutidget) | **GET** /{product_id}/cashout/{cashout_id}/ | Get Cashout Detail| +|[**getCashoutMethodsProductIdCashoutMethodsGet**](#getcashoutmethodsproductidcashoutmethodsget) | **GET** /{product_id}/cashout_methods/ | Get Cashout Methods| +|[**getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet**](#getexpectedredemptionvalueproductidcashoutmethodcashoutmethodidvalueget) | **GET** /{product_id}/cashout_method/{cashout_method_id}/value/ | Get Expected Redemption Value| +|[**getUserTransactionHistoryProductIdTransactionHistoryGet**](#getusertransactionhistoryproductidtransactionhistoryget) | **GET** /{product_id}/transaction_history/ | Get User Transaction History| +|[**getUserWalletBalanceProductIdWalletGet**](#getuserwalletbalanceproductidwalletget) | **GET** /{product_id}/wallet/ | Get User Wallet Balance| +|[**submitUserCashoutProductIdCashoutPost**](#submitusercashoutproductidcashoutpost) | **POST** /{product_id}/cashout/ | Submit User Cashout| + +# **createCashoutMethodProductIdCashoutMethodsPost** +> CashoutMethodResponse createCashoutMethodProductIdCashoutMethodsPost(body) + +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 + +### Example + +```typescript +import { + WalletApi, + Configuration, + Body +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let body: Body; // + +const { status, data } = await apiInstance.createCashoutMethodProductIdCashoutMethodsPost( + productId, + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Body**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| + + +### Return type + +**CashoutMethodResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete** +> StatusResponse deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete() + +Delete a cashout method + +### Example + +```typescript +import { + WalletApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let cashoutMethodId: string; //The ID of the cashout method to delete (default to undefined) +let bpuid: string; //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. (default to undefined) + +const { status, data } = await apiInstance.deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete( + productId, + cashoutMethodId, + bpuid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **cashoutMethodId** | [**string**] | The ID of the cashout method to delete | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**StatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getCashoutDetailProductIdCashoutCashoutIdGet** +> CashoutRequestResponse getCashoutDetailProductIdCashoutCashoutIdGet() + +Retrieve the details for a specific Cashout event + +### Example + +```typescript +import { + WalletApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let cashoutId: string; //The cashout event ID (default to undefined) + +const { status, data } = await apiInstance.getCashoutDetailProductIdCashoutCashoutIdGet( + productId, + cashoutId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **cashoutId** | [**string**] | The cashout event ID | defaults to undefined| + + +### Return type + +**CashoutRequestResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getCashoutMethodsProductIdCashoutMethodsGet** +> CashoutMethodsResponse getCashoutMethodsProductIdCashoutMethodsGet() + +Retrieve the current available mechanisms that a user can use to retrieve funds. + +### Example + +```typescript +import { + WalletApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) + +const { status, data } = await apiInstance.getCashoutMethodsProductIdCashoutMethodsGet( + productId, + bpuid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**CashoutMethodsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet** +> CashoutMethodForeignValueResponse getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet() + +Use this function to get the \"value\" (in local currency, e.g. CAD, BTC) for this cashout_method, for amount (in USD cents). + +### Example + +```typescript +import { + WalletApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let cashoutMethodId: string; //The ID of the cashout method (default to undefined) +let amount: number; //(USD cents) The amount to convert (default to undefined) + +const { status, data } = await apiInstance.getExpectedRedemptionValueProductIdCashoutMethodCashoutMethodIdValueGet( + productId, + cashoutMethodId, + amount +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **cashoutMethodId** | [**string**] | The ID of the cashout method | defaults to undefined| +| **amount** | [**number**] | (USD cents) The amount to convert | defaults to undefined| + + +### Return type + +**CashoutMethodForeignValueResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserTransactionHistoryProductIdTransactionHistoryGet** +> UserLedgerTransactionsResponse getUserTransactionHistoryProductIdTransactionHistoryGet() + +Return array of user events that altered their wallet balance + +### Example + +```typescript +import { + WalletApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) +let createdAfter: string; //Filter transactions created after this timestamp (optional) (default to undefined) +let createdBefore: string; //Filter transactions created before this timestamp (optional) (default to undefined) +let orderBy: string; //Comma-separated fields to order by (optional) (default to 'created') +let page: number; // (optional) (default to 1) +let size: number; // (optional) (default to 50) + +const { status, data } = await apiInstance.getUserTransactionHistoryProductIdTransactionHistoryGet( + productId, + bpuid, + createdAfter, + createdBefore, + orderBy, + page, + size +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| +| **createdAfter** | [**string**] | Filter transactions created after this timestamp | (optional) defaults to undefined| +| **createdBefore** | [**string**] | Filter transactions created before this timestamp | (optional) defaults to undefined| +| **orderBy** | [**string**] | Comma-separated fields to order by | (optional) defaults to 'created'| +| **page** | [**number**] | | (optional) defaults to 1| +| **size** | [**number**] | | (optional) defaults to 50| + + +### Return type + +**UserLedgerTransactionsResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserWalletBalanceProductIdWalletGet** +> UserWalletBalanceResponse getUserWalletBalanceProductIdWalletGet() + +Retrieve the current balance of a respondent\'s wallet balance for display + +### Example + +```typescript +import { + WalletApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let bpuid: string; //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. (default to undefined) + +const { status, data } = await apiInstance.getUserWalletBalanceProductIdWalletGet( + productId, + bpuid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **bpuid** | [**string**] | 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. | defaults to undefined| + + +### Return type + +**UserWalletBalanceResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **submitUserCashoutProductIdCashoutPost** +> CashoutRequestResponse submitUserCashoutProductIdCashoutPost(createCashoutRequest) + +Request a cashout taken from a user\'s available wallet balance, to be paid via a particular cashout method. + +### Example + +```typescript +import { + WalletApi, + Configuration, + CreateCashoutRequest +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new WalletApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let createCashoutRequest: CreateCashoutRequest; // + +const { status, data } = await apiInstance.submitUserCashoutProductIdCashoutPost( + productId, + createCashoutRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **createCashoutRequest** | **CreateCashoutRequest**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| + + +### Return type + +**CashoutRequestResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Successful Response | - | +|**422** | Validation Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/jb-ui/src/api_fsb/docs/YieldManConfig.md b/jb-ui/src/api_fsb/docs/YieldManConfig.md new file mode 100644 index 0000000..f6d245b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/YieldManConfig.md @@ -0,0 +1,22 @@ +# YieldManConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category_request** | [**OfferWallCategoryRequest**](OfferWallCategoryRequest.md) | | [optional] [default to undefined] +**scoring_params** | [**OfferWallRequestYieldmanParams**](OfferWallRequestYieldmanParams.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { YieldManConfig } from './api'; + +const instance: YieldManConfig = { + category_request, + scoring_params, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |