@cobo/cobo-waas2 1.26.0 → 1.28.0

package/dist/model/PaymentPayoutEvent.js

@@ -0,0 +1,433 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _BankAccount = _interopRequireDefault(require("./BankAccount"));
+var _PaymentPayoutDetail = _interopRequireDefault(require("./PaymentPayoutDetail"));
+var _PaymentPayoutItemDetail = _interopRequireDefault(require("./PaymentPayoutItemDetail"));
+var _PaymentPayoutStatus = _interopRequireDefault(require("./PaymentPayoutStatus"));
+var _PayoutChannel = _interopRequireDefault(require("./PayoutChannel"));
+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); }
+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 PaymentPayoutEvent model module.
+ * @module model/PaymentPayoutEvent
+ */
+var PaymentPayoutEvent = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>PaymentPayoutEvent</code>.
+   * @alias module:model/PaymentPayoutEvent
+   * @implements module:model/WebhookEventDataType
+   * @implements module:model/PaymentPayoutDetail
+   * @param data_type {module:model/PaymentPayoutEvent.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. - `PaymentPayout`: The payment payout 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 payout_id {String} The payout ID generated by Cobo.
+   * @param request_id {String} The request ID provided by you when creating the payout.
+   * @param status {module:model/PaymentPayoutStatus} 
+   */
+  function PaymentPayoutEvent(data_type, payout_id, request_id, status) {
+    _classCallCheck(this, PaymentPayoutEvent);
+    _WebhookEventDataType["default"].initialize(this, data_type);
+    _PaymentPayoutDetail["default"].initialize(this, payout_id, request_id, status);
+    PaymentPayoutEvent.initialize(this, data_type, payout_id, request_id, status);
+  }
+
+  /**
+   * 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(PaymentPayoutEvent, null, [{
+    key: "initialize",
+    value: function initialize(obj, data_type, payout_id, request_id, status) {
+      obj['data_type'] = data_type;
+      obj['payout_id'] = payout_id;
+      obj['request_id'] = request_id;
+      obj['status'] = status;
+    }
+
+    /**
+     * Constructs a <code>PaymentPayoutEvent</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/PaymentPayoutEvent} obj Optional instance to populate.
+     * @return {module:model/PaymentPayoutEvent} The populated <code>PaymentPayoutEvent</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new PaymentPayoutEvent();
+        _WebhookEventDataType["default"].constructFromObject(data, obj);
+        _PaymentPayoutDetail["default"].constructFromObject(data, obj);
+        if (data.hasOwnProperty('data_type')) {
+          obj['data_type'] = _ApiClient["default"].convertToType(data['data_type'], 'String');
+        }
+        if (data.hasOwnProperty('payout_id')) {
+          obj['payout_id'] = _ApiClient["default"].convertToType(data['payout_id'], 'String');
+        }
+        if (data.hasOwnProperty('request_id')) {
+          obj['request_id'] = _ApiClient["default"].convertToType(data['request_id'], 'String');
+        }
+        if (data.hasOwnProperty('status')) {
+          obj['status'] = _PaymentPayoutStatus["default"].constructFromObject(data['status']);
+        }
+        if (data.hasOwnProperty('payout_item_details')) {
+          obj['payout_item_details'] = _ApiClient["default"].convertToType(data['payout_item_details'], [_PaymentPayoutItemDetail["default"]]);
+        }
+        if (data.hasOwnProperty('created_timestamp')) {
+          obj['created_timestamp'] = _ApiClient["default"].convertToType(data['created_timestamp'], 'Number');
+        }
+        if (data.hasOwnProperty('updated_timestamp')) {
+          obj['updated_timestamp'] = _ApiClient["default"].convertToType(data['updated_timestamp'], 'Number');
+        }
+        if (data.hasOwnProperty('initiator')) {
+          obj['initiator'] = _ApiClient["default"].convertToType(data['initiator'], 'String');
+        }
+        if (data.hasOwnProperty('payout_channel')) {
+          obj['payout_channel'] = _PayoutChannel["default"].constructFromObject(data['payout_channel']);
+        }
+        if (data.hasOwnProperty('currency')) {
+          obj['currency'] = _ApiClient["default"].convertToType(data['currency'], 'String');
+        }
+        if (data.hasOwnProperty('actual_payout_amount')) {
+          obj['actual_payout_amount'] = _ApiClient["default"].convertToType(data['actual_payout_amount'], 'String');
+        }
+        if (data.hasOwnProperty('bank_account')) {
+          obj['bank_account'] = _BankAccount["default"].constructFromObject(data['bank_account']);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>PaymentPayoutEvent</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>PaymentPayoutEvent</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(PaymentPayoutEvent.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['data_type'] && !(typeof data['data_type'] === 'string' || data['data_type'] instanceof String)) {
+        throw new Error("Expected the field `data_type` to be a primitive type in the JSON string but got " + data['data_type']);
+      }
+      // ensure the json data is a string
+      if (data['payout_id'] && !(typeof data['payout_id'] === 'string' || data['payout_id'] instanceof String)) {
+        throw new Error("Expected the field `payout_id` to be a primitive type in the JSON string but got " + data['payout_id']);
+      }
+      // ensure the json data is a string
+      if (data['request_id'] && !(typeof data['request_id'] === 'string' || data['request_id'] instanceof String)) {
+        throw new Error("Expected the field `request_id` to be a primitive type in the JSON string but got " + data['request_id']);
+      }
+      if (data['payout_item_details']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['payout_item_details'])) {
+          throw new Error("Expected the field `payout_item_details` to be an array in the JSON data but got " + data['payout_item_details']);
+        }
+        // validate the optional field `payout_item_details` (array)
+        var _iterator2 = _createForOfIteratorHelper(data['payout_item_details']),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var item = _step2.value;
+            _PaymentPayoutItemDetail["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+        ;
+      }
+      // ensure the json data is a string
+      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['actual_payout_amount'] && !(typeof data['actual_payout_amount'] === 'string' || data['actual_payout_amount'] instanceof String)) {
+        throw new Error("Expected the field `actual_payout_amount` to be a primitive type in the JSON string but got " + data['actual_payout_amount']);
+      }
+      // 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;
+    }
+  }]);
+}();
+PaymentPayoutEvent.RequiredProperties = ["data_type", "payout_id", "request_id", "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. - `PaymentPayout`: The payment payout 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/PaymentPayoutEvent.DataTypeEnum} data_type
+ */
+PaymentPayoutEvent.prototype['data_type'] = undefined;
+
+/**
+ * The payout ID generated by Cobo.
+ * @member {String} payout_id
+ */
+PaymentPayoutEvent.prototype['payout_id'] = undefined;
+
+/**
+ * The request ID provided by you when creating the payout.
+ * @member {String} request_id
+ */
+PaymentPayoutEvent.prototype['request_id'] = undefined;
+
+/**
+ * @member {module:model/PaymentPayoutStatus} status
+ */
+PaymentPayoutEvent.prototype['status'] = undefined;
+
+/**
+ * @member {Array.<module:model/PaymentPayoutItemDetail>} payout_item_details
+ */
+PaymentPayoutEvent.prototype['payout_item_details'] = undefined;
+
+/**
+ * The created time of the payout, represented as a UNIX timestamp in seconds.
+ * @member {Number} created_timestamp
+ */
+PaymentPayoutEvent.prototype['created_timestamp'] = undefined;
+
+/**
+ * The updated time of the payout, represented as a UNIX timestamp in seconds.
+ * @member {Number} updated_timestamp
+ */
+PaymentPayoutEvent.prototype['updated_timestamp'] = undefined;
+
+/**
+ * The initiator of this payout, usually the user's API key.
+ * @member {String} initiator
+ */
+PaymentPayoutEvent.prototype['initiator'] = undefined;
+
+/**
+ * @member {module:model/PayoutChannel} payout_channel
+ */
+PaymentPayoutEvent.prototype['payout_channel'] = undefined;
+
+/**
+ * The fiat currency for the payout.
+ * @member {String} currency
+ */
+PaymentPayoutEvent.prototype['currency'] = undefined;
+
+/**
+ * The actual amount of this payout. 
+ * @member {String} actual_payout_amount
+ */
+PaymentPayoutEvent.prototype['actual_payout_amount'] = undefined;
+
+/**
+ * @member {module:model/BankAccount} bank_account
+ */
+PaymentPayoutEvent.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. - `PaymentPayout`: The payment payout 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;
+// Implement PaymentPayoutDetail interface:
+/**
+ * The payout ID generated by Cobo.
+ * @member {String} payout_id
+ */
+_PaymentPayoutDetail["default"].prototype['payout_id'] = undefined;
+/**
+ * The request ID provided by you when creating the payout.
+ * @member {String} request_id
+ */
+_PaymentPayoutDetail["default"].prototype['request_id'] = undefined;
+/**
+ * @member {module:model/PaymentPayoutStatus} status
+ */
+_PaymentPayoutDetail["default"].prototype['status'] = undefined;
+/**
+ * @member {Array.<module:model/PaymentPayoutItemDetail>} payout_item_details
+ */
+_PaymentPayoutDetail["default"].prototype['payout_item_details'] = undefined;
+/**
+ * The created time of the payout, represented as a UNIX timestamp in seconds.
+ * @member {Number} created_timestamp
+ */
+_PaymentPayoutDetail["default"].prototype['created_timestamp'] = undefined;
+/**
+ * The updated time of the payout, represented as a UNIX timestamp in seconds.
+ * @member {Number} updated_timestamp
+ */
+_PaymentPayoutDetail["default"].prototype['updated_timestamp'] = undefined;
+/**
+ * The initiator of this payout, usually the user's API key.
+ * @member {String} initiator
+ */
+_PaymentPayoutDetail["default"].prototype['initiator'] = undefined;
+/**
+ * @member {module:model/PayoutChannel} payout_channel
+ */
+_PaymentPayoutDetail["default"].prototype['payout_channel'] = undefined;
+/**
+ * The fiat currency for the payout.
+ * @member {String} currency
+ */
+_PaymentPayoutDetail["default"].prototype['currency'] = undefined;
+/**
+ * The actual amount of this payout. 
+ * @member {String} actual_payout_amount
+ */
+_PaymentPayoutDetail["default"].prototype['actual_payout_amount'] = undefined;
+/**
+ * @member {module:model/BankAccount} bank_account
+ */
+_PaymentPayoutDetail["default"].prototype['bank_account'] = undefined;
+
+/**
+ * Allowed values for the <code>data_type</code> property.
+ * @enum {String}
+ * @readonly
+ */
+PaymentPayoutEvent['DataTypeEnum'] = {
+  /**
+   * value: "Transaction"
+   * @const
+   */
+  "Transaction": "Transaction",
+  /**
+   * value: "TSSRequest"
+   * @const
+   */
+  "TSSRequest": "TSSRequest",
+  /**
+   * value: "Addresses"
+   * @const
+   */
+  "Addresses": "Addresses",
+  /**
+   * value: "WalletInfo"
+   * @const
+   */
+  "WalletInfo": "WalletInfo",
+  /**
+   * value: "MPCVault"
+   * @const
+   */
+  "MPCVault": "MPCVault",
+  /**
+   * value: "Chains"
+   * @const
+   */
+  "Chains": "Chains",
+  /**
+   * value: "Tokens"
+   * @const
+   */
+  "Tokens": "Tokens",
+  /**
+   * value: "TokenListing"
+   * @const
+   */
+  "TokenListing": "TokenListing",
+  /**
+   * value: "PaymentOrder"
+   * @const
+   */
+  "PaymentOrder": "PaymentOrder",
+  /**
+   * value: "PaymentRefund"
+   * @const
+   */
+  "PaymentRefund": "PaymentRefund",
+  /**
+   * value: "PaymentSettlement"
+   * @const
+   */
+  "PaymentSettlement": "PaymentSettlement",
+  /**
+   * value: "PaymentTransaction"
+   * @const
+   */
+  "PaymentTransaction": "PaymentTransaction",
+  /**
+   * value: "PaymentAddressUpdate"
+   * @const
+   */
+  "PaymentAddressUpdate": "PaymentAddressUpdate",
+  /**
+   * value: "PaymentPayout"
+   * @const
+   */
+  "PaymentPayout": "PaymentPayout",
+  /**
+   * value: "BalanceUpdateInfo"
+   * @const
+   */
+  "BalanceUpdateInfo": "BalanceUpdateInfo",
+  /**
+   * value: "SuspendedToken"
+   * @const
+   */
+  "SuspendedToken": "SuspendedToken",
+  /**
+   * value: "ComplianceDisposition"
+   * @const
+   */
+  "ComplianceDisposition": "ComplianceDisposition",
+  /**
+   * value: "ComplianceKytScreenings"
+   * @const
+   */
+  "ComplianceKytScreenings": "ComplianceKytScreenings",
+  /**
+   * value: "unknown_default_open_api"
+   * @const
+   */
+  "unknown_default_open_api": "unknown_default_open_api"
+};
+var _default = exports["default"] = PaymentPayoutEvent;