diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/WalletApi.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/WalletApi.md | 133 |
1 files changed, 131 insertions, 2 deletions
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 |