@cobo/cobo-waas2 1.29.0 → 1.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/README.md +24 -9
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/ComplianceApi.js +2 -2
  4. package/dist/api/GraphQLApi.js +85 -0
  5. package/dist/api/PaymentApi.js +218 -86
  6. package/dist/api/SwapsApi.js +3 -0
  7. package/dist/api/WalletsApi.js +18 -18
  8. package/dist/index.js +112 -28
  9. package/dist/model/AddressesEventData.js +8 -3
  10. package/dist/model/{AllocationRecord.js → AllocationItem.js} +42 -42
  11. package/dist/model/{AllocationRequest.js → AllocationParam.js} +33 -33
  12. package/dist/model/BalanceUpdateInfoEventData.js +8 -3
  13. package/dist/model/BatchAllocation.js +11 -11
  14. package/dist/model/BatchAllocationDetail.js +15 -17
  15. package/dist/model/BridgingFee.js +3 -3
  16. package/dist/model/ChainsEventData.js +8 -3
  17. package/dist/model/ComplianceDispositionUpdateEventData.js +8 -3
  18. package/dist/model/ComplianceKyaScreeningsUpdateEventData.js +8 -3
  19. package/dist/model/ComplianceKytScreeningsUpdateEventData.js +8 -3
  20. package/dist/model/ContractCallParams.js +1 -1
  21. package/dist/model/CreateBatchAllocationRequest.js +17 -17
  22. package/dist/model/CreateBulkSendRequest.js +167 -0
  23. package/dist/model/CreateBulkSendRequestPayoutParamsInner.js +153 -0
  24. package/dist/model/CreateKyaScreeningsBody.js +3 -3
  25. package/dist/model/CreatePaymentOrderRequest.js +7 -5
  26. package/dist/model/CreatePayoutRequest.js +33 -26
  27. package/dist/model/CreateTopUpAddresses.js +139 -0
  28. package/dist/model/CreateTopUpAddresses201Response.js +107 -0
  29. package/dist/model/{ListAllocations200Response.js → ListAllocationItems200Response.js} +22 -22
  30. package/dist/model/{ListPayoutItems200Response.js → ListBulkSendItems200Response.js} +22 -22
  31. package/dist/model/MPCVaultEventData.js +8 -3
  32. package/dist/model/OrderLinkBusinessInfo.js +10 -4
  33. package/dist/model/PaymentAddressUpdateEventData.js +8 -3
  34. package/dist/model/PaymentBulkSend.js +182 -0
  35. package/dist/model/PaymentBulkSendEvent.js +359 -0
  36. package/dist/model/PaymentBulkSendExecutionMode.js +61 -0
  37. package/dist/model/PaymentBulkSendItem.js +190 -0
  38. package/dist/model/{PaymentPayoutItemStatus.js → PaymentBulkSendItemStatus.js} +11 -11
  39. package/dist/model/PaymentBulkSendItemValidationStatus.js +66 -0
  40. package/dist/model/PaymentBulkSendStatus.js +81 -0
  41. package/dist/model/PaymentEstimateFeeRequest.js +13 -0
  42. package/dist/model/PaymentFeeType.js +15 -0
  43. package/dist/model/PaymentOrderEventData.js +8 -3
  44. package/dist/model/PaymentPayout.js +64 -46
  45. package/dist/model/PaymentPayoutDetail.js +166 -52
  46. package/dist/model/PaymentPayoutEvent.js +149 -82
  47. package/dist/model/PaymentPayoutItem.js +9 -167
  48. package/dist/model/PaymentPayoutParam.js +6 -47
  49. package/dist/model/PaymentPayoutRecipientInfo.js +126 -0
  50. package/dist/model/PaymentPayoutStatus.js +9 -4
  51. package/dist/model/PaymentRefundEventData.js +8 -3
  52. package/dist/model/PaymentSettlementEvent.js +8 -3
  53. package/dist/model/PaymentTransactionEventData.js +8 -3
  54. package/dist/model/SuspendedTokenEventData.js +8 -3
  55. package/dist/model/TSSRequestWebhookEventData.js +8 -3
  56. package/dist/model/TokenListingEventData.js +8 -3
  57. package/dist/model/TokensEventData.js +8 -3
  58. package/dist/model/TransactionCoboCategory.js +5 -0
  59. package/dist/model/TransactionExtraType.js +5 -0
  60. package/dist/model/TransactionWalletConnectInfo.js +146 -0
  61. package/dist/model/TransactionWebhookEventData.js +8 -3
  62. package/dist/model/WalletInfoEventData.js +8 -3
  63. package/dist/model/WebhookEventData.js +76 -17
  64. package/dist/model/WebhookEventDataType.js +7 -2
  65. package/dist/model/WebhookEventType.js +10 -0
  66. package/docs/AddressesEventData.md +3 -1
  67. package/docs/AllocationItem.md +15 -0
  68. package/docs/AllocationParam.md +13 -0
  69. package/docs/BalanceUpdateInfoEventData.md +3 -1
  70. package/docs/BatchAllocation.md +1 -1
  71. package/docs/BatchAllocationDetail.md +1 -1
  72. package/docs/BridgingFee.md +2 -2
  73. package/docs/ChainsEventData.md +3 -1
  74. package/docs/ComplianceApi.md +1 -1
  75. package/docs/ComplianceDispositionUpdateEventData.md +3 -1
  76. package/docs/ComplianceKyaScreeningsUpdateEventData.md +3 -1
  77. package/docs/ComplianceKytScreeningsUpdateEventData.md +3 -1
  78. package/docs/ContractCallParams.md +1 -1
  79. package/docs/CreateBatchAllocationRequest.md +1 -1
  80. package/docs/CreateBulkSendRequest.md +12 -0
  81. package/docs/CreateBulkSendRequestPayoutParamsInner.md +12 -0
  82. package/docs/CreateKyaScreeningsBody.md +1 -1
  83. package/docs/CreatePaymentOrderRequest.md +2 -2
  84. package/docs/CreatePayoutRequest.md +3 -3
  85. package/docs/CreateTopUpAddresses.md +11 -0
  86. package/docs/CreateTopUpAddresses201Response.md +9 -0
  87. package/docs/GraphQLApi.md +61 -0
  88. package/docs/{ListAllocations200Response.md → ListAllocationItems200Response.md} +2 -2
  89. package/docs/{ListPayoutItems200Response.md → ListBulkSendItems200Response.md} +2 -2
  90. package/docs/MPCVaultEventData.md +3 -1
  91. package/docs/OrderLinkBusinessInfo.md +3 -3
  92. package/docs/PaymentAddressUpdateEventData.md +3 -1
  93. package/docs/PaymentApi.md +231 -76
  94. package/docs/PaymentBulkSend.md +15 -0
  95. package/docs/PaymentBulkSendEvent.md +65 -0
  96. package/docs/PaymentBulkSendExecutionMode.md +12 -0
  97. package/docs/PaymentBulkSendItem.md +15 -0
  98. package/docs/{PaymentPayoutItemStatus.md → PaymentBulkSendItemStatus.md} +3 -3
  99. package/docs/PaymentBulkSendItemValidationStatus.md +14 -0
  100. package/docs/PaymentBulkSendStatus.md +20 -0
  101. package/docs/PaymentEstimateFeeRequest.md +1 -0
  102. package/docs/PaymentFeeType.md +6 -0
  103. package/docs/PaymentOrderEventData.md +3 -1
  104. package/docs/PaymentPayout.md +8 -7
  105. package/docs/PaymentPayoutDetail.md +10 -8
  106. package/docs/PaymentPayoutEvent.md +13 -9
  107. package/docs/PaymentPayoutItem.md +2 -13
  108. package/docs/PaymentPayoutParam.md +1 -4
  109. package/docs/PaymentPayoutRecipientInfo.md +12 -0
  110. package/docs/PaymentPayoutStatus.md +4 -2
  111. package/docs/PaymentRefundEventData.md +3 -1
  112. package/docs/PaymentSettlementEvent.md +3 -1
  113. package/docs/PaymentTransactionEventData.md +3 -1
  114. package/docs/SuspendedTokenEventData.md +3 -1
  115. package/docs/SwapsApi.md +2 -0
  116. package/docs/TSSRequestWebhookEventData.md +3 -1
  117. package/docs/TokenListingEventData.md +3 -1
  118. package/docs/TokensEventData.md +3 -1
  119. package/docs/TransactionCoboCategory.md +2 -0
  120. package/docs/TransactionExtraType.md +2 -0
  121. package/docs/TransactionWalletConnectInfo.md +12 -0
  122. package/docs/TransactionWebhookEventData.md +3 -1
  123. package/docs/WalletInfoEventData.md +3 -1
  124. package/docs/WalletsApi.md +9 -9
  125. package/docs/WebhookEventData.md +15 -8
  126. package/docs/WebhookEventDataType.md +3 -1
  127. package/docs/WebhookEventType.md +4 -0
  128. package/package.json +1 -1
  129. package/dist/model/PaymentPayoutItemDetail.js +0 -299
  130. package/docs/AllocationRecord.md +0 -15
  131. package/docs/AllocationRequest.md +0 -13
  132. package/docs/PaymentPayoutItemDetail.md +0 -22
@@ -23,13 +23,13 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
23
23
  *
24
24
  */
25
25
  /**
26
- * Enum class PaymentPayoutItemStatus.
26
+ * Enum class PaymentBulkSendItemStatus.
27
27
  * @enum {}
28
28
  * @readonly
29
29
  */
30
- var PaymentPayoutItemStatus = exports["default"] = /*#__PURE__*/function () {
31
- function PaymentPayoutItemStatus() {
32
- _classCallCheck(this, PaymentPayoutItemStatus);
30
+ var PaymentBulkSendItemStatus = exports["default"] = /*#__PURE__*/function () {
31
+ function PaymentBulkSendItemStatus() {
32
+ _classCallCheck(this, PaymentBulkSendItemStatus);
33
33
  /**
34
34
  * value: "Pending"
35
35
  * @const
@@ -46,28 +46,28 @@ var PaymentPayoutItemStatus = exports["default"] = /*#__PURE__*/function () {
46
46
  */
47
47
  _defineProperty(this, "Completed", "Completed");
48
48
  /**
49
- * value: "PartiallyCompleted"
49
+ * value: "Failed"
50
50
  * @const
51
51
  */
52
- _defineProperty(this, "PartiallyCompleted", "PartiallyCompleted");
52
+ _defineProperty(this, "Failed", "Failed");
53
53
  /**
54
- * value: "Failed"
54
+ * value: "NotExecuted"
55
55
  * @const
56
56
  */
57
- _defineProperty(this, "Failed", "Failed");
57
+ _defineProperty(this, "NotExecuted", "NotExecuted");
58
58
  /**
59
59
  * value: "unknown_default_open_api"
60
60
  * @const
61
61
  */
62
62
  _defineProperty(this, "unknown_default_open_api", "unknown_default_open_api");
63
63
  }
64
- return _createClass(PaymentPayoutItemStatus, null, [{
64
+ return _createClass(PaymentBulkSendItemStatus, null, [{
65
65
  key: "constructFromObject",
66
66
  value:
67
67
  /**
68
- * Returns a <code>PaymentPayoutItemStatus</code> enum value from a Javascript object name.
68
+ * Returns a <code>PaymentBulkSendItemStatus</code> enum value from a Javascript object name.
69
69
  * @param {Object} data The plain JavaScript object containing the name of the enum value.
70
- * @return {module:model/PaymentPayoutItemStatus} The enum <code>PaymentPayoutItemStatus</code> value.
70
+ * @return {module:model/PaymentBulkSendItemStatus} The enum <code>PaymentBulkSendItemStatus</code> value.
71
71
  */
72
72
  function constructFromObject(object) {
73
73
  return object;
@@ -0,0 +1,66 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ 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); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ 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); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ 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; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ 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); } /**
16
+ * Cobo Wallet as a Service 2.0
17
+ *
18
+ * Contact: help@cobo.com
19
+ *
20
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
21
+ * https://openapi-generator.tech
22
+ * Do not edit the class manually.
23
+ *
24
+ */
25
+ /**
26
+ * Enum class PaymentBulkSendItemValidationStatus.
27
+ * @enum {}
28
+ * @readonly
29
+ */
30
+ var PaymentBulkSendItemValidationStatus = exports["default"] = /*#__PURE__*/function () {
31
+ function PaymentBulkSendItemValidationStatus() {
32
+ _classCallCheck(this, PaymentBulkSendItemValidationStatus);
33
+ /**
34
+ * value: "Pending"
35
+ * @const
36
+ */
37
+ _defineProperty(this, "Pending", "Pending");
38
+ /**
39
+ * value: "Validated"
40
+ * @const
41
+ */
42
+ _defineProperty(this, "Validated", "Validated");
43
+ /**
44
+ * value: "ValidationFailed"
45
+ * @const
46
+ */
47
+ _defineProperty(this, "ValidationFailed", "ValidationFailed");
48
+ /**
49
+ * value: "unknown_default_open_api"
50
+ * @const
51
+ */
52
+ _defineProperty(this, "unknown_default_open_api", "unknown_default_open_api");
53
+ }
54
+ return _createClass(PaymentBulkSendItemValidationStatus, null, [{
55
+ key: "constructFromObject",
56
+ value:
57
+ /**
58
+ * Returns a <code>PaymentBulkSendItemValidationStatus</code> enum value from a Javascript object name.
59
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
60
+ * @return {module:model/PaymentBulkSendItemValidationStatus} The enum <code>PaymentBulkSendItemValidationStatus</code> value.
61
+ */
62
+ function constructFromObject(object) {
63
+ return object;
64
+ }
65
+ }]);
66
+ }();
@@ -0,0 +1,81 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ 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); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ 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); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ 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; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
15
+ 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); } /**
16
+ * Cobo Wallet as a Service 2.0
17
+ *
18
+ * Contact: help@cobo.com
19
+ *
20
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
21
+ * https://openapi-generator.tech
22
+ * Do not edit the class manually.
23
+ *
24
+ */
25
+ /**
26
+ * Enum class PaymentBulkSendStatus.
27
+ * @enum {}
28
+ * @readonly
29
+ */
30
+ var PaymentBulkSendStatus = exports["default"] = /*#__PURE__*/function () {
31
+ function PaymentBulkSendStatus() {
32
+ _classCallCheck(this, PaymentBulkSendStatus);
33
+ /**
34
+ * value: "Pending"
35
+ * @const
36
+ */
37
+ _defineProperty(this, "Pending", "Pending");
38
+ /**
39
+ * value: "Validating"
40
+ * @const
41
+ */
42
+ _defineProperty(this, "Validating", "Validating");
43
+ /**
44
+ * value: "Transferring"
45
+ * @const
46
+ */
47
+ _defineProperty(this, "Transferring", "Transferring");
48
+ /**
49
+ * value: "Completed"
50
+ * @const
51
+ */
52
+ _defineProperty(this, "Completed", "Completed");
53
+ /**
54
+ * value: "PartiallyCompleted"
55
+ * @const
56
+ */
57
+ _defineProperty(this, "PartiallyCompleted", "PartiallyCompleted");
58
+ /**
59
+ * value: "Failed"
60
+ * @const
61
+ */
62
+ _defineProperty(this, "Failed", "Failed");
63
+ /**
64
+ * value: "unknown_default_open_api"
65
+ * @const
66
+ */
67
+ _defineProperty(this, "unknown_default_open_api", "unknown_default_open_api");
68
+ }
69
+ return _createClass(PaymentBulkSendStatus, null, [{
70
+ key: "constructFromObject",
71
+ value:
72
+ /**
73
+ * Returns a <code>PaymentBulkSendStatus</code> enum value from a Javascript object name.
74
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
75
+ * @return {module:model/PaymentBulkSendStatus} The enum <code>PaymentBulkSendStatus</code> value.
76
+ */
77
+ function constructFromObject(object) {
78
+ return object;
79
+ }
80
+ }]);
81
+ }();
@@ -70,6 +70,9 @@ var PaymentEstimateFeeRequest = /*#__PURE__*/function () {
70
70
  if (data.hasOwnProperty('estimate_fees')) {
71
71
  obj['estimate_fees'] = _ApiClient["default"].convertToType(data['estimate_fees'], [_PaymentEstimateFee["default"]]);
72
72
  }
73
+ if (data.hasOwnProperty('recipient_token_id')) {
74
+ obj['recipient_token_id'] = _ApiClient["default"].convertToType(data['recipient_token_id'], 'String');
75
+ }
73
76
  }
74
77
  return obj;
75
78
  }
@@ -118,6 +121,10 @@ var PaymentEstimateFeeRequest = /*#__PURE__*/function () {
118
121
  }
119
122
  ;
120
123
  }
124
+ // ensure the json data is a string
125
+ if (data['recipient_token_id'] && !(typeof data['recipient_token_id'] === 'string' || data['recipient_token_id'] instanceof String)) {
126
+ throw new Error("Expected the field `recipient_token_id` to be a primitive type in the JSON string but got " + data['recipient_token_id']);
127
+ }
121
128
  return true;
122
129
  }
123
130
  }]);
@@ -134,4 +141,10 @@ PaymentEstimateFeeRequest.prototype['fee_type'] = undefined;
134
141
  * @member {Array.<module:model/PaymentEstimateFee>} estimate_fees
135
142
  */
136
143
  PaymentEstimateFeeRequest.prototype['estimate_fees'] = undefined;
144
+
145
+ /**
146
+ * The token ID that the recipient will receive. Required only when `fee_type` is `CryptoPayoutBridge`.
147
+ * @member {String} recipient_token_id
148
+ */
149
+ PaymentEstimateFeeRequest.prototype['recipient_token_id'] = undefined;
137
150
  var _default = exports["default"] = PaymentEstimateFeeRequest;
@@ -50,6 +50,21 @@ var PaymentFeeType = exports["default"] = /*#__PURE__*/function () {
50
50
  * @const
51
51
  */
52
52
  _defineProperty(this, "OffRampSettlement", "OffRampSettlement");
53
+ /**
54
+ * value: "CryptoPayout"
55
+ * @const
56
+ */
57
+ _defineProperty(this, "CryptoPayout", "CryptoPayout");
58
+ /**
59
+ * value: "CryptoPayoutBridge"
60
+ * @const
61
+ */
62
+ _defineProperty(this, "CryptoPayoutBridge", "CryptoPayoutBridge");
63
+ /**
64
+ * value: "OffRampPayout"
65
+ * @const
66
+ */
67
+ _defineProperty(this, "OffRampPayout", "OffRampPayout");
53
68
  /**
54
69
  * value: "unknown_default_open_api"
55
70
  * @const
@@ -39,7 +39,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
39
39
  * @alias module:model/PaymentOrderEventData
40
40
  * @implements module:model/WebhookEventDataType
41
41
  * @implements module:model/Order
42
- * @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. - `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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
42
+ * @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. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
43
43
  * @param order_id {String} The order ID.
44
44
  * @param psp_order_code {String} A unique reference code assigned by the developer to identify this order in their system.
45
45
  * @param fee_amount {String} The developer fee for the order. It is added to the base amount to determine the final charge.
@@ -290,7 +290,7 @@ var PaymentOrderEventData = /*#__PURE__*/function () {
290
290
  PaymentOrderEventData.RequiredProperties = ["data_type", "order_id", "psp_order_code", "fee_amount", "chain_id", "payable_amount", "exchange_rate", "receive_address", "status", "received_token_amount"];
291
291
 
292
292
  /**
293
- * 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
293
+ * 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
294
294
  * @member {module:model/PaymentOrderEventData.DataTypeEnum} data_type
295
295
  */
296
296
  PaymentOrderEventData.prototype['data_type'] = undefined;
@@ -433,7 +433,7 @@ PaymentOrderEventData.prototype['settlement_status'] = undefined;
433
433
 
434
434
  // Implement WebhookEventDataType interface:
435
435
  /**
436
- * 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
436
+ * 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. - `PaymentBulkSend`: The payment bulk send 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. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.
437
437
  * @member {module:model/WebhookEventDataType.DataTypeEnum} data_type
438
438
  */
439
439
  _WebhookEventDataType["default"].prototype['data_type'] = undefined;
@@ -628,6 +628,11 @@ PaymentOrderEventData['DataTypeEnum'] = {
628
628
  * @const
629
629
  */
630
630
  "PaymentPayout": "PaymentPayout",
631
+ /**
632
+ * value: "PaymentBulkSend"
633
+ * @const
634
+ */
635
+ "PaymentBulkSend": "PaymentBulkSend",
631
636
  /**
632
637
  * value: "BalanceUpdateInfo"
633
638
  * @const
@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _BankAccount = _interopRequireDefault(require("./BankAccount"));
9
8
  var _PaymentPayoutItem = _interopRequireDefault(require("./PaymentPayoutItem"));
9
+ var _PaymentPayoutRecipientInfo = _interopRequireDefault(require("./PaymentPayoutRecipientInfo"));
10
10
  var _PaymentPayoutStatus = _interopRequireDefault(require("./PaymentPayoutStatus"));
11
11
  var _PayoutChannel = _interopRequireDefault(require("./PayoutChannel"));
12
12
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
@@ -40,10 +40,12 @@ var PaymentPayout = /*#__PURE__*/function () {
40
40
  * @param request_id {String} The request ID provided by you when creating the payout.
41
41
  * @param payout_channel {module:model/PayoutChannel}
42
42
  * @param status {module:model/PaymentPayoutStatus}
43
+ * @param created_timestamp {Number} The created time of the payout, represented as a UNIX timestamp in seconds.
44
+ * @param updated_timestamp {Number} The updated time of the payout, represented as a UNIX timestamp in seconds.
43
45
  */
44
- function PaymentPayout(payout_id, request_id, payout_channel, status) {
46
+ function PaymentPayout(payout_id, request_id, payout_channel, status, created_timestamp, updated_timestamp) {
45
47
  _classCallCheck(this, PaymentPayout);
46
- PaymentPayout.initialize(this, payout_id, request_id, payout_channel, status);
48
+ PaymentPayout.initialize(this, payout_id, request_id, payout_channel, status, created_timestamp, updated_timestamp);
47
49
  }
48
50
 
49
51
  /**
@@ -53,11 +55,13 @@ var PaymentPayout = /*#__PURE__*/function () {
53
55
  */
54
56
  return _createClass(PaymentPayout, null, [{
55
57
  key: "initialize",
56
- value: function initialize(obj, payout_id, request_id, payout_channel, status) {
58
+ value: function initialize(obj, payout_id, request_id, payout_channel, status, created_timestamp, updated_timestamp) {
57
59
  obj['payout_id'] = payout_id;
58
60
  obj['request_id'] = request_id;
59
61
  obj['payout_channel'] = payout_channel;
60
62
  obj['status'] = status;
63
+ obj['created_timestamp'] = created_timestamp;
64
+ obj['updated_timestamp'] = updated_timestamp;
61
65
  }
62
66
 
63
67
  /**
@@ -81,30 +85,33 @@ var PaymentPayout = /*#__PURE__*/function () {
81
85
  if (data.hasOwnProperty('payout_channel')) {
82
86
  obj['payout_channel'] = _PayoutChannel["default"].constructFromObject(data['payout_channel']);
83
87
  }
88
+ if (data.hasOwnProperty('source_account')) {
89
+ obj['source_account'] = _ApiClient["default"].convertToType(data['source_account'], 'String');
90
+ }
84
91
  if (data.hasOwnProperty('payout_items')) {
85
92
  obj['payout_items'] = _ApiClient["default"].convertToType(data['payout_items'], [_PaymentPayoutItem["default"]]);
86
93
  }
94
+ if (data.hasOwnProperty('recipient_info')) {
95
+ obj['recipient_info'] = _PaymentPayoutRecipientInfo["default"].constructFromObject(data['recipient_info']);
96
+ }
97
+ if (data.hasOwnProperty('initiator')) {
98
+ obj['initiator'] = _ApiClient["default"].convertToType(data['initiator'], 'String');
99
+ }
100
+ if (data.hasOwnProperty('actual_payout_amount')) {
101
+ obj['actual_payout_amount'] = _ApiClient["default"].convertToType(data['actual_payout_amount'], 'String');
102
+ }
87
103
  if (data.hasOwnProperty('status')) {
88
104
  obj['status'] = _PaymentPayoutStatus["default"].constructFromObject(data['status']);
89
105
  }
106
+ if (data.hasOwnProperty('remark')) {
107
+ obj['remark'] = _ApiClient["default"].convertToType(data['remark'], 'String');
108
+ }
90
109
  if (data.hasOwnProperty('created_timestamp')) {
91
110
  obj['created_timestamp'] = _ApiClient["default"].convertToType(data['created_timestamp'], 'Number');
92
111
  }
93
112
  if (data.hasOwnProperty('updated_timestamp')) {
94
113
  obj['updated_timestamp'] = _ApiClient["default"].convertToType(data['updated_timestamp'], 'Number');
95
114
  }
96
- if (data.hasOwnProperty('initiator')) {
97
- obj['initiator'] = _ApiClient["default"].convertToType(data['initiator'], 'String');
98
- }
99
- if (data.hasOwnProperty('currency')) {
100
- obj['currency'] = _ApiClient["default"].convertToType(data['currency'], 'String');
101
- }
102
- if (data.hasOwnProperty('actual_payout_amount')) {
103
- obj['actual_payout_amount'] = _ApiClient["default"].convertToType(data['actual_payout_amount'], 'String');
104
- }
105
- if (data.hasOwnProperty('bank_account')) {
106
- obj['bank_account'] = _BankAccount["default"].constructFromObject(data['bank_account']);
107
- }
108
115
  }
109
116
  return obj;
110
117
  }
@@ -140,6 +147,10 @@ var PaymentPayout = /*#__PURE__*/function () {
140
147
  if (data['request_id'] && !(typeof data['request_id'] === 'string' || data['request_id'] instanceof String)) {
141
148
  throw new Error("Expected the field `request_id` to be a primitive type in the JSON string but got " + data['request_id']);
142
149
  }
150
+ // ensure the json data is a string
151
+ if (data['source_account'] && !(typeof data['source_account'] === 'string' || data['source_account'] instanceof String)) {
152
+ throw new Error("Expected the field `source_account` to be a primitive type in the JSON string but got " + data['source_account']);
153
+ }
143
154
  if (data['payout_items']) {
144
155
  // data not null
145
156
  // ensure the json data is an array
@@ -161,30 +172,30 @@ var PaymentPayout = /*#__PURE__*/function () {
161
172
  }
162
173
  ;
163
174
  }
175
+ // validate the optional field `recipient_info`
176
+ if (data['recipient_info']) {
177
+ // data not null
178
+ if (!!_PaymentPayoutRecipientInfo["default"].validateJSON) {
179
+ _PaymentPayoutRecipientInfo["default"].validateJSON(data['recipient_info']);
180
+ }
181
+ }
164
182
  // ensure the json data is a string
165
183
  if (data['initiator'] && !(typeof data['initiator'] === 'string' || data['initiator'] instanceof String)) {
166
184
  throw new Error("Expected the field `initiator` to be a primitive type in the JSON string but got " + data['initiator']);
167
185
  }
168
186
  // ensure the json data is a string
169
- if (data['currency'] && !(typeof data['currency'] === 'string' || data['currency'] instanceof String)) {
170
- throw new Error("Expected the field `currency` to be a primitive type in the JSON string but got " + data['currency']);
171
- }
172
- // ensure the json data is a string
173
187
  if (data['actual_payout_amount'] && !(typeof data['actual_payout_amount'] === 'string' || data['actual_payout_amount'] instanceof String)) {
174
188
  throw new Error("Expected the field `actual_payout_amount` to be a primitive type in the JSON string but got " + data['actual_payout_amount']);
175
189
  }
176
- // validate the optional field `bank_account`
177
- if (data['bank_account']) {
178
- // data not null
179
- if (!!_BankAccount["default"].validateJSON) {
180
- _BankAccount["default"].validateJSON(data['bank_account']);
181
- }
190
+ // ensure the json data is a string
191
+ if (data['remark'] && !(typeof data['remark'] === 'string' || data['remark'] instanceof String)) {
192
+ throw new Error("Expected the field `remark` to be a primitive type in the JSON string but got " + data['remark']);
182
193
  }
183
194
  return true;
184
195
  }
185
196
  }]);
186
197
  }();
187
- PaymentPayout.RequiredProperties = ["payout_id", "request_id", "payout_channel", "status"];
198
+ PaymentPayout.RequiredProperties = ["payout_id", "request_id", "payout_channel", "status", "created_timestamp", "updated_timestamp"];
188
199
 
189
200
  /**
190
201
  * The payout ID generated by Cobo.
@@ -204,47 +215,54 @@ PaymentPayout.prototype['request_id'] = undefined;
204
215
  PaymentPayout.prototype['payout_channel'] = undefined;
205
216
 
206
217
  /**
218
+ * 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\"`.
219
+ * @member {String} source_account
220
+ */
221
+ PaymentPayout.prototype['source_account'] = undefined;
222
+
223
+ /**
224
+ * required
207
225
  * @member {Array.<module:model/PaymentPayoutItem>} payout_items
208
226
  */
209
227
  PaymentPayout.prototype['payout_items'] = undefined;
210
228
 
211
229
  /**
212
- * @member {module:model/PaymentPayoutStatus} status
230
+ * @member {module:model/PaymentPayoutRecipientInfo} recipient_info
213
231
  */
214
- PaymentPayout.prototype['status'] = undefined;
232
+ PaymentPayout.prototype['recipient_info'] = undefined;
215
233
 
216
234
  /**
217
- * The created time of the payout, represented as a UNIX timestamp in seconds.
218
- * @member {Number} created_timestamp
235
+ * The initiator of this payout, usually the user's API key.
236
+ * @member {String} initiator
219
237
  */
220
- PaymentPayout.prototype['created_timestamp'] = undefined;
238
+ PaymentPayout.prototype['initiator'] = undefined;
221
239
 
222
240
  /**
223
- * The updated time of the payout, represented as a UNIX timestamp in seconds.
224
- * @member {Number} updated_timestamp
241
+ * - 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.)
242
+ * @member {String} actual_payout_amount
225
243
  */
226
- PaymentPayout.prototype['updated_timestamp'] = undefined;
244
+ PaymentPayout.prototype['actual_payout_amount'] = undefined;
227
245
 
228
246
  /**
229
- * The initiator of this payout, usually the API key used to create the payout.
230
- * @member {String} initiator
247
+ * @member {module:model/PaymentPayoutStatus} status
231
248
  */
232
- PaymentPayout.prototype['initiator'] = undefined;
249
+ PaymentPayout.prototype['status'] = undefined;
233
250
 
234
251
  /**
235
- * The fiat currency you will receive from the payout.
236
- * @member {String} currency
252
+ * A note or comment about the payout.
253
+ * @member {String} remark
237
254
  */
238
- PaymentPayout.prototype['currency'] = undefined;
255
+ PaymentPayout.prototype['remark'] = undefined;
239
256
 
240
257
  /**
241
- * The total amount of cryptocurrency actually paid out for this payout.
242
- * @member {String} actual_payout_amount
258
+ * The created time of the payout, represented as a UNIX timestamp in seconds.
259
+ * @member {Number} created_timestamp
243
260
  */
244
- PaymentPayout.prototype['actual_payout_amount'] = undefined;
261
+ PaymentPayout.prototype['created_timestamp'] = undefined;
245
262
 
246
263
  /**
247
- * @member {module:model/BankAccount} bank_account
264
+ * The updated time of the payout, represented as a UNIX timestamp in seconds.
265
+ * @member {Number} updated_timestamp
248
266
  */
249
- PaymentPayout.prototype['bank_account'] = undefined;
267
+ PaymentPayout.prototype['updated_timestamp'] = undefined;
250
268
  var _default = exports["default"] = PaymentPayout;