@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
package/docs/AddressBooksApi.md
CHANGED
|
@@ -4,17 +4,173 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
7
|
+
[**createAddressBooks**](AddressBooksApi.md#createAddressBooks) | **POST** /address_books | Create Address Book entries
|
|
8
|
+
[**deleteAddressBookById**](AddressBooksApi.md#deleteAddressBookById) | **POST** /address_books/{entry_id}/delete | Delete Address Book entry
|
|
9
|
+
[**getAddressBookById**](AddressBooksApi.md#getAddressBookById) | **GET** /address_books/{entry_id} | Get Address Book entry
|
|
10
|
+
[**listAddressBooks**](AddressBooksApi.md#listAddressBooks) | **GET** /address_books | List Address Book entries
|
|
11
|
+
[**updateAddressBookById**](AddressBooksApi.md#updateAddressBookById) | **PUT** /address_books/{entry_id} | Update Address Book entry
|
|
8
12
|
|
|
9
13
|
|
|
10
14
|
|
|
15
|
+
## createAddressBooks
|
|
16
|
+
|
|
17
|
+
> CreateAddressBooks201Response createAddressBooks(opts)
|
|
18
|
+
|
|
19
|
+
Create Address Book entries
|
|
20
|
+
|
|
21
|
+
This operation adds new entries (records) to your Address Book.
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```javascript
|
|
26
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
27
|
+
// Initialize the API client
|
|
28
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
29
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
30
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
31
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
32
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
33
|
+
// Call the API
|
|
34
|
+
const apiInstance = new CoboWaas2.AddressBooksApi();
|
|
35
|
+
const opts = {
|
|
36
|
+
'CreateAddressBooksParam': new CoboWaas2.CreateAddressBooksParam()
|
|
37
|
+
};
|
|
38
|
+
apiInstance.createAddressBooks(opts).then((data) => {
|
|
39
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
40
|
+
}, (error) => {
|
|
41
|
+
console.error(error);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
Name | Type | Description | Notes
|
|
50
|
+
------------- | ------------- | ------------- | -------------
|
|
51
|
+
**CreateAddressBooksParam** | [**CreateAddressBooksParam**](CreateAddressBooksParam.md)| The request body of the create Address Books operation. | [optional]
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
[**CreateAddressBooks201Response**](CreateAddressBooks201Response.md)
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: application/json
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
## deleteAddressBookById
|
|
68
|
+
|
|
69
|
+
> DeleteAddressBookById201Response deleteAddressBookById(entry_id)
|
|
70
|
+
|
|
71
|
+
Delete Address Book entry
|
|
72
|
+
|
|
73
|
+
This operation deletes a specified Address Book entry (record).
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```javascript
|
|
78
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
79
|
+
// Initialize the API client
|
|
80
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
81
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
82
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
83
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
84
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
85
|
+
// Call the API
|
|
86
|
+
const apiInstance = new CoboWaas2.AddressBooksApi();
|
|
87
|
+
const entry_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
88
|
+
apiInstance.deleteAddressBookById(entry_id).then((data) => {
|
|
89
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
90
|
+
}, (error) => {
|
|
91
|
+
console.error(error);
|
|
92
|
+
});
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
Name | Type | Description | Notes
|
|
100
|
+
------------- | ------------- | ------------- | -------------
|
|
101
|
+
**entry_id** | **String**| The Address Book entry ID. |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
[**DeleteAddressBookById201Response**](DeleteAddressBookById201Response.md)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
## getAddressBookById
|
|
118
|
+
|
|
119
|
+
> AddressBook getAddressBookById(entry_id)
|
|
120
|
+
|
|
121
|
+
Get Address Book entry
|
|
122
|
+
|
|
123
|
+
This operation retrieves the detailed information about a specified Address Book entry (record).
|
|
124
|
+
|
|
125
|
+
### Example
|
|
126
|
+
|
|
127
|
+
```javascript
|
|
128
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
129
|
+
// Initialize the API client
|
|
130
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
131
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
132
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
133
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
134
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
135
|
+
// Call the API
|
|
136
|
+
const apiInstance = new CoboWaas2.AddressBooksApi();
|
|
137
|
+
const entry_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
138
|
+
apiInstance.getAddressBookById(entry_id).then((data) => {
|
|
139
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
140
|
+
}, (error) => {
|
|
141
|
+
console.error(error);
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Parameters
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
Name | Type | Description | Notes
|
|
150
|
+
------------- | ------------- | ------------- | -------------
|
|
151
|
+
**entry_id** | **String**| The Address Book entry ID. |
|
|
152
|
+
|
|
153
|
+
### Return type
|
|
154
|
+
|
|
155
|
+
[**AddressBook**](AddressBook.md)
|
|
156
|
+
|
|
157
|
+
### Authorization
|
|
158
|
+
|
|
159
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
160
|
+
|
|
161
|
+
### HTTP request headers
|
|
162
|
+
|
|
163
|
+
- **Content-Type**: Not defined
|
|
164
|
+
- **Accept**: application/json
|
|
165
|
+
|
|
166
|
+
|
|
11
167
|
## listAddressBooks
|
|
12
168
|
|
|
13
|
-
> ListAddressBooks200Response listAddressBooks(
|
|
169
|
+
> ListAddressBooks200Response listAddressBooks(opts)
|
|
14
170
|
|
|
15
|
-
List
|
|
171
|
+
List Address Book entries
|
|
16
172
|
|
|
17
|
-
This operation retrieves
|
|
173
|
+
This operation retrieves all entries (records) from your Address Book. You can filter the entries by chain ID, address, and label.
|
|
18
174
|
|
|
19
175
|
### Example
|
|
20
176
|
|
|
@@ -28,15 +184,15 @@ apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
|
28
184
|
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
29
185
|
// Call the API
|
|
30
186
|
const apiInstance = new CoboWaas2.AddressBooksApi();
|
|
31
|
-
const chain_id = "ETH";
|
|
32
187
|
const opts = {
|
|
188
|
+
'chain_id': "ETH",
|
|
33
189
|
'address': "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
|
|
34
190
|
'label': "test",
|
|
35
191
|
'limit': 10,
|
|
36
192
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
37
193
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
38
194
|
};
|
|
39
|
-
apiInstance.listAddressBooks(
|
|
195
|
+
apiInstance.listAddressBooks(opts).then((data) => {
|
|
40
196
|
console.log('API called successfully. Returned data: ' + data);
|
|
41
197
|
}, (error) => {
|
|
42
198
|
console.error(error);
|
|
@@ -49,9 +205,9 @@ apiInstance.listAddressBooks(chain_id, opts).then((data) => {
|
|
|
49
205
|
|
|
50
206
|
Name | Type | Description | Notes
|
|
51
207
|
------------- | ------------- | ------------- | -------------
|
|
52
|
-
**chain_id** | **String**| The chain ID, which 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). |
|
|
208
|
+
**chain_id** | **String**| The chain ID, which 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). | [optional]
|
|
53
209
|
**address** | **String**| The wallet address. | [optional]
|
|
54
|
-
**label** | **String**|
|
|
210
|
+
**label** | **String**| A user-defined label for the address. | [optional]
|
|
55
211
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
56
212
|
**before** | **String**| 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. | [optional]
|
|
57
213
|
**after** | **String**| 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. | [optional]
|
|
@@ -69,3 +225,57 @@ Name | Type | Description | Notes
|
|
|
69
225
|
- **Content-Type**: Not defined
|
|
70
226
|
- **Accept**: application/json
|
|
71
227
|
|
|
228
|
+
|
|
229
|
+
## updateAddressBookById
|
|
230
|
+
|
|
231
|
+
> AddressBook updateAddressBookById(entry_id, opts)
|
|
232
|
+
|
|
233
|
+
Update Address Book entry
|
|
234
|
+
|
|
235
|
+
This operation updates the information of a specified Address Book entry (record).
|
|
236
|
+
|
|
237
|
+
### Example
|
|
238
|
+
|
|
239
|
+
```javascript
|
|
240
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
241
|
+
// Initialize the API client
|
|
242
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
243
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
244
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
245
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
246
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
247
|
+
// Call the API
|
|
248
|
+
const apiInstance = new CoboWaas2.AddressBooksApi();
|
|
249
|
+
const entry_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
250
|
+
const opts = {
|
|
251
|
+
'UpdateAddressBookParam': new CoboWaas2.UpdateAddressBookParam()
|
|
252
|
+
};
|
|
253
|
+
apiInstance.updateAddressBookById(entry_id, opts).then((data) => {
|
|
254
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
255
|
+
}, (error) => {
|
|
256
|
+
console.error(error);
|
|
257
|
+
});
|
|
258
|
+
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### Parameters
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
Name | Type | Description | Notes
|
|
265
|
+
------------- | ------------- | ------------- | -------------
|
|
266
|
+
**entry_id** | **String**| The Address Book entry ID. |
|
|
267
|
+
**UpdateAddressBookParam** | [**UpdateAddressBookParam**](UpdateAddressBookParam.md)| The request body of the update Address Book operation. | [optional]
|
|
268
|
+
|
|
269
|
+
### Return type
|
|
270
|
+
|
|
271
|
+
[**AddressBook**](AddressBook.md)
|
|
272
|
+
|
|
273
|
+
### Authorization
|
|
274
|
+
|
|
275
|
+
[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth)
|
|
276
|
+
|
|
277
|
+
### HTTP request headers
|
|
278
|
+
|
|
279
|
+
- **Content-Type**: application/json
|
|
280
|
+
- **Accept**: application/json
|
|
281
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**addresses** | [**[AddressesEventDataAllOfAddresses]**](AddressesEventDataAllOfAddresses.md) | A list of addresses. | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -42,6 +42,8 @@ Name | Type | Description | Notes
|
|
|
42
42
|
|
|
43
43
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
44
44
|
|
|
45
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
46
|
+
|
|
45
47
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
46
48
|
|
|
47
49
|
|
package/docs/ApprovalDetail.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**transaction_id** | **String** |
|
|
8
|
-
**cobo_id** | **String** |
|
|
9
|
-
**request_id** | **String** |
|
|
7
|
+
**transaction_id** | **String** | Transaction ID. | [optional]
|
|
8
|
+
**cobo_id** | **String** | Cobo ID used to track a transaction. | [optional]
|
|
9
|
+
**request_id** | **String** | Request ID used to track a transaction request. | [optional]
|
|
10
10
|
**address_owner** | [**RoleDetail**](RoleDetail.md) | | [optional]
|
|
11
11
|
**spender** | [**RoleDetail**](RoleDetail.md) | | [optional]
|
|
12
12
|
**approver** | [**RoleDetail**](RoleDetail.md) | | [optional]
|
package/docs/ApprovalResult.md
CHANGED
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
## Enum
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
* `
|
|
6
|
+
* `APPROVED` (value: `"Approved"`)
|
|
7
7
|
|
|
8
|
-
* `
|
|
8
|
+
* `REJECTED` (value: `"Rejected"`)
|
|
9
9
|
|
|
10
|
-
* `
|
|
11
|
-
|
|
12
|
-
* `unknown_default_open_api` (value: `11184809`)
|
|
10
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
13
11
|
|
|
14
12
|
|
package/docs/ApprovalTemplate.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**business_key** | **String** |
|
|
8
|
-
**template_text** | **String** |
|
|
9
|
-
**template_version** | **String** |
|
|
7
|
+
**business_key** | **String** | Business key used to identify the type of approval template. | [optional]
|
|
8
|
+
**template_text** | **String** | Text content defined in the approval template used to generate approval messages shown to users | [optional]
|
|
9
|
+
**template_version** | **String** | Version of the approval template. | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
## Enum
|
|
4
4
|
|
|
5
5
|
|
|
6
|
-
* `REJECTED` (value:
|
|
6
|
+
* `REJECTED` (value: `"Rejected"`)
|
|
7
7
|
|
|
8
|
-
* `PENDING` (value: `
|
|
8
|
+
* `PENDING` (value: `"Pending"`)
|
|
9
9
|
|
|
10
|
-
* `APPROVED` (value: `
|
|
10
|
+
* `APPROVED` (value: `"Approved"`)
|
|
11
11
|
|
|
12
|
-
* `unknown_default_open_api` (value: `
|
|
12
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
13
13
|
|
|
14
14
|
|
|
@@ -4,15 +4,21 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
7
|
+
**name** | **String** | Name of the user who approved the transaction. | [optional]
|
|
8
|
+
**email** | **String** | Email of the user. | [optional]
|
|
9
|
+
**pubkey** | **String** | Public key of the user. | [optional]
|
|
10
|
+
**signature** | **String** | Signature produced by the user for this approval. | [optional]
|
|
11
|
+
**statement_uuid** | **String** | UUID of the statement associated with this approval. | [optional]
|
|
11
12
|
**result** | [**ApprovalResult**](ApprovalResult.md) | | [optional]
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**
|
|
16
|
-
**
|
|
13
|
+
**approval_result_code** | **Number** | Integer value representing the result of the approval. | [optional]
|
|
14
|
+
**created_time** | **Number** | Timestamp when the approval was created. | [optional]
|
|
15
|
+
**template_version** | **String** | Version of the template used for the transaction approval. | [optional]
|
|
16
|
+
**header_title** | **String** | Display title used in the transaction approval. | [optional]
|
|
17
|
+
**is_for_sign** | **Boolean** | Indicates whether this approval requires signing: - `true`: The user must sign the transaction. - `false`: The user only needs to approve or reject without signing. | [optional]
|
|
18
|
+
**show_info** | **String** | Additional information to show for the transaction approval. | [optional]
|
|
19
|
+
**language** | **String** | Language used for the transaction approval. | [optional]
|
|
20
|
+
**message_version** | **String** | Version of the message format used for the transaction approval. | [optional]
|
|
21
|
+
**message** | **String** | Message associated with the transaction approval. | [optional]
|
|
22
|
+
**extra_message** | **String** | Any additional message or information related to the transaction approval. | [optional]
|
|
17
23
|
|
|
18
24
|
|
package/docs/AutoSweepApi.md
CHANGED
|
@@ -4,11 +4,11 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**createAutoSweepTask**](AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks |
|
|
8
|
-
[**createWalletSweepToAddresses**](AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | create
|
|
9
|
-
[**getAutoSweepTaskById**](AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto
|
|
10
|
-
[**listAutoSweepTask**](AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List
|
|
11
|
-
[**listWalletSweepToAddresses**](AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List
|
|
7
|
+
[**createAutoSweepTask**](AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks | Create auto-sweep task
|
|
8
|
+
[**createWalletSweepToAddresses**](AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | create sweep-to address
|
|
9
|
+
[**getAutoSweepTaskById**](AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto-sweep task details
|
|
10
|
+
[**listAutoSweepTask**](AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List auto-sweep tasks
|
|
11
|
+
[**listWalletSweepToAddresses**](AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List sweep-to addresses
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
|
|
@@ -16,9 +16,9 @@ Method | HTTP request | Description
|
|
|
16
16
|
|
|
17
17
|
> AutoSweepTask createAutoSweepTask(opts)
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Create auto-sweep task
|
|
20
20
|
|
|
21
|
-
This operation
|
|
21
|
+
This operation creates an auto-sweep task for the specified wallet and token. The task triggers transactions to sweep the full balance of the specified token to the configured sweep-to address.
|
|
22
22
|
|
|
23
23
|
### Example
|
|
24
24
|
|
|
@@ -48,7 +48,7 @@ apiInstance.createAutoSweepTask(opts).then((data) => {
|
|
|
48
48
|
|
|
49
49
|
Name | Type | Description | Notes
|
|
50
50
|
------------- | ------------- | ------------- | -------------
|
|
51
|
-
**CreateAutoSweepTask** | [**CreateAutoSweepTask**](CreateAutoSweepTask.md)| The request body to
|
|
51
|
+
**CreateAutoSweepTask** | [**CreateAutoSweepTask**](CreateAutoSweepTask.md)| The request body to create an auto-sweep task. | [optional]
|
|
52
52
|
|
|
53
53
|
### Return type
|
|
54
54
|
|
|
@@ -68,9 +68,9 @@ Name | Type | Description | Notes
|
|
|
68
68
|
|
|
69
69
|
> SweepToAddress createWalletSweepToAddresses(opts)
|
|
70
70
|
|
|
71
|
-
create
|
|
71
|
+
create sweep-to address
|
|
72
72
|
|
|
73
|
-
This operation
|
|
73
|
+
This operation creates a new sweep-to address for the specified wallet. The previously sweep-to address for the same token becomes invalid once the new one is created. Use this operation to change the sweep-to address when your setup changes, you switch networks, or the current address is compromised or tainted by suspicious funds. You can withdraw any remaining balances from the old sweep-to addresses to the new address or another designated destination. <Note>Sweep-to addresses are only applicable to MPC Wallets and Web3 Wallets with the auto-sweep feature enabled.</Note>
|
|
74
74
|
|
|
75
75
|
### Example
|
|
76
76
|
|
|
@@ -100,7 +100,7 @@ apiInstance.createWalletSweepToAddresses(opts).then((data) => {
|
|
|
100
100
|
|
|
101
101
|
Name | Type | Description | Notes
|
|
102
102
|
------------- | ------------- | ------------- | -------------
|
|
103
|
-
**CreateSweepToAddress** | [**CreateSweepToAddress**](CreateSweepToAddress.md)| The request body to generates a new sweep
|
|
103
|
+
**CreateSweepToAddress** | [**CreateSweepToAddress**](CreateSweepToAddress.md)| The request body to generates a new sweep-to address within a specified wallet. | [optional]
|
|
104
104
|
|
|
105
105
|
### Return type
|
|
106
106
|
|
|
@@ -120,9 +120,9 @@ Name | Type | Description | Notes
|
|
|
120
120
|
|
|
121
121
|
> AutoSweepTask getAutoSweepTaskById(task_id)
|
|
122
122
|
|
|
123
|
-
Get auto
|
|
123
|
+
Get auto-sweep task details
|
|
124
124
|
|
|
125
|
-
This operation retrieves detailed information about a specified auto
|
|
125
|
+
This operation retrieves detailed information about a specified auto-sweep task.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -170,9 +170,9 @@ Name | Type | Description | Notes
|
|
|
170
170
|
|
|
171
171
|
> ListAutoSweepTask200Response listAutoSweepTask(wallet_id, opts)
|
|
172
172
|
|
|
173
|
-
List
|
|
173
|
+
List auto-sweep tasks
|
|
174
174
|
|
|
175
|
-
This operation retrieves a list of auto
|
|
175
|
+
This operation retrieves a list of auto-sweep tasks for the specified wallet. You can filter the results by token ID, task IDs, or a created-time range.
|
|
176
176
|
|
|
177
177
|
### Example
|
|
178
178
|
|
|
@@ -212,7 +212,7 @@ Name | Type | Description | Notes
|
|
|
212
212
|
------------- | ------------- | ------------- | -------------
|
|
213
213
|
**wallet_id** | **String**| The wallet ID. |
|
|
214
214
|
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
215
|
-
**task_ids** | **String**| A list of auto
|
|
215
|
+
**task_ids** | **String**| A list of auto-sweep task IDs, separated by comma. | [optional]
|
|
216
216
|
**min_created_timestamp** | **Number**| 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. | [optional]
|
|
217
217
|
**max_created_timestamp** | **Number**| 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. | [optional]
|
|
218
218
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
@@ -238,9 +238,9 @@ Name | Type | Description | Notes
|
|
|
238
238
|
|
|
239
239
|
> ListWalletSweepToAddresses200Response listWalletSweepToAddresses(wallet_id)
|
|
240
240
|
|
|
241
|
-
List
|
|
241
|
+
List sweep-to addresses
|
|
242
242
|
|
|
243
|
-
This operation retrieves a list of sweep
|
|
243
|
+
This operation retrieves a list of sweep-to addresses within your wallet. <Note>Sweep-to addresses are only applicable to MPC Wallets and Web3 Wallets with the auto-sweep feature enabled.</Note>
|
|
244
244
|
|
|
245
245
|
### Example
|
|
246
246
|
|
package/docs/AutoSweepTask.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**task_id** | **String** |
|
|
8
|
-
**wallet_id** | **String** |
|
|
9
|
-
**token_id** | **String** |
|
|
7
|
+
**task_id** | **String** | Auto-sweep task ID. |
|
|
8
|
+
**wallet_id** | **String** | Wallet ID. |
|
|
9
|
+
**token_id** | **String** | Token ID of the swept token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
10
10
|
**status** | [**AutoSweepTaskStatus**](AutoSweepTaskStatus.md) | |
|
|
11
|
-
**transaction_ids** | **[String]** |
|
|
12
|
-
**failed_reasons** | **[String]** |
|
|
11
|
+
**transaction_ids** | **[String]** | IDs of the transactions triggered by the task. | [optional]
|
|
12
|
+
**failed_reasons** | **[String]** | Reasons why the task creation failed. | [optional]
|
|
13
13
|
**created_timestamp** | **Number** | The time when the task was created, in Unix timestamp format, measured in milliseconds. |
|
|
14
14
|
**updated_timestamp** | **Number** | The time when the task was updated, in Unix timestamp format, measured in milliseconds. | [optional]
|
|
15
15
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**token_id** | **String** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
9
9
|
**address** | **String** | The wallet address. |
|
|
10
10
|
**wallet_uuid** | **String** | The wallet ID. |
|
|
@@ -46,6 +46,8 @@ Name | Type | Description | Notes
|
|
|
46
46
|
|
|
47
47
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
48
48
|
|
|
49
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
50
|
+
|
|
49
51
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
50
52
|
|
|
51
53
|
|
package/docs/ChainInfo.md
CHANGED
|
@@ -5,8 +5,9 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. |
|
|
8
|
-
**symbol** | **String** | The chain symbol, which is the abbreviated name of a chain. | [optional]
|
|
8
|
+
**symbol** | **String** | The chain symbol for display purposes, which is the abbreviated name of a chain. | [optional]
|
|
9
9
|
**icon_url** | **String** | The URL of the chain icon. | [optional]
|
|
10
|
+
**chain_identifier** | **String** | A functional identifier used to group blockchains with similar execution logic. For example, `ETH` for all EVM-compatible chains (Ethereum, BNB Smart Chain, Polygon). | [optional]
|
|
10
11
|
**explorer_tx_url** | **String** | The transaction URL pattern on the blockchain explorer. You can use it to concatenate the transaction URLs. | [optional]
|
|
11
12
|
**explorer_address_url** | **String** | The address URL pattern on the blockchain explorer. You can use it to concatenate the address URLs. | [optional]
|
|
12
13
|
**require_memo** | **Boolean** | Whether the chain requires a memo. | [optional]
|
package/docs/ChainsEventData.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. |
|
|
7
|
+
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. |
|
|
8
8
|
**chains** | [**[ChainInfo]**](ChainInfo.md) | The enabled chains. |
|
|
9
9
|
**wallet_type** | [**WalletType**](WalletType.md) | | [optional]
|
|
10
10
|
**wallet_subtypes** | [**[WalletSubtype]**](WalletSubtype.md) | | [optional]
|
|
@@ -44,6 +44,8 @@ Name | Type | Description | Notes
|
|
|
44
44
|
|
|
45
45
|
* `SuspendedToken` (value: `"SuspendedToken"`)
|
|
46
46
|
|
|
47
|
+
* `ComplianceDisposition` (value: `"ComplianceDisposition"`)
|
|
48
|
+
|
|
47
49
|
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
48
50
|
|
|
49
51
|
|