diff options
| author | Max Nanis | 2026-09-13 19:03:55 +0000 |
|---|---|---|
| committer | Max Nanis | 2026-09-13 19:03:55 +0000 |
| commit | 8fbe8d439b418796932aaa88297e006c714e4d13 (patch) | |
| tree | 6c800476edc1e771fc570b559d483df8d59d4324 /jb-ui/src/api_fsb/docs | |
| parent | 12f6fee851b68e86af658dfa17e4a0daed457dd1 (diff) | |
| parent | 2c94f248d2438071a918fa9a30bf114ef9aa29b4 (diff) | |
| download | amt-jb-8fbe8d439b418796932aaa88297e006c714e4d13.tar.gz amt-jb-8fbe8d439b418796932aaa88297e006c714e4d13.zip | |
Merges pull request #3
Off of Amazon!!!
Diffstat (limited to 'jb-ui/src/api_fsb/docs')
35 files changed, 593 insertions, 265 deletions
diff --git a/jb-ui/src/api_fsb/docs/AccessType.md b/jb-ui/src/api_fsb/docs/AccessType.md new file mode 100644 index 0000000..1e4ea7d --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AccessType.md @@ -0,0 +1,19 @@ +# AccessType + +How the network is used + +## Enum + +* `Residential` (value: `'residential'`) + +* `Mobile` (value: `'mobile'`) + +* `Satellite` (value: `'satellite'`) + +* `Datacenter` (value: `'datacenter'`) + +* `Enterprise` (value: `'enterprise'`) + +* `Unknown` (value: `'unknown'`) + +[[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/AccountType.md b/jb-ui/src/api_fsb/docs/AccountType.md index 6d2e246..d6ae50d 100644 --- a/jb-ui/src/api_fsb/docs/AccountType.md +++ b/jb-ui/src/api_fsb/docs/AccountType.md @@ -9,6 +9,8 @@ * `UserWallet` (value: `'user_wallet'`) +* `UserAttemptCredit` (value: `'user_attempt_credit'`) + * `Cash` (value: `'cash'`) * `Revenue` (value: `'revenue'`) diff --git a/jb-ui/src/api_fsb/docs/Amount.md b/jb-ui/src/api_fsb/docs/Amount.md new file mode 100644 index 0000000..ace69cb --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Amount.md @@ -0,0 +1,19 @@ +# Amount + +The amount of the entry in integer counts or USD Cents + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { Amount } from './api'; + +const instance: 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/AttemptCreditClaimBody.md b/jb-ui/src/api_fsb/docs/AttemptCreditClaimBody.md new file mode 100644 index 0000000..acf6c7e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AttemptCreditClaimBody.md @@ -0,0 +1,20 @@ +# AttemptCreditClaimBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bpuid** | **string** | (product_user_id) The user requesting the claim | [default to undefined] + +## Example + +```typescript +import { AttemptCreditClaimBody } from './api'; + +const instance: AttemptCreditClaimBody = { + 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/AttemptCreditClaimResponse.md b/jb-ui/src/api_fsb/docs/AttemptCreditClaimResponse.md new file mode 100644 index 0000000..c8d0850 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AttemptCreditClaimResponse.md @@ -0,0 +1,20 @@ +# AttemptCreditClaimResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **number** | | [default to undefined] + +## Example + +```typescript +import { AttemptCreditClaimResponse } from './api'; + +const instance: AttemptCreditClaimResponse = { + 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/BrokerageProductPayoutEvent.md b/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md index c2d2ca6..794932f 100644 --- a/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md +++ b/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md @@ -7,14 +7,14 @@ The amount - created: When the Brokerage Product was paid out 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] +**debit_account_uuid** | **string** | | [default to undefined] +**cashout_method_uuid** | **string** | | [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] +**request_data** | **object** | | [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] diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodOut.md b/jb-ui/src/api_fsb/docs/CashoutMethodOut.md index c4e4832..b8c4b94 100644 --- a/jb-ui/src/api_fsb/docs/CashoutMethodOut.md +++ b/jb-ui/src/api_fsb/docs/CashoutMethodOut.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **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] +**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 out via a Tango Gift Card - __DWOLLA__ *(DWOLLA)*: DWOLLA - __ACH__ *(ACH)*: A payment is made to a bank account using ACH - __WIRE__ *(WIRE)*: A payment is made to a bank account using ACH - __CASH_IN_MAIL__ *(CASH_IN_MAIL)*: A payment is made in cash and mailed to the user. - __PRIZE__ *(PRIZE)*: A payment is made as a prize with some monetary value - __AMT__ *(AMT)*: This is used to designate either AMT_BONUS or AMT_HIT - __AMT_BONUS__ *(AMT_BONUS)*: Amazon Mechanical Turk as a Bonus - __AMT_ASSIGNMENT__ *(AMT_HIT)*: Amazon Mechanical Turk for a HIT | [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] diff --git a/jb-ui/src/api_fsb/docs/ContestEntry.md b/jb-ui/src/api_fsb/docs/ContestEntry.md new file mode 100644 index 0000000..a83f01f --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestEntry.md @@ -0,0 +1,32 @@ +# ContestEntry + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**created_at** | **string** | | [optional] [default to undefined] +**updated_at** | **string** | | [optional] [default to undefined] +**entry_type** | [**ContestEntryType**](ContestEntryType.md) | | [default to undefined] +**amount** | [**Amount**](Amount.md) | | [default to undefined] +**amount_str** | **string** | | [readonly] [default to undefined] +**censored_product_user_id** | **string** | | [readonly] [default to undefined] + +## Example + +```typescript +import { ContestEntry } from './api'; + +const instance: ContestEntry = { + uuid, + created_at, + updated_at, + entry_type, + amount, + amount_str, + censored_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/ContestEntryType.md b/jb-ui/src/api_fsb/docs/ContestEntryType.md new file mode 100644 index 0000000..933920b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestEntryType.md @@ -0,0 +1,11 @@ +# ContestEntryType + +All entries into a contest must be of the same type, and match the entry_type of the Contest itself. + +## Enum + +* `Count` (value: `'count'`) + +* `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/GeoIPInformation.md b/jb-ui/src/api_fsb/docs/GeoIPInformation.md index 5df598e..2066626 100644 --- a/jb-ui/src/api_fsb/docs/GeoIPInformation.md +++ b/jb-ui/src/api_fsb/docs/GeoIPInformation.md @@ -36,7 +36,7 @@ Name | Type | Description | Notes **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] +**user_type** | [**AccessType**](AccessType.md) | | [optional] [default to undefined] **postal_code** | **string** | | [optional] [default to undefined] **latitude** | **number** | | [optional] [default to undefined] **longitude** | **number** | | [optional] [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/Leaderboard.md b/jb-ui/src/api_fsb/docs/Leaderboard.md index adae56c..a735f49 100644 --- a/jb-ui/src/api_fsb/docs/Leaderboard.md +++ b/jb-ui/src/api_fsb/docs/Leaderboard.md @@ -6,18 +6,18 @@ A leaderboard exists independently for each product_id in each country. Each cou 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] +**id** | **string** | | [optional] [default to undefined] +**name** | **string** | | [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] +**timezone_name** | **string** | | [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] +**period_end_local** | **string** | | [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] diff --git a/jb-ui/src/api_fsb/docs/LeaderboardRow.md b/jb-ui/src/api_fsb/docs/LeaderboardRow.md index 23ad7ab..0313f07 100644 --- a/jb-ui/src/api_fsb/docs/LeaderboardRow.md +++ b/jb-ui/src/api_fsb/docs/LeaderboardRow.md @@ -8,6 +8,7 @@ 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] +**display_name** | **string** | | [optional] [default to undefined] ## Example @@ -18,6 +19,7 @@ const instance: LeaderboardRow = { bpuid, rank, value, + display_name, }; ``` diff --git a/jb-ui/src/api_fsb/docs/LedgerAccount.md b/jb-ui/src/api_fsb/docs/LedgerAccount.md index f9b1ffa..29caaba 100644 --- a/jb-ui/src/api_fsb/docs/LedgerAccount.md +++ b/jb-ui/src/api_fsb/docs/LedgerAccount.md @@ -8,7 +8,7 @@ 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] +**account_type** | [**AccountType**](AccountType.md) | - `bp_commission` = BP_COMMISSION - `bp_wallet` = BP_WALLET - `user_wallet` = USER_WALLET - `user_attempt_credit` = USER_ATTEMPT_CREDIT - `cash` = CASH - `revenue` = REVENUE - `expense` = EXPENSE - `contest_wallet` = CONTEST_WALLET - `credit_line` = CREDIT_LINE - `wa_wallet` = WA_WALLET - `wa_budget_pool` = WA_BUDGET_POOL - `wa_held` = WA_HELD - `wa_credit_line` = WA_CREDIT_LINE | [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] diff --git a/jb-ui/src/api_fsb/docs/ManageCashoutBody.md b/jb-ui/src/api_fsb/docs/ManageCashoutBody.md new file mode 100644 index 0000000..61fdcb2 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ManageCashoutBody.md @@ -0,0 +1,22 @@ +# ManageCashoutBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payout_id** | **string** | | [default to undefined] +**new_status** | [**PayoutStatus**](PayoutStatus.md) | | [default to undefined] + +## Example + +```typescript +import { ManageCashoutBody } from './api'; + +const instance: ManageCashoutBody = { + payout_id, + new_status, +}; +``` + +[[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 index 8e7591d..4b77589 100644 --- a/jb-ui/src/api_fsb/docs/OfferwallApi.md +++ b/jb-ui/src/api_fsb/docs/OfferwallApi.md @@ -10,12 +10,9 @@ All URIs are relative to *https://fsb.generalresearch.com* |[**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| @@ -476,164 +473,6 @@ No authorization required [[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() @@ -880,88 +719,6 @@ No authorization required [[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() diff --git a/jb-ui/src/api_fsb/docs/OrderData1.md b/jb-ui/src/api_fsb/docs/OrderData1.md new file mode 100644 index 0000000..0cd86fa --- /dev/null +++ b/jb-ui/src/api_fsb/docs/OrderData1.md @@ -0,0 +1,37 @@ +# OrderData1 + +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 { OrderData1 } from './api'; + +const instance: OrderData1 = { + 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/PayoutTransformation.md b/jb-ui/src/api_fsb/docs/PayoutTransformation.md index 378fde0..fdc0d1b 100644 --- a/jb-ui/src/api_fsb/docs/PayoutTransformation.md +++ b/jb-ui/src/api_fsb/docs/PayoutTransformation.md @@ -1,6 +1,6 @@ # 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. +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 diff --git a/jb-ui/src/api_fsb/docs/Product.md b/jb-ui/src/api_fsb/docs/Product.md index 3dfe1d3..c62184a 100644 --- a/jb-ui/src/api_fsb/docs/Product.md +++ b/jb-ui/src/api_fsb/docs/Product.md @@ -8,7 +8,7 @@ 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] +**payments_enabled** | **boolean** | This is only to determine if ACH or Wire payments should be made to the Product. | [optional] [default to true] **created** | **string** | | [optional] [default to undefined] **team_id** | **string** | | [optional] [default to undefined] **business_id** | **string** | | [optional] [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/ProductBalances.md b/jb-ui/src/api_fsb/docs/ProductBalances.md index 92a9170..30172f2 100644 --- a/jb-ui/src/api_fsb/docs/ProductBalances.md +++ b/jb-ui/src/api_fsb/docs/ProductBalances.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes **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** | **number** | The amount that must be held back to recover a negative Product balance. This is $0.00 when the Product balance is positive or zero; otherwise it is the absolute value of the negative balance. Business-level payout calculations use this amount to offset deficits from one Product against available funds from other Products before issuing Supplier Payments. | [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] diff --git a/jb-ui/src/api_fsb/docs/ProfilingConfig.md b/jb-ui/src/api_fsb/docs/ProfilingConfig.md index 22d329d..22c2038 100644 --- a/jb-ui/src/api_fsb/docs/ProfilingConfig.md +++ b/jb-ui/src/api_fsb/docs/ProfilingConfig.md @@ -6,12 +6,12 @@ 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] +**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] +**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 diff --git a/jb-ui/src/api_fsb/docs/SupplyPolicy.md b/jb-ui/src/api_fsb/docs/SupplyPolicy.md index 6d72fa9..8eb86eb 100644 --- a/jb-ui/src/api_fsb/docs/SupplyPolicy.md +++ b/jb-ui/src/api_fsb/docs/SupplyPolicy.md @@ -1,6 +1,6 @@ # SupplyPolicy -One policy describing how GRL can interact with a marketplaces in a certain way. This is only used on the special \"global product\", and then internally in grpc logic. +One policy describing how GRL can interact with a marketplaces in a certain way. This is only used on the special \"global product\", and then internally in grpc logic. ## Properties diff --git a/jb-ui/src/api_fsb/docs/THLApi.md b/jb-ui/src/api_fsb/docs/THLApi.md new file mode 100644 index 0000000..ed20c0a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/THLApi.md @@ -0,0 +1,60 @@ +# THLApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**manageCashoutThlManageCashoutPost**](#managecashoutthlmanagecashoutpost) | **POST** /thl/manage_cashout/ | Manage Cashout| + +# **manageCashoutThlManageCashoutPost** +> UserPayoutEvent manageCashoutThlManageCashoutPost(manageCashoutBody) + + +### Example + +```typescript +import { + THLApi, + Configuration, + ManageCashoutBody +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new THLApi(configuration); + +let manageCashoutBody: ManageCashoutBody; // + +const { status, data } = await apiInstance.manageCashoutThlManageCashoutPost( + manageCashoutBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **manageCashoutBody** | **ManageCashoutBody**| | | + + +### Return type + +**UserPayoutEvent** + +### 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/UpkQuestion.md b/jb-ui/src/api_fsb/docs/UpkQuestion.md index 332d09f..945e91b 100644 --- a/jb-ui/src/api_fsb/docs/UpkQuestion.md +++ b/jb-ui/src/api_fsb/docs/UpkQuestion.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **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] +**selector** | [**Selector**](Selector.md) | | [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] diff --git a/jb-ui/src/api_fsb/docs/UpkQuestionOut.md b/jb-ui/src/api_fsb/docs/UpkQuestionOut.md index 351ffaf..8d2f7ac 100644 --- a/jb-ui/src/api_fsb/docs/UpkQuestionOut.md +++ b/jb-ui/src/api_fsb/docs/UpkQuestionOut.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **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] +**selector** | [**Selector**](Selector.md) | | [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] diff --git a/jb-ui/src/api_fsb/docs/UserCpi.md b/jb-ui/src/api_fsb/docs/UserCpi.md new file mode 100644 index 0000000..18048f3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserCpi.md @@ -0,0 +1,19 @@ +# UserCpi + + 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. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { UserCpi } from './api'; + +const instance: UserCpi = { +}; +``` + +[[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/UserDisplayedWalletBalance.md b/jb-ui/src/api_fsb/docs/UserDisplayedWalletBalance.md new file mode 100644 index 0000000..78c82e6 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserDisplayedWalletBalance.md @@ -0,0 +1,25 @@ +# UserDisplayedWalletBalance + +Combined user-visible balance for one ledger currency. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **string** | | [default to undefined] +**amount** | **number** | Displayed balance in the currency\'s smallest ledger unit. | [default to undefined] +**amount_string** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { UserDisplayedWalletBalance } from './api'; + +const instance: UserDisplayedWalletBalance = { + currency, + amount, + 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 index f513148..05cda73 100644 --- a/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskComplete.md +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTaskComplete.md @@ -1,6 +1,6 @@ # 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. +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 diff --git a/jb-ui/src/api_fsb/docs/UserLedgerWallet.md b/jb-ui/src/api_fsb/docs/UserLedgerWallet.md new file mode 100644 index 0000000..d223586 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerWallet.md @@ -0,0 +1,37 @@ +# UserLedgerWallet + +A user-owned ledger account exposed by the wallets endpoint. + +## 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** | | [optional] [default to undefined] +**amount_string** | **string** | | [optional] [default to undefined] +**redeemable_amount_string** | **string** | | [optional] [default to undefined] +**account_uuid** | **string** | A unique identifier for this Ledger Account | [default to undefined] +**account_type** | **string** | | [default to undefined] +**currency** | **string** | | [optional] [default to 'USD'] +**display_name** | **string** | Human-readable description of the Ledger Account | [default to undefined] + +## Example + +```typescript +import { UserLedgerWallet } from './api'; + +const instance: UserLedgerWallet = { + amount, + redeemable_amount, + payout_format, + amount_string, + redeemable_amount_string, + account_uuid, + account_type, + currency, + display_name, +}; +``` + +[[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/UserLedgerWallets.md b/jb-ui/src/api_fsb/docs/UserLedgerWallets.md new file mode 100644 index 0000000..5d202a3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerWallets.md @@ -0,0 +1,22 @@ +# UserLedgerWallets + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**wallets** | [**Array<UserLedgerWallet>**](UserLedgerWallet.md) | | [optional] [default to undefined] +**displayed_balances** | [**Array<UserDisplayedWalletBalance>**](UserDisplayedWalletBalance.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { UserLedgerWallets } from './api'; + +const instance: UserLedgerWallets = { + wallets, + displayed_balances, +}; +``` + +[[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/UserPayoutEvent.md b/jb-ui/src/api_fsb/docs/UserPayoutEvent.md new file mode 100644 index 0000000..02b62ab --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserPayoutEvent.md @@ -0,0 +1,45 @@ +# UserPayoutEvent + +A user has requested to be paid from their wallet balance. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**debit_account_uuid** | **string** | | [default to undefined] +**cashout_method_uuid** | **string** | | [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** | | [optional] [default to undefined] +**order_data** | [**OrderData1**](OrderData1.md) | | [optional] [default to undefined] +**account_reference_type** | **string** | | [optional] [default to undefined] +**account_reference_uuid** | **string** | | [optional] [default to undefined] +**description** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { UserPayoutEvent } from './api'; + +const instance: UserPayoutEvent = { + uuid, + debit_account_uuid, + cashout_method_uuid, + created, + amount, + status, + ext_ref_id, + payout_type, + request_data, + order_data, + account_reference_type, + account_reference_uuid, + 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/UserProfile.md b/jb-ui/src/api_fsb/docs/UserProfile.md index 7bacbdf..843cb50 100644 --- a/jb-ui/src/api_fsb/docs/UserProfile.md +++ b/jb-ui/src/api_fsb/docs/UserProfile.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email_address** | **string** | | [optional] [default to undefined] +**display_name** | **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] @@ -20,6 +21,7 @@ import { UserProfile } from './api'; const instance: UserProfile = { email_address, + display_name, user, marketplace_pids, streaks, diff --git a/jb-ui/src/api_fsb/docs/UserWalletConfig.md b/jb-ui/src/api_fsb/docs/UserWalletConfig.md index 96d9587..2d9ef41 100644 --- a/jb-ui/src/api_fsb/docs/UserWalletConfig.md +++ b/jb-ui/src/api_fsb/docs/UserWalletConfig.md @@ -7,9 +7,11 @@ Stores configuration for the user wallet handling Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enabled** | **boolean** | If enabled, the users\' wallets are managed. | [optional] [default to false] +**balance_type** | **string** | The balance used as the user\'s displayed balance. | [optional] [default to BalanceTypeEnum_WalletBalance] **amt** | **boolean** | Uses Amazon Mechanical Turk | [optional] [default to false] -**supported_payout_types** | [**Set<PayoutType>**](PayoutType.md) | | [optional] [default to undefined] +**supported_payout_types** | [**Array<PayoutType>**](PayoutType.md) | | [optional] [default to undefined] **min_cashout** | **string** | | [optional] [default to undefined] +**failed_attempt_credit** | **string** | | [optional] [default to undefined] ## Example @@ -18,9 +20,11 @@ import { UserWalletConfig } from './api'; const instance: UserWalletConfig = { enabled, + balance_type, amt, supported_payout_types, min_cashout, + failed_attempt_credit, }; ``` diff --git a/jb-ui/src/api_fsb/docs/ValidationError.md b/jb-ui/src/api_fsb/docs/ValidationError.md index d2e7ec1..912f97f 100644 --- a/jb-ui/src/api_fsb/docs/ValidationError.md +++ b/jb-ui/src/api_fsb/docs/ValidationError.md @@ -8,6 +8,8 @@ Name | Type | Description | Notes **loc** | [**Array<ValidationErrorLocInner>**](ValidationErrorLocInner.md) | | [default to undefined] **msg** | **string** | | [default to undefined] **type** | **string** | | [default to undefined] +**input** | **any** | | [optional] [default to undefined] +**ctx** | **object** | | [optional] [default to undefined] ## Example @@ -18,6 +20,8 @@ const instance: ValidationError = { loc, msg, type, + input, + ctx, }; ``` diff --git a/jb-ui/src/api_fsb/docs/WallOut.md b/jb-ui/src/api_fsb/docs/WallOut.md index aca3aef..89830a1 100644 --- a/jb-ui/src/api_fsb/docs/WallOut.md +++ b/jb-ui/src/api_fsb/docs/WallOut.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **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** | [**UserCpi**](UserCpi.md) | | [optional] [default to undefined] **user_cpi_string** | [**UserCpiString**](UserCpiString.md) | | [optional] [default to undefined] ## Example diff --git a/jb-ui/src/api_fsb/docs/WalletApi.md b/jb-ui/src/api_fsb/docs/WalletApi.md index 80bd3ed..a4acfd4 100644 --- a/jb-ui/src/api_fsb/docs/WalletApi.md +++ b/jb-ui/src/api_fsb/docs/WalletApi.md @@ -4,15 +4,74 @@ All URIs are relative to *https://fsb.generalresearch.com* |Method | HTTP request | Description| |------------- | ------------- | -------------| +|[**claimLatestAttemptCreditProductIdWalletAttemptCreditPost**](#claimlatestattemptcreditproductidwalletattemptcreditpost) | **POST** /{product_id}/wallet/attempt-credit/ | Claim Latest Attempt Credit| |[**createCashoutMethodProductIdCashoutMethodsPost**](#createcashoutmethodproductidcashoutmethodspost) | **POST** /{product_id}/cashout_methods/ | Create Cashout Method| |[**deleteCashoutMethodProductIdCashoutMethodsCashoutMethodIdDelete**](#deletecashoutmethodproductidcashoutmethodscashoutmethodiddelete) | **DELETE** /{product_id}/cashout_methods/{cashout_method_id}/ | Delete Cashout Method| +|[**getAttemptCreditProductIdWalletAttemptCreditTsidGet**](#getattemptcreditproductidwalletattemptcredittsidget) | **GET** /{product_id}/wallet/attempt-credit/{tsid}/ | Get Attempt Credit| |[**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| +|[**getUserWalletsProductIdWalletsGet**](#getuserwalletsproductidwalletsget) | **GET** /{product_id}/wallets/ | Get User Wallets| |[**submitUserCashoutProductIdCashoutPost**](#submitusercashoutproductidcashoutpost) | **POST** /{product_id}/cashout/ | Submit User Cashout| +# **claimLatestAttemptCreditProductIdWalletAttemptCreditPost** +> AttemptCreditClaimResponse claimLatestAttemptCreditProductIdWalletAttemptCreditPost(attemptCreditClaimBody) + +Attempt to claim an Attempt Credit from the user\'s latest Session. + +### Example + +```typescript +import { + WalletApi, + Configuration, + AttemptCreditClaimBody +} 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 attemptCreditClaimBody: AttemptCreditClaimBody; // + +const { status, data } = await apiInstance.claimLatestAttemptCreditProductIdWalletAttemptCreditPost( + productId, + attemptCreditClaimBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **attemptCreditClaimBody** | **AttemptCreditClaimBody**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| + + +### Return type + +**AttemptCreditClaimResponse** + +### 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) + # **createCashoutMethodProductIdCashoutMethodsPost** > CashoutMethodResponse createCashoutMethodProductIdCashoutMethodsPost(body) @@ -127,6 +186,61 @@ No authorization required [[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) +# **getAttemptCreditProductIdWalletAttemptCreditTsidGet** +> AttemptCreditClaimResponse getAttemptCreditProductIdWalletAttemptCreditTsidGet() + +Get an Attempt Credit by a user\'s Session. + +### 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 tsid: string; //A unique identifier for the session (default to undefined) + +const { status, data } = await apiInstance.getAttemptCreditProductIdWalletAttemptCreditTsidGet( + 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 + +**AttemptCreditClaimResponse** + +### 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() @@ -420,6 +534,61 @@ No authorization required [[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) +# **getUserWalletsProductIdWalletsGet** +> UserLedgerWallets getUserWalletsProductIdWalletsGet() + +Retrieve a respondent\'s wallets and balances 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.getUserWalletsProductIdWalletsGet( + 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 + +**UserLedgerWallets** + +### 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) |