@cobo/cobo-waas2 1.20.0 → 1.22.0

package/docs/AutoSweepApi.md

@@ -0,0 +1,285 @@
+# CoboWaas2.AutoSweepApi
+
+All URIs are relative to *https://api.dev.cobo.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createAutoSweepTask**](AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks | create auto sweep task
+[**createWalletSweepToAddresses**](AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | create wallet sweep to addresses
+[**getAutoSweepTaskById**](AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto sweep task information
+[**listAutoSweepTask**](AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List wallet auto sweep task
+[**listWalletSweepToAddresses**](AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List wallet sweep to addresses
+
+
+
+## createAutoSweepTask
+
+> AutoSweepTask createAutoSweepTask(opts)
+
+create auto sweep task
+
+This operation create a new auto sweep task. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.AutoSweepApi();
+const opts = {
+  'CreateAutoSweepTask': new CoboWaas2.CreateAutoSweepTask()
+};
+apiInstance.createAutoSweepTask(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **CreateAutoSweepTask** | [**CreateAutoSweepTask**](CreateAutoSweepTask.md)| The request body to generates a new sweep to addresses within a specified wallet. | [optional] 
+
+### Return type
+
+[**AutoSweepTask**](AutoSweepTask.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## createWalletSweepToAddresses
+
+> SweepToAddress createWalletSweepToAddresses(opts)
+
+create wallet sweep to addresses
+
+This operation create a new sweep to address for the wallet. The old sweep to address will become invalid. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.AutoSweepApi();
+const opts = {
+  'CreateSweepToAddress': new CoboWaas2.CreateSweepToAddress()
+};
+apiInstance.createWalletSweepToAddresses(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **CreateSweepToAddress** | [**CreateSweepToAddress**](CreateSweepToAddress.md)| The request body to generates a new sweep to addresses within a specified wallet. | [optional] 
+
+### Return type
+
+[**SweepToAddress**](SweepToAddress.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## getAutoSweepTaskById
+
+> AutoSweepTask getAutoSweepTaskById(task_id)
+
+Get auto sweep task information
+
+This operation retrieves detailed information about a specified auto sweep task. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.AutoSweepApi();
+const task_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+apiInstance.getAutoSweepTaskById(task_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| The auto sweep task ID. | 
+
+### Return type
+
+[**AutoSweepTask**](AutoSweepTask.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## listAutoSweepTask
+
+> ListAutoSweepTask200Response listAutoSweepTask(wallet_id, opts)
+
+List wallet auto sweep task
+
+This operation retrieves a list of auto sweep task. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.AutoSweepApi();
+const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+const opts = {
+  'token_id': "ETH_USDT",
+  'task_ids': "f47ac10b-58cc-4372-a567-0e02b2c3d479,1ddca562-8434-41c9-8809-d437bad9c868",
+  'min_created_timestamp': 1635744000000,
+  'max_created_timestamp': 1635744000000,
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
+  'direction': "ASC"
+};
+apiInstance.listAutoSweepTask(wallet_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **wallet_id** | **String**| The wallet ID. | 
+ **token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional] 
+ **task_ids** | **String**| A list of auto sweep task IDs, separated by comma. | [optional] 
+ **min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time.  If not provided, the default value is 90 days before the current time. This default value is subject to change.  | [optional] 
+ **max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time.  If not provided, the default value is the current time. This default value is subject to change.  | [optional] 
+ **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
+ **before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.  | [optional] 
+ **after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.  | [optional] 
+ **direction** | **String**| The sort direction. Possible values include:   - &#x60;ASC&#x60;: Sort the results in ascending order.   - &#x60;DESC&#x60;: Sort the results in descending order.  | [optional] [default to &#39;ASC&#39;]
+
+### Return type
+
+[**ListAutoSweepTask200Response**](ListAutoSweepTask200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## listWalletSweepToAddresses
+
+> ListWalletSweepToAddresses200Response listWalletSweepToAddresses(wallet_id)
+
+List wallet sweep to addresses
+
+This operation retrieves a list of sweep to addresses within your wallet. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.AutoSweepApi();
+const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+apiInstance.listWalletSweepToAddresses(wallet_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **wallet_id** | **String**| The wallet ID. | 
+
+### Return type
+
+[**ListWalletSweepToAddresses200Response**](ListWalletSweepToAddresses200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/docs/AutoSweepTask.md

@@ -0,0 +1,16 @@
+# CoboWaas2.AutoSweepTask
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task_id** | **String** | The auto sweep task ID. | 
+**wallet_id** | **String** | The wallet ID. | 
+**token_id** | **String** | The token ID of the swept token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | 
+**status** | [**AutoSweepTaskStatus**](AutoSweepTaskStatus.md) |  | 
+**transaction_ids** | **[String]** | The IDs of the corresponding transactions of the auto sweep task. | [optional] 
+**failed_reasons** | **[String]** | Failed reason of create auto sweep transaction. | [optional] 
+**created_timestamp** | **Number** | The time when the task was created, in Unix timestamp format, measured in milliseconds. | 
+**updated_timestamp** | **Number** | The time when the task was updated, in Unix timestamp format, measured in milliseconds. | [optional] 
+
+

package/docs/AutoSweepTaskStatus.md

@@ -0,0 +1,12 @@
+# CoboWaas2.AutoSweepTaskStatus
+
+## Enum
+
+
+* `Submitted` (value: `"Submitted"`)
+
+* `TransactionCreated` (value: `"TransactionCreated"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/BalanceUpdateInfoEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
 **token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | 
 **address** | **String** | The wallet address. | 
 **wallet_uuid** | **String** | The wallet ID. | 

package/docs/ChainsEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The payment address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data.        - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. | 
 **chains** | [**[ChainInfo]**](ChainInfo.md) | The enabled chains. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | [optional] 
 **wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) |  | [optional] 

package/docs/CreateAutoSweepTask.md

@@ -0,0 +1,10 @@
+# CoboWaas2.CreateAutoSweepTask
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_id** | **String** | The wallet ID. | 
+**token_id** | **String** | The token ID of the swept token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | 
+
+

package/docs/CreateCryptoAddressRequest.md

@@ -0,0 +1,11 @@
+# CoboWaas2.CreateCryptoAddressRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include:   - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
+**address** | **String** | The blockchain address in its native format. This is the actual destination address where funds will be sent. The address must match the format required by the specified blockchain. For example:   - For `SOL_USDC`: Provide a Solana address   - For `ETH_USDT`: Provide an Ethereum address  | 
+**label** | **String** | A label to help identify the address's purpose. | [optional] 
+
+

package/docs/CreateCustodialWalletParams.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
 
 

package/docs/CreateExchangeWalletParams.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | 
 **apikey** | **String** | The API key of your exchange account. | 
 **secret** | **String** | The API secret of your exchange account. | 

package/docs/CreateMpcWalletParams.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
 **vault_id** | **String** | The ID of the owning vault. You can call [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults) to retrieve all vault IDs under your organization. | 
 
 

package/docs/CreatePaymentOrderRequest.md

@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **merchant_id** | **String** | The merchant ID. | 
 **token_id** | **String** | The ID of the cryptocurrency used for payment. Supported values:    - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
-**currency** | **String** | The fiat currency of the order. Currently, only `USD` is supported. | [optional] [default to '']
-**order_amount** | **String** | The base amount of the order in fiat currency, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | 
-**fee_amount** | **String** | The developer fee for the order in fiat currency. It is added to the base amount (`order_amount`) to determine the final charge. For example, if order_amount is \"100.00\" and fee_amount is \"2.00\", the customer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant and \"2.00\" settled to the developer. Values must be greater than 0 and contain two decimal places. | 
+**currency** | **String** | The fiat currency for the base order amount and the developer fee. Currently, only `USD` is supported.  If left empty, both `order_amount` and `fee_amount` will be denominated in the cryptocurrency specified by `token_id`  | [optional] [default to '']
+**order_amount** | **String** |  The base amount of the order, excluding the developer fee (specified in `fee_amount`), in the currency specified by `currency`. If `currency` is not specified, the amount is in the cryptocurrency specified by `token_id`.   Values must be greater than `0` and contain two decimal places.   | 
+**fee_amount** | **String** |  The developer fee for the order, in the currency specified by `currency`. If `currency` is not specified, the fee is in the cryptocurrency specified by `token_id`.  The developer fee is added to the base amount (`order_amount`) to determine the final charge. For example: - Base amount (`order_amount`): \"100.00\" - Developer fee (`fee_amount`): \"2.00\"  - Total charged to customer: \"102.00\"  Values must be greater than 0 and contain two decimal places.  | 
 **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters. | [optional] 
 **psp_order_code** | **String** | A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters.  | 
 **expired_in** | **Number** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. After expiration: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event.  | [optional] [default to 1800]

package/docs/CreateSafeWalletParams.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
 **chain_id** | **String** | The ID of the chain that the wallet operates on. | 
 **smart_contract_wallet_type** | [**SmartContractWalletType**](SmartContractWalletType.md) |  | 
 **safe_address** | **String** | The address of the Smart Contract Wallet. If this is not provided, Cobo will create a new Safe{Wallet} and set up Cobo Safe for you. In that case, the `threshold` and `signers` properties are required. | [optional] 

package/docs/CreateSettlement.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **merchant_id** | **String** | The merchant ID. Specify this field when `settlement_type` is set to `Merchant`. | [optional] 
-**token_id** | **String** | The ID of the cryptocurrency you want to settle. Specify this field when `payout_channel` is set to `Crypto`. Supported values:  - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | [optional] 
+**token_id** | **String** | The ID of the cryptocurrency you want to settle. Specify this field when `payout_channel` is set to `Crypto`. Supported values:  - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
 **currency** | **String** | The fiat currency for settling the cryptocurrency. Currently, only `USD` is supported. Specify this field when `payout_channel` is set to `OffRamp`. | [optional] 
 **amount** | **String** | The settlement amount. When settling merchant balance from orders (`acquiring_type` is `Order` and `settlement_type` is `Merchant`), do not specify this field as the settlement amount will be automatically calculated based on the order amounts. - If `payout_channel` is set to `Crypto`, this represents the settlement amount in the specified cryptocurrency. - If `payout_channel` is set to `OffRamp`, this represents the settlement amount in the specified fiat currency.  | [optional] 
 **bank_account_id** | **String** | The ID of the bank account where the settled funds will be deposited. This field is only applicable when `payout_channel` is set to `OffRamp`. Call [List all bank accounts](/v2/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts.  | [optional] 

package/docs/CreateSmartContractWalletParams.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
 **chain_id** | **String** | The ID of the chain that the wallet operates on. | 
 **smart_contract_wallet_type** | [**SmartContractWalletType**](SmartContractWalletType.md) |  | 
 **safe_address** | **String** | The address of the Smart Contract Wallet. If this is not provided, Cobo will create a new Safe{Wallet} and set up Cobo Safe for you. In that case, the `threshold` and `signers` properties are required. | [optional] 

package/docs/CreateSweepToAddress.md

@@ -0,0 +1,10 @@
+# CoboWaas2.CreateSweepToAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_id** | **String** | The wallet ID. | 
+**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | 
+
+

package/docs/CreateWalletParams.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet. This parameter only applies to MPC and Web3 wallets. | [optional] 
 **vault_id** | **String** | The ID of the owning vault. You can call [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults) to retrieve all vault IDs under your organization. | 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | 
 **apikey** | **String** | The API key of your exchange account. | 

package/docs/CreatedWalletInfo.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **name** | **String** | The wallet name. | 
 **org_id** | **String** | The ID of the owning organization. | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional] 
 **project_id** | **String** | The project ID. | [optional] 
 **project_name** | **String** | The project name. | [optional] 
 **vault_id** | **String** | The ID of the owning vault. | 

package/docs/CryptoAddress.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **token_id** | **String** | The token identifier (e.g., ETH_USDT, TRON_USDT) that this address is associated with. | 
-**address_id** | **String** | A unique identifier for this crypto address, automatically generated by Cobo. Use this ID (not the raw blockchain address) when submitting a settlement request.  | 
+**crypto_address_id** | **String** | A unique identifier for this crypto address, automatically generated by Cobo. Use this ID (not the raw blockchain address) when submitting a settlement request.  | 
 **address** | **String** | The blockchain address in its native format. This is the actual destination address where funds will be sent. Note: When submitting a settlement request, use the address ID rather than this raw address.  | 
 **label** | **String** | A label to help identify the address's purpose. | [optional] 
 **created_timestamp** | **Number** | The creation time of the crypto address, represented as a UNIX timestamp in seconds. | [optional] 

package/docs/CustodialWalletInfo.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **name** | **String** | The wallet name. | 
 **org_id** | **String** | The ID of the owning organization. | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional] 
 
 

package/docs/DeleteCryptoAddress201Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.DeleteCryptoAddress201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**crypto_address_id** | **String** | The ID of the deleted crypto address. | 
+
+

package/docs/ExchangeWalletInfo.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **name** | **String** | The wallet name. | 
 **org_id** | **String** | The ID of the owning organization. | 
+**enable_auto_sweep** | **Boolean** | Enable the auto sweep feature for the wallet | [optional] 
 **apikey** | **String** | The API key of your exchange account. | 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | 
 **main_wallet_id** | **String** | The wallet ID of the Main Account associated with the Sub Account. This property is returned only if you are creating or querying an Exchange Wallet (Sub Account). | [optional] 

package/docs/ForcedSweep.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**forced_sweep_id** | **String** | The force sweep ID. | 
-**request_id** | **String** | The request ID provided by you when creating the force sweep request. | 
-**wallet_id** | **String** | The wallet ID to force sweep, which is the unique identifier of a wallet. | [optional] 
-**token_id** | **String** | The token ID to force sweep, which is the unique identifier of a token. | [optional] 
-**amount** | **String** | The amount of needing force sweep. | [optional] 
+**forced_sweep_id** | **String** | The forced sweep ID generated by Cobo. | 
+**request_id** | **String** | The request ID provided by you when creating the forced sweep. | 
+**wallet_id** | **String** | The ID of the wallet in which the funds have been forcefully swept. | [optional] 
+**token_id** | **String** | The ID of the token that has been forcefully swept. | [optional] 
+**amount** | **String** | The amount of token that has been forcefully swept. | [optional] 
 **status** | [**ForcedSweepStatus**](ForcedSweepStatus.md) |  | 
-**created_timestamp** | **Number** | The created time of the force sweep request, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The updated time of the force sweep request, represented as a UNIX timestamp in seconds. | [optional] 
+**created_timestamp** | **Number** | The creation time of the forced sweep, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The update time of the forced sweep, represented as a UNIX timestamp in seconds. | [optional] 
 
 

package/docs/ForcedSweepRequest.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_id** | **String** | The request id of the force sweep. | 
-**wallet_id** | **String** | The wallet ID to force sweep, which is the unique identifier of a wallet. | 
-**token_id** | **String** | The token ID to force sweep, which is the unique identifier of a token. | 
-**amount** | **String** | The amount of needing force sweep. | 
+**request_id** | **String** | The request ID that is used to track a forced sweep. The request ID is provided by you and must be unique. | 
+**wallet_id** | **String** | The ID of the wallet in which the funds will be forcefully swept. | 
+**token_id** | **String** | The ID of the token to be forcefully swept. | 
+**amount** | **String** | The amount of the token to be forcefully swept. | 
 
 

package/docs/GetTokenizationAllowlistActivation200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.GetTokenizationAllowlistActivation200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activated** | **Boolean** | Indicates whether the allowlist feature is activated for the token. | 
+
+

package/docs/ListAutoSweepTask200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListAutoSweepTask200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[AutoSweepTask]**](AutoSweepTask.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/ListMerchantBalances200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.ListMerchantBalances200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[MerchantBalance]**](MerchantBalance.md) |  | [optional] 
+
+

package/docs/ListPaymentWalletBalances200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.ListPaymentWalletBalances200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[PaymentWalletBalance]**](PaymentWalletBalance.md) |  | [optional] 
+
+

package/docs/ListSettlementDetails200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListSettlementDetails200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[SettlementDetail]**](SettlementDetail.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/ListTokenizationBlocklistAddresses200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListTokenizationBlocklistAddresses200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[TokenizationBlocklistAddressNote]**](TokenizationBlocklistAddressNote.md) |  | 
+**pagination** | [**Pagination**](Pagination.md) |  | 
+
+

package/docs/ListWalletSweepToAddresses200Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.ListWalletSweepToAddresses200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[SweepToAddress]**](SweepToAddress.md) |  | [optional] 
+
+