@cobo/cobo-waas2 1.16.0 → 1.18.0

package/dist/model/WebhookEventData.js

@@ -7,6 +7,8 @@ exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _AddressesEventData = _interopRequireDefault(require("./AddressesEventData"));
 var _AddressesEventDataAllOfAddresses = _interopRequireDefault(require("./AddressesEventDataAllOfAddresses"));
+var _Balance = _interopRequireDefault(require("./Balance"));
+var _BalanceUpdateInfoEventData = _interopRequireDefault(require("./BalanceUpdateInfoEventData"));
 var _ChainInfo = _interopRequireDefault(require("./ChainInfo"));
 var _ChainsEventData = _interopRequireDefault(require("./ChainsEventData"));
 var _MPCVaultEventData = _interopRequireDefault(require("./MPCVaultEventData"));
@@ -18,6 +20,7 @@ var _PaymentTransaction = _interopRequireDefault(require("./PaymentTransaction")
 var _RefundType = _interopRequireDefault(require("./RefundType"));
 var _RootPubkey = _interopRequireDefault(require("./RootPubkey"));
 var _SettleRequestStatus = _interopRequireDefault(require("./SettleRequestStatus"));
+var _SettleStatus = _interopRequireDefault(require("./SettleStatus"));
 var _SettlementDetail = _interopRequireDefault(require("./SettlementDetail"));
 var _SourceGroup = _interopRequireDefault(require("./SourceGroup"));
 var _TSSRequestWebhookEventData = _interopRequireDefault(require("./TSSRequestWebhookEventData"));
@@ -65,7 +68,7 @@ var WebhookEventData = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>WebhookEventData</code>.
    * @alias module:model/WebhookEventData
-   * @param {(module:model/AddressesEventData|module:model/ChainsEventData|module:model/MPCVaultEventData|module:model/PaymentOrderEventData|module:model/PaymentRefundEventData|module:model/PaymentSettlementEvent|module:model/TSSRequestWebhookEventData|module:model/TokenListingEventData|module:model/TokensEventData|module:model/TransactionWebhookEventData|module:model/WalletInfoEventData)} instance The actual instance to initialize WebhookEventData.
+   * @param {(module:model/AddressesEventData|module:model/BalanceUpdateInfoEventData|module:model/ChainsEventData|module:model/MPCVaultEventData|module:model/PaymentOrderEventData|module:model/PaymentRefundEventData|module:model/PaymentSettlementEvent|module:model/TSSRequestWebhookEventData|module:model/TokenListingEventData|module:model/TokensEventData|module:model/TransactionWebhookEventData|module:model/WalletInfoEventData)} instance The actual instance to initialize WebhookEventData.
    */
   function WebhookEventData() {
     var instance = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
@@ -90,6 +93,10 @@ var WebhookEventData = /*#__PURE__*/function () {
           this.actualInstance = _AddressesEventData["default"].constructFromObject(instance);
           match++;
           break;
+        case "BalanceUpdateInfo":
+          this.actualInstance = _BalanceUpdateInfoEventData["default"].constructFromObject(instance);
+          match++;
+          break;
         case "Chains":
           this.actualInstance = _ChainsEventData["default"].constructFromObject(instance);
           match++;
@@ -320,6 +327,29 @@ var WebhookEventData = /*#__PURE__*/function () {
       // json data failed to deserialize into TokenListingEventData
       errorMessages.push("Failed to construct TokenListingEventData: " + err);
     }
+    try {
+      if (instance instanceof _BalanceUpdateInfoEventData["default"]) {
+        this.actualInstance = instance;
+      } else if (!!_BalanceUpdateInfoEventData["default"].validateJSON && _BalanceUpdateInfoEventData["default"].validateJSON(instance)) {
+        // plain JS object
+        // create BalanceUpdateInfoEventData from JS object
+        this.actualInstance = _BalanceUpdateInfoEventData["default"].constructFromObject(instance);
+      } else {
+        if (_BalanceUpdateInfoEventData["default"].constructFromObject(instance)) {
+          if (!!_BalanceUpdateInfoEventData["default"].constructFromObject(instance).toJSON) {
+            if (_BalanceUpdateInfoEventData["default"].constructFromObject(instance).toJSON()) {
+              this.actualInstance = _BalanceUpdateInfoEventData["default"].constructFromObject(instance);
+            }
+          } else {
+            this.actualInstance = _BalanceUpdateInfoEventData["default"].constructFromObject(instance);
+          }
+        }
+      }
+      match++;
+    } catch (err) {
+      // json data failed to deserialize into BalanceUpdateInfoEventData
+      errorMessages.push("Failed to construct BalanceUpdateInfoEventData: " + err);
+    }
     try {
       if (instance instanceof _PaymentOrderEventData["default"]) {
         this.actualInstance = instance;
@@ -391,11 +421,11 @@ var WebhookEventData = /*#__PURE__*/function () {
     }
 
     // if (match > 1) {
-    //    throw new Error("Multiple matches found constructing `WebhookEventData` with oneOf schemas AddressesEventData, ChainsEventData, MPCVaultEventData, PaymentOrderEventData, PaymentRefundEventData, PaymentSettlementEvent, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Input: " + JSON.stringify(instance));
+    //    throw new Error("Multiple matches found constructing `WebhookEventData` with oneOf schemas AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, MPCVaultEventData, PaymentOrderEventData, PaymentRefundEventData, PaymentSettlementEvent, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Input: " + JSON.stringify(instance));
     // } else
     if (match === 0) {
       //    this.actualInstance = null; // clear the actual instance in case there are multiple matches
-      //    throw new Error("No match found constructing `WebhookEventData` with oneOf schemas AddressesEventData, ChainsEventData, MPCVaultEventData, PaymentOrderEventData, PaymentRefundEventData, PaymentSettlementEvent, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " +
+      //    throw new Error("No match found constructing `WebhookEventData` with oneOf schemas AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, MPCVaultEventData, PaymentOrderEventData, PaymentRefundEventData, PaymentSettlementEvent, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " +
       //                    errorMessages.join(", "));
       return;
     } else {// only 1 match
@@ -414,16 +444,16 @@ var WebhookEventData = /*#__PURE__*/function () {
     key: "getActualInstance",
     value:
     /**
-     * Gets the actual instance, which can be <code>AddressesEventData</code>, <code>ChainsEventData</code>, <code>MPCVaultEventData</code>, <code>PaymentOrderEventData</code>, <code>PaymentRefundEventData</code>, <code>PaymentSettlementEvent</code>, <code>TSSRequestWebhookEventData</code>, <code>TokenListingEventData</code>, <code>TokensEventData</code>, <code>TransactionWebhookEventData</code>, <code>WalletInfoEventData</code>.
-     * @return {(module:model/AddressesEventData|module:model/ChainsEventData|module:model/MPCVaultEventData|module:model/PaymentOrderEventData|module:model/PaymentRefundEventData|module:model/PaymentSettlementEvent|module:model/TSSRequestWebhookEventData|module:model/TokenListingEventData|module:model/TokensEventData|module:model/TransactionWebhookEventData|module:model/WalletInfoEventData)} The actual instance.
+     * Gets the actual instance, which can be <code>AddressesEventData</code>, <code>BalanceUpdateInfoEventData</code>, <code>ChainsEventData</code>, <code>MPCVaultEventData</code>, <code>PaymentOrderEventData</code>, <code>PaymentRefundEventData</code>, <code>PaymentSettlementEvent</code>, <code>TSSRequestWebhookEventData</code>, <code>TokenListingEventData</code>, <code>TokensEventData</code>, <code>TransactionWebhookEventData</code>, <code>WalletInfoEventData</code>.
+     * @return {(module:model/AddressesEventData|module:model/BalanceUpdateInfoEventData|module:model/ChainsEventData|module:model/MPCVaultEventData|module:model/PaymentOrderEventData|module:model/PaymentRefundEventData|module:model/PaymentSettlementEvent|module:model/TSSRequestWebhookEventData|module:model/TokenListingEventData|module:model/TokensEventData|module:model/TransactionWebhookEventData|module:model/WalletInfoEventData)} The actual instance.
      */
     function getActualInstance() {
       return this.actualInstance;
     }
 
     /**
-     * Sets the actual instance, which can be <code>AddressesEventData</code>, <code>ChainsEventData</code>, <code>MPCVaultEventData</code>, <code>PaymentOrderEventData</code>, <code>PaymentRefundEventData</code>, <code>PaymentSettlementEvent</code>, <code>TSSRequestWebhookEventData</code>, <code>TokenListingEventData</code>, <code>TokensEventData</code>, <code>TransactionWebhookEventData</code>, <code>WalletInfoEventData</code>.
-     * @param {(module:model/AddressesEventData|module:model/ChainsEventData|module:model/MPCVaultEventData|module:model/PaymentOrderEventData|module:model/PaymentRefundEventData|module:model/PaymentSettlementEvent|module:model/TSSRequestWebhookEventData|module:model/TokenListingEventData|module:model/TokensEventData|module:model/TransactionWebhookEventData|module:model/WalletInfoEventData)} obj The actual instance.
+     * Sets the actual instance, which can be <code>AddressesEventData</code>, <code>BalanceUpdateInfoEventData</code>, <code>ChainsEventData</code>, <code>MPCVaultEventData</code>, <code>PaymentOrderEventData</code>, <code>PaymentRefundEventData</code>, <code>PaymentSettlementEvent</code>, <code>TSSRequestWebhookEventData</code>, <code>TokenListingEventData</code>, <code>TokensEventData</code>, <code>TransactionWebhookEventData</code>, <code>WalletInfoEventData</code>.
+     * @param {(module:model/AddressesEventData|module:model/BalanceUpdateInfoEventData|module:model/ChainsEventData|module:model/MPCVaultEventData|module:model/PaymentOrderEventData|module:model/PaymentRefundEventData|module:model/PaymentSettlementEvent|module:model/TSSRequestWebhookEventData|module:model/TokenListingEventData|module:model/TokensEventData|module:model/TransactionWebhookEventData|module:model/WalletInfoEventData)} obj The actual instance.
      */
   }, {
     key: "setActualInstance",
@@ -438,7 +468,7 @@ var WebhookEventData = /*#__PURE__*/function () {
   }]);
 }();
 /**
- *  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.
+ *  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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data.
  * @member {module:model/WebhookEventData.DataTypeEnum} data_type
  */
 _WebhookEventData = WebhookEventData;
@@ -536,7 +566,7 @@ WebhookEventData.prototype['result'] = undefined;
 WebhookEventData.prototype['fee'] = undefined;
 
 /**
- * The initiator of this settlement request, usually the user's API key.
+ *  The initiator of this settlement request. Can return either an API key or the Payment Management App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payment API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payment Management App using the App ID. 
  * @member {String} initiator
  */
 WebhookEventData.prototype['initiator'] = undefined;
@@ -615,13 +645,13 @@ WebhookEventData.prototype['extra'] = undefined;
 WebhookEventData.prototype['fueling_info'] = undefined;
 
 /**
- * The created time of the settlement request, represented as a UNIX timestamp in seconds.
+ * The creation time of the settlement request, represented as a UNIX timestamp in seconds.
  * @member {Number} created_timestamp
  */
 WebhookEventData.prototype['created_timestamp'] = undefined;
 
 /**
- * The updated time of the settlement request, represented as a UNIX timestamp in seconds.
+ * The last update time of the settlement request, represented as a UNIX timestamp in seconds.
  * @member {Number} updated_timestamp
  */
 WebhookEventData.prototype['updated_timestamp'] = undefined;
@@ -722,7 +752,24 @@ WebhookEventData.prototype['token'] = undefined;
 WebhookEventData.prototype['feedback'] = undefined;
 
 /**
- * The order ID corresponding to this refund.
+ * The wallet address.
+ * @member {String} address
+ */
+WebhookEventData.prototype['address'] = undefined;
+
+/**
+ * The wallet ID.
+ * @member {String} wallet_uuid
+ */
+WebhookEventData.prototype['wallet_uuid'] = undefined;
+
+/**
+ * @member {module:model/Balance} balance
+ */
+WebhookEventData.prototype['balance'] = undefined;
+
+/**
+ * The ID of the pay-in order corresponding to this refund.
  * @member {String} order_id
  */
 WebhookEventData.prototype['order_id'] = undefined;
@@ -799,6 +846,11 @@ WebhookEventData.prototype['received_token_amount'] = undefined;
  */
 WebhookEventData.prototype['transactions'] = undefined;
 
+/**
+ * @member {module:model/SettleStatus} settlement_status
+ */
+WebhookEventData.prototype['settlement_status'] = undefined;
+
 /**
  * The refund order ID.
  * @member {String} refund_id
@@ -822,6 +874,24 @@ WebhookEventData.prototype['to_address'] = undefined;
  */
 WebhookEventData.prototype['refund_type'] = undefined;
 
+/**
+ * Whether to charge developer fee to the merchant for the refund.    - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance    - `false`: The merchant is not charged any developer fee. 
+ * @member {Boolean} charge_merchant_fee
+ */
+WebhookEventData.prototype['charge_merchant_fee'] = undefined;
+
+/**
+ * The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`.
+ * @member {String} merchant_fee_amount
+ */
+WebhookEventData.prototype['merchant_fee_amount'] = undefined;
+
+/**
+ * The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true.
+ * @member {String} merchant_fee_token_id
+ */
+WebhookEventData.prototype['merchant_fee_token_id'] = undefined;
+
 /**
  * The settlement request ID generated by Cobo.
  * @member {String} settlement_request_id
@@ -832,5 +902,5 @@ WebhookEventData.prototype['settlement_request_id'] = undefined;
  * @member {Array.<module:model/SettlementDetail>} settlements
  */
 WebhookEventData.prototype['settlements'] = undefined;
-WebhookEventData.OneOf = ["AddressesEventData", "ChainsEventData", "MPCVaultEventData", "PaymentOrderEventData", "PaymentRefundEventData", "PaymentSettlementEvent", "TSSRequestWebhookEventData", "TokenListingEventData", "TokensEventData", "TransactionWebhookEventData", "WalletInfoEventData"];
+WebhookEventData.OneOf = ["AddressesEventData", "BalanceUpdateInfoEventData", "ChainsEventData", "MPCVaultEventData", "PaymentOrderEventData", "PaymentRefundEventData", "PaymentSettlementEvent", "TSSRequestWebhookEventData", "TokenListingEventData", "TokensEventData", "TransactionWebhookEventData", "WalletInfoEventData"];
 var _default = exports["default"] = WebhookEventData;

package/dist/model/WebhookEventDataType.js

@@ -33,7 +33,7 @@ var WebhookEventDataType = /*#__PURE__*/function () {
    * Constructs a new <code>WebhookEventDataType</code>.
    * The data type of the event.
    * @alias module:model/WebhookEventDataType
-   * @param data_type {module:model/WebhookEventDataType.DataTypeEnum}  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.
+   * @param data_type {module:model/WebhookEventDataType.DataTypeEnum}  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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data.
    */
   function WebhookEventDataType(data_type) {
     _classCallCheck(this, WebhookEventDataType);
@@ -104,7 +104,7 @@ var WebhookEventDataType = /*#__PURE__*/function () {
 WebhookEventDataType.RequiredProperties = ["data_type"];
 
 /**
- *  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.
+ *  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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 WebhookEventDataType.prototype['data_type'] = undefined;
@@ -155,6 +155,11 @@ WebhookEventDataType['DataTypeEnum'] = {
    * @const
    */
   "TokenListing": "TokenListing",
+  /**
+   * value: "BalanceUpdateInfo"
+   * @const
+   */
+  "BalanceUpdateInfo": "BalanceUpdateInfo",
   /**
    * value: "PaymentOrder"
    * @const

package/dist/model/WebhookEventLog.js

@@ -35,7 +35,7 @@ var WebhookEventLog = /*#__PURE__*/function () {
    * The webhook event log.
    * @alias module:model/WebhookEventLog
    * @param id {String} The event log ID.
-   * @param created_timestamp {Number} The time when the log was created, in Unix timestamp format, measured in milliseconds.
+   * @param created_timestamp {Number} The time when the event type was triggered, in Unix timestamp format (milliseconds). - The value remains unchanged across retries. - The default webhook timeout is 2 seconds. 
    * @param request_headers {Object} The request headers of the webhook event.
    * @param request_body {module:model/WebhookEvent} 
    * @param success {Boolean} Whether the webhook event has been successfully delivered.
@@ -158,7 +158,7 @@ WebhookEventLog.RequiredProperties = ["id", "created_timestamp", "request_header
 WebhookEventLog.prototype['id'] = undefined;
 
 /**
- * The time when the log was created, in Unix timestamp format, measured in milliseconds.
+ * The time when the event type was triggered, in Unix timestamp format (milliseconds). - The value remains unchanged across retries. - The default webhook timeout is 2 seconds. 
  * @member {Number} created_timestamp
  */
 WebhookEventLog.prototype['created_timestamp'] = undefined;

package/dist/model/WebhookEventType.js

@@ -125,6 +125,16 @@ var WebhookEventType = exports["default"] = /*#__PURE__*/function () {
      * @const
      */
     _defineProperty(this, "wallet.chain.enabled", "wallet.chain.enabled");
+    /**
+     * value: "wallet.mpc.balance.updated"
+     * @const
+     */
+    _defineProperty(this, "wallet.mpc.balance.updated", "wallet.mpc.balance.updated");
+    /**
+     * value: "wallet.web3.balance.updated"
+     * @const
+     */
+    _defineProperty(this, "wallet.web3.balance.updated", "wallet.web3.balance.updated");
     /**
      * value: "payment.transaction.created"
      * @const
@@ -135,6 +145,11 @@ var WebhookEventType = exports["default"] = /*#__PURE__*/function () {
      * @const
      */
     _defineProperty(this, "payment.transaction.late", "payment.transaction.late");
+    /**
+     * value: "payment.transaction.completed"
+     * @const
+     */
+    _defineProperty(this, "payment.transaction.completed", "payment.transaction.completed");
     /**
      * value: "payment.transaction.held"
      * @const

package/docs/Account.md

@@ -0,0 +1,14 @@
+# CoboWaas2.Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_id** | **String** | The ID of the cryptocurrency that this account is configured to handle. | 
+**address** | **String** | The top-up address corresponding to the account. | 
+**merchant_balance** | **String** | The amount of merchant funds under this account. | 
+**psp_balance** | **String** | The amount of developer funds under this account. | 
+**created_timestamp** | **Number** | The creation time of the account, in Unix timestamp format, measured in milliseconds. | [optional] 
+**updated_timestamp** | **Number** | The last update time of the account, in Unix timestamp format, measured in milliseconds. | [optional] 
+
+

package/docs/AcquiringType.md

@@ -0,0 +1,12 @@
+# CoboWaas2.AcquiringType
+
+## Enum
+
+
+* `Order` (value: `"Order"`)
+
+* `TopUp` (value: `"TopUp"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/AddressTransferDestination.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **utxo_outputs** | [**[AddressTransferDestinationUtxoOutputsInner]**](AddressTransferDestinationUtxoOutputsInner.md) |  | [optional] 
 **change_address** | **String** | The address used to receive the remaining funds or change from the transaction. | [optional] 
 **change_output_type** | **String** | The position of the change output in the transaction's outputs. Possible values are: - `Last`: The change output is placed at the end of the transaction's outputs.   - `First`: The change output is placed at the beginning of the transaction's outputs.  | [optional] 
-**force_internal** | **Boolean** | Whether the transaction request must be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer.   - `true`: The transaction request must be executed as a Cobo Loop transfer.   - `false`: The transaction request may not be executed as a Cobo Loop transfer.    Please do not set both `force_internal` and `force_external` as `true`.  | [optional] 
-**force_external** | **Boolean** | Whether the transaction request must not be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer.   - `true`: The transaction request must not be executed as a Cobo Loop transfer.   - `false`: The transaction request can be executed as a Cobo Loop transfer.  Please do not set both `force_internal` and `force_external` as `true`.  | [optional] 
+**force_internal** | **Boolean** | Whether the transaction request must be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer.   - `true`: The transaction request must be executed as a Cobo Loop transfer.   - `false`: The transaction request may not be executed as a Cobo Loop transfer.    Please do not set both `force_internal` and `force_external` as `true`. If both are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer.  | [optional] 
+**force_external** | **Boolean** | Whether the transaction request must not be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer.   - `true`: The transaction request must not be executed as a Cobo Loop transfer.   - `false`: The transaction request can be executed as a Cobo Loop transfer.  Please do not set both `force_internal` and `force_external` as `true`. If both are set to `false`, the system uses Cobo Loop by default if possible; otherwise, it proceeds with an on-chain transfer.  | [optional] 
 
 
 

package/docs/AddressesEventData.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. | 
+**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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. | 
 **addresses** | [**[AddressesEventDataAllOfAddresses]**](AddressesEventDataAllOfAddresses.md) | A list of addresses. | [optional] 
 
 
@@ -28,6 +28,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)

package/docs/AppWorkflow.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**workflow_id** | **String** | The workflow id. | 
-**operation_id** | **String** | The workflow operation id. | 
-**operation_name** | **String** | The workflow operation name. | 
+**workflow_id** | **String** | The unique ID distinguishing the approval workflow instance among organizations. | 
+**operation_id** | **String** | The unique ID of the approval workflow. | 
+**operation_name** | **String** | The name of the approval workflow. | 
 **current_policies** | [**[AppWorkflowPolicy]**](AppWorkflowPolicy.md) |  | 
 
 

package/docs/AppWorkflowField.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**field** | **String** | The app workflow field name. | 
+**field** | **String** | The workflow field name. | 
 **value_type** | [**PolicyFieldValueType**](PolicyFieldValueType.md) |  | 
-**value** | **String** | The app workflow field value. | 
+**value** | **String** | The workflow field value. | 
 
 

package/docs/AppWorkflowsApi.md

@@ -6,7 +6,7 @@ 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
+[**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
 
@@ -18,7 +18,7 @@ Method | HTTP request | Description
 
 Request workflow approval
 
-This operation is request approval from app workflow with idempotency checks. 
+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
 
@@ -48,7 +48,7 @@ apiInstance.createApprovalRequest(opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **RequestApproval** | [**RequestApproval**](RequestApproval.md)| The request body to app workflow approval. | [optional] 
+ **RequestApproval** | [**RequestApproval**](RequestApproval.md)| The request body to request workflow approval. | [optional] 
 
 ### Return type
 
@@ -70,7 +70,7 @@ Name | Type | Description  | Notes
 
 Get approval request details
 
-This operation is retrieves approval request from app workflow. 
+This operation retrieves the details of a specific 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
 
@@ -98,7 +98,7 @@ apiInstance.getApprovalRequestById(approval_id).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **approval_id** | **String**| The approval ID that is used to track a workflow approval request. | 
+ **approval_id** | **String**| The system-generated unique ID of the approval request. | 
 
 ### Return type
 
@@ -118,9 +118,9 @@ Name | Type | Description  | Notes
 
 > [AppWorkflow] listAppWorkflows()
 
-list app workflows
+List app workflows
 
-This operation is list app workflows of app. 
+This operation retrieves all approval workflows of an Cobo Portal App. <Note>You need to [configure approval workflow](https://www.cobo.com/developers/v2/apps/configure-workflow) in the app Manifest file first.</Note> <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
 
@@ -166,7 +166,7 @@ This endpoint does not need any parameter.
 
 List approval requests
 
-This operation is retrieves list approval requests from app workflow. 
+This operation retrieves a list of approval requests.  <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
 
@@ -199,7 +199,7 @@ apiInstance.listApprovalRequests(operation_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **operation_id** | **String**| The operation ID that is used to track a workflow. The operation ID is provided by you and must be unique within your app. | 
+ **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] 
@@ -224,7 +224,7 @@ Name | Type | Description  | Notes
 
 Revoke approval request
 
-This operation is revoke approval request from app workflow. 
+This operation revokes a pending 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
 
@@ -255,8 +255,8 @@ apiInstance.revokeApprovalRequest(approval_id, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **approval_id** | **String**| The approval ID that is used to track a workflow approval request. | 
- **RevokeApprovalRequestRequest** | [**RevokeApprovalRequestRequest**](RevokeApprovalRequestRequest.md)| The revoke request body to app workflow approval. | [optional] 
+ **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
 

package/docs/ApprovalRequest.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**approval_id** | **String** |  | 
-**request_id** | **String** |  | 
+**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

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**approval_id** | **String** |  | [optional] 
+**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) |  | 

package/docs/ApprovalUser.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** | The approval user email. | 
-**name** | **String** | The approval user name. | [optional] 
+**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/BalanceUpdateInfo.md

@@ -0,0 +1,13 @@
+# CoboWaas2.BalanceUpdateInfo
+
+## 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). | 
+**address** | **String** | The wallet address. | 
+**wallet_uuid** | **String** | The wallet ID. | 
+**updated_timestamp** | **Number** | The time when the balance updated, in Unix timestamp format, measured in milliseconds.  | 
+**balance** | [**Balance**](Balance.md) |  | 
+
+

package/docs/BalanceUpdateInfoEventData.md

@@ -0,0 +1,47 @@
+# CoboWaas2.BalanceUpdateInfoEventData
+
+## Properties
+
+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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement 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. | 
+**updated_timestamp** | **Number** | The time when the balance updated, in Unix timestamp format, measured in milliseconds.  | 
+**balance** | [**Balance**](Balance.md) |  | 
+
+
+
+## Enum: DataTypeEnum
+
+
+* `Transaction` (value: `"Transaction"`)
+
+* `TSSRequest` (value: `"TSSRequest"`)
+
+* `Addresses` (value: `"Addresses"`)
+
+* `WalletInfo` (value: `"WalletInfo"`)
+
+* `MPCVault` (value: `"MPCVault"`)
+
+* `Chains` (value: `"Chains"`)
+
+* `Tokens` (value: `"Tokens"`)
+
+* `TokenListing` (value: `"TokenListing"`)
+
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
+* `PaymentOrder` (value: `"PaymentOrder"`)
+
+* `PaymentRefund` (value: `"PaymentRefund"`)
+
+* `PaymentSettlement` (value: `"PaymentSettlement"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/BankAccount.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **bank_account_id** | **String** | The bank account ID. | 
 **info** | **{String: Object}** | JSON-formatted bank account details. | 
-**created_timestamp** | **Number** | The created time of the bank account, represented as a UNIX timestamp in seconds. | [optional] 
-**updated_timestamp** | **Number** | The updated time of the bank account, represented as a UNIX timestamp in seconds. | [optional] 
+**created_timestamp** | **Number** | The creation time of the bank account, represented as a UNIX timestamp in seconds. | [optional] 
+**updated_timestamp** | **Number** | The last update time of the bank account, represented as a UNIX timestamp in seconds. | [optional] 
 
 

package/docs/ChainInfo.md

@@ -11,6 +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 for a coinbase transaction to be mature, such as 100 for BTC. | [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/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. | 
+**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. - `BalanceUpdateInfo`: The balance update event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. | 
 **chains** | [**[ChainInfo]**](ChainInfo.md) | The enabled chains. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | [optional] 
 **wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) |  | [optional] 
@@ -30,6 +30,8 @@ Name | Type | Description | Notes
 
 * `TokenListing` (value: `"TokenListing"`)
 
+* `BalanceUpdateInfo` (value: `"BalanceUpdateInfo"`)
+
 * `PaymentOrder` (value: `"PaymentOrder"`)
 
 * `PaymentRefund` (value: `"PaymentRefund"`)

package/docs/CreateApprovalRequest201Response.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**approval_id** | **String** |  | 
+**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. |