aboutsummaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/WalletApi.md
diff options
context:
space:
mode:
authorMax Nanis2026-09-09 20:03:48 -0700
committerMax Nanis2026-09-09 20:03:48 -0700
commite7e5b5f8bf81e78e417ecdb9dd6ab1616e722fa0 (patch)
tree6ef3117ec22e65b195103770158e2b3864e3cfbf /jb-ui/src/api_fsb/docs/WalletApi.md
parentf3e37a1c73bd0d68966f24995011b5c93305273d (diff)
downloadamt-jb-e7e5b5f8bf81e78e417ecdb9dd6ab1616e722fa0.tar.gz
amt-jb-e7e5b5f8bf81e78e417ecdb9dd6ab1616e722fa0.zip
new api_fsb generated files
Diffstat (limited to 'jb-ui/src/api_fsb/docs/WalletApi.md')
-rw-r--r--jb-ui/src/api_fsb/docs/WalletApi.md169
1 files changed, 169 insertions, 0 deletions
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)