@cobo/cobo-waas2 1.23.0 → 1.25.0

package/dist/model/PaymentEstimatedFee.js

@@ -0,0 +1,173 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _BridgingFee = _interopRequireDefault(require("./BridgingFee"));
+var _CommissionFee = _interopRequireDefault(require("./CommissionFee"));
+var _OtcFee = _interopRequireDefault(require("./OtcFee"));
+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 PaymentEstimatedFee model module.
+ * @module model/PaymentEstimatedFee
+ */
+var PaymentEstimatedFee = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>PaymentEstimatedFee</code>.
+   * @alias module:model/PaymentEstimatedFee
+   * @param token_id {String} The token ID for which fees will be calculated.
+   * @param amount {String} The transaction amount for which fees will be calculated.
+   */
+  function PaymentEstimatedFee(token_id, amount) {
+    _classCallCheck(this, PaymentEstimatedFee);
+    PaymentEstimatedFee.initialize(this, token_id, amount);
+  }
+
+  /**
+   * 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(PaymentEstimatedFee, null, [{
+    key: "initialize",
+    value: function initialize(obj, token_id, amount) {
+      obj['token_id'] = token_id;
+      obj['amount'] = amount;
+    }
+
+    /**
+     * Constructs a <code>PaymentEstimatedFee</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/PaymentEstimatedFee} obj Optional instance to populate.
+     * @return {module:model/PaymentEstimatedFee} The populated <code>PaymentEstimatedFee</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new PaymentEstimatedFee();
+        if (data.hasOwnProperty('token_id')) {
+          obj['token_id'] = _ApiClient["default"].convertToType(data['token_id'], 'String');
+        }
+        if (data.hasOwnProperty('amount')) {
+          obj['amount'] = _ApiClient["default"].convertToType(data['amount'], 'String');
+        }
+        if (data.hasOwnProperty('commission_fee')) {
+          obj['commission_fee'] = _CommissionFee["default"].constructFromObject(data['commission_fee']);
+        }
+        if (data.hasOwnProperty('bridging_fee')) {
+          obj['bridging_fee'] = _BridgingFee["default"].constructFromObject(data['bridging_fee']);
+        }
+        if (data.hasOwnProperty('otc_fee')) {
+          obj['otc_fee'] = _OtcFee["default"].constructFromObject(data['otc_fee']);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>PaymentEstimatedFee</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>PaymentEstimatedFee</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(PaymentEstimatedFee.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['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['amount'] && !(typeof data['amount'] === 'string' || data['amount'] instanceof String)) {
+        throw new Error("Expected the field `amount` to be a primitive type in the JSON string but got " + data['amount']);
+      }
+      // validate the optional field `commission_fee`
+      if (data['commission_fee']) {
+        // data not null
+        if (!!_CommissionFee["default"].validateJSON) {
+          _CommissionFee["default"].validateJSON(data['commission_fee']);
+        }
+      }
+      // validate the optional field `bridging_fee`
+      if (data['bridging_fee']) {
+        // data not null
+        if (!!_BridgingFee["default"].validateJSON) {
+          _BridgingFee["default"].validateJSON(data['bridging_fee']);
+        }
+      }
+      // validate the optional field `otc_fee`
+      if (data['otc_fee']) {
+        // data not null
+        if (!!_OtcFee["default"].validateJSON) {
+          _OtcFee["default"].validateJSON(data['otc_fee']);
+        }
+      }
+      return true;
+    }
+  }]);
+}();
+PaymentEstimatedFee.RequiredProperties = ["token_id", "amount"];
+
+/**
+ * The token ID for which fees will be calculated.
+ * @member {String} token_id
+ */
+PaymentEstimatedFee.prototype['token_id'] = undefined;
+
+/**
+ * The transaction amount for which fees will be calculated.
+ * @member {String} amount
+ */
+PaymentEstimatedFee.prototype['amount'] = undefined;
+
+/**
+ * @member {module:model/CommissionFee} commission_fee
+ */
+PaymentEstimatedFee.prototype['commission_fee'] = undefined;
+
+/**
+ * @member {module:model/BridgingFee} bridging_fee
+ */
+PaymentEstimatedFee.prototype['bridging_fee'] = undefined;
+
+/**
+ * @member {module:model/OtcFee} otc_fee
+ */
+PaymentEstimatedFee.prototype['otc_fee'] = undefined;
+var _default = exports["default"] = PaymentEstimatedFee;

package/dist/model/PaymentFeeType.js

@@ -0,0 +1,71 @@
+"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 _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 _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, 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.
+ *
+ */
+/**
+* Enum class PaymentFeeType.
+* @enum {}
+* @readonly
+*/
+var PaymentFeeType = exports["default"] = /*#__PURE__*/function () {
+  function PaymentFeeType() {
+    _classCallCheck(this, PaymentFeeType);
+    /**
+     * value: "Order"
+     * @const
+     */
+    _defineProperty(this, "Order", "Order");
+    /**
+     * value: "Refund"
+     * @const
+     */
+    _defineProperty(this, "Refund", "Refund");
+    /**
+     * value: "CryptoSettlement"
+     * @const
+     */
+    _defineProperty(this, "CryptoSettlement", "CryptoSettlement");
+    /**
+     * value: "OffRampSettlement"
+     * @const
+     */
+    _defineProperty(this, "OffRampSettlement", "OffRampSettlement");
+    /**
+     * value: "unknown_default_open_api"
+     * @const
+     */
+    _defineProperty(this, "unknown_default_open_api", "unknown_default_open_api");
+  }
+  return _createClass(PaymentFeeType, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>PaymentFeeType</code> enum value from a Javascript object name.
+    * @param {Object} data The plain JavaScript object containing the name of the enum value.
+    * @return {module:model/PaymentFeeType} The enum <code>PaymentFeeType</code> value.
+    */
+    function constructFromObject(object) {
+      return object;
+    }
+  }]);
+}();

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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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` 
@@ -157,6 +157,9 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
         if (data.hasOwnProperty('settlement_status')) {
           obj['settlement_status'] = _SettleStatus["default"].constructFromObject(data['settlement_status']);
         }
+        if (data.hasOwnProperty('amount_tolerance')) {
+          obj['amount_tolerance'] = _ApiClient["default"].convertToType(data['amount_tolerance'], 'String');
+        }
       }
       return obj;
     }
@@ -261,6 +264,10 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
         }
         ;
       }
+      // ensure the json data is a string
+      if (data['amount_tolerance'] && !(typeof data['amount_tolerance'] === 'string' || data['amount_tolerance'] instanceof String)) {
+        throw new Error("Expected the field `amount_tolerance` to be a primitive type in the JSON string but got " + data['amount_tolerance']);
+      }
       return true;
     }
   }]);
@@ -268,7 +275,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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data.
  * @member {module:model/PaymentOrderEventData.DataTypeEnum} data_type
  */
 PaymentOrderEventData.prototype['data_type'] = undefined;
@@ -385,9 +392,15 @@ PaymentOrderEventData.prototype['transactions'] = undefined;
  */
 PaymentOrderEventData.prototype['settlement_status'] = undefined;
 
+/**
+ * Allowed amount deviation.
+ * @member {String} amount_tolerance
+ */
+PaymentOrderEventData.prototype['amount_tolerance'] = 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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -485,6 +498,11 @@ _Order["default"].prototype['transactions'] = undefined;
  * @member {module:model/SettleStatus} settlement_status
  */
 _Order["default"].prototype['settlement_status'] = undefined;
+/**
+ * Allowed amount deviation.
+ * @member {String} amount_tolerance
+ */
+_Order["default"].prototype['amount_tolerance'] = undefined;
 
 /**
  * Allowed values for the <code>data_type</code> property.
@@ -572,6 +590,11 @@ PaymentOrderEventData['DataTypeEnum'] = {
    * @const
    */
   "ComplianceDisposition": "ComplianceDisposition",
+  /**
+   * value: "ComplianceKytScreenings"
+   * @const
+   */
+  "ComplianceKytScreenings": "ComplianceKytScreenings",
   /**
    * value: "unknown_default_open_api"
    * @const

package/dist/model/PaymentRefundEventData.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _CommissionFee = _interopRequireDefault(require("./CommissionFee"));
 var _PaymentTransaction = _interopRequireDefault(require("./PaymentTransaction"));
 var _Refund = _interopRequireDefault(require("./Refund"));
 var _RefundStatus = _interopRequireDefault(require("./RefundStatus"));
@@ -39,7 +40,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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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.
@@ -139,6 +140,9 @@ var PaymentRefundEventData = /*#__PURE__*/function () {
         if (data.hasOwnProperty('merchant_fee_token_id')) {
           obj['merchant_fee_token_id'] = _ApiClient["default"].convertToType(data['merchant_fee_token_id'], 'String');
         }
+        if (data.hasOwnProperty('commission_fee')) {
+          obj['commission_fee'] = _CommissionFee["default"].constructFromObject(data['commission_fee']);
+        }
       }
       return obj;
     }
@@ -235,6 +239,13 @@ var PaymentRefundEventData = /*#__PURE__*/function () {
       if (data['merchant_fee_token_id'] && !(typeof data['merchant_fee_token_id'] === 'string' || data['merchant_fee_token_id'] instanceof String)) {
         throw new Error("Expected the field `merchant_fee_token_id` to be a primitive type in the JSON string but got " + data['merchant_fee_token_id']);
       }
+      // validate the optional field `commission_fee`
+      if (data['commission_fee']) {
+        // data not null
+        if (!!_CommissionFee["default"].validateJSON) {
+          _CommissionFee["default"].validateJSON(data['commission_fee']);
+        }
+      }
       return true;
     }
   }]);
@@ -242,7 +253,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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data.
  * @member {module:model/PaymentRefundEventData.DataTypeEnum} data_type
  */
 PaymentRefundEventData.prototype['data_type'] = undefined;
@@ -318,7 +329,7 @@ PaymentRefundEventData.prototype['created_timestamp'] = undefined;
 PaymentRefundEventData.prototype['updated_timestamp'] = undefined;
 
 /**
- *  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. 
+ *  The initiator of this settlement request. Can return either an API key or the Payments App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. 
  * @member {String} initiator
  */
 PaymentRefundEventData.prototype['initiator'] = undefined;
@@ -347,9 +358,14 @@ PaymentRefundEventData.prototype['merchant_fee_amount'] = undefined;
  */
 PaymentRefundEventData.prototype['merchant_fee_token_id'] = undefined;
 
+/**
+ * @member {module:model/CommissionFee} commission_fee
+ */
+PaymentRefundEventData.prototype['commission_fee'] = 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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -413,7 +429,7 @@ _Refund["default"].prototype['created_timestamp'] = undefined;
  */
 _Refund["default"].prototype['updated_timestamp'] = undefined;
 /**
- *  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. 
+ *  The initiator of this settlement request. Can return either an API key or the Payments App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. 
  * @member {String} initiator
  */
 _Refund["default"].prototype['initiator'] = undefined;
@@ -437,6 +453,10 @@ _Refund["default"].prototype['merchant_fee_amount'] = undefined;
  * @member {String} merchant_fee_token_id
  */
 _Refund["default"].prototype['merchant_fee_token_id'] = undefined;
+/**
+ * @member {module:model/CommissionFee} commission_fee
+ */
+_Refund["default"].prototype['commission_fee'] = undefined;
 
 /**
  * Allowed values for the <code>data_type</code> property.
@@ -524,6 +544,11 @@ PaymentRefundEventData['DataTypeEnum'] = {
    * @const
    */
   "ComplianceDisposition": "ComplianceDisposition",
+  /**
+   * value: "ComplianceKytScreenings"
+   * @const
+   */
+  "ComplianceKytScreenings": "ComplianceKytScreenings",
   /**
    * value: "unknown_default_open_api"
    * @const

package/dist/model/PaymentSettlementEvent.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _AcquiringType = _interopRequireDefault(require("./AcquiringType"));
+var _BankAccount = _interopRequireDefault(require("./BankAccount"));
 var _PayoutChannel = _interopRequireDefault(require("./PayoutChannel"));
 var _SettleRequestStatus = _interopRequireDefault(require("./SettleRequestStatus"));
 var _Settlement = _interopRequireDefault(require("./Settlement"));
@@ -41,7 +42,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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings 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} 
@@ -116,6 +117,15 @@ var PaymentSettlementEvent = /*#__PURE__*/function () {
         if (data.hasOwnProperty('settlement_type')) {
           obj['settlement_type'] = _SettlementType["default"].constructFromObject(data['settlement_type']);
         }
+        if (data.hasOwnProperty('currency')) {
+          obj['currency'] = _ApiClient["default"].convertToType(data['currency'], 'String');
+        }
+        if (data.hasOwnProperty('received_amount_fiat')) {
+          obj['received_amount_fiat'] = _ApiClient["default"].convertToType(data['received_amount_fiat'], 'String');
+        }
+        if (data.hasOwnProperty('bank_account')) {
+          obj['bank_account'] = _BankAccount["default"].constructFromObject(data['bank_account']);
+        }
       }
       return obj;
     }
@@ -180,6 +190,21 @@ var PaymentSettlementEvent = /*#__PURE__*/function () {
       if (data['initiator'] && !(typeof data['initiator'] === 'string' || data['initiator'] instanceof String)) {
         throw new Error("Expected the field `initiator` to be a primitive type in the JSON string but got " + data['initiator']);
       }
+      // ensure the json data is a string
+      if (data['currency'] && !(typeof data['currency'] === 'string' || data['currency'] instanceof String)) {
+        throw new Error("Expected the field `currency` to be a primitive type in the JSON string but got " + data['currency']);
+      }
+      // ensure the json data is a string
+      if (data['received_amount_fiat'] && !(typeof data['received_amount_fiat'] === 'string' || data['received_amount_fiat'] instanceof String)) {
+        throw new Error("Expected the field `received_amount_fiat` to be a primitive type in the JSON string but got " + data['received_amount_fiat']);
+      }
+      // validate the optional field `bank_account`
+      if (data['bank_account']) {
+        // data not null
+        if (!!_BankAccount["default"].validateJSON) {
+          _BankAccount["default"].validateJSON(data['bank_account']);
+        }
+      }
       return true;
     }
   }]);
@@ -187,7 +212,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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data.
  * @member {module:model/PaymentSettlementEvent.DataTypeEnum} data_type
  */
 PaymentSettlementEvent.prototype['data_type'] = undefined;
@@ -215,19 +240,19 @@ PaymentSettlementEvent.prototype['status'] = undefined;
 PaymentSettlementEvent.prototype['settlements'] = undefined;
 
 /**
- * The creation time of the settlement request, represented as a UNIX timestamp in seconds.
+ * The created time of the settlement request, represented as a UNIX timestamp in seconds.
  * @member {Number} created_timestamp
  */
 PaymentSettlementEvent.prototype['created_timestamp'] = undefined;
 
 /**
- * The last update time of the settlement request, represented as a UNIX timestamp in seconds.
+ * The updated time of the settlement request, represented as a UNIX timestamp in seconds.
  * @member {Number} updated_timestamp
  */
 PaymentSettlementEvent.prototype['updated_timestamp'] = undefined;
 
 /**
- *  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. 
+ *  The initiator of this settlement request. Can return either an API key or the Payments App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. 
  * @member {String} initiator
  */
 PaymentSettlementEvent.prototype['initiator'] = undefined;
@@ -247,9 +272,26 @@ PaymentSettlementEvent.prototype['payout_channel'] = undefined;
  */
 PaymentSettlementEvent.prototype['settlement_type'] = undefined;
 
+/**
+ * The fiat currency for the off-ramp.
+ * @member {String} currency
+ */
+PaymentSettlementEvent.prototype['currency'] = undefined;
+
+/**
+ * The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees.
+ * @member {String} received_amount_fiat
+ */
+PaymentSettlementEvent.prototype['received_amount_fiat'] = undefined;
+
+/**
+ * @member {module:model/BankAccount} bank_account
+ */
+PaymentSettlementEvent.prototype['bank_account'] = 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 top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition 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. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data.
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
  */
 _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -273,17 +315,17 @@ _Settlement["default"].prototype['status'] = undefined;
  */
 _Settlement["default"].prototype['settlements'] = undefined;
 /**
- * The creation time of the settlement request, represented as a UNIX timestamp in seconds.
+ * The created time of the settlement request, represented as a UNIX timestamp in seconds.
  * @member {Number} created_timestamp
  */
 _Settlement["default"].prototype['created_timestamp'] = undefined;
 /**
- * The last update time of the settlement request, represented as a UNIX timestamp in seconds.
+ * The updated time of the settlement request, represented as a UNIX timestamp in seconds.
  * @member {Number} updated_timestamp
  */
 _Settlement["default"].prototype['updated_timestamp'] = undefined;
 /**
- *  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. 
+ *  The initiator of this settlement request. Can return either an API key or the Payments App's ID.  - Format `api_key_<API_KEY>`: Indicates the settlement request was initiated via the Payments API using the API key. - Format `app_<APP_ID>`: Indicates the settlement request was initiated through the Payments App using the App ID. 
  * @member {String} initiator
  */
 _Settlement["default"].prototype['initiator'] = undefined;
@@ -299,6 +341,20 @@ _Settlement["default"].prototype['payout_channel'] = undefined;
  * @member {module:model/SettlementType} settlement_type
  */
 _Settlement["default"].prototype['settlement_type'] = undefined;
+/**
+ * The fiat currency for the off-ramp.
+ * @member {String} currency
+ */
+_Settlement["default"].prototype['currency'] = undefined;
+/**
+ * The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees.
+ * @member {String} received_amount_fiat
+ */
+_Settlement["default"].prototype['received_amount_fiat'] = undefined;
+/**
+ * @member {module:model/BankAccount} bank_account
+ */
+_Settlement["default"].prototype['bank_account'] = undefined;
 
 /**
  * Allowed values for the <code>data_type</code> property.
@@ -386,6 +442,11 @@ PaymentSettlementEvent['DataTypeEnum'] = {
    * @const
    */
   "ComplianceDisposition": "ComplianceDisposition",
+  /**
+   * value: "ComplianceKytScreenings"
+   * @const
+   */
+  "ComplianceKytScreenings": "ComplianceKytScreenings",
   /**
    * value: "unknown_default_open_api"
    * @const