diff options
| author | Max Nanis | 2026-09-29 11:47:48 -0700 |
|---|---|---|
| committer | Max Nanis | 2026-09-29 11:47:48 -0700 |
| commit | cd173e67e4e0514271371f4a5e5136f7f61d06d1 (patch) | |
| tree | 03d389b22cc02a4b1dd702eca0db1f13a43c4e3f /jb-ui/src/api_fsb/docs | |
| parent | 08643310a783d4da5212ef419ee8d909f683f8e2 (diff) | |
| download | amt-jb-cd173e67e4e0514271371f4a5e5136f7f61d06d1.tar.gz amt-jb-cd173e67e4e0514271371f4a5e5136f7f61d06d1.zip | |
Redemption Modal. Redemption Magic flow. User Account Icondev
Diffstat (limited to 'jb-ui/src/api_fsb/docs')
35 files changed, 591 insertions, 92 deletions
diff --git a/jb-ui/src/api_fsb/docs/AccessControlEvent.md b/jb-ui/src/api_fsb/docs/AccessControlEvent.md new file mode 100644 index 0000000..b977345 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AccessControlEvent.md @@ -0,0 +1,26 @@ +# AccessControlEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quality_event_type** | **string** | | [default to undefined] +**product_id** | **string** | | [optional] [default to undefined] +**bpuid** | **string** | | [optional] [default to undefined] +**user_id** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { AccessControlEvent } from './api'; + +const instance: AccessControlEvent = { + quality_event_type, + product_id, + bpuid, + 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/AccessControlEventBody.md b/jb-ui/src/api_fsb/docs/AccessControlEventBody.md new file mode 100644 index 0000000..f8b6f88 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/AccessControlEventBody.md @@ -0,0 +1,20 @@ +# AccessControlEventBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**events** | [**Array<AccessControlEvent>**](AccessControlEvent.md) | | [default to undefined] + +## Example + +```typescript +import { AccessControlEventBody } from './api'; + +const instance: AccessControlEventBody = { + events, +}; +``` + +[[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/Amount1.md b/jb-ui/src/api_fsb/docs/Amount1.md new file mode 100644 index 0000000..54d2e98 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Amount1.md @@ -0,0 +1,19 @@ +# Amount1 + +If negative, the status should adjusted to incomplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { Amount1 } from './api'; + +const instance: Amount1 = { +}; +``` + +[[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 794932f..39a28a4 100644 --- a/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md +++ b/jb-ui/src/api_fsb/docs/BrokerageProductPayoutEvent.md @@ -13,11 +13,11 @@ Name | Type | Description | Notes **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] +**payout_type** | [**PayoutType**](PayoutType.md) | - `PAYPAL` = PAYPAL - `TANGO` = TANGO - `TREMENDOUS` = TREMENDOUS - `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** | [**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] +**method** | [**PayoutType**](PayoutType.md) | - `PAYPAL` = PAYPAL - `TANGO` = TANGO - `TREMENDOUS` = TREMENDOUS - `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] diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodForeignValue.md b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValue.md index e9e4ae4..91159b6 100644 --- a/jb-ui/src/api_fsb/docs/CashoutMethodForeignValue.md +++ b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValue.md @@ -7,7 +7,7 @@ Shows the expected value of a redemption in a foreign currency. 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] +**currency** | [**Currency**](Currency.md) | Allowed values: - __USD__ *(USD)*: United States Dollar. Smallest Unit: Cents. - __CAD__ *(CAD)*: Canadian Dollar. Smallest Unit: Cents. - __GBP__ *(GBP)*: British Pound. Smallest Unit: Pence. - __EUR__ *(EUR)*: Euro. Smallest Unit: Cents. - __INR__ *(INR)*: Indian Rupee. Smallest Unit: Paise. - __AUD__ *(AUD)*: Australian Dollar. Smallest Unit: Cents. - __PLN__ *(PLN)*: Polish Zloty. Smallest Unit: Grosz. - __SEK__ *(SEK)*: Swedish Krona. Smallest Unit: Öre. - __SGD__ *(SGD)*: Singapore Dollar. Smallest Unit: Cents. - __MXN__ *(MXN)*: Mexican Peso. Smallest Unit: Centavos. | [default to undefined] **value_string** | **string** | A string representation of the value in the currency. | [default to undefined] ## Example diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodForeignValueResponse.md b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValueResponse.md index 5d7345b..45d9d5c 100644 --- a/jb-ui/src/api_fsb/docs/CashoutMethodForeignValueResponse.md +++ b/jb-ui/src/api_fsb/docs/CashoutMethodForeignValueResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **cashout_method_value** | [**CashoutMethodForeignValue**](CashoutMethodForeignValue.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodOut.md b/jb-ui/src/api_fsb/docs/CashoutMethodOut.md index b8c4b94..90ff61f 100644 --- a/jb-ui/src/api_fsb/docs/CashoutMethodOut.md +++ b/jb-ui/src/api_fsb/docs/CashoutMethodOut.md @@ -14,13 +14,14 @@ 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 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] +**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 - __TREMENDOUS__ *(TREMENDOUS)*: Tremendous 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] +**category** | [**PayoutCategory**](PayoutCategory.md) | | [readonly] [default to undefined] ## Example @@ -44,6 +45,7 @@ const instance: CashoutMethodOut = { min_value_usd, product_id, product_user_id, + category, }; ``` diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodResponse.md b/jb-ui/src/api_fsb/docs/CashoutMethodResponse.md index 4775d15..3be22af 100644 --- a/jb-ui/src/api_fsb/docs/CashoutMethodResponse.md +++ b/jb-ui/src/api_fsb/docs/CashoutMethodResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **cashout_method** | [**CashoutMethodOut**](CashoutMethodOut.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/CashoutMethodsResponse.md b/jb-ui/src/api_fsb/docs/CashoutMethodsResponse.md index b90d887..b0ac04b 100644 --- a/jb-ui/src/api_fsb/docs/CashoutMethodsResponse.md +++ b/jb-ui/src/api_fsb/docs/CashoutMethodsResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **cashout_methods** | [**Array<CashoutMethodOut>**](CashoutMethodOut.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/CashoutRequestDetail.md b/jb-ui/src/api_fsb/docs/CashoutRequestDetail.md new file mode 100644 index 0000000..27dd7ea --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutRequestDetail.md @@ -0,0 +1,38 @@ +# CashoutRequestDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique ID for this cashout | [default to undefined] +**description** | **string** | This is the name of the cashout method. | [default to undefined] +**status** | [**PayoutStatus**](PayoutStatus.md) | | [optional] [default to undefined] +**product_id** | **string** | | [default to undefined] +**product_user_id** | **string** | | [default to undefined] +**payout_type** | [**PayoutType**](PayoutType.md) | - `PAYPAL` = PAYPAL - `TANGO` = TANGO - `TREMENDOUS` = TREMENDOUS - `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] +**amount** | **number** | The amount in USD Cents | [default to undefined] +**created** | **string** | | [default to undefined] +**transaction_info** | **object** | | [optional] [default to undefined] +**category** | [**PayoutCategory**](PayoutCategory.md) | | [readonly] [default to undefined] + +## Example + +```typescript +import { CashoutRequestDetail } from './api'; + +const instance: CashoutRequestDetail = { + id, + description, + status, + product_id, + product_user_id, + payout_type, + amount, + created, + transaction_info, + 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/CashoutRequestResponse.md b/jb-ui/src/api_fsb/docs/CashoutRequestResponse.md index a91d277..c04aa89 100644 --- a/jb-ui/src/api_fsb/docs/CashoutRequestResponse.md +++ b/jb-ui/src/api_fsb/docs/CashoutRequestResponse.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] -**cashout** | [**CashoutRequestInfo**](CashoutRequestInfo.md) | | [default to undefined] +**cashout** | [**CashoutRequestDetail**](CashoutRequestDetail.md) | | [default to undefined] ## Example diff --git a/jb-ui/src/api_fsb/docs/CashoutRequestSummary.md b/jb-ui/src/api_fsb/docs/CashoutRequestSummary.md new file mode 100644 index 0000000..f4c60e7 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutRequestSummary.md @@ -0,0 +1,37 @@ +# CashoutRequestSummary + +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** | Unique ID for this cashout | [default to undefined] +**description** | **string** | This is the name of the cashout method. | [default to undefined] +**status** | [**PayoutStatus**](PayoutStatus.md) | | [optional] [default to undefined] +**product_id** | **string** | | [default to undefined] +**product_user_id** | **string** | | [default to undefined] +**payout_type** | [**PayoutType**](PayoutType.md) | - `PAYPAL` = PAYPAL - `TANGO` = TANGO - `TREMENDOUS` = TREMENDOUS - `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] +**amount** | **number** | The amount in USD Cents | [default to undefined] +**created** | **string** | | [default to undefined] +**category** | [**PayoutCategory**](PayoutCategory.md) | | [readonly] [default to undefined] + +## Example + +```typescript +import { CashoutRequestSummary } from './api'; + +const instance: CashoutRequestSummary = { + id, + description, + status, + product_id, + product_user_id, + payout_type, + amount, + created, + 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/CashoutRequestsResponse.md b/jb-ui/src/api_fsb/docs/CashoutRequestsResponse.md new file mode 100644 index 0000000..a6fa5b2 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/CashoutRequestsResponse.md @@ -0,0 +1,32 @@ +# CashoutRequestsResponse + + +## 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] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] +**msg** | **string** | | [optional] [default to undefined] +**cashouts** | [**Array<CashoutRequestSummary>**](CashoutRequestSummary.md) | | [default to undefined] +**pages** | **number** | | [default to undefined] + +## Example + +```typescript +import { CashoutRequestsResponse } from './api'; + +const instance: CashoutRequestsResponse = { + page, + size, + total, + status, + msg, + cashouts, + 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/GeoIPInformation.md b/jb-ui/src/api_fsb/docs/GeoIPInformation.md index 2066626..ee2b6ff 100644 --- a/jb-ui/src/api_fsb/docs/GeoIPInformation.md +++ b/jb-ui/src/api_fsb/docs/GeoIPInformation.md @@ -1,46 +1,20 @@ # GeoIPInformation +Fields we\'ll always pull from GRIP\'s mmdb files at minimum ## 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] +**ip** | **string** | | [default to undefined] +**country_iso** | **string** | | [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** | [**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] -**accuracy_radius** | **number** | | [optional] [default to undefined] +**access_type** | [**AccessType**](AccessType.md) | | [optional] [default to undefined] ## Example @@ -48,42 +22,15 @@ Name | Type | Description | Notes import { GeoIPInformation } from './api'; const instance: GeoIPInformation = { - geoname_id, - continent_code, - continent_name, + ip, 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, + access_type, }; ``` diff --git a/jb-ui/src/api_fsb/docs/LeaderboardResponse.md b/jb-ui/src/api_fsb/docs/LeaderboardResponse.md index 11d4559..fd066b6 100644 --- a/jb-ui/src/api_fsb/docs/LeaderboardResponse.md +++ b/jb-ui/src/api_fsb/docs/LeaderboardResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **leaderboard** | [**Leaderboard**](Leaderboard.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/LeaderboardWinnerResponse.md b/jb-ui/src/api_fsb/docs/LeaderboardWinnerResponse.md index 1b89707..4366f30 100644 --- a/jb-ui/src/api_fsb/docs/LeaderboardWinnerResponse.md +++ b/jb-ui/src/api_fsb/docs/LeaderboardWinnerResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **winners** | [**Array<LeaderboardWinner>**](LeaderboardWinner.md) | | [optional] [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/PayoutCategory.md b/jb-ui/src/api_fsb/docs/PayoutCategory.md new file mode 100644 index 0000000..3794e2a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutCategory.md @@ -0,0 +1,16 @@ +# PayoutCategory + + +## Enum + +* `Cash` (value: `'CASH'`) + +* `GiftCard` (value: `'GIFT_CARD'`) + +* `Prize` (value: `'PRIZE'`) + +* `Crypto` (value: `'CRYPTO'`) + +* `PlatformCredit` (value: `'PLATFORM_CREDIT'`) + +[[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 index a918be1..121e3cf 100644 --- a/jb-ui/src/api_fsb/docs/PayoutType.md +++ b/jb-ui/src/api_fsb/docs/PayoutType.md @@ -8,6 +8,8 @@ The method in which the requested payout is delivered. * `Tango` (value: `'TANGO'`) +* `Tremendous` (value: `'TREMENDOUS'`) + * `Dwolla` (value: `'DWOLLA'`) * `Ach` (value: `'ACH'`) diff --git a/jb-ui/src/api_fsb/docs/ProfilingInfoResponse.md b/jb-ui/src/api_fsb/docs/ProfilingInfoResponse.md index 598f68b..5302c43 100644 --- a/jb-ui/src/api_fsb/docs/ProfilingInfoResponse.md +++ b/jb-ui/src/api_fsb/docs/ProfilingInfoResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **profiling_info** | [**Array<UpkProperty>**](UpkProperty.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/StatusResponse.md b/jb-ui/src/api_fsb/docs/StatusResponse.md index 4a9dd73..82f15bd 100644 --- a/jb-ui/src/api_fsb/docs/StatusResponse.md +++ b/jb-ui/src/api_fsb/docs/StatusResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] ## Example diff --git a/jb-ui/src/api_fsb/docs/THLApi.md b/jb-ui/src/api_fsb/docs/THLApi.md index ed20c0a..40cceee 100644 --- a/jb-ui/src/api_fsb/docs/THLApi.md +++ b/jb-ui/src/api_fsb/docs/THLApi.md @@ -4,10 +4,12 @@ All URIs are relative to *https://fsb.generalresearch.com* |Method | HTTP request | Description| |------------- | ------------- | -------------| -|[**manageCashoutThlManageCashoutPost**](#managecashoutthlmanagecashoutpost) | **POST** /thl/manage_cashout/ | Manage Cashout| +|[**paypalWebhookThlPaypalWebhookPost**](#paypalwebhookthlpaypalwebhookpost) | **POST** /thl/paypal_webhook/ | Paypal Webhook| +|[**submitAccessControlRequestThl9bf111afe03e40719c5cd0de0dc43c31Post**](#submitaccesscontrolrequestthl9bf111afe03e40719c5cd0de0dc43c31post) | **POST** /thl/9bf111afe03e40719c5cd0de0dc43c31/ | Submit Access Control Request| +|[**submitTaskAdjustmentThlF4484dbdf144451ab60cda256ce14266Post**](#submittaskadjustmentthlf4484dbdf144451ab60cda256ce14266post) | **POST** /thl/f4484dbdf144451ab60cda256ce14266/ | Submit Task Adjustment| -# **manageCashoutThlManageCashoutPost** -> UserPayoutEvent manageCashoutThlManageCashoutPost(manageCashoutBody) +# **paypalWebhookThlPaypalWebhookPost** +> any paypalWebhookThlPaypalWebhookPost() ### Example @@ -15,17 +17,114 @@ All URIs are relative to *https://fsb.generalresearch.com* ```typescript import { THLApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new THLApi(configuration); + +const { status, data } = await apiInstance.paypalWebhookThlPaypalWebhookPost(); +``` + +### 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) + +# **submitAccessControlRequestThl9bf111afe03e40719c5cd0de0dc43c31Post** +> StatusResponse submitAccessControlRequestThl9bf111afe03e40719c5cd0de0dc43c31Post(accessControlEventBody) + +Handle user access control adjustment requests. This is to add/remove users from white/black lists (for manual blocking/unblocking). Internally, this hits the UserQualityHistory grpc call. + +### Example + +```typescript +import { + THLApi, + Configuration, + AccessControlEventBody +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new THLApi(configuration); + +let accessControlEventBody: AccessControlEventBody; // + +const { status, data } = await apiInstance.submitAccessControlRequestThl9bf111afe03e40719c5cd0de0dc43c31Post( + accessControlEventBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **accessControlEventBody** | **AccessControlEventBody**| | | + + +### 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) + +# **submitTaskAdjustmentThlF4484dbdf144451ab60cda256ce14266Post** +> StatusResponse submitTaskAdjustmentThlF4484dbdf144451ab60cda256ce14266Post(taskAdjustmentEventBody) + +Handle Wall status adjustment requests. Typically, this is a complete -> failure recon or the reverse. Internally, this hits the UserQualityHistory grpc call. + +### Example + +```typescript +import { + THLApi, Configuration, - ManageCashoutBody + TaskAdjustmentEventBody } from './api'; const configuration = new Configuration(); const apiInstance = new THLApi(configuration); -let manageCashoutBody: ManageCashoutBody; // +let taskAdjustmentEventBody: TaskAdjustmentEventBody; // -const { status, data } = await apiInstance.manageCashoutThlManageCashoutPost( - manageCashoutBody +const { status, data } = await apiInstance.submitTaskAdjustmentThlF4484dbdf144451ab60cda256ce14266Post( + taskAdjustmentEventBody ); ``` @@ -33,12 +132,12 @@ const { status, data } = await apiInstance.manageCashoutThlManageCashoutPost( |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| -| **manageCashoutBody** | **ManageCashoutBody**| | | +| **taskAdjustmentEventBody** | **TaskAdjustmentEventBody**| | | ### Return type -**UserPayoutEvent** +**StatusResponse** ### Authorization diff --git a/jb-ui/src/api_fsb/docs/TaskAdjustmentEvent.md b/jb-ui/src/api_fsb/docs/TaskAdjustmentEvent.md new file mode 100644 index 0000000..4bf5cf8 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TaskAdjustmentEvent.md @@ -0,0 +1,40 @@ +# TaskAdjustmentEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mid** | **string** | | [default to undefined] +**source** | [**Source**](Source.md) | | [default to undefined] +**status** | [**WallAdjustedStatus**](WallAdjustedStatus.md) | | [default to undefined] +**alert_time** | **string** | | [optional] [default to undefined] +**quality_event_type** | **string** | | [optional] [default to QualityEventTypeEnum_TaskAdjustment] +**survey_id** | **string** | | [optional] [default to undefined] +**amount** | [**Amount1**](Amount1.md) | | [optional] [default to undefined] +**event_time** | **string** | | [optional] [default to undefined] +**product_id** | **string** | | [optional] [default to undefined] +**bpuid** | **string** | | [optional] [default to undefined] +**user_id** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { TaskAdjustmentEvent } from './api'; + +const instance: TaskAdjustmentEvent = { + mid, + source, + status, + alert_time, + quality_event_type, + survey_id, + amount, + event_time, + product_id, + bpuid, + 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/TaskAdjustmentEventBody.md b/jb-ui/src/api_fsb/docs/TaskAdjustmentEventBody.md new file mode 100644 index 0000000..103ec10 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TaskAdjustmentEventBody.md @@ -0,0 +1,20 @@ +# TaskAdjustmentEventBody + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**events** | [**Array<TaskAdjustmentEvent>**](TaskAdjustmentEvent.md) | | [default to undefined] + +## Example + +```typescript +import { TaskAdjustmentEventBody } from './api'; + +const instance: TaskAdjustmentEventBody = { + events, +}; +``` + +[[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 index 455d59f..177fdb8 100644 --- a/jb-ui/src/api_fsb/docs/UpkQuestionResponse.md +++ b/jb-ui/src/api_fsb/docs/UpkQuestionResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **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] diff --git a/jb-ui/src/api_fsb/docs/UserInfoResponse.md b/jb-ui/src/api_fsb/docs/UserInfoResponse.md index 9185d35..3445a70 100644 --- a/jb-ui/src/api_fsb/docs/UserInfoResponse.md +++ b/jb-ui/src/api_fsb/docs/UserInfoResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **user_profile** | [**UserInfo**](UserInfo.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionAttemptCredit.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionAttemptCredit.md new file mode 100644 index 0000000..5069c29 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionAttemptCredit.md @@ -0,0 +1,34 @@ +# UserLedgerTransactionAttemptCredit + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | When the Transaction was created | [default to undefined] +**description** | **string** | | [optional] [default to 'Attempt Credit'] +**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_UserAttemptCredit] +**tsid** | **string** | | [default to undefined] +**url** | **string** | | [default to undefined] +**amount_string** | **string** | | [default to undefined] + +## Example + +```typescript +import { UserLedgerTransactionAttemptCredit } from './api'; + +const instance: UserLedgerTransactionAttemptCredit = { + 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/UserLedgerTransactionTypesSummary.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypesSummary.md index 7a946a3..f1f15ba 100644 --- a/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypesSummary.md +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionTypesSummary.md @@ -8,6 +8,7 @@ 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_attempt_credit** | [**UserLedgerTransactionTypeSummary**](UserLedgerTransactionTypeSummary.md) | | [optional] [default to undefined] **user_payout_request** | [**UserLedgerTransactionTypeSummary**](UserLedgerTransactionTypeSummary.md) | | [optional] [default to undefined] ## Example @@ -19,6 +20,7 @@ const instance: UserLedgerTransactionTypesSummary = { bp_adjustment, bp_payment, user_bonus, + user_attempt_credit, user_payout_request, }; ``` diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserPayoutCancel.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserPayoutCancel.md new file mode 100644 index 0000000..baaba3e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionUserPayoutCancel.md @@ -0,0 +1,34 @@ +# UserLedgerTransactionUserPayoutCancel + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | When the Transaction was created | [default to undefined] +**description** | **string** | | [optional] [default to 'Payout Cancelled'] +**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_UserPayoutCancel] +**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 { UserLedgerTransactionUserPayoutCancel } from './api'; + +const instance: UserLedgerTransactionUserPayoutCancel = { + 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 index 52925b0..f938b82 100644 --- a/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponse.md +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponse.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **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] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **pages** | **number** | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponseTransactionsInner.md b/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponseTransactionsInner.md index 236b56e..74a35fb 100644 --- a/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponseTransactionsInner.md +++ b/jb-ui/src/api_fsb/docs/UserLedgerTransactionsResponseTransactionsInner.md @@ -6,14 +6,14 @@ 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'] +**description** | **string** | | [default to 'Attempt Credit'] **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] +**tx_type** | **string** | | [optional] [default to TxTypeEnum_UserAttemptCredit] **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] +**tsid** | **string** | | [default to undefined] ## Example diff --git a/jb-ui/src/api_fsb/docs/UserProfile.md b/jb-ui/src/api_fsb/docs/UserProfile.md index 843cb50..a3cdd34 100644 --- a/jb-ui/src/api_fsb/docs/UserProfile.md +++ b/jb-ui/src/api_fsb/docs/UserProfile.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **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] +**canonical_email** | **string** | | [default to undefined] **email_md5** | **string** | | [default to undefined] **email_sha1** | **string** | | [default to undefined] **email_sha256** | **string** | | [default to undefined] @@ -25,6 +26,7 @@ const instance: UserProfile = { user, marketplace_pids, streaks, + canonical_email, email_md5, email_sha1, email_sha256, diff --git a/jb-ui/src/api_fsb/docs/UserProfileResponse.md b/jb-ui/src/api_fsb/docs/UserProfileResponse.md index af39b22..ea85cdf 100644 --- a/jb-ui/src/api_fsb/docs/UserProfileResponse.md +++ b/jb-ui/src/api_fsb/docs/UserProfileResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **user_profile** | [**UserProfile**](UserProfile.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/UserProfilesResponse.md b/jb-ui/src/api_fsb/docs/UserProfilesResponse.md index 1b8bfad..c9d231d 100644 --- a/jb-ui/src/api_fsb/docs/UserProfilesResponse.md +++ b/jb-ui/src/api_fsb/docs/UserProfilesResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **user_profiles** | [**Array<UserProfile>**](UserProfile.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/UserWalletBalanceResponse.md b/jb-ui/src/api_fsb/docs/UserWalletBalanceResponse.md index f9cdc80..fa6c177 100644 --- a/jb-ui/src/api_fsb/docs/UserWalletBalanceResponse.md +++ b/jb-ui/src/api_fsb/docs/UserWalletBalanceResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **string** | The status of the API response. | [default to undefined] +**status** | **string** | The status of the API response. | [optional] [default to StatusEnum_Success] **msg** | **string** | | [optional] [default to undefined] **wallet** | [**UserWalletBalance**](UserWalletBalance.md) | | [default to undefined] diff --git a/jb-ui/src/api_fsb/docs/WalletApi.md b/jb-ui/src/api_fsb/docs/WalletApi.md index a4acfd4..05d0c5a 100644 --- a/jb-ui/src/api_fsb/docs/WalletApi.md +++ b/jb-ui/src/api_fsb/docs/WalletApi.md @@ -7,8 +7,10 @@ All URIs are relative to *https://fsb.generalresearch.com* |[**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| +|[**filterUserCashoutsProductIdCashoutGet**](#filterusercashoutsproductidcashoutget) | **GET** /{product_id}/cashout/ | Filter User Cashouts| |[**getAttemptCreditProductIdWalletAttemptCreditTsidGet**](#getattemptcreditproductidwalletattemptcredittsidget) | **GET** /{product_id}/wallet/attempt-credit/{tsid}/ | Get Attempt Credit| |[**getCashoutDetailProductIdCashoutCashoutIdGet**](#getcashoutdetailproductidcashoutcashoutidget) | **GET** /{product_id}/cashout/{cashout_id}/ | Get Cashout Detail| +|[**getCashoutMethodProductIdCashoutMethodsCashoutMethodIdGet**](#getcashoutmethodproductidcashoutmethodscashoutmethodidget) | **GET** /{product_id}/cashout_methods/{cashout_method_id}/ | Get Cashout Method| |[**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| @@ -75,7 +77,7 @@ No authorization required # **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 +A user can only have 1 unique Cashout Method of any type at a time (e.g. 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 is supported ### Example @@ -186,6 +188,75 @@ 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) +# **filterUserCashoutsProductIdCashoutGet** +> CashoutRequestsResponse filterUserCashoutsProductIdCashoutGet() + + +### 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 status: Array<PayoutStatus>; //Filter by one or more payout statuses (optional) (default to undefined) +let payoutType: Array<PayoutType>; //Filter by one or more payout types (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.filterUserCashoutsProductIdCashoutGet( + productId, + bpuid, + status, + payoutType, + 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| +| **status** | **Array<PayoutStatus>** | Filter by one or more payout statuses | (optional) defaults to undefined| +| **payoutType** | **Array<PayoutType>** | Filter by one or more payout types | (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 + +**CashoutRequestsResponse** + +### 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) + # **getAttemptCreditProductIdWalletAttemptCreditTsidGet** > AttemptCreditClaimResponse getAttemptCreditProductIdWalletAttemptCreditTsidGet() @@ -296,6 +367,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) +# **getCashoutMethodProductIdCashoutMethodsCashoutMethodIdGet** +> CashoutMethodResponse getCashoutMethodProductIdCashoutMethodsCashoutMethodIdGet() + +Retrieve 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 (default to undefined) + +const { status, data } = await apiInstance.getCashoutMethodProductIdCashoutMethodsCashoutMethodIdGet( + productId, + cashoutMethodId +); +``` + +### 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| + + +### Return type + +**CashoutMethodResponse** + +### 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() @@ -314,10 +440,12 @@ 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 ip: string; //The end user\'s public IPv4 or IPv6 address. (optional) (default to undefined) const { status, data } = await apiInstance.getCashoutMethodsProductIdCashoutMethodsGet( productId, - bpuid + bpuid, + ip ); ``` @@ -327,6 +455,7 @@ const { status, data } = await apiInstance.getCashoutMethodsProductIdCashoutMeth |------------- | ------------- | ------------- | -------------| | **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**] | The end user\'s public IPv4 or IPv6 address. | (optional) defaults to undefined| ### Return type |
