@cobo/cobo-waas2 1.20.0 → 1.22.0

package/dist/model/PaymentAddressUpdateEventData.js

@@ -34,12 +34,12 @@ var PaymentAddressUpdateEventData = /*#__PURE__*/function () {
    * Constructs a new <code>PaymentAddressUpdateEventData</code>.
    * @alias module:model/PaymentAddressUpdateEventData
    * @implements module:model/WebhookEventDataType
-   * @param data_type {module:model/PaymentAddressUpdateEventData.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. - `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.
-   * @param custom_payer_id {String} Unique user identifier on the merchant side, used to assign a dedicated deposit address. 
-   * @param payer_id {String} Unique payer identifier on the Cobo side, auto-generated by the system. 
-   * @param chain {String} Blockchain network identifier, e.g., 'ETH' for Ethereum, 'TRON' for Tron. 
-   * @param previous_address {String} The previous deposit address that was assigned before update. 
-   * @param updated_address {String} The new updated deposit address assigned to the user. 
+   * @param data_type {module:model/PaymentAddressUpdateEventData.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. - `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.
+   * @param custom_payer_id {String} A unique identifier assigned by the developer to track and identify individual payers in their system.
+   * @param payer_id {String} A unique identifier assigned by Cobo to track and identify individual payers.
+   * @param chain {String} The chain ID.
+   * @param previous_address {String} The previous top-up address that was assigned to the payer.
+   * @param updated_address {String} The new top-up address that has been assigned to the payer.
    */
   function PaymentAddressUpdateEventData(data_type, custom_payer_id, payer_id, chain, previous_address, updated_address) {
     _classCallCheck(this, PaymentAddressUpdateEventData);
@@ -152,44 +152,44 @@ var PaymentAddressUpdateEventData = /*#__PURE__*/function () {
 PaymentAddressUpdateEventData.RequiredProperties = ["data_type", "custom_payer_id", "payer_id", "chain", "previous_address", "updated_address"];
 
 /**
- *  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.
+ *  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.
  * @member {module:model/PaymentAddressUpdateEventData.DataTypeEnum} data_type
  */
 PaymentAddressUpdateEventData.prototype['data_type'] = undefined;
 
 /**
- * Unique user identifier on the merchant side, used to assign a dedicated deposit address. 
+ * A unique identifier assigned by the developer to track and identify individual payers in their system.
  * @member {String} custom_payer_id
  */
 PaymentAddressUpdateEventData.prototype['custom_payer_id'] = undefined;
 
 /**
- * Unique payer identifier on the Cobo side, auto-generated by the system. 
+ * A unique identifier assigned by Cobo to track and identify individual payers.
  * @member {String} payer_id
  */
 PaymentAddressUpdateEventData.prototype['payer_id'] = undefined;
 
 /**
- * Blockchain network identifier, e.g., 'ETH' for Ethereum, 'TRON' for Tron. 
+ * The chain ID.
  * @member {String} chain
  */
 PaymentAddressUpdateEventData.prototype['chain'] = undefined;
 
 /**
- * The previous deposit address that was assigned before update. 
+ * The previous top-up address that was assigned to the payer.
  * @member {String} previous_address
  */
 PaymentAddressUpdateEventData.prototype['previous_address'] = undefined;
 
 /**
- * The new updated deposit address assigned to the user. 
+ * The new top-up address that has been assigned to the payer.
  * @member {String} updated_address
  */
 PaymentAddressUpdateEventData.prototype['updated_address'] = undefined;
 
 // Implement WebhookEventDataType interface:
 /**
- *  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.
+ *  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.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;

package/dist/model/PaymentOrderEventData.js

@@ -39,7 +39,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
    * @alias module:model/PaymentOrderEventData
    * @implements module:model/WebhookEventDataType
    * @implements module:model/Order
-   * @param data_type {module:model/PaymentOrderEventData.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. - `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.
+   * @param data_type {module:model/PaymentOrderEventData.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. - `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.
    * @param order_id {String} The order ID.
    * @param token_id {String}  The ID of the cryptocurrency used for payment. Supported tokens:  - 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` 
    * @param chain_id {String}  The ID of the blockchain network where the payment transaction should be made. Supported chains:  - USDC: `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` - USDT: `TRON`, `ETH`, `ARBITRUM`, `SOL`, `BASE`, `MATIC`, `BSC` 
@@ -268,7 +268,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
 PaymentOrderEventData.RequiredProperties = ["data_type", "order_id", "token_id", "chain_id", "payable_amount", "receive_address", "currency", "order_amount", "fee_amount", "exchange_rate", "psp_order_code", "status", "received_token_amount"];
 
 /**
- *  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.
+ *  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.
  * @member {module:model/PaymentOrderEventData.DataTypeEnum} data_type
  */
 PaymentOrderEventData.prototype['data_type'] = undefined;
@@ -387,7 +387,7 @@ PaymentOrderEventData.prototype['settlement_status'] = undefined;
 
 // Implement WebhookEventDataType interface:
 /**
- *  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.
+ *  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.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;

package/dist/model/PaymentRefundEventData.js

@@ -39,7 +39,7 @@ var PaymentRefundEventData = /*#__PURE__*/function () {
    * @alias module:model/PaymentRefundEventData
    * @implements module:model/WebhookEventDataType
    * @implements module:model/Refund
-   * @param data_type {module:model/PaymentRefundEventData.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. - `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.
+   * @param data_type {module:model/PaymentRefundEventData.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. - `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.
    * @param refund_id {String} The refund order ID.
    * @param token_id {String} The ID of the cryptocurrency used for refund.
    * @param chain_id {String} The ID of the blockchain network on which the refund transaction occurs.
@@ -242,7 +242,7 @@ var PaymentRefundEventData = /*#__PURE__*/function () {
 PaymentRefundEventData.RequiredProperties = ["data_type", "refund_id", "token_id", "chain_id", "amount", "to_address", "status"];
 
 /**
- *  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.
+ *  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.
  * @member {module:model/PaymentRefundEventData.DataTypeEnum} data_type
  */
 PaymentRefundEventData.prototype['data_type'] = undefined;
@@ -349,7 +349,7 @@ PaymentRefundEventData.prototype['merchant_fee_token_id'] = undefined;
 
 // Implement WebhookEventDataType interface:
 /**
- *  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.
+ *  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.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;

package/dist/model/PaymentSettlementEvent.js

@@ -5,9 +5,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _AcquiringType = _interopRequireDefault(require("./AcquiringType"));
+var _PayoutChannel = _interopRequireDefault(require("./PayoutChannel"));
 var _SettleRequestStatus = _interopRequireDefault(require("./SettleRequestStatus"));
 var _Settlement = _interopRequireDefault(require("./Settlement"));
 var _SettlementDetail = _interopRequireDefault(require("./SettlementDetail"));
+var _SettlementType = _interopRequireDefault(require("./SettlementType"));
 var _WebhookEventDataType = _interopRequireDefault(require("./WebhookEventDataType"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
@@ -38,7 +41,7 @@ var PaymentSettlementEvent = /*#__PURE__*/function () {
    * @alias module:model/PaymentSettlementEvent
    * @implements module:model/WebhookEventDataType
    * @implements module:model/Settlement
-   * @param data_type {module:model/PaymentSettlementEvent.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. - `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.
+   * @param data_type {module:model/PaymentSettlementEvent.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. - `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.
    * @param settlement_request_id {String} The settlement request ID generated by Cobo.
    * @param request_id {String} The request ID provided by you when creating the settlement request.
    * @param status {module:model/SettleRequestStatus} 
@@ -104,6 +107,15 @@ var PaymentSettlementEvent = /*#__PURE__*/function () {
         if (data.hasOwnProperty('initiator')) {
           obj['initiator'] = _ApiClient["default"].convertToType(data['initiator'], 'String');
         }
+        if (data.hasOwnProperty('acquiring_type')) {
+          obj['acquiring_type'] = _AcquiringType["default"].constructFromObject(data['acquiring_type']);
+        }
+        if (data.hasOwnProperty('payout_channel')) {
+          obj['payout_channel'] = _PayoutChannel["default"].constructFromObject(data['payout_channel']);
+        }
+        if (data.hasOwnProperty('settlement_type')) {
+          obj['settlement_type'] = _SettlementType["default"].constructFromObject(data['settlement_type']);
+        }
       }
       return obj;
     }
@@ -175,7 +187,7 @@ var PaymentSettlementEvent = /*#__PURE__*/function () {
 PaymentSettlementEvent.RequiredProperties = ["data_type", "settlement_request_id", "request_id", "status", "settlements"];
 
 /**
- *  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.
+ *  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.
  * @member {module:model/PaymentSettlementEvent.DataTypeEnum} data_type
  */
 PaymentSettlementEvent.prototype['data_type'] = undefined;
@@ -220,9 +232,24 @@ PaymentSettlementEvent.prototype['updated_timestamp'] = undefined;
  */
 PaymentSettlementEvent.prototype['initiator'] = undefined;
 
+/**
+ * @member {module:model/AcquiringType} acquiring_type
+ */
+PaymentSettlementEvent.prototype['acquiring_type'] = undefined;
+
+/**
+ * @member {module:model/PayoutChannel} payout_channel
+ */
+PaymentSettlementEvent.prototype['payout_channel'] = undefined;
+
+/**
+ * @member {module:model/SettlementType} settlement_type
+ */
+PaymentSettlementEvent.prototype['settlement_type'] = undefined;
+
 // Implement WebhookEventDataType interface:
 /**
- *  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.
+ *  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.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -260,6 +287,18 @@ _Settlement["default"].prototype['updated_timestamp'] = undefined;
  * @member {String} initiator
  */
 _Settlement["default"].prototype['initiator'] = undefined;
+/**
+ * @member {module:model/AcquiringType} acquiring_type
+ */
+_Settlement["default"].prototype['acquiring_type'] = undefined;
+/**
+ * @member {module:model/PayoutChannel} payout_channel
+ */
+_Settlement["default"].prototype['payout_channel'] = undefined;
+/**
+ * @member {module:model/SettlementType} settlement_type
+ */
+_Settlement["default"].prototype['settlement_type'] = undefined;
 
 /**
  * Allowed values for the <code>data_type</code> property.

package/dist/model/PaymentTransactionEventData.js

@@ -49,7 +49,7 @@ var PaymentTransactionEventData = /*#__PURE__*/function () {
    * @alias module:model/PaymentTransactionEventData
    * @implements module:model/WebhookEventDataType
    * @implements module:model/Transaction
-   * @param data_type {module:model/PaymentTransactionEventData.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. - `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.
+   * @param data_type {module:model/PaymentTransactionEventData.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. - `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.
    * @param transaction_id {String} The transaction ID.
    * @param wallet_id {String} For deposit transactions, this property represents the wallet ID of the transaction destination. For transactions of other types, this property represents the wallet ID of the transaction source.
    * @param status {module:model/TransactionStatus} 
@@ -378,7 +378,7 @@ var PaymentTransactionEventData = /*#__PURE__*/function () {
 PaymentTransactionEventData.RequiredProperties = ["data_type", "transaction_id", "wallet_id", "status", "source", "destination", "initiator_type", "created_timestamp", "updated_timestamp", "acquiring_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. - `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.
+ *  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.
  * @member {module:model/PaymentTransactionEventData.DataTypeEnum} data_type
  */
 PaymentTransactionEventData.prototype['data_type'] = undefined;
@@ -563,7 +563,7 @@ PaymentTransactionEventData.prototype['updated_timestamp'] = undefined;
 PaymentTransactionEventData.prototype['acquiring_type'] = undefined;
 
 /**
- * Unique identifier of a single order
+ * The pay-in order ID.
  * @member {String} order_id
  */
 PaymentTransactionEventData.prototype['order_id'] = undefined;
@@ -575,20 +575,20 @@ PaymentTransactionEventData.prototype['order_id'] = undefined;
 PaymentTransactionEventData.prototype['psp_order_code'] = undefined;
 
 /**
- * Unique payer identifier on the Cobo side, auto-generated by the system. 
+ * A unique identifier assigned by Cobo to track and identify individual payers.
  * @member {String} payer_id
  */
 PaymentTransactionEventData.prototype['payer_id'] = undefined;
 
 /**
- * Unique user identifier on the merchant side, used to assign a dedicated deposit address. 
+ * A unique identifier assigned by the developer to track and identify individual payers in their system.
  * @member {String} custom_payer_id
  */
 PaymentTransactionEventData.prototype['custom_payer_id'] = undefined;
 
 // Implement WebhookEventDataType interface:
 /**
- *  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.
+ *  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.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;

package/dist/model/PaymentWalletBalance.js

@@ -0,0 +1,177 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * Cobo Wallet as a Service 2.0
+ *
+ * Contact: help@cobo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The PaymentWalletBalance model module.
+ * @module model/PaymentWalletBalance
+ */
+var PaymentWalletBalance = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>PaymentWalletBalance</code>.
+   * @alias module:model/PaymentWalletBalance
+   * @param wallet_id {String} The unique identifier of the wallet.
+   * @param token_id {String} The ID of the cryptocurrency.
+   */
+  function PaymentWalletBalance(wallet_id, token_id) {
+    _classCallCheck(this, PaymentWalletBalance);
+    PaymentWalletBalance.initialize(this, wallet_id, token_id);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(PaymentWalletBalance, null, [{
+    key: "initialize",
+    value: function initialize(obj, wallet_id, token_id) {
+      obj['wallet_id'] = wallet_id;
+      obj['token_id'] = token_id;
+    }
+
+    /**
+     * Constructs a <code>PaymentWalletBalance</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/PaymentWalletBalance} obj Optional instance to populate.
+     * @return {module:model/PaymentWalletBalance} The populated <code>PaymentWalletBalance</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new PaymentWalletBalance();
+        if (data.hasOwnProperty('wallet_id')) {
+          obj['wallet_id'] = _ApiClient["default"].convertToType(data['wallet_id'], 'String');
+        }
+        if (data.hasOwnProperty('token_id')) {
+          obj['token_id'] = _ApiClient["default"].convertToType(data['token_id'], 'String');
+        }
+        if (data.hasOwnProperty('swept_balance')) {
+          obj['swept_balance'] = _ApiClient["default"].convertToType(data['swept_balance'], 'String');
+        }
+        if (data.hasOwnProperty('available_balance')) {
+          obj['available_balance'] = _ApiClient["default"].convertToType(data['available_balance'], 'String');
+        }
+        if (data.hasOwnProperty('total_balance')) {
+          obj['total_balance'] = _ApiClient["default"].convertToType(data['total_balance'], 'String');
+        }
+        if (data.hasOwnProperty('above_sweep_threshold_balance')) {
+          obj['above_sweep_threshold_balance'] = _ApiClient["default"].convertToType(data['above_sweep_threshold_balance'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>PaymentWalletBalance</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>PaymentWalletBalance</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(PaymentWalletBalance.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (data['wallet_id'] && !(typeof data['wallet_id'] === 'string' || data['wallet_id'] instanceof String)) {
+        throw new Error("Expected the field `wallet_id` to be a primitive type in the JSON string but got " + data['wallet_id']);
+      }
+      // ensure the json data is a string
+      if (data['token_id'] && !(typeof data['token_id'] === 'string' || data['token_id'] instanceof String)) {
+        throw new Error("Expected the field `token_id` to be a primitive type in the JSON string but got " + data['token_id']);
+      }
+      // ensure the json data is a string
+      if (data['swept_balance'] && !(typeof data['swept_balance'] === 'string' || data['swept_balance'] instanceof String)) {
+        throw new Error("Expected the field `swept_balance` to be a primitive type in the JSON string but got " + data['swept_balance']);
+      }
+      // ensure the json data is a string
+      if (data['available_balance'] && !(typeof data['available_balance'] === 'string' || data['available_balance'] instanceof String)) {
+        throw new Error("Expected the field `available_balance` to be a primitive type in the JSON string but got " + data['available_balance']);
+      }
+      // ensure the json data is a string
+      if (data['total_balance'] && !(typeof data['total_balance'] === 'string' || data['total_balance'] instanceof String)) {
+        throw new Error("Expected the field `total_balance` to be a primitive type in the JSON string but got " + data['total_balance']);
+      }
+      // ensure the json data is a string
+      if (data['above_sweep_threshold_balance'] && !(typeof data['above_sweep_threshold_balance'] === 'string' || data['above_sweep_threshold_balance'] instanceof String)) {
+        throw new Error("Expected the field `above_sweep_threshold_balance` to be a primitive type in the JSON string but got " + data['above_sweep_threshold_balance']);
+      }
+      return true;
+    }
+  }]);
+}();
+PaymentWalletBalance.RequiredProperties = ["wallet_id", "token_id"];
+
+/**
+ * The unique identifier of the wallet.
+ * @member {String} wallet_id
+ */
+PaymentWalletBalance.prototype['wallet_id'] = undefined;
+
+/**
+ * The ID of the cryptocurrency.
+ * @member {String} token_id
+ */
+PaymentWalletBalance.prototype['token_id'] = undefined;
+
+/**
+ * The payment wallet swept balance.
+ * @member {String} swept_balance
+ */
+PaymentWalletBalance.prototype['swept_balance'] = undefined;
+
+/**
+ * The payment wallet available balance.
+ * @member {String} available_balance
+ */
+PaymentWalletBalance.prototype['available_balance'] = undefined;
+
+/**
+ * The payment wallet total balance.
+ * @member {String} total_balance
+ */
+PaymentWalletBalance.prototype['total_balance'] = undefined;
+
+/**
+ * The payment wallet above sweep threshold balance.
+ * @member {String} above_sweep_threshold_balance
+ */
+PaymentWalletBalance.prototype['above_sweep_threshold_balance'] = undefined;
+var _default = exports["default"] = PaymentWalletBalance;