@cobo/cobo-waas2 1.29.0 → 1.30.0

package/dist/model/PaymentPayoutDetail.js

@@ -5,9 +5,11 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
-var _BankAccount = _interopRequireDefault(require("./BankAccount"));
-var _PaymentPayoutItemDetail = _interopRequireDefault(require("./PaymentPayoutItemDetail"));
+var _PaymentPayout = _interopRequireDefault(require("./PaymentPayout"));
+var _PaymentPayoutItem = _interopRequireDefault(require("./PaymentPayoutItem"));
+var _PaymentPayoutRecipientInfo = _interopRequireDefault(require("./PaymentPayoutRecipientInfo"));
 var _PaymentPayoutStatus = _interopRequireDefault(require("./PaymentPayoutStatus"));
+var _PaymentTransaction = _interopRequireDefault(require("./PaymentTransaction"));
 var _PayoutChannel = _interopRequireDefault(require("./PayoutChannel"));
 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); }
@@ -36,13 +38,18 @@ var PaymentPayoutDetail = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>PaymentPayoutDetail</code>.
    * @alias module:model/PaymentPayoutDetail
+   * @implements module:model/PaymentPayout
    * @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 payout_channel {module:model/PayoutChannel} 
    * @param status {module:model/PaymentPayoutStatus} 
+   * @param created_timestamp {Number} The created time of the payout, represented as a UNIX timestamp in seconds.
+   * @param updated_timestamp {Number} The updated time of the payout, represented as a UNIX timestamp in seconds.
    */
-  function PaymentPayoutDetail(payout_id, request_id, status) {
+  function PaymentPayoutDetail(payout_id, request_id, payout_channel, status, created_timestamp, updated_timestamp) {
     _classCallCheck(this, PaymentPayoutDetail);
-    PaymentPayoutDetail.initialize(this, payout_id, request_id, status);
+    _PaymentPayout["default"].initialize(this, payout_id, request_id, payout_channel, status, created_timestamp, updated_timestamp);
+    PaymentPayoutDetail.initialize(this, payout_id, request_id, payout_channel, status, created_timestamp, updated_timestamp);
   }
 
   /**
@@ -52,10 +59,13 @@ var PaymentPayoutDetail = /*#__PURE__*/function () {
    */
   return _createClass(PaymentPayoutDetail, null, [{
     key: "initialize",
-    value: function initialize(obj, payout_id, request_id, status) {
+    value: function initialize(obj, payout_id, request_id, payout_channel, status, created_timestamp, updated_timestamp) {
       obj['payout_id'] = payout_id;
       obj['request_id'] = request_id;
+      obj['payout_channel'] = payout_channel;
       obj['status'] = status;
+      obj['created_timestamp'] = created_timestamp;
+      obj['updated_timestamp'] = updated_timestamp;
     }
 
     /**
@@ -70,38 +80,45 @@ var PaymentPayoutDetail = /*#__PURE__*/function () {
     value: function constructFromObject(data, obj) {
       if (data) {
         obj = obj || new PaymentPayoutDetail();
+        _PaymentPayout["default"].constructFromObject(data, obj);
         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_channel')) {
+          obj['payout_channel'] = _PayoutChannel["default"].constructFromObject(data['payout_channel']);
         }
-        if (data.hasOwnProperty('payout_item_details')) {
-          obj['payout_item_details'] = _ApiClient["default"].convertToType(data['payout_item_details'], [_PaymentPayoutItemDetail["default"]]);
+        if (data.hasOwnProperty('source_account')) {
+          obj['source_account'] = _ApiClient["default"].convertToType(data['source_account'], 'String');
         }
-        if (data.hasOwnProperty('created_timestamp')) {
-          obj['created_timestamp'] = _ApiClient["default"].convertToType(data['created_timestamp'], 'Number');
+        if (data.hasOwnProperty('payout_items')) {
+          obj['payout_items'] = _ApiClient["default"].convertToType(data['payout_items'], [_PaymentPayoutItem["default"]]);
         }
-        if (data.hasOwnProperty('updated_timestamp')) {
-          obj['updated_timestamp'] = _ApiClient["default"].convertToType(data['updated_timestamp'], 'Number');
+        if (data.hasOwnProperty('recipient_info')) {
+          obj['recipient_info'] = _PaymentPayoutRecipientInfo["default"].constructFromObject(data['recipient_info']);
         }
         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']);
+        if (data.hasOwnProperty('status')) {
+          obj['status'] = _PaymentPayoutStatus["default"].constructFromObject(data['status']);
+        }
+        if (data.hasOwnProperty('remark')) {
+          obj['remark'] = _ApiClient["default"].convertToType(data['remark'], 'String');
+        }
+        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('transactions')) {
+          obj['transactions'] = _ApiClient["default"].convertToType(data['transactions'], [_PaymentTransaction["default"]]);
         }
       }
       return obj;
@@ -138,19 +155,23 @@ var PaymentPayoutDetail = /*#__PURE__*/function () {
       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']) {
+      // ensure the json data is a string
+      if (data['source_account'] && !(typeof data['source_account'] === 'string' || data['source_account'] instanceof String)) {
+        throw new Error("Expected the field `source_account` to be a primitive type in the JSON string but got " + data['source_account']);
+      }
+      if (data['payout_items']) {
         // 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']);
+        if (!Array.isArray(data['payout_items'])) {
+          throw new Error("Expected the field `payout_items` to be an array in the JSON data but got " + data['payout_items']);
         }
-        // validate the optional field `payout_item_details` (array)
-        var _iterator2 = _createForOfIteratorHelper(data['payout_item_details']),
+        // validate the optional field `payout_items` (array)
+        var _iterator2 = _createForOfIteratorHelper(data['payout_items']),
           _step2;
         try {
           for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
             var item = _step2.value;
-            _PaymentPayoutItemDetail["default"].validateJSON(item);
+            _PaymentPayoutItem["default"].validateJSON(item);
           }
         } catch (err) {
           _iterator2.e(err);
@@ -159,30 +180,51 @@ var PaymentPayoutDetail = /*#__PURE__*/function () {
         }
         ;
       }
+      // validate the optional field `recipient_info`
+      if (data['recipient_info']) {
+        // data not null
+        if (!!_PaymentPayoutRecipientInfo["default"].validateJSON) {
+          _PaymentPayoutRecipientInfo["default"].validateJSON(data['recipient_info']);
+        }
+      }
       // 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']) {
+      // ensure the json data is a string
+      if (data['remark'] && !(typeof data['remark'] === 'string' || data['remark'] instanceof String)) {
+        throw new Error("Expected the field `remark` to be a primitive type in the JSON string but got " + data['remark']);
+      }
+      if (data['transactions']) {
         // data not null
-        if (!!_BankAccount["default"].validateJSON) {
-          _BankAccount["default"].validateJSON(data['bank_account']);
+        // ensure the json data is an array
+        if (!Array.isArray(data['transactions'])) {
+          throw new Error("Expected the field `transactions` to be an array in the JSON data but got " + data['transactions']);
+        }
+        // validate the optional field `transactions` (array)
+        var _iterator3 = _createForOfIteratorHelper(data['transactions']),
+          _step3;
+        try {
+          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+            var _item = _step3.value;
+            _PaymentTransaction["default"].validateJSON(_item);
+          }
+        } catch (err) {
+          _iterator3.e(err);
+        } finally {
+          _iterator3.f();
         }
+        ;
       }
       return true;
     }
   }]);
 }();
-PaymentPayoutDetail.RequiredProperties = ["payout_id", "request_id", "status"];
+PaymentPayoutDetail.RequiredProperties = ["payout_id", "request_id", "payout_channel", "status", "created_timestamp", "updated_timestamp"];
 
 /**
  * The payout ID generated by Cobo.
@@ -196,15 +238,50 @@ PaymentPayoutDetail.prototype['payout_id'] = undefined;
  */
 PaymentPayoutDetail.prototype['request_id'] = undefined;
 
+/**
+ * @member {module:model/PayoutChannel} payout_channel
+ */
+PaymentPayoutDetail.prototype['payout_channel'] = undefined;
+
+/**
+ * The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. 
+ * @member {String} source_account
+ */
+PaymentPayoutDetail.prototype['source_account'] = undefined;
+
+/**
+ * required
+ * @member {Array.<module:model/PaymentPayoutItem>} payout_items
+ */
+PaymentPayoutDetail.prototype['payout_items'] = undefined;
+
+/**
+ * @member {module:model/PaymentPayoutRecipientInfo} recipient_info
+ */
+PaymentPayoutDetail.prototype['recipient_info'] = undefined;
+
+/**
+ * The initiator of this payout, usually the user's API key.
+ * @member {String} initiator
+ */
+PaymentPayoutDetail.prototype['initiator'] = undefined;
+
+/**
+ * - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) 
+ * @member {String} actual_payout_amount
+ */
+PaymentPayoutDetail.prototype['actual_payout_amount'] = undefined;
+
 /**
  * @member {module:model/PaymentPayoutStatus} status
  */
 PaymentPayoutDetail.prototype['status'] = undefined;
 
 /**
- * @member {Array.<module:model/PaymentPayoutItemDetail>} payout_item_details
+ * A note or comment about the payout.
+ * @member {String} remark
  */
-PaymentPayoutDetail.prototype['payout_item_details'] = undefined;
+PaymentPayoutDetail.prototype['remark'] = undefined;
 
 /**
  * The created time of the payout, represented as a UNIX timestamp in seconds.
@@ -219,30 +296,67 @@ PaymentPayoutDetail.prototype['created_timestamp'] = undefined;
 PaymentPayoutDetail.prototype['updated_timestamp'] = undefined;
 
 /**
- * The initiator of this payout, usually the API key used to create the payout.
- * @member {String} initiator
+ * An array of payout transactions.
+ * @member {Array.<module:model/PaymentTransaction>} transactions
  */
-PaymentPayoutDetail.prototype['initiator'] = undefined;
+PaymentPayoutDetail.prototype['transactions'] = undefined;
 
+// Implement PaymentPayout interface:
+/**
+ * The payout ID generated by Cobo.
+ * @member {String} payout_id
+ */
+_PaymentPayout["default"].prototype['payout_id'] = undefined;
+/**
+ * The request ID provided by you when creating the payout.
+ * @member {String} request_id
+ */
+_PaymentPayout["default"].prototype['request_id'] = undefined;
 /**
  * @member {module:model/PayoutChannel} payout_channel
  */
-PaymentPayoutDetail.prototype['payout_channel'] = undefined;
-
+_PaymentPayout["default"].prototype['payout_channel'] = undefined;
 /**
- * The fiat currency you will receive from the payout.
- * @member {String} currency
+ * The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. 
+ * @member {String} source_account
  */
-PaymentPayoutDetail.prototype['currency'] = undefined;
-
+_PaymentPayout["default"].prototype['source_account'] = undefined;
+/**
+ * required
+ * @member {Array.<module:model/PaymentPayoutItem>} payout_items
+ */
+_PaymentPayout["default"].prototype['payout_items'] = undefined;
+/**
+ * @member {module:model/PaymentPayoutRecipientInfo} recipient_info
+ */
+_PaymentPayout["default"].prototype['recipient_info'] = undefined;
+/**
+ * The initiator of this payout, usually the user's API key.
+ * @member {String} initiator
+ */
+_PaymentPayout["default"].prototype['initiator'] = undefined;
 /**
- * The total amount of cryptocurrency actually paid out for this payout. 
+ * - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) 
  * @member {String} actual_payout_amount
  */
-PaymentPayoutDetail.prototype['actual_payout_amount'] = undefined;
-
+_PaymentPayout["default"].prototype['actual_payout_amount'] = undefined;
 /**
- * @member {module:model/BankAccount} bank_account
+ * @member {module:model/PaymentPayoutStatus} status
+ */
+_PaymentPayout["default"].prototype['status'] = undefined;
+/**
+ * A note or comment about the payout.
+ * @member {String} remark
+ */
+_PaymentPayout["default"].prototype['remark'] = undefined;
+/**
+ * The created time of the payout, represented as a UNIX timestamp in seconds.
+ * @member {Number} created_timestamp
+ */
+_PaymentPayout["default"].prototype['created_timestamp'] = undefined;
+/**
+ * The updated time of the payout, represented as a UNIX timestamp in seconds.
+ * @member {Number} updated_timestamp
  */
-PaymentPayoutDetail.prototype['bank_account'] = undefined;
+_PaymentPayout["default"].prototype['updated_timestamp'] = undefined;
 var _default = exports["default"] = PaymentPayoutDetail;