@cobo/cobo-waas2 1.22.0 → 1.23.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.
- package/README.md +39 -14
- package/dist/ApiClient.js +1 -1
- package/dist/api/AddressBooksApi.js +200 -21
- package/dist/api/AutoSweepApi.js +26 -26
- package/dist/api/ComplianceApi.js +214 -0
- package/dist/api/PaymentApi.js +16 -16
- package/dist/api/TokenizationApi.js +2 -2
- package/dist/api/TransactionsApi.js +16 -16
- package/dist/api/WalletsApi.js +4 -4
- package/dist/api/WalletsMPCWalletsApi.js +2 -2
- package/dist/index.js +105 -7
- package/dist/model/AddressBook.js +12 -12
- package/dist/model/AddressesEventData.js +8 -3
- package/dist/model/ApprovalDetail.js +4 -4
- package/dist/model/ApprovalResult.js +6 -11
- package/dist/model/ApprovalTemplate.js +4 -4
- package/dist/model/ApprovalTransactionResult.js +8 -8
- package/dist/model/ApprovalUserDetail.js +95 -24
- package/dist/model/AutoSweepTask.js +9 -9
- package/dist/model/BalanceUpdateInfoEventData.js +8 -3
- package/dist/model/ChainInfo.js +14 -1
- package/dist/model/ChainsEventData.js +8 -3
- package/dist/model/ComplianceDispositionUpdateEventData.js +321 -0
- package/dist/model/CreateAddressBookParam.js +165 -0
- package/dist/model/CreateAddressBooks201Response.js +107 -0
- package/dist/model/CreateAddressBooksParam.js +128 -0
- package/dist/model/CreateAutoSweepTask.js +5 -5
- package/dist/model/CreateCustodialWalletParams.js +1 -1
- package/dist/model/CreateExchangeWalletParams.js +2 -2
- package/dist/model/CreateMerchantRequest.js +1 -1
- package/dist/model/CreateMpcWalletParams.js +2 -2
- package/dist/model/CreatePaymentOrderRequest.js +3 -3
- package/dist/model/CreateRefundRequest.js +2 -2
- package/dist/model/CreateSafeWalletParams.js +1 -1
- package/dist/model/CreateSettlement.js +1 -1
- package/dist/model/CreateSmartContractWalletParams.js +1 -1
- package/dist/model/CreateSweepToAddress.js +1 -1
- package/dist/model/CreateWalletParams.js +1 -1
- package/dist/model/DeleteAddressBookById201Response.js +106 -0
- package/dist/model/DispositionEventData.js +170 -0
- package/dist/model/DispositionQueryResponse.js +146 -0
- package/dist/model/DispositionResponse.js +122 -0
- package/dist/model/DispositionStatus.js +116 -0
- package/dist/model/DispositionType.js +66 -0
- package/dist/model/IsolateDisposition.js +167 -0
- package/dist/model/MPCVaultEventData.js +8 -3
- package/dist/model/Merchant.js +1 -1
- package/dist/model/MerchantBalance.js +7 -7
- package/dist/model/OrgInfo.js +9 -0
- package/dist/model/PaymentAddressUpdateEventData.js +8 -3
- package/dist/model/PaymentOrderEventData.js +8 -3
- package/dist/model/PaymentRefundEventData.js +8 -3
- package/dist/model/PaymentSettlementEvent.js +8 -3
- package/dist/model/PaymentTransactionEventData.js +8 -3
- package/dist/model/PaymentWalletBalance.js +6 -6
- package/dist/model/PspBalance.js +7 -7
- package/dist/model/ReceivedAmountPerAddress.js +5 -5
- package/dist/model/RefundDisposition.js +167 -0
- package/dist/model/RoleDetail.js +41 -6
- package/dist/model/SuspendedTokenEventData.js +8 -3
- package/dist/model/SweepToAddress.js +1 -1
- package/dist/model/TSSRequestWebhookEventData.js +8 -3
- package/dist/model/TokenListingEventData.js +8 -3
- package/dist/model/TokensEventData.js +8 -3
- package/dist/model/TransactionWebhookEventData.js +8 -3
- package/dist/model/UnfreezeDisposition.js +111 -0
- package/dist/model/UpdateAddressBookParam.js +150 -0
- package/dist/model/UpdateMerchantByIdRequest.js +1 -1
- package/dist/model/WalletInfoEventData.js +8 -3
- package/dist/model/WebhookEventData.js +62 -10
- package/dist/model/WebhookEventDataType.js +7 -2
- package/dist/model/WebhookEventType.js +5 -0
- package/docs/AddressBook.md +7 -7
- package/docs/AddressBooksApi.md +218 -8
- package/docs/AddressesEventData.md +3 -1
- package/docs/ApprovalDetail.md +3 -3
- package/docs/ApprovalResult.md +3 -5
- package/docs/ApprovalTemplate.md +3 -3
- package/docs/ApprovalTransactionResult.md +4 -4
- package/docs/ApprovalUserDetail.md +15 -9
- package/docs/AutoSweepApi.md +18 -18
- package/docs/AutoSweepTask.md +5 -5
- package/docs/BalanceUpdateInfoEventData.md +3 -1
- package/docs/ChainInfo.md +2 -1
- package/docs/ChainsEventData.md +3 -1
- package/docs/ComplianceApi.md +218 -0
- package/docs/ComplianceDispositionUpdateEventData.md +56 -0
- package/docs/CreateAddressBookParam.md +13 -0
- package/docs/CreateAddressBooks201Response.md +9 -0
- package/docs/CreateAddressBooksParam.md +9 -0
- package/docs/CreateAutoSweepTask.md +2 -2
- package/docs/CreateCustodialWalletParams.md +1 -1
- package/docs/CreateExchangeWalletParams.md +1 -1
- package/docs/CreateMerchantRequest.md +1 -1
- package/docs/CreateMpcWalletParams.md +1 -1
- package/docs/CreatePaymentOrderRequest.md +2 -2
- package/docs/CreateRefundRequest.md +1 -1
- package/docs/CreateSafeWalletParams.md +1 -1
- package/docs/CreateSettlement.md +1 -1
- package/docs/CreateSmartContractWalletParams.md +1 -1
- package/docs/CreateWalletParams.md +1 -1
- package/docs/DeleteAddressBookById201Response.md +9 -0
- package/docs/DispositionEventData.md +14 -0
- package/docs/DispositionQueryResponse.md +12 -0
- package/docs/DispositionResponse.md +10 -0
- package/docs/DispositionStatus.md +34 -0
- package/docs/DispositionType.md +14 -0
- package/docs/IsolateDisposition.md +13 -0
- package/docs/MPCVaultEventData.md +3 -1
- package/docs/Merchant.md +1 -1
- package/docs/MerchantBalance.md +6 -6
- package/docs/OrgInfo.md +1 -0
- package/docs/PaymentAddressUpdateEventData.md +3 -1
- package/docs/PaymentApi.md +10 -10
- package/docs/PaymentOrderEventData.md +3 -1
- package/docs/PaymentRefundEventData.md +3 -1
- package/docs/PaymentSettlementEvent.md +3 -1
- package/docs/PaymentTransactionEventData.md +3 -1
- package/docs/PaymentWalletBalance.md +5 -5
- package/docs/PspBalance.md +6 -6
- package/docs/ReceivedAmountPerAddress.md +2 -2
- package/docs/RefundDisposition.md +13 -0
- package/docs/RoleDetail.md +4 -1
- package/docs/SuspendedTokenEventData.md +3 -1
- package/docs/TSSRequestWebhookEventData.md +3 -1
- package/docs/TokenListingEventData.md +3 -1
- package/docs/TokenizationApi.md +2 -2
- package/docs/TokensEventData.md +3 -1
- package/docs/TransactionWebhookEventData.md +3 -1
- package/docs/TransactionsApi.md +10 -10
- package/docs/UnfreezeDisposition.md +9 -0
- package/docs/UpdateAddressBookParam.md +12 -0
- package/docs/UpdateMerchantByIdRequest.md +1 -1
- package/docs/WalletInfoEventData.md +3 -1
- package/docs/WalletsApi.md +2 -2
- package/docs/WalletsMPCWalletsApi.md +1 -1
- package/docs/WebhookEventData.md +8 -2
- package/docs/WebhookEventDataType.md +3 -1
- package/docs/WebhookEventType.md +2 -0
- package/package.json +1 -1
- package/dist/model/ApprovalShowInfo.js +0 -140
- package/docs/ApprovalShowInfo.md +0 -13
|
@@ -0,0 +1,214 @@
|
|
|
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
|
+
var _DispositionQueryResponse = _interopRequireDefault(require("../model/DispositionQueryResponse"));
|
|
9
|
+
var _DispositionResponse = _interopRequireDefault(require("../model/DispositionResponse"));
|
|
10
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
11
|
+
var _IsolateDisposition = _interopRequireDefault(require("../model/IsolateDisposition"));
|
|
12
|
+
var _RefundDisposition = _interopRequireDefault(require("../model/RefundDisposition"));
|
|
13
|
+
var _UnfreezeDisposition = _interopRequireDefault(require("../model/UnfreezeDisposition"));
|
|
14
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
15
|
+
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); }
|
|
16
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
17
|
+
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); } }
|
|
18
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
19
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
20
|
+
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); } /**
|
|
21
|
+
* Cobo Wallet as a Service 2.0
|
|
22
|
+
*
|
|
23
|
+
* Contact: help@cobo.com
|
|
24
|
+
*
|
|
25
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
26
|
+
* https://openapi-generator.tech
|
|
27
|
+
* Do not edit the class manually.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
/**
|
|
31
|
+
* Compliance service.
|
|
32
|
+
* @module api/ComplianceApi
|
|
33
|
+
*/
|
|
34
|
+
var ComplianceApi = exports["default"] = /*#__PURE__*/function () {
|
|
35
|
+
/**
|
|
36
|
+
* Constructs a new ComplianceApi.
|
|
37
|
+
* @alias module:api/ComplianceApi
|
|
38
|
+
* @class
|
|
39
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
40
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
41
|
+
*/
|
|
42
|
+
function ComplianceApi(apiClient) {
|
|
43
|
+
_classCallCheck(this, ComplianceApi);
|
|
44
|
+
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Get disposition status
|
|
49
|
+
* This operation retrieves the current status of a disposition request for a specific transaction. You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze) that has been initiated for a transaction. The response includes the disposition type, current status, and the disposition transaction ID if applicable. <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note>
|
|
50
|
+
* @param {String} transaction_id The UUID of the transaction to query for disposition status.
|
|
51
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionQueryResponse} and HTTP response
|
|
52
|
+
*/
|
|
53
|
+
return _createClass(ComplianceApi, [{
|
|
54
|
+
key: "getDispositionStatusWithHttpInfo",
|
|
55
|
+
value: function getDispositionStatusWithHttpInfo(transaction_id) {
|
|
56
|
+
var postBody = null;
|
|
57
|
+
if (postBody && postBody.toJSON) {
|
|
58
|
+
postBody = postBody.toJSON();
|
|
59
|
+
}
|
|
60
|
+
// verify the required parameter 'transaction_id' is set
|
|
61
|
+
if (transaction_id === undefined || transaction_id === null) {
|
|
62
|
+
throw new Error("Missing the required parameter 'transaction_id' when calling getDispositionStatus");
|
|
63
|
+
}
|
|
64
|
+
var pathParams = {};
|
|
65
|
+
var queryParams = {
|
|
66
|
+
'transaction_id': transaction_id
|
|
67
|
+
};
|
|
68
|
+
var headerParams = {};
|
|
69
|
+
var formParams = {};
|
|
70
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
71
|
+
var contentTypes = [];
|
|
72
|
+
var accepts = ['application/json'];
|
|
73
|
+
var returnType = _DispositionQueryResponse["default"];
|
|
74
|
+
return this.apiClient.callApi('/compliance/funds/disposition', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Get disposition status
|
|
79
|
+
* This operation retrieves the current status of a disposition request for a specific transaction. You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze) that has been initiated for a transaction. The response includes the disposition type, current status, and the disposition transaction ID if applicable. <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note>
|
|
80
|
+
* @param {String} transaction_id The UUID of the transaction to query for disposition status.
|
|
81
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionQueryResponse}
|
|
82
|
+
*/
|
|
83
|
+
}, {
|
|
84
|
+
key: "getDispositionStatus",
|
|
85
|
+
value: function getDispositionStatus(transaction_id) {
|
|
86
|
+
return this.getDispositionStatusWithHttpInfo(transaction_id).then(function (response_and_data) {
|
|
87
|
+
return response_and_data.data;
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Isolate funds
|
|
93
|
+
* This operation creates a request to isolate funds for a specific transaction. The funds will be sent to a designated isolation address for compliance purposes. You need to specify the transaction ID to be isolated and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The isolation will initiate a withdrawal transaction from the compliance-managed address to the specified isolation address.</Note>
|
|
94
|
+
* @param {Object} opts Optional parameters
|
|
95
|
+
* @param {module:model/IsolateDisposition} [IsolateDisposition] The request body to isolate funds.
|
|
96
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionResponse} and HTTP response
|
|
97
|
+
*/
|
|
98
|
+
}, {
|
|
99
|
+
key: "isolateFundsWithHttpInfo",
|
|
100
|
+
value: function isolateFundsWithHttpInfo(opts) {
|
|
101
|
+
opts = opts || {};
|
|
102
|
+
var postBody = opts['IsolateDisposition'];
|
|
103
|
+
if (postBody && postBody.toJSON) {
|
|
104
|
+
postBody = postBody.toJSON();
|
|
105
|
+
}
|
|
106
|
+
var pathParams = {};
|
|
107
|
+
var queryParams = {};
|
|
108
|
+
var headerParams = {};
|
|
109
|
+
var formParams = {};
|
|
110
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
111
|
+
var contentTypes = ['application/json'];
|
|
112
|
+
var accepts = ['application/json'];
|
|
113
|
+
var returnType = _DispositionResponse["default"];
|
|
114
|
+
return this.apiClient.callApi('/compliance/funds/disposition/isolate', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* Isolate funds
|
|
119
|
+
* This operation creates a request to isolate funds for a specific transaction. The funds will be sent to a designated isolation address for compliance purposes. You need to specify the transaction ID to be isolated and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The isolation will initiate a withdrawal transaction from the compliance-managed address to the specified isolation address.</Note>
|
|
120
|
+
* @param {Object} opts Optional parameters
|
|
121
|
+
* @param {module:model/IsolateDisposition} opts.IsolateDisposition The request body to isolate funds.
|
|
122
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionResponse}
|
|
123
|
+
*/
|
|
124
|
+
}, {
|
|
125
|
+
key: "isolateFunds",
|
|
126
|
+
value: function isolateFunds(opts) {
|
|
127
|
+
return this.isolateFundsWithHttpInfo(opts).then(function (response_and_data) {
|
|
128
|
+
return response_and_data.data;
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Refund funds
|
|
134
|
+
* This operation creates a request to refund funds for a specific transaction. The funds will be sent to the specified destination address. You need to specify the transaction ID to be refunded and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The refund will initiate a withdrawal transaction from the compliance-managed address to the specified destination.</Note>
|
|
135
|
+
* @param {Object} opts Optional parameters
|
|
136
|
+
* @param {module:model/RefundDisposition} [RefundDisposition] The request body to refund funds.
|
|
137
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionResponse} and HTTP response
|
|
138
|
+
*/
|
|
139
|
+
}, {
|
|
140
|
+
key: "refundFundsWithHttpInfo",
|
|
141
|
+
value: function refundFundsWithHttpInfo(opts) {
|
|
142
|
+
opts = opts || {};
|
|
143
|
+
var postBody = opts['RefundDisposition'];
|
|
144
|
+
if (postBody && postBody.toJSON) {
|
|
145
|
+
postBody = postBody.toJSON();
|
|
146
|
+
}
|
|
147
|
+
var pathParams = {};
|
|
148
|
+
var queryParams = {};
|
|
149
|
+
var headerParams = {};
|
|
150
|
+
var formParams = {};
|
|
151
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
152
|
+
var contentTypes = ['application/json'];
|
|
153
|
+
var accepts = ['application/json'];
|
|
154
|
+
var returnType = _DispositionResponse["default"];
|
|
155
|
+
return this.apiClient.callApi('/compliance/funds/disposition/refund', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* Refund funds
|
|
160
|
+
* This operation creates a request to refund funds for a specific transaction. The funds will be sent to the specified destination address. You need to specify the transaction ID to be refunded and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The refund will initiate a withdrawal transaction from the compliance-managed address to the specified destination.</Note>
|
|
161
|
+
* @param {Object} opts Optional parameters
|
|
162
|
+
* @param {module:model/RefundDisposition} opts.RefundDisposition The request body to refund funds.
|
|
163
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionResponse}
|
|
164
|
+
*/
|
|
165
|
+
}, {
|
|
166
|
+
key: "refundFunds",
|
|
167
|
+
value: function refundFunds(opts) {
|
|
168
|
+
return this.refundFundsWithHttpInfo(opts).then(function (response_and_data) {
|
|
169
|
+
return response_and_data.data;
|
|
170
|
+
});
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Unfreeze frozen funds
|
|
175
|
+
* This operation creates a request to unfreeze funds for a previously frozen transaction. It releases the frozen funds back to their original state. You only need to specify the transaction ID to be unfrozen. Once unfrozen, the funds will be available for normal operations. <Note>The unfreeze process will release the compliance hold on the transaction, allowing it to proceed normally.</Note>
|
|
176
|
+
* @param {Object} opts Optional parameters
|
|
177
|
+
* @param {module:model/UnfreezeDisposition} [UnfreezeDisposition] The request body to unfreeze funds.
|
|
178
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionResponse} and HTTP response
|
|
179
|
+
*/
|
|
180
|
+
}, {
|
|
181
|
+
key: "unfreezeFundsWithHttpInfo",
|
|
182
|
+
value: function unfreezeFundsWithHttpInfo(opts) {
|
|
183
|
+
opts = opts || {};
|
|
184
|
+
var postBody = opts['UnfreezeDisposition'];
|
|
185
|
+
if (postBody && postBody.toJSON) {
|
|
186
|
+
postBody = postBody.toJSON();
|
|
187
|
+
}
|
|
188
|
+
var pathParams = {};
|
|
189
|
+
var queryParams = {};
|
|
190
|
+
var headerParams = {};
|
|
191
|
+
var formParams = {};
|
|
192
|
+
var authNames = ['OAuth2', 'CoboAuth'];
|
|
193
|
+
var contentTypes = ['application/json'];
|
|
194
|
+
var accepts = ['application/json'];
|
|
195
|
+
var returnType = _DispositionResponse["default"];
|
|
196
|
+
return this.apiClient.callApi('/compliance/funds/disposition/unfreeze', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* Unfreeze frozen funds
|
|
201
|
+
* This operation creates a request to unfreeze funds for a previously frozen transaction. It releases the frozen funds back to their original state. You only need to specify the transaction ID to be unfrozen. Once unfrozen, the funds will be available for normal operations. <Note>The unfreeze process will release the compliance hold on the transaction, allowing it to proceed normally.</Note>
|
|
202
|
+
* @param {Object} opts Optional parameters
|
|
203
|
+
* @param {module:model/UnfreezeDisposition} opts.UnfreezeDisposition The request body to unfreeze funds.
|
|
204
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionResponse}
|
|
205
|
+
*/
|
|
206
|
+
}, {
|
|
207
|
+
key: "unfreezeFunds",
|
|
208
|
+
value: function unfreezeFunds(opts) {
|
|
209
|
+
return this.unfreezeFundsWithHttpInfo(opts).then(function (response_and_data) {
|
|
210
|
+
return response_and_data.data;
|
|
211
|
+
});
|
|
212
|
+
}
|
|
213
|
+
}]);
|
|
214
|
+
}();
|
package/dist/api/PaymentApi.js
CHANGED
|
@@ -201,7 +201,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
201
201
|
|
|
202
202
|
/**
|
|
203
203
|
* Create merchant
|
|
204
|
-
* This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet. Upon successful creation, a merchant ID is generated and returned along with the merchant's information.
|
|
204
|
+
* This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. If you are a merchant (directly serving the payer), you only need to create one merchant and do not need to configure the developer fee rate. The developer fee rate only applies to platforms such as payment service providers (PSPs) that charge fees to their downstream merchants.
|
|
205
205
|
* @param {Object} opts Optional parameters
|
|
206
206
|
* @param {module:model/CreateMerchantRequest} [CreateMerchantRequest] The request body to create a merchant.
|
|
207
207
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Merchant} and HTTP response
|
|
@@ -227,7 +227,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
227
227
|
|
|
228
228
|
/**
|
|
229
229
|
* Create merchant
|
|
230
|
-
* This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet. Upon successful creation, a merchant ID is generated and returned along with the merchant's information.
|
|
230
|
+
* This operation creates a merchant and links it to a specified wallet. Payments to the merchant will be deposited into the linked wallet. Upon successful creation, a merchant ID is generated and returned along with the merchant's information. If you are a merchant (directly serving the payer), you only need to create one merchant and do not need to configure the developer fee rate. The developer fee rate only applies to platforms such as payment service providers (PSPs) that charge fees to their downstream merchants.
|
|
231
231
|
* @param {Object} opts Optional parameters
|
|
232
232
|
* @param {module:model/CreateMerchantRequest} opts.CreateMerchantRequest The request body to create a merchant.
|
|
233
233
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Merchant}
|
|
@@ -459,8 +459,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
459
459
|
}
|
|
460
460
|
|
|
461
461
|
/**
|
|
462
|
-
* Get payer balance
|
|
463
|
-
* This operation retrieves
|
|
462
|
+
* Get payer balance
|
|
463
|
+
* This operation retrieves the total amount received for a specific payer. The information is grouped by token and receiving address.
|
|
464
464
|
* @param {String} merchant_id The merchant ID.
|
|
465
465
|
* @param {String} payer_id Unique payer identifier on the Cobo side, auto-generated by the system.
|
|
466
466
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
@@ -501,8 +501,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
501
501
|
}
|
|
502
502
|
|
|
503
503
|
/**
|
|
504
|
-
* Get payer balance
|
|
505
|
-
* This operation retrieves
|
|
504
|
+
* Get payer balance
|
|
505
|
+
* This operation retrieves the total amount received for a specific payer. The information is grouped by token and receiving address.
|
|
506
506
|
* @param {String} merchant_id The merchant ID.
|
|
507
507
|
* @param {String} payer_id Unique payer identifier on the Cobo side, auto-generated by the system.
|
|
508
508
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
@@ -561,8 +561,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
561
561
|
}
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
|
-
* Get
|
|
565
|
-
* This operation retrieves the information
|
|
564
|
+
* Get developer balance
|
|
565
|
+
* This operation retrieves the balance information for you as the developer. The balance information is grouped by token.
|
|
566
566
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
567
567
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PspBalance} and HTTP response
|
|
568
568
|
*/
|
|
@@ -591,8 +591,8 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
591
591
|
}
|
|
592
592
|
|
|
593
593
|
/**
|
|
594
|
-
* Get
|
|
595
|
-
* This operation retrieves the information
|
|
594
|
+
* Get developer balance
|
|
595
|
+
* This operation retrieves the balance information for you as the developer. The balance information is grouped by token.
|
|
596
596
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
597
597
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PspBalance}
|
|
598
598
|
*/
|
|
@@ -990,9 +990,9 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
990
990
|
|
|
991
991
|
/**
|
|
992
992
|
* List merchant balances
|
|
993
|
-
* This operation retrieves the information
|
|
993
|
+
* This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned.
|
|
994
994
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
995
|
-
* @param {module:model/AcquiringType} acquiring_type
|
|
995
|
+
* @param {module:model/AcquiringType} acquiring_type The payment acquisition type. - `Order`: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions. - `TopUp`: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models.
|
|
996
996
|
* @param {Object} opts Optional parameters
|
|
997
997
|
* @param {String} [merchant_ids] A list of merchant IDs to query.
|
|
998
998
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListMerchantBalances200Response} and HTTP response
|
|
@@ -1030,9 +1030,9 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1030
1030
|
|
|
1031
1031
|
/**
|
|
1032
1032
|
* List merchant balances
|
|
1033
|
-
* This operation retrieves the information
|
|
1033
|
+
* This operation retrieves the balance information for specified merchants. The balance information is grouped by token and acquiring type. If you do not specify the `merchant_ids` parameter, the balance information for all merchants will be returned.
|
|
1034
1034
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
1035
|
-
* @param {module:model/AcquiringType} acquiring_type
|
|
1035
|
+
* @param {module:model/AcquiringType} acquiring_type The payment acquisition type. - `Order`: Payers pay by fixed-amount orders. Ideal for specific purchases and one-time transactions. - `TopUp`: Account recharge flow where payers deposit funds to their dedicated top-up addresses. Ideal for flexible or usage-based payment models.
|
|
1036
1036
|
* @param {Object} opts Optional parameters
|
|
1037
1037
|
* @param {String} opts.merchant_ids A list of merchant IDs to query.
|
|
1038
1038
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListMerchantBalances200Response}
|
|
@@ -1196,7 +1196,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1196
1196
|
|
|
1197
1197
|
/**
|
|
1198
1198
|
* List payment wallet balances
|
|
1199
|
-
* This operation retrieves the information
|
|
1199
|
+
* This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the `wallet_ids` parameter, the balance information for all payment wallets will be returned.
|
|
1200
1200
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
1201
1201
|
* @param {Object} opts Optional parameters
|
|
1202
1202
|
* @param {String} [wallet_ids] A list of wallet IDs to query.
|
|
@@ -1230,7 +1230,7 @@ var PaymentApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1230
1230
|
|
|
1231
1231
|
/**
|
|
1232
1232
|
* List payment wallet balances
|
|
1233
|
-
* This operation retrieves the information
|
|
1233
|
+
* This operation retrieves the balance information for specified payment wallets. The balance information is grouped by token. If you do not specify the `wallet_ids` parameter, the balance information for all payment wallets will be returned.
|
|
1234
1234
|
* @param {String} token_id The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - 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`
|
|
1235
1235
|
* @param {Object} opts Optional parameters
|
|
1236
1236
|
* @param {String} opts.wallet_ids A list of wallet IDs to query.
|
|
@@ -512,7 +512,7 @@ var TokenizationApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
512
512
|
}
|
|
513
513
|
|
|
514
514
|
/**
|
|
515
|
-
*
|
|
515
|
+
* List addresses on blocklist
|
|
516
516
|
* This operation lists addresses on the blocklist.
|
|
517
517
|
* @param {String} token_id The token ID, which is the unique identifier of a token.
|
|
518
518
|
* @param {Object} opts Optional parameters
|
|
@@ -553,7 +553,7 @@ var TokenizationApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
553
553
|
}
|
|
554
554
|
|
|
555
555
|
/**
|
|
556
|
-
*
|
|
556
|
+
* List addresses on blocklist
|
|
557
557
|
* This operation lists addresses on the blocklist.
|
|
558
558
|
* @param {String} token_id The token ID, which is the unique identifier of a token.
|
|
559
559
|
* @param {Object} opts Optional parameters
|
|
@@ -244,7 +244,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
244
244
|
|
|
245
245
|
/**
|
|
246
246
|
* Sign message
|
|
247
|
-
* This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note>This operation only
|
|
247
|
+
* This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note> This operation only supports message signing transactions from the following wallets and chains: - MPC Wallets: BTC, EVM-compatible chains, Cosmos, and Solana. - Web3 Wallets: EVM-compatible chains. </Note>
|
|
248
248
|
* @param {Object} opts Optional parameters
|
|
249
249
|
* @param {module:model/MessageSignParams} [MessageSignParams] The request body to create a message signing transaction
|
|
250
250
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateTransferTransaction201Response} and HTTP response
|
|
@@ -270,7 +270,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
270
270
|
|
|
271
271
|
/**
|
|
272
272
|
* Sign message
|
|
273
|
-
* This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note>This operation only
|
|
273
|
+
* This operation creates a transaction to sign the provided message using cryptographic techniques. In some scenarios, you want to sign a message for identity authentication or transaction approval. You need to provide details such as the source address, destination address, and the message to be signed. A transaction request for tracking is returned upon successful operation. You can get the signature result by calling [Get transaction information](https://www.cobo.com/developers/v2/api-references/transactions/get-transaction-information). <Note> This operation only supports message signing transactions from the following wallets and chains: - MPC Wallets: BTC, EVM-compatible chains, Cosmos, and Solana. - Web3 Wallets: EVM-compatible chains. </Note>
|
|
274
274
|
* @param {Object} opts Optional parameters
|
|
275
275
|
* @param {module:model/MessageSignParams} opts.MessageSignParams The request body to create a message signing transaction
|
|
276
276
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateTransferTransaction201Response}
|
|
@@ -503,8 +503,8 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
503
503
|
}
|
|
504
504
|
|
|
505
505
|
/**
|
|
506
|
-
* List
|
|
507
|
-
* This operation retrieves
|
|
506
|
+
* List approval details
|
|
507
|
+
* This operation retrieves comprehensive approval information for transactions, including approval status, reviewer details, signatures, and approval history. You can filter the results by transaction IDs, Cobo IDs, or request IDs. This operation is commonly used to monitor approval progress and identify delays in multi-signature workflows.
|
|
508
508
|
* @param {Object} opts Optional parameters
|
|
509
509
|
* @param {String} [transaction_ids] A list of transaction IDs, separated by comma.
|
|
510
510
|
* @param {String} [cobo_ids] A list of Cobo IDs, separated by comma. A Cobo ID can be used to track a transaction.
|
|
@@ -535,8 +535,8 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
535
535
|
}
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
|
-
* List
|
|
539
|
-
* This operation retrieves
|
|
538
|
+
* List approval details
|
|
539
|
+
* This operation retrieves comprehensive approval information for transactions, including approval status, reviewer details, signatures, and approval history. You can filter the results by transaction IDs, Cobo IDs, or request IDs. This operation is commonly used to monitor approval progress and identify delays in multi-signature workflows.
|
|
540
540
|
* @param {Object} opts Optional parameters
|
|
541
541
|
* @param {String} opts.transaction_ids A list of transaction IDs, separated by comma.
|
|
542
542
|
* @param {String} opts.cobo_ids A list of Cobo IDs, separated by comma. A Cobo ID can be used to track a transaction.
|
|
@@ -598,11 +598,11 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
598
598
|
}
|
|
599
599
|
|
|
600
600
|
/**
|
|
601
|
-
*
|
|
602
|
-
* This operation retrieves
|
|
603
|
-
* @param {String} template_key
|
|
601
|
+
* List transaction templates
|
|
602
|
+
* This operation retrieves approval templates based on the specified template key and template version. These templates define the content used to generate approval messages displayed to users, including messages for transaction approvals and other approval workflows.
|
|
603
|
+
* @param {String} template_key Key of the transaction template used to create an approval message.
|
|
604
604
|
* @param {Object} opts Optional parameters
|
|
605
|
-
* @param {String} [template_version]
|
|
605
|
+
* @param {String} [template_version] Version of the template.
|
|
606
606
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/ApprovalTemplate>} and HTTP response
|
|
607
607
|
*/
|
|
608
608
|
}, {
|
|
@@ -632,11 +632,11 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
632
632
|
}
|
|
633
633
|
|
|
634
634
|
/**
|
|
635
|
-
*
|
|
636
|
-
* This operation retrieves
|
|
637
|
-
* @param {String} template_key
|
|
635
|
+
* List transaction templates
|
|
636
|
+
* This operation retrieves approval templates based on the specified template key and template version. These templates define the content used to generate approval messages displayed to users, including messages for transaction approvals and other approval workflows.
|
|
637
|
+
* @param {String} template_key Key of the transaction template used to create an approval message.
|
|
638
638
|
* @param {Object} opts Optional parameters
|
|
639
|
-
* @param {String} opts.template_version
|
|
639
|
+
* @param {String} opts.template_version Version of the template.
|
|
640
640
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/ApprovalTemplate>}
|
|
641
641
|
*/
|
|
642
642
|
}, {
|
|
@@ -664,7 +664,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
664
664
|
* @param {String} [vault_id] The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults).
|
|
665
665
|
* @param {module:model/WalletType} [wallet_type] The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
666
666
|
* @param {module:model/WalletSubtype} [wallet_subtype] The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
667
|
-
* @param {String} [project_id] The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
667
|
+
* @param {String} [project_id] (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
668
668
|
* @param {Number} [min_created_timestamp] The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change.
|
|
669
669
|
* @param {Number} [max_created_timestamp] The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change.
|
|
670
670
|
* @param {Number} [limit = 10)] The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
@@ -730,7 +730,7 @@ var TransactionsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
730
730
|
* @param {String} opts.vault_id The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults).
|
|
731
731
|
* @param {module:model/WalletType} opts.wallet_type The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
732
732
|
* @param {module:model/WalletSubtype} opts.wallet_subtype The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
733
|
-
* @param {String} opts.project_id The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
733
|
+
* @param {String} opts.project_id (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
734
734
|
* @param {Number} opts.min_created_timestamp The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change.
|
|
735
735
|
* @param {Number} opts.max_created_timestamp The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change.
|
|
736
736
|
* @param {Number} opts.limit The maximum number of objects to return. For most operations, the value range is [1, 50]. (default to 10)
|
package/dist/api/WalletsApi.js
CHANGED
|
@@ -817,7 +817,7 @@ var WalletsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
817
817
|
|
|
818
818
|
/**
|
|
819
819
|
* List wallet addresses
|
|
820
|
-
* This operation retrieves a list of addresses within a specified wallet.
|
|
820
|
+
* This operation retrieves a list of addresses within a specified wallet. <Note> For Web3 Wallets, Asset Wallets, and MPC Wallets, addresses created on one EVM chain automatically work on all other supported EVM chains. Currently, query results for EVM chain addresses differ between interfaces: - API: Query results are limited by chain_id, so only addresses from that specific chain are returned. - Cobo Portal: Displays addresses from all supported EVM chains, so the number of addresses may be larger than the API results. </Note>
|
|
821
821
|
* @param {String} wallet_id The wallet ID.
|
|
822
822
|
* @param {Object} opts Optional parameters
|
|
823
823
|
* @param {String} [chain_ids] A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).
|
|
@@ -860,7 +860,7 @@ var WalletsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
860
860
|
|
|
861
861
|
/**
|
|
862
862
|
* List wallet addresses
|
|
863
|
-
* This operation retrieves a list of addresses within a specified wallet.
|
|
863
|
+
* This operation retrieves a list of addresses within a specified wallet. <Note> For Web3 Wallets, Asset Wallets, and MPC Wallets, addresses created on one EVM chain automatically work on all other supported EVM chains. Currently, query results for EVM chain addresses differ between interfaces: - API: Query results are limited by chain_id, so only addresses from that specific chain are returned. - Cobo Portal: Displays addresses from all supported EVM chains, so the number of addresses may be larger than the API results. </Note>
|
|
864
864
|
* @param {String} wallet_id The wallet ID.
|
|
865
865
|
* @param {Object} opts Optional parameters
|
|
866
866
|
* @param {String} opts.chain_ids A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).
|
|
@@ -1368,7 +1368,7 @@ var WalletsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1368
1368
|
* @param {Object} opts Optional parameters
|
|
1369
1369
|
* @param {module:model/WalletType} [wallet_type] The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
1370
1370
|
* @param {module:model/WalletSubtype} [wallet_subtype] The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
1371
|
-
* @param {String} [project_id] The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
1371
|
+
* @param {String} [project_id] (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
1372
1372
|
* @param {String} [vault_id] The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults).
|
|
1373
1373
|
* @param {Number} [limit = 10)] The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
1374
1374
|
* @param {String} [before] A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.
|
|
@@ -1408,7 +1408,7 @@ var WalletsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
1408
1408
|
* @param {Object} opts Optional parameters
|
|
1409
1409
|
* @param {module:model/WalletType} opts.wallet_type The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction)
|
|
1410
1410
|
* @param {module:model/WalletSubtype} opts.wallet_subtype The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet})
|
|
1411
|
-
* @param {String} opts.project_id The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
1411
|
+
* @param {String} opts.project_id (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
1412
1412
|
* @param {String} opts.vault_id The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults).
|
|
1413
1413
|
* @param {Number} opts.limit The maximum number of objects to return. For most operations, the value range is [1, 50]. (default to 10)
|
|
1414
1414
|
* @param {String} opts.before A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.
|
|
@@ -792,7 +792,7 @@ var WalletsMPCWalletsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
792
792
|
* This operation retrieves a list of all vaults. You can filter the result by project ID. **Notes for query parameters**: 1. `project_id` is required when `vault_type` is set to `User-Controlled`. 2. `project_id` must be left blank when `vault_type` is set to `Org-Controlled`. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
793
793
|
* @param {module:model/MPCVaultType} vault_type The vault type. Possible values include: - `Org-Controlled`: This vault is a collection of [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#organization-controlled-wallets). - `User-Controlled`: This vault is a collection of [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#user-controlled-wallets).
|
|
794
794
|
* @param {Object} opts Optional parameters
|
|
795
|
-
* @param {String} [project_id] The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
795
|
+
* @param {String} [project_id] (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
796
796
|
* @param {Number} [limit = 10)] The maximum number of objects to return. For most operations, the value range is [1, 50].
|
|
797
797
|
* @param {String} [before] A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.
|
|
798
798
|
* @param {String} [after] A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.
|
|
@@ -832,7 +832,7 @@ var WalletsMPCWalletsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
832
832
|
* This operation retrieves a list of all vaults. You can filter the result by project ID. **Notes for query parameters**: 1. `project_id` is required when `vault_type` is set to `User-Controlled`. 2. `project_id` must be left blank when `vault_type` is set to `Org-Controlled`. <Info>To learn what a vault is and how it relates to MPC Wallets, see [Get started with MPC Wallets](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#technical-architecture).</Info>
|
|
833
833
|
* @param {module:model/MPCVaultType} vault_type The vault type. Possible values include: - `Org-Controlled`: This vault is a collection of [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#organization-controlled-wallets). - `User-Controlled`: This vault is a collection of [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#user-controlled-wallets).
|
|
834
834
|
* @param {Object} opts Optional parameters
|
|
835
|
-
* @param {String} opts.project_id The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
835
|
+
* @param {String} opts.project_id (This parameter is only applicable to User-Controlled Wallets.) The project ID, which you can retrieve by calling [List all projects](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-projects).
|
|
836
836
|
* @param {Number} opts.limit The maximum number of objects to return. For most operations, the value range is [1, 50]. (default to 10)
|
|
837
837
|
* @param {String} opts.before A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.
|
|
838
838
|
* @param {String} opts.after A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.
|