@cobo/cobo-waas2 1.15.0 → 1.17.0

package/docs/AppWorkflowsApi.md

@@ -0,0 +1,273 @@
+# CoboWaas2.AppWorkflowsApi
+
+All URIs are relative to *https://api.dev.cobo.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createApprovalRequest**](AppWorkflowsApi.md#createApprovalRequest) | **POST** /app/workflows/approval_requests | Request workflow approval
+[**getApprovalRequestById**](AppWorkflowsApi.md#getApprovalRequestById) | **GET** /app/workflows/approval_requests/{approval_id} | Get approval request details
+[**listAppWorkflows**](AppWorkflowsApi.md#listAppWorkflows) | **GET** /app/workflows | List app workflows
+[**listApprovalRequests**](AppWorkflowsApi.md#listApprovalRequests) | **GET** /app/workflows/approval_requests | List approval requests
+[**revokeApprovalRequest**](AppWorkflowsApi.md#revokeApprovalRequest) | **POST** /app/workflows/approval_requests/{approval_id}/revoke | Revoke approval request
+
+
+
+## createApprovalRequest
+
+> CreateApprovalRequest201Response createApprovalRequest(opts)
+
+Request workflow approval
+
+This operation triggers a specified workflow and generates a new approval request.  <Note>To use the approval workflow operations, you must use the Cobo OAuth authentication method ([Org Access Token](https://www.cobo.com/developers/v2/apps/org-access-tokens)).</Note> 
+
+### 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.AppWorkflowsApi();
+const opts = {
+  'RequestApproval': new CoboWaas2.RequestApproval()
+};
+apiInstance.createApprovalRequest(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **RequestApproval** | [**RequestApproval**](RequestApproval.md)| The request body to request workflow approval. | [optional] 
+
+### Return type
+
+[**CreateApprovalRequest201Response**](CreateApprovalRequest201Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## getApprovalRequestById
+
+> ApprovalRequestDetail getApprovalRequestById(approval_id)
+
+Get approval request details
+
+This operation retrieves the details of a specific approval request.  &lt;Note&gt;To use the approval workflow operations, you must use the Cobo OAuth authentication method ([Org Access Token](https://www.cobo.com/developers/v2/apps/org-access-tokens)).&lt;/Note&gt; 
+
+### 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.AppWorkflowsApi();
+const approval_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+apiInstance.getApprovalRequestById(approval_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **approval_id** | **String**| The system-generated unique ID of the approval request. | 
+
+### Return type
+
+[**ApprovalRequestDetail**](ApprovalRequestDetail.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## listAppWorkflows
+
+> [AppWorkflow] listAppWorkflows()
+
+List app workflows
+
+This operation retrieves all approval workflows of an Cobo Portal App. &lt;Note&gt;You need to [configure approval workflow](https://www.cobo.com/developers/v2/apps/configure-workflow) in the app Manifest file first.&lt;/Note&gt; &lt;Note&gt;To use the approval workflow operations, you must use the Cobo OAuth authentication method ([Org Access Token](https://www.cobo.com/developers/v2/apps/org-access-tokens)).&lt;/Note&gt; 
+
+### 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.AppWorkflowsApi();
+apiInstance.listAppWorkflows().then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**[AppWorkflow]**](AppWorkflow.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## listApprovalRequests
+
+> ListApprovalRequests200Response listApprovalRequests(operation_id, opts)
+
+List approval requests
+
+This operation retrieves a list of approval requests.  &lt;Note&gt;To use the approval workflow operations, you must use the Cobo OAuth authentication method ([Org Access Token](https://www.cobo.com/developers/v2/apps/org-access-tokens)).&lt;/Note&gt; 
+
+### 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.AppWorkflowsApi();
+const operation_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+const opts = {
+  'limit': 10,
+  'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
+  'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
+};
+apiInstance.listApprovalRequests(operation_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **operation_id** | **String**| The unique ID of the approval workflow. | 
+ **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] 
+
+### Return type
+
+[**ListApprovalRequests200Response**](ListApprovalRequests200Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## revokeApprovalRequest
+
+> RevokeApprovalRequest201Response revokeApprovalRequest(approval_id, opts)
+
+Revoke approval request
+
+This operation revokes a pending approval request.  &lt;Note&gt;To use the approval workflow operations, you must use the Cobo OAuth authentication method ([Org Access Token](https://www.cobo.com/developers/v2/apps/org-access-tokens)).&lt;/Note&gt; 
+
+### 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.AppWorkflowsApi();
+const approval_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
+const opts = {
+  'RevokeApprovalRequestRequest': new CoboWaas2.RevokeApprovalRequestRequest()
+};
+apiInstance.revokeApprovalRequest(approval_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **approval_id** | **String**| The system-generated unique ID of the approval request. | 
+ **RevokeApprovalRequestRequest** | [**RevokeApprovalRequestRequest**](RevokeApprovalRequestRequest.md)| The request body to revoke an approval request. | [optional] 
+
+### Return type
+
+[**RevokeApprovalRequest201Response**](RevokeApprovalRequest201Response.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

package/docs/ApprovalEntry.md

@@ -0,0 +1,11 @@
+# CoboWaas2.ApprovalEntry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**ApprovalStatus**](ApprovalStatus.md) |  | 
+**created_timestamp** | **Number** | The time when the approval was created, in Unix timestamp format, measured in milliseconds. | 
+**approval_users** | [**[ApprovalUser]**](ApprovalUser.md) |  | [optional] 
+
+

package/docs/ApprovalRequest.md

@@ -0,0 +1,13 @@
+# CoboWaas2.ApprovalRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**approval_id** | **String** | The system-generated unique ID of the approval request. | 
+**request_id** | **String** | An identifier provided by you when requesting the approval. | 
+**fields** | [**[AppWorkflowField]**](AppWorkflowField.md) |  | 
+**status** | [**ApprovalStatus**](ApprovalStatus.md) |  | 
+**initiated_timestamp** | **Number** | The time when the approval was initiated, in Unix timestamp format, measured in milliseconds. | 
+
+

package/docs/ApprovalRequestDetail.md

@@ -0,0 +1,13 @@
+# CoboWaas2.ApprovalRequestDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**approval_id** | **String** | The system-generated unique ID of the approval request. | [optional] 
+**initiator** | [**ApprovalUser**](ApprovalUser.md) |  | 
+**approved_list** | [**[ApprovalEntry]**](ApprovalEntry.md) |  | [optional] 
+**status** | [**ApprovalStatus**](ApprovalStatus.md) |  | 
+**modified_timestamp** | **Number** | The time when the approval was modified, in Unix timestamp format, measured in milliseconds. | [optional] 
+
+

package/docs/ApprovalStatus.md

@@ -0,0 +1,16 @@
+# CoboWaas2.ApprovalStatus
+
+## Enum
+
+
+* `Pending` (value: `"Pending"`)
+
+* `Completed` (value: `"Completed"`)
+
+* `Failed` (value: `"Failed"`)
+
+* `Revoked` (value: `"Revoked"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/ApprovalUser.md

@@ -0,0 +1,12 @@
+# CoboWaas2.ApprovalUser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The user email. | 
+**name** | **String** | The user name. | [optional] 
+**status** | [**ApprovalStatus**](ApprovalStatus.md) |  | 
+**created_timestamp** | **Number** | The time when the approval was created, in Unix timestamp format, measured in milliseconds. | 
+
+

package/docs/BabylonStakeExtra.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **finality_provider_public_key** | **String** | The public key of the finality provider. | 
 **stake_block_time** | **Number** | The number of blocks that need to be processed before the locked tokens are unlocked and become accessible. | 
 **auto_broadcast** | **Boolean** | Whether to automatically broadcast the transaction. The default value is `true`.  - `true`: Automatically broadcast the transaction. - `false`: The transaction will not be submitted to the blockchain automatically. You can call [Broadcast signed transactions](https://www.cobo.com/developers/v2/api-references/transactions/broadcast-signed-transactions) to broadcast the transaction to the blockchain, or retrieve the signed raw transaction data `raw_tx` by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information) and broadcast it yourself.  | [optional] 
+**babylon_address** | [**StakingSource**](StakingSource.md) |  | [optional] 
 
 

package/docs/BatchCheckUtxo201Response.md

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

package/docs/BatchCheckUtxoRequest.md

@@ -0,0 +1,10 @@
+# CoboWaas2.BatchCheckUtxoRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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). | 
+**utxos** | [**[BatchUTXOParam]**](BatchUTXOParam.md) |  | 
+
+

package/docs/BatchUTXOParam.md

@@ -0,0 +1,10 @@
+# CoboWaas2.BatchUTXOParam
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tx_hash** | **String** | The transaction hash. | 
+**vout_ns** | **[Number]** |  | [optional] 
+
+

package/docs/ChainInfo.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **explorer_address_url** | **String** | The address URL pattern on the blockchain explorer. You can use it to concatenate the address URLs. | [optional] 
 **require_memo** | **Boolean** | Whether the chain requires a memo. | [optional] 
 **confirming_threshold** | **Number** | The number of confirmations required for an on-chain transaction, such as 64 for Ethereum. | [optional] 
+**coinbase_maturity** | **Number** | The number of confirmations required before a coinbase transaction is considered mature and can be spent, for example, 100 confirmations for BTC. | [optional] 
 
 

package/docs/CreateApprovalRequest201Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.CreateApprovalRequest201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**approval_id** | **String** | The system-generated unique ID of the approval request. You can use this ID to query the approval request status or revoke the request. | 
+
+

package/docs/CreatePaymentOrderRequest.md

@@ -11,6 +11,6 @@ Name | Type | Description | Notes
 **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. | 
 **merchant_order_code** | **String** | A unique reference code assigned by the merchant to identify this order in their system. | [optional] 
 **psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. | 
-**expired_at** | **Number** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. After this time: - 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] 
+**expired_in** | **Number** | The pay-in order will expire after approximately a certain number of seconds: - 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] 
 
 

package/docs/CreateRefundRequest.md

@@ -11,5 +11,8 @@ Name | Type | Description | Notes
 **token_id** | **String** | The ID of the cryptocurrency used for refund. Supported values:    - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC`   - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | 
 **refund_type** | [**RefundType**](RefundType.md) |  | 
 **order_id** | **String** | The ID of the original pay-in order associated with this refund. Use this to track refunds against specific payments. | [optional] 
+**charge_merchant_fee** | **Boolean** | Indicates whether the merchant should bear the transaction fee for the refund.  If true, the fee will be deducted from merchant's account balance.  | [optional] 
+**merchant_fee_amount** | **String** | The amount of the transaction fee that the merchant will bear for the refund.  This is only applicable if `charge_merchant_fee` is set to true.  | [optional] 
+**merchant_fee_token_id** | **String** | The ID of the cryptocurrency used for the transaction fee.  This is only applicable if `charge_merchant_fee` is set to true.  | [optional] 
 
 

package/docs/CreateSettlement.md

@@ -7,8 +7,11 @@ Name | Type | Description | Notes
 **merchant_id** | **String** | The merchant ID. | [optional] 
 **token_id** | **String** | The ID of the cryptocurrency you want to settle. Supported values:  - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT`  | [optional] 
 **currency** | **String** | The fiat currency for settling the cryptocurrency. Currently, only `USD` is supported. | [optional] [default to 'USD']
-**amount** | **String** | The settlement amount. - If `token_id` is specified, this represents the settlement amount in the specified cryptocurrency. - If `token_id` is not specified, this represents the settlement amount in the specified fiat currency. | 
-**bank_account_id** | **String** | The ID of the bank account where the settled funds will be deposited. | 
+**amount** | **String** | The settlement amount. - If `token_id` is specified, this represents the settlement amount in the specified cryptocurrency. - If `token_id` is not specified, 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. | [optional] 
 **settlement_type** | [**SettlementType**](SettlementType.md) |  | [optional] 
+**crypto_address_id** | **String** | The ID of the pre-approved crypto address used for Crypto settlements.  - This field is only applicable when `payout_channel` is set to `Crypto`. - If `payout_channel` is `OffRamp`, this field will be ignored. - The value must refer to a valid address that has been pre-configured and approved for the given token.  | [optional] 
+**payout_channel** | [**PayoutChannel**](PayoutChannel.md) |  | [optional] 
+**order_ids** | **[String]** | A list of unique order IDs to be included in this settlement.  - This field is only applicable when `settlement_type` is set to `Merchant`. - If provided, the settlement will only apply to the specified orders. - The settlement `amount` must exactly match the total eligible amount from these orders. - This ensures consistency between the declared amount and the actual order-level data being settled.  | [optional] 
 
 

package/docs/CreateStakeActivityExtra.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **finality_provider_public_key** | **String** | The public key of the finality provider. | 
 **stake_block_time** | **Number** | The number of blocks that need to be processed before the locked tokens are unlocked and become accessible. | 
 **auto_broadcast** | **Boolean** | Whether to automatically broadcast the transaction. The default value is `true`.  - `true`: Automatically broadcast the transaction. - `false`: The transaction will not be submitted to the blockchain automatically. You can call [Broadcast signed transactions](https://www.cobo.com/developers/v2/api-references/transactions/broadcast-signed-transactions) to broadcast the transaction to the blockchain, or retrieve the signed raw transaction data `raw_tx` by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information) and broadcast it yourself.  | [optional] 
+**babylon_address** | [**StakingSource**](StakingSource.md) |  | [optional] 
 **provider_name** | **String** | The name of the provider. | 
 **timelock** | **Number** | The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. | 
 **change_address** | **String** | The change address on the Bitcoin chain. If not provided, the source wallet's address will be used as the change address. | [optional] 

package/docs/CryptoAddress.md

@@ -0,0 +1,14 @@
+# CoboWaas2.CryptoAddress
+
+## Properties
+
+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** | Unique identifier for the pre-approved crypto address, used to reference the address securely in requests. This ID is returned by the system and should be used instead of the raw blockchain address in API calls. | 
+**address** | **String** | The actual blockchain address to which funds will be transferred. This is for display purposes only; external clients should always use address_id to refer to the address in secure operations. | 
+**label** | **String** | A human-readable label or alias for the crypto address, set by the merchant or platform operator. This field is optional and intended to help distinguish addresses by usage or purpose (e.g., \"Main Payout Wallet\", \"Cold Wallet\"). | [optional] 
+**created_timestamp** | **Number** | The created time of the crypto address, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The updated time of the crypto address, represented as a UNIX timestamp in seconds. | [optional] 
+
+

package/docs/CustodialTransferDestination.md

@@ -0,0 +1,11 @@
+# CoboWaas2.CustodialTransferDestination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_type** | [**TransferDestinationType**](TransferDestinationType.md) |  | 
+**wallet_id** | **String** | The wallet ID. | 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`.  | 
+
+

package/docs/CustodialWeb3TransferSource.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **source_type** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
-**address** | **String** | The wallet address.  If you want to specify the UTXOs to be used, please provide the `included_utxos` property. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing.  You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail.  | [optional] 
+**address** | **String** | The wallet address.  If you want to specify the UTXOs to be used, please provide the `included_utxos` property. When `included_utxos` is specified, only these specified UTXOs will be used for the transaction. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing.  You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail.  | [optional] 
 **included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
 **excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
 

package/docs/DevelopersApi.md

@@ -105,8 +105,8 @@ Name | Type | Description  | Notes
  **wallet_ids** | **String**| A list of wallet IDs, separated by commas. | [optional] 
  **status** | **String**| The callback message status. Possible values include `Approved`, `Denied`, and `Failed`. | [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**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C.  If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned.  | [optional] 
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.  | [optional] 
+ **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] 
 
 ### Return type
 

package/docs/DevelopersWebhooksApi.md

@@ -214,8 +214,8 @@ Name | Type | Description  | Notes
  **status** | [**WebhookEndpointStatus**](.md)|  | [optional] 
  **event_type** | [**WebhookEventType**](.md)|  | [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**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C.  If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned.  | [optional] 
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.  | [optional] 
+ **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] 
 
 ### Return type
 
@@ -320,8 +320,8 @@ Name | Type | Description  | Notes
  **event_id** | **String**| The event ID. You can obtain a list of event IDs by calling [List all events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-events). | 
  **endpoint_id** | **String**| The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling [List webhook endpoints](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-webhook-endpoints). | 
  **limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
- **before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C.  If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned.  | [optional] 
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.  | [optional] 
+ **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] 
 
 ### Return type
 
@@ -382,8 +382,8 @@ Name | Type | Description  | Notes
  **status** | [**WebhookEventStatus**](.md)|  | [optional] 
  **type** | [**WebhookEventType**](.md)|  | [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**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C.  If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned.  | [optional] 
- **after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset.    Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C.    **Notes**:   - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned.  | [optional] 
+ **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] 
 
 ### Return type
 

package/docs/EstimateContractCallFeeParams.md

@@ -10,5 +10,6 @@ Name | Type | Description | Notes
 **source** | [**ContractCallSource**](ContractCallSource.md) |  | 
 **destination** | [**ContractCallDestination**](ContractCallDestination.md) |  | 
 **fee_type** | [**FeeType**](FeeType.md) |  | [optional] 
+**replaced_transaction_id** | **String** | The ID of the transaction that this transaction replaced. | [optional] 
 
 

package/docs/EstimateFeeParams.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **token_id** | **String** | The token ID of the transferred 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). | 
 **destination** | [**ContractCallDestination**](ContractCallDestination.md) |  | 
 **fee_type** | [**FeeType**](FeeType.md) |  | [optional] 
+**replaced_transaction_id** | **String** | The ID of the transaction that this transaction replaced. | [optional] 
 **chain_id** | **String** | The chain ID of the chain on which the smart contract is deployed. 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/EstimateTransferFeeParams.md

@@ -10,5 +10,6 @@ Name | Type | Description | Notes
 **token_id** | **String** | The token ID of the transferred 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). | 
 **destination** | [**TransferDestination**](TransferDestination.md) |  | [optional] 
 **fee_type** | [**FeeType**](FeeType.md) |  | [optional] 
+**replaced_transaction_id** | **String** | The ID of the transaction that this transaction replaced. | [optional] 
 
 

package/docs/ExchangePermissionToken201Response.md

@@ -0,0 +1,12 @@
+# CoboWaas2.ExchangePermissionToken201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **String** | The new Permission Access Token. | [optional] 
+**token_type** | **String** | The type of the tokens, which is Bearer. | [optional] 
+**expires_in** | **Number** | The time in seconds in which the new Permission Access Token expires. | [optional] 
+**refresh_token** | **String** | The Refresh Token, used to obtain another Org Access Token when the new Permission Access Token expires. The expiration time for Refresh Tokens is currently set to 7 days and is subject to change. | [optional] 
+
+

package/docs/ExchangePermissionTokenRequest.md

@@ -0,0 +1,9 @@
+# CoboWaas2.ExchangePermissionTokenRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permission_type** | **String** | The OAuth permission type. Set the value as `payment_orders_payin`. | 
+
+