@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.
Files changed (142) hide show
  1. package/README.md +39 -14
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AddressBooksApi.js +200 -21
  4. package/dist/api/AutoSweepApi.js +26 -26
  5. package/dist/api/ComplianceApi.js +214 -0
  6. package/dist/api/PaymentApi.js +16 -16
  7. package/dist/api/TokenizationApi.js +2 -2
  8. package/dist/api/TransactionsApi.js +16 -16
  9. package/dist/api/WalletsApi.js +4 -4
  10. package/dist/api/WalletsMPCWalletsApi.js +2 -2
  11. package/dist/index.js +105 -7
  12. package/dist/model/AddressBook.js +12 -12
  13. package/dist/model/AddressesEventData.js +8 -3
  14. package/dist/model/ApprovalDetail.js +4 -4
  15. package/dist/model/ApprovalResult.js +6 -11
  16. package/dist/model/ApprovalTemplate.js +4 -4
  17. package/dist/model/ApprovalTransactionResult.js +8 -8
  18. package/dist/model/ApprovalUserDetail.js +95 -24
  19. package/dist/model/AutoSweepTask.js +9 -9
  20. package/dist/model/BalanceUpdateInfoEventData.js +8 -3
  21. package/dist/model/ChainInfo.js +14 -1
  22. package/dist/model/ChainsEventData.js +8 -3
  23. package/dist/model/ComplianceDispositionUpdateEventData.js +321 -0
  24. package/dist/model/CreateAddressBookParam.js +165 -0
  25. package/dist/model/CreateAddressBooks201Response.js +107 -0
  26. package/dist/model/CreateAddressBooksParam.js +128 -0
  27. package/dist/model/CreateAutoSweepTask.js +5 -5
  28. package/dist/model/CreateCustodialWalletParams.js +1 -1
  29. package/dist/model/CreateExchangeWalletParams.js +2 -2
  30. package/dist/model/CreateMerchantRequest.js +1 -1
  31. package/dist/model/CreateMpcWalletParams.js +2 -2
  32. package/dist/model/CreatePaymentOrderRequest.js +3 -3
  33. package/dist/model/CreateRefundRequest.js +2 -2
  34. package/dist/model/CreateSafeWalletParams.js +1 -1
  35. package/dist/model/CreateSettlement.js +1 -1
  36. package/dist/model/CreateSmartContractWalletParams.js +1 -1
  37. package/dist/model/CreateSweepToAddress.js +1 -1
  38. package/dist/model/CreateWalletParams.js +1 -1
  39. package/dist/model/DeleteAddressBookById201Response.js +106 -0
  40. package/dist/model/DispositionEventData.js +170 -0
  41. package/dist/model/DispositionQueryResponse.js +146 -0
  42. package/dist/model/DispositionResponse.js +122 -0
  43. package/dist/model/DispositionStatus.js +116 -0
  44. package/dist/model/DispositionType.js +66 -0
  45. package/dist/model/IsolateDisposition.js +167 -0
  46. package/dist/model/MPCVaultEventData.js +8 -3
  47. package/dist/model/Merchant.js +1 -1
  48. package/dist/model/MerchantBalance.js +7 -7
  49. package/dist/model/OrgInfo.js +9 -0
  50. package/dist/model/PaymentAddressUpdateEventData.js +8 -3
  51. package/dist/model/PaymentOrderEventData.js +8 -3
  52. package/dist/model/PaymentRefundEventData.js +8 -3
  53. package/dist/model/PaymentSettlementEvent.js +8 -3
  54. package/dist/model/PaymentTransactionEventData.js +8 -3
  55. package/dist/model/PaymentWalletBalance.js +6 -6
  56. package/dist/model/PspBalance.js +7 -7
  57. package/dist/model/ReceivedAmountPerAddress.js +5 -5
  58. package/dist/model/RefundDisposition.js +167 -0
  59. package/dist/model/RoleDetail.js +41 -6
  60. package/dist/model/SuspendedTokenEventData.js +8 -3
  61. package/dist/model/SweepToAddress.js +1 -1
  62. package/dist/model/TSSRequestWebhookEventData.js +8 -3
  63. package/dist/model/TokenListingEventData.js +8 -3
  64. package/dist/model/TokensEventData.js +8 -3
  65. package/dist/model/TransactionWebhookEventData.js +8 -3
  66. package/dist/model/UnfreezeDisposition.js +111 -0
  67. package/dist/model/UpdateAddressBookParam.js +150 -0
  68. package/dist/model/UpdateMerchantByIdRequest.js +1 -1
  69. package/dist/model/WalletInfoEventData.js +8 -3
  70. package/dist/model/WebhookEventData.js +62 -10
  71. package/dist/model/WebhookEventDataType.js +7 -2
  72. package/dist/model/WebhookEventType.js +5 -0
  73. package/docs/AddressBook.md +7 -7
  74. package/docs/AddressBooksApi.md +218 -8
  75. package/docs/AddressesEventData.md +3 -1
  76. package/docs/ApprovalDetail.md +3 -3
  77. package/docs/ApprovalResult.md +3 -5
  78. package/docs/ApprovalTemplate.md +3 -3
  79. package/docs/ApprovalTransactionResult.md +4 -4
  80. package/docs/ApprovalUserDetail.md +15 -9
  81. package/docs/AutoSweepApi.md +18 -18
  82. package/docs/AutoSweepTask.md +5 -5
  83. package/docs/BalanceUpdateInfoEventData.md +3 -1
  84. package/docs/ChainInfo.md +2 -1
  85. package/docs/ChainsEventData.md +3 -1
  86. package/docs/ComplianceApi.md +218 -0
  87. package/docs/ComplianceDispositionUpdateEventData.md +56 -0
  88. package/docs/CreateAddressBookParam.md +13 -0
  89. package/docs/CreateAddressBooks201Response.md +9 -0
  90. package/docs/CreateAddressBooksParam.md +9 -0
  91. package/docs/CreateAutoSweepTask.md +2 -2
  92. package/docs/CreateCustodialWalletParams.md +1 -1
  93. package/docs/CreateExchangeWalletParams.md +1 -1
  94. package/docs/CreateMerchantRequest.md +1 -1
  95. package/docs/CreateMpcWalletParams.md +1 -1
  96. package/docs/CreatePaymentOrderRequest.md +2 -2
  97. package/docs/CreateRefundRequest.md +1 -1
  98. package/docs/CreateSafeWalletParams.md +1 -1
  99. package/docs/CreateSettlement.md +1 -1
  100. package/docs/CreateSmartContractWalletParams.md +1 -1
  101. package/docs/CreateWalletParams.md +1 -1
  102. package/docs/DeleteAddressBookById201Response.md +9 -0
  103. package/docs/DispositionEventData.md +14 -0
  104. package/docs/DispositionQueryResponse.md +12 -0
  105. package/docs/DispositionResponse.md +10 -0
  106. package/docs/DispositionStatus.md +34 -0
  107. package/docs/DispositionType.md +14 -0
  108. package/docs/IsolateDisposition.md +13 -0
  109. package/docs/MPCVaultEventData.md +3 -1
  110. package/docs/Merchant.md +1 -1
  111. package/docs/MerchantBalance.md +6 -6
  112. package/docs/OrgInfo.md +1 -0
  113. package/docs/PaymentAddressUpdateEventData.md +3 -1
  114. package/docs/PaymentApi.md +10 -10
  115. package/docs/PaymentOrderEventData.md +3 -1
  116. package/docs/PaymentRefundEventData.md +3 -1
  117. package/docs/PaymentSettlementEvent.md +3 -1
  118. package/docs/PaymentTransactionEventData.md +3 -1
  119. package/docs/PaymentWalletBalance.md +5 -5
  120. package/docs/PspBalance.md +6 -6
  121. package/docs/ReceivedAmountPerAddress.md +2 -2
  122. package/docs/RefundDisposition.md +13 -0
  123. package/docs/RoleDetail.md +4 -1
  124. package/docs/SuspendedTokenEventData.md +3 -1
  125. package/docs/TSSRequestWebhookEventData.md +3 -1
  126. package/docs/TokenListingEventData.md +3 -1
  127. package/docs/TokenizationApi.md +2 -2
  128. package/docs/TokensEventData.md +3 -1
  129. package/docs/TransactionWebhookEventData.md +3 -1
  130. package/docs/TransactionsApi.md +10 -10
  131. package/docs/UnfreezeDisposition.md +9 -0
  132. package/docs/UpdateAddressBookParam.md +12 -0
  133. package/docs/UpdateMerchantByIdRequest.md +1 -1
  134. package/docs/WalletInfoEventData.md +3 -1
  135. package/docs/WalletsApi.md +2 -2
  136. package/docs/WalletsMPCWalletsApi.md +1 -1
  137. package/docs/WebhookEventData.md +8 -2
  138. package/docs/WebhookEventDataType.md +3 -1
  139. package/docs/WebhookEventType.md +2 -0
  140. package/package.json +1 -1
  141. package/dist/model/ApprovalShowInfo.js +0 -140
  142. package/docs/ApprovalShowInfo.md +0 -13
package/README.md CHANGED
@@ -15,7 +15,7 @@ For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](http
15
15
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
16
16
 
17
17
  - API version: v2
18
- - Package version: 1.22.0
18
+ - Package version: 1.23.0
19
19
  - Generator version: 7.6.0
20
20
  - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
21
21
  For more information, please visit [https://www.cobo.com/waas](https://www.cobo.com/waas)
@@ -67,17 +67,25 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
67
67
 
68
68
  Class | Method | HTTP request | Description
69
69
  ------------ | ------------- | ------------- | -------------
70
- *CoboWaas2.AddressBooksApi* | [**listAddressBooks**](docs/AddressBooksApi.md#listAddressBooks) | **GET** /address_books | List address book entries
70
+ *CoboWaas2.AddressBooksApi* | [**createAddressBooks**](docs/AddressBooksApi.md#createAddressBooks) | **POST** /address_books | Create Address Book entries
71
+ *CoboWaas2.AddressBooksApi* | [**deleteAddressBookById**](docs/AddressBooksApi.md#deleteAddressBookById) | **POST** /address_books/{entry_id}/delete | Delete Address Book entry
72
+ *CoboWaas2.AddressBooksApi* | [**getAddressBookById**](docs/AddressBooksApi.md#getAddressBookById) | **GET** /address_books/{entry_id} | Get Address Book entry
73
+ *CoboWaas2.AddressBooksApi* | [**listAddressBooks**](docs/AddressBooksApi.md#listAddressBooks) | **GET** /address_books | List Address Book entries
74
+ *CoboWaas2.AddressBooksApi* | [**updateAddressBookById**](docs/AddressBooksApi.md#updateAddressBookById) | **PUT** /address_books/{entry_id} | Update Address Book entry
71
75
  *CoboWaas2.AppWorkflowsApi* | [**createApprovalRequest**](docs/AppWorkflowsApi.md#createApprovalRequest) | **POST** /app/workflows/approval_requests | Request workflow approval
72
76
  *CoboWaas2.AppWorkflowsApi* | [**getApprovalRequestById**](docs/AppWorkflowsApi.md#getApprovalRequestById) | **GET** /app/workflows/approval_requests/{approval_id} | Get approval request details
73
77
  *CoboWaas2.AppWorkflowsApi* | [**listAppWorkflows**](docs/AppWorkflowsApi.md#listAppWorkflows) | **GET** /app/workflows | List app workflows
74
78
  *CoboWaas2.AppWorkflowsApi* | [**listApprovalRequests**](docs/AppWorkflowsApi.md#listApprovalRequests) | **GET** /app/workflows/approval_requests | List approval requests
75
79
  *CoboWaas2.AppWorkflowsApi* | [**revokeApprovalRequest**](docs/AppWorkflowsApi.md#revokeApprovalRequest) | **POST** /app/workflows/approval_requests/{approval_id}/revoke | Revoke approval request
76
- *CoboWaas2.AutoSweepApi* | [**createAutoSweepTask**](docs/AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks | create auto sweep task
77
- *CoboWaas2.AutoSweepApi* | [**createWalletSweepToAddresses**](docs/AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | create wallet sweep to addresses
78
- *CoboWaas2.AutoSweepApi* | [**getAutoSweepTaskById**](docs/AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto sweep task information
79
- *CoboWaas2.AutoSweepApi* | [**listAutoSweepTask**](docs/AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List wallet auto sweep task
80
- *CoboWaas2.AutoSweepApi* | [**listWalletSweepToAddresses**](docs/AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List wallet sweep to addresses
80
+ *CoboWaas2.AutoSweepApi* | [**createAutoSweepTask**](docs/AutoSweepApi.md#createAutoSweepTask) | **POST** /auto_sweep/tasks | Create auto-sweep task
81
+ *CoboWaas2.AutoSweepApi* | [**createWalletSweepToAddresses**](docs/AutoSweepApi.md#createWalletSweepToAddresses) | **POST** /auto_sweep/sweep_to_addresses | create sweep-to address
82
+ *CoboWaas2.AutoSweepApi* | [**getAutoSweepTaskById**](docs/AutoSweepApi.md#getAutoSweepTaskById) | **GET** /auto_sweep/tasks/{task_id} | Get auto-sweep task details
83
+ *CoboWaas2.AutoSweepApi* | [**listAutoSweepTask**](docs/AutoSweepApi.md#listAutoSweepTask) | **GET** /auto_sweep/tasks | List auto-sweep tasks
84
+ *CoboWaas2.AutoSweepApi* | [**listWalletSweepToAddresses**](docs/AutoSweepApi.md#listWalletSweepToAddresses) | **GET** /auto_sweep/sweep_to_addresses | List sweep-to addresses
85
+ *CoboWaas2.ComplianceApi* | [**getDispositionStatus**](docs/ComplianceApi.md#getDispositionStatus) | **GET** /compliance/funds/disposition | Get disposition status
86
+ *CoboWaas2.ComplianceApi* | [**isolateFunds**](docs/ComplianceApi.md#isolateFunds) | **POST** /compliance/funds/disposition/isolate | Isolate funds
87
+ *CoboWaas2.ComplianceApi* | [**refundFunds**](docs/ComplianceApi.md#refundFunds) | **POST** /compliance/funds/disposition/refund | Refund funds
88
+ *CoboWaas2.ComplianceApi* | [**unfreezeFunds**](docs/ComplianceApi.md#unfreezeFunds) | **POST** /compliance/funds/disposition/unfreeze | Unfreeze frozen funds
81
89
  *CoboWaas2.DevelopersApi* | [**getApiKeyInfo**](docs/DevelopersApi.md#getApiKeyInfo) | **GET** /developers/api_key_info | Get API key information
82
90
  *CoboWaas2.DevelopersApi* | [**listCallbackMessages**](docs/DevelopersApi.md#listCallbackMessages) | **GET** /developers/callback_messages | List all callback messages
83
91
  *CoboWaas2.DevelopersApi* | [**retryCallbackMessage**](docs/DevelopersApi.md#retryCallbackMessage) | **POST** /developers/callback_messages/{message_id}/retry | Retry callback message
@@ -110,9 +118,9 @@ Class | Method | HTTP request | Description
110
118
  *CoboWaas2.PaymentApi* | [**createSettlementRequest**](docs/PaymentApi.md#createSettlementRequest) | **POST** /payments/settlement_requests | Create settlement request
111
119
  *CoboWaas2.PaymentApi* | [**deleteCryptoAddress**](docs/PaymentApi.md#deleteCryptoAddress) | **POST** /payments/crypto_addresses/{crypto_address_id}/delete | Delete crypto address
112
120
  *CoboWaas2.PaymentApi* | [**getExchangeRate**](docs/PaymentApi.md#getExchangeRate) | **GET** /payments/exchange_rates/{token_id}/{currency} | Get exchange rate
113
- *CoboWaas2.PaymentApi* | [**getPayerBalanceByAddress**](docs/PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance by address
121
+ *CoboWaas2.PaymentApi* | [**getPayerBalanceByAddress**](docs/PaymentApi.md#getPayerBalanceByAddress) | **GET** /payments/balance/payer/address | Get payer balance
114
122
  *CoboWaas2.PaymentApi* | [**getPaymentOrderDetailById**](docs/PaymentApi.md#getPaymentOrderDetailById) | **GET** /payments/orders/{order_id} | Get pay-in order information
115
- *CoboWaas2.PaymentApi* | [**getPspBalance**](docs/PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get psp balance
123
+ *CoboWaas2.PaymentApi* | [**getPspBalance**](docs/PaymentApi.md#getPspBalance) | **GET** /payments/balance/psp | Get developer balance
116
124
  *CoboWaas2.PaymentApi* | [**getRefundDetailById**](docs/PaymentApi.md#getRefundDetailById) | **GET** /payments/refunds/{refund_id} | Get refund order information
117
125
  *CoboWaas2.PaymentApi* | [**getRefunds**](docs/PaymentApi.md#getRefunds) | **GET** /payments/refunds | List all refund orders
118
126
  *CoboWaas2.PaymentApi* | [**getSettlementById**](docs/PaymentApi.md#getSettlementById) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information
@@ -168,7 +176,7 @@ Class | Method | HTTP request | Description
168
176
  *CoboWaas2.TokenizationApi* | [**listIssuedTokens**](docs/TokenizationApi.md#listIssuedTokens) | **GET** /tokenization/tokens | List issued tokens
169
177
  *CoboWaas2.TokenizationApi* | [**listTokenizationActivities**](docs/TokenizationApi.md#listTokenizationActivities) | **GET** /tokenization/activities | List tokenization activities
170
178
  *CoboWaas2.TokenizationApi* | [**listTokenizationAllowlistAddresses**](docs/TokenizationApi.md#listTokenizationAllowlistAddresses) | **GET** /tokenization/tokens/{token_id}/allowlist/addresses | List addresses on allowlist
171
- *CoboWaas2.TokenizationApi* | [**listTokenizationBlocklistAddresses**](docs/TokenizationApi.md#listTokenizationBlocklistAddresses) | **GET** /tokenization/tokens/{token_id}/blocklist/addresses | Lists addresses on blocklist
179
+ *CoboWaas2.TokenizationApi* | [**listTokenizationBlocklistAddresses**](docs/TokenizationApi.md#listTokenizationBlocklistAddresses) | **GET** /tokenization/tokens/{token_id}/blocklist/addresses | List addresses on blocklist
172
180
  *CoboWaas2.TokenizationApi* | [**listTokenizationHoldings**](docs/TokenizationApi.md#listTokenizationHoldings) | **GET** /tokenization/tokens/{token_id}/holdings | Get token holdings information
173
181
  *CoboWaas2.TokenizationApi* | [**listTokenizationSupportedChains**](docs/TokenizationApi.md#listTokenizationSupportedChains) | **GET** /tokenization/enabled_chains | List supported chains for tokenization
174
182
  *CoboWaas2.TokenizationApi* | [**mintTokenization**](docs/TokenizationApi.md#mintTokenization) | **POST** /tokenization/tokens/{token_id}/mint | Mint tokens
@@ -188,9 +196,9 @@ Class | Method | HTTP request | Description
188
196
  *CoboWaas2.TransactionsApi* | [**estimateFee**](docs/TransactionsApi.md#estimateFee) | **POST** /transactions/estimate_fee | Estimate transaction fee
189
197
  *CoboWaas2.TransactionsApi* | [**getTransactionApprovalDetail**](docs/TransactionsApi.md#getTransactionApprovalDetail) | **GET** /transactions/{transaction_id}/approval_detail | Get transaction approval details
190
198
  *CoboWaas2.TransactionsApi* | [**getTransactionById**](docs/TransactionsApi.md#getTransactionById) | **GET** /transactions/{transaction_id} | Get transaction information
191
- *CoboWaas2.TransactionsApi* | [**listApprovalDetails**](docs/TransactionsApi.md#listApprovalDetails) | **GET** /transactions/approval/details | List transaction approval details
199
+ *CoboWaas2.TransactionsApi* | [**listApprovalDetails**](docs/TransactionsApi.md#listApprovalDetails) | **GET** /transactions/approval/details | List approval details
192
200
  *CoboWaas2.TransactionsApi* | [**listTransactionApprovalDetails**](docs/TransactionsApi.md#listTransactionApprovalDetails) | **GET** /transactions/approval_details | List transaction approval details
193
- *CoboWaas2.TransactionsApi* | [**listTransactionTemplates**](docs/TransactionsApi.md#listTransactionTemplates) | **GET** /transactions/templates | list transaction templates
201
+ *CoboWaas2.TransactionsApi* | [**listTransactionTemplates**](docs/TransactionsApi.md#listTransactionTemplates) | **GET** /transactions/templates | List transaction templates
194
202
  *CoboWaas2.TransactionsApi* | [**listTransactions**](docs/TransactionsApi.md#listTransactions) | **GET** /transactions | List all transactions
195
203
  *CoboWaas2.TransactionsApi* | [**resendTransactionById**](docs/TransactionsApi.md#resendTransactionById) | **POST** /transactions/{transaction_id}/resend | Resend transaction
196
204
  *CoboWaas2.TransactionsApi* | [**signAndBroadcastTransactionById**](docs/TransactionsApi.md#signAndBroadcastTransactionById) | **POST** /transactions/{transaction_id}/sign_and_broadcast | Sign and broadcast transaction
@@ -287,7 +295,6 @@ Class | Method | HTTP request | Description
287
295
  - [CoboWaas2.ApprovalRequest](docs/ApprovalRequest.md)
288
296
  - [CoboWaas2.ApprovalRequestDetail](docs/ApprovalRequestDetail.md)
289
297
  - [CoboWaas2.ApprovalResult](docs/ApprovalResult.md)
290
- - [CoboWaas2.ApprovalShowInfo](docs/ApprovalShowInfo.md)
291
298
  - [CoboWaas2.ApprovalStatementStatus](docs/ApprovalStatementStatus.md)
292
299
  - [CoboWaas2.ApprovalStatus](docs/ApprovalStatus.md)
293
300
  - [CoboWaas2.ApprovalTemplate](docs/ApprovalTemplate.md)
@@ -336,6 +343,7 @@ Class | Method | HTTP request | Description
336
343
  - [CoboWaas2.CheckLoopTransfers200ResponseInner](docs/CheckLoopTransfers200ResponseInner.md)
337
344
  - [CoboWaas2.CoboSafeDelegate](docs/CoboSafeDelegate.md)
338
345
  - [CoboWaas2.CoboSafeDelegateType](docs/CoboSafeDelegateType.md)
346
+ - [CoboWaas2.ComplianceDispositionUpdateEventData](docs/ComplianceDispositionUpdateEventData.md)
339
347
  - [CoboWaas2.ContractCallDestination](docs/ContractCallDestination.md)
340
348
  - [CoboWaas2.ContractCallDestinationType](docs/ContractCallDestinationType.md)
341
349
  - [CoboWaas2.ContractCallParams](docs/ContractCallParams.md)
@@ -347,6 +355,9 @@ Class | Method | HTTP request | Description
347
355
  - [CoboWaas2.CosmosAdr36MessageSignDestination](docs/CosmosAdr36MessageSignDestination.md)
348
356
  - [CoboWaas2.CosmosContractCallDestination](docs/CosmosContractCallDestination.md)
349
357
  - [CoboWaas2.CosmosContractCallMessage](docs/CosmosContractCallMessage.md)
358
+ - [CoboWaas2.CreateAddressBookParam](docs/CreateAddressBookParam.md)
359
+ - [CoboWaas2.CreateAddressBooks201Response](docs/CreateAddressBooks201Response.md)
360
+ - [CoboWaas2.CreateAddressBooksParam](docs/CreateAddressBooksParam.md)
350
361
  - [CoboWaas2.CreateAddressRequest](docs/CreateAddressRequest.md)
351
362
  - [CoboWaas2.CreateApprovalRequest201Response](docs/CreateApprovalRequest201Response.md)
352
363
  - [CoboWaas2.CreateAutoSweepTask](docs/CreateAutoSweepTask.md)
@@ -398,11 +409,17 @@ Class | Method | HTTP request | Description
398
409
  - [CoboWaas2.CustodialWeb3ContractCallSource](docs/CustodialWeb3ContractCallSource.md)
399
410
  - [CoboWaas2.CustodialWeb3MessageSignSource](docs/CustodialWeb3MessageSignSource.md)
400
411
  - [CoboWaas2.CustodialWeb3TransferSource](docs/CustodialWeb3TransferSource.md)
412
+ - [CoboWaas2.DeleteAddressBookById201Response](docs/DeleteAddressBookById201Response.md)
401
413
  - [CoboWaas2.DeleteCryptoAddress201Response](docs/DeleteCryptoAddress201Response.md)
402
414
  - [CoboWaas2.DeleteGuardPubkey201Response](docs/DeleteGuardPubkey201Response.md)
403
415
  - [CoboWaas2.DeleteKeyShareHolderGroupById201Response](docs/DeleteKeyShareHolderGroupById201Response.md)
404
416
  - [CoboWaas2.DeleteWalletById201Response](docs/DeleteWalletById201Response.md)
405
417
  - [CoboWaas2.DestinationWalletType](docs/DestinationWalletType.md)
418
+ - [CoboWaas2.DispositionEventData](docs/DispositionEventData.md)
419
+ - [CoboWaas2.DispositionQueryResponse](docs/DispositionQueryResponse.md)
420
+ - [CoboWaas2.DispositionResponse](docs/DispositionResponse.md)
421
+ - [CoboWaas2.DispositionStatus](docs/DispositionStatus.md)
422
+ - [CoboWaas2.DispositionType](docs/DispositionType.md)
406
423
  - [CoboWaas2.EigenLayerLstStakeExtra](docs/EigenLayerLstStakeExtra.md)
407
424
  - [CoboWaas2.EigenLayerNativeStakeExtra](docs/EigenLayerNativeStakeExtra.md)
408
425
  - [CoboWaas2.EigenlayerValidator](docs/EigenlayerValidator.md)
@@ -477,6 +494,7 @@ Class | Method | HTTP request | Description
477
494
  - [CoboWaas2.GraphQLRequest](docs/GraphQLRequest.md)
478
495
  - [CoboWaas2.GraphQLResponse](docs/GraphQLResponse.md)
479
496
  - [CoboWaas2.GuardPubkeyStatus](docs/GuardPubkeyStatus.md)
497
+ - [CoboWaas2.IsolateDisposition](docs/IsolateDisposition.md)
480
498
  - [CoboWaas2.KeyShareHolder](docs/KeyShareHolder.md)
481
499
  - [CoboWaas2.KeyShareHolderGroup](docs/KeyShareHolderGroup.md)
482
500
  - [CoboWaas2.KeyShareHolderGroupStatus](docs/KeyShareHolderGroupStatus.md)
@@ -588,6 +606,7 @@ Class | Method | HTTP request | Description
588
606
  - [CoboWaas2.RefreshToken2XXResponse](docs/RefreshToken2XXResponse.md)
589
607
  - [CoboWaas2.RefreshTokenRequest](docs/RefreshTokenRequest.md)
590
608
  - [CoboWaas2.Refund](docs/Refund.md)
609
+ - [CoboWaas2.RefundDisposition](docs/RefundDisposition.md)
591
610
  - [CoboWaas2.RefundStatus](docs/RefundStatus.md)
592
611
  - [CoboWaas2.RefundType](docs/RefundType.md)
593
612
  - [CoboWaas2.ReplaceType](docs/ReplaceType.md)
@@ -873,6 +892,8 @@ Class | Method | HTTP request | Description
873
892
  - [CoboWaas2.TriggerTestWebhookEvent201Response](docs/TriggerTestWebhookEvent201Response.md)
874
893
  - [CoboWaas2.TriggerTestWebhookEventRequest](docs/TriggerTestWebhookEventRequest.md)
875
894
  - [CoboWaas2.UTXO](docs/UTXO.md)
895
+ - [CoboWaas2.UnfreezeDisposition](docs/UnfreezeDisposition.md)
896
+ - [CoboWaas2.UpdateAddressBookParam](docs/UpdateAddressBookParam.md)
876
897
  - [CoboWaas2.UpdateCustodialWalletParams](docs/UpdateCustodialWalletParams.md)
877
898
  - [CoboWaas2.UpdateExchangeWalletParams](docs/UpdateExchangeWalletParams.md)
878
899
  - [CoboWaas2.UpdateGroupAction](docs/UpdateGroupAction.md)
@@ -936,7 +957,7 @@ Authentication schemes defined for the API:
936
957
  - **Flow**: accessCode
937
958
  - **Authorization URL**: https://auth.cobo.com/authorize
938
959
  - **Scopes**:
939
- - address_book.read: Read address book
960
+ - address_book.read: Read Address Book
940
961
  - api_key.read: Read API key information
941
962
  - callback.read: Read callback message
942
963
  - callback.resend: Resend callback message
@@ -983,4 +1004,8 @@ Authentication schemes defined for the API:
983
1004
  - payment_merchant.update: Update payment merchant
984
1005
  - payment_force_sweep.create: Create payment force sweep request
985
1006
  - payment_force_sweep.read: Read payment force sweep request information
1007
+ - compliance_funds.refund: Refund compliance funds request
1008
+ - compliance_funds.isolate: Isolate compliance funds request
1009
+ - compliance_funds.unfreeze: Unfreeze compliance funds request
1010
+ - compliance_funds.read: Read compliance funds request information
986
1011
 
package/dist/ApiClient.js CHANGED
@@ -102,7 +102,7 @@ var ApiClient = /*#__PURE__*/function () {
102
102
  * @default {}
103
103
  */
104
104
  this.defaultHeaders = {
105
- 'User-Agent': 'cobo-waas2-js-sdk/1.22.0'
105
+ 'User-Agent': 'cobo-waas2-js-sdk/1.23.0'
106
106
  };
107
107
 
108
108
  /**
@@ -5,8 +5,13 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _AddressBook = _interopRequireDefault(require("../model/AddressBook"));
9
+ var _CreateAddressBooks201Response = _interopRequireDefault(require("../model/CreateAddressBooks201Response"));
10
+ var _CreateAddressBooksParam = _interopRequireDefault(require("../model/CreateAddressBooksParam"));
11
+ var _DeleteAddressBookById201Response = _interopRequireDefault(require("../model/DeleteAddressBookById201Response"));
8
12
  var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
9
13
  var _ListAddressBooks200Response = _interopRequireDefault(require("../model/ListAddressBooks200Response"));
14
+ var _UpdateAddressBookParam = _interopRequireDefault(require("../model/UpdateAddressBookParam"));
10
15
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
11
16
  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); }
12
17
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -41,32 +46,157 @@ var AddressBooksApi = exports["default"] = /*#__PURE__*/function () {
41
46
  }
42
47
 
43
48
  /**
44
- * List address book entries
45
- * This operation retrieves a list of addresses from your address book.
46
- * @param {String} chain_id 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).
49
+ * Create Address Book entries
50
+ * This operation adds new entries (records) to your Address Book.
47
51
  * @param {Object} opts Optional parameters
48
- * @param {String} [address] The wallet address.
49
- * @param {String} [label] The address label.
50
- * @param {Number} [limit = 10)] The maximum number of objects to return. For most operations, the value range is [1, 50].
51
- * @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.
52
- * @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.
53
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListAddressBooks200Response} and HTTP response
52
+ * @param {module:model/CreateAddressBooksParam} [CreateAddressBooksParam] The request body of the create Address Books operation.
53
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateAddressBooks201Response} and HTTP response
54
54
  */
55
55
  return _createClass(AddressBooksApi, [{
56
- key: "listAddressBooksWithHttpInfo",
57
- value: function listAddressBooksWithHttpInfo(chain_id, opts) {
56
+ key: "createAddressBooksWithHttpInfo",
57
+ value: function createAddressBooksWithHttpInfo(opts) {
58
58
  opts = opts || {};
59
+ var postBody = opts['CreateAddressBooksParam'];
60
+ if (postBody && postBody.toJSON) {
61
+ postBody = postBody.toJSON();
62
+ }
63
+ var pathParams = {};
64
+ var queryParams = {};
65
+ var headerParams = {};
66
+ var formParams = {};
67
+ var authNames = ['OAuth2', 'CoboAuth'];
68
+ var contentTypes = ['application/json'];
69
+ var accepts = ['application/json'];
70
+ var returnType = _CreateAddressBooks201Response["default"];
71
+ return this.apiClient.callApi('/address_books', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
72
+ }
73
+
74
+ /**
75
+ * Create Address Book entries
76
+ * This operation adds new entries (records) to your Address Book.
77
+ * @param {Object} opts Optional parameters
78
+ * @param {module:model/CreateAddressBooksParam} opts.CreateAddressBooksParam The request body of the create Address Books operation.
79
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateAddressBooks201Response}
80
+ */
81
+ }, {
82
+ key: "createAddressBooks",
83
+ value: function createAddressBooks(opts) {
84
+ return this.createAddressBooksWithHttpInfo(opts).then(function (response_and_data) {
85
+ return response_and_data.data;
86
+ });
87
+ }
88
+
89
+ /**
90
+ * Delete Address Book entry
91
+ * This operation deletes a specified Address Book entry (record).
92
+ * @param {String} entry_id The Address Book entry ID.
93
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteAddressBookById201Response} and HTTP response
94
+ */
95
+ }, {
96
+ key: "deleteAddressBookByIdWithHttpInfo",
97
+ value: function deleteAddressBookByIdWithHttpInfo(entry_id) {
59
98
  var postBody = null;
60
99
  if (postBody && postBody.toJSON) {
61
100
  postBody = postBody.toJSON();
62
101
  }
63
- // verify the required parameter 'chain_id' is set
64
- if (chain_id === undefined || chain_id === null) {
65
- throw new Error("Missing the required parameter 'chain_id' when calling listAddressBooks");
102
+ // verify the required parameter 'entry_id' is set
103
+ if (entry_id === undefined || entry_id === null) {
104
+ throw new Error("Missing the required parameter 'entry_id' when calling deleteAddressBookById");
105
+ }
106
+ var pathParams = {
107
+ 'entry_id': entry_id
108
+ };
109
+ var queryParams = {};
110
+ var headerParams = {};
111
+ var formParams = {};
112
+ var authNames = ['OAuth2', 'CoboAuth'];
113
+ var contentTypes = [];
114
+ var accepts = ['application/json'];
115
+ var returnType = _DeleteAddressBookById201Response["default"];
116
+ return this.apiClient.callApi('/address_books/{entry_id}/delete', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
117
+ }
118
+
119
+ /**
120
+ * Delete Address Book entry
121
+ * This operation deletes a specified Address Book entry (record).
122
+ * @param {String} entry_id The Address Book entry ID.
123
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteAddressBookById201Response}
124
+ */
125
+ }, {
126
+ key: "deleteAddressBookById",
127
+ value: function deleteAddressBookById(entry_id) {
128
+ return this.deleteAddressBookByIdWithHttpInfo(entry_id).then(function (response_and_data) {
129
+ return response_and_data.data;
130
+ });
131
+ }
132
+
133
+ /**
134
+ * Get Address Book entry
135
+ * This operation retrieves the detailed information about a specified Address Book entry (record).
136
+ * @param {String} entry_id The Address Book entry ID.
137
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddressBook} and HTTP response
138
+ */
139
+ }, {
140
+ key: "getAddressBookByIdWithHttpInfo",
141
+ value: function getAddressBookByIdWithHttpInfo(entry_id) {
142
+ var postBody = null;
143
+ if (postBody && postBody.toJSON) {
144
+ postBody = postBody.toJSON();
145
+ }
146
+ // verify the required parameter 'entry_id' is set
147
+ if (entry_id === undefined || entry_id === null) {
148
+ throw new Error("Missing the required parameter 'entry_id' when calling getAddressBookById");
149
+ }
150
+ var pathParams = {
151
+ 'entry_id': entry_id
152
+ };
153
+ var queryParams = {};
154
+ var headerParams = {};
155
+ var formParams = {};
156
+ var authNames = ['OAuth2', 'CoboAuth'];
157
+ var contentTypes = [];
158
+ var accepts = ['application/json'];
159
+ var returnType = _AddressBook["default"];
160
+ return this.apiClient.callApi('/address_books/{entry_id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
161
+ }
162
+
163
+ /**
164
+ * Get Address Book entry
165
+ * This operation retrieves the detailed information about a specified Address Book entry (record).
166
+ * @param {String} entry_id The Address Book entry ID.
167
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddressBook}
168
+ */
169
+ }, {
170
+ key: "getAddressBookById",
171
+ value: function getAddressBookById(entry_id) {
172
+ return this.getAddressBookByIdWithHttpInfo(entry_id).then(function (response_and_data) {
173
+ return response_and_data.data;
174
+ });
175
+ }
176
+
177
+ /**
178
+ * List Address Book entries
179
+ * This operation retrieves all entries (records) from your Address Book. You can filter the entries by chain ID, address, and label.
180
+ * @param {Object} opts Optional parameters
181
+ * @param {String} [chain_id] 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).
182
+ * @param {String} [address] The wallet address.
183
+ * @param {String} [label] A user-defined label for the address.
184
+ * @param {Number} [limit = 10)] The maximum number of objects to return. For most operations, the value range is [1, 50].
185
+ * @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.
186
+ * @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.
187
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListAddressBooks200Response} and HTTP response
188
+ */
189
+ }, {
190
+ key: "listAddressBooksWithHttpInfo",
191
+ value: function listAddressBooksWithHttpInfo(opts) {
192
+ opts = opts || {};
193
+ var postBody = null;
194
+ if (postBody && postBody.toJSON) {
195
+ postBody = postBody.toJSON();
66
196
  }
67
197
  var pathParams = {};
68
198
  var queryParams = {
69
- 'chain_id': chain_id,
199
+ 'chain_id': opts['chain_id'],
70
200
  'address': opts['address'],
71
201
  'label': opts['label'],
72
202
  'limit': opts['limit'],
@@ -83,12 +213,12 @@ var AddressBooksApi = exports["default"] = /*#__PURE__*/function () {
83
213
  }
84
214
 
85
215
  /**
86
- * List address book entries
87
- * This operation retrieves a list of addresses from your address book.
88
- * @param {String} chain_id 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).
216
+ * List Address Book entries
217
+ * This operation retrieves all entries (records) from your Address Book. You can filter the entries by chain ID, address, and label.
89
218
  * @param {Object} opts Optional parameters
219
+ * @param {String} opts.chain_id 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).
90
220
  * @param {String} opts.address The wallet address.
91
- * @param {String} opts.label The address label.
221
+ * @param {String} opts.label A user-defined label for the address.
92
222
  * @param {Number} opts.limit The maximum number of objects to return. For most operations, the value range is [1, 50]. (default to 10)
93
223
  * @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.
94
224
  * @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.
@@ -96,8 +226,57 @@ var AddressBooksApi = exports["default"] = /*#__PURE__*/function () {
96
226
  */
97
227
  }, {
98
228
  key: "listAddressBooks",
99
- value: function listAddressBooks(chain_id, opts) {
100
- return this.listAddressBooksWithHttpInfo(chain_id, opts).then(function (response_and_data) {
229
+ value: function listAddressBooks(opts) {
230
+ return this.listAddressBooksWithHttpInfo(opts).then(function (response_and_data) {
231
+ return response_and_data.data;
232
+ });
233
+ }
234
+
235
+ /**
236
+ * Update Address Book entry
237
+ * This operation updates the information of a specified Address Book entry (record).
238
+ * @param {String} entry_id The Address Book entry ID.
239
+ * @param {Object} opts Optional parameters
240
+ * @param {module:model/UpdateAddressBookParam} [UpdateAddressBookParam] The request body of the update Address Book operation.
241
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AddressBook} and HTTP response
242
+ */
243
+ }, {
244
+ key: "updateAddressBookByIdWithHttpInfo",
245
+ value: function updateAddressBookByIdWithHttpInfo(entry_id, opts) {
246
+ opts = opts || {};
247
+ var postBody = opts['UpdateAddressBookParam'];
248
+ if (postBody && postBody.toJSON) {
249
+ postBody = postBody.toJSON();
250
+ }
251
+ // verify the required parameter 'entry_id' is set
252
+ if (entry_id === undefined || entry_id === null) {
253
+ throw new Error("Missing the required parameter 'entry_id' when calling updateAddressBookById");
254
+ }
255
+ var pathParams = {
256
+ 'entry_id': entry_id
257
+ };
258
+ var queryParams = {};
259
+ var headerParams = {};
260
+ var formParams = {};
261
+ var authNames = ['OAuth2', 'CoboAuth'];
262
+ var contentTypes = ['application/json'];
263
+ var accepts = ['application/json'];
264
+ var returnType = _AddressBook["default"];
265
+ return this.apiClient.callApi('/address_books/{entry_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
266
+ }
267
+
268
+ /**
269
+ * Update Address Book entry
270
+ * This operation updates the information of a specified Address Book entry (record).
271
+ * @param {String} entry_id The Address Book entry ID.
272
+ * @param {Object} opts Optional parameters
273
+ * @param {module:model/UpdateAddressBookParam} opts.UpdateAddressBookParam The request body of the update Address Book operation.
274
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AddressBook}
275
+ */
276
+ }, {
277
+ key: "updateAddressBookById",
278
+ value: function updateAddressBookById(entry_id, opts) {
279
+ return this.updateAddressBookByIdWithHttpInfo(entry_id, opts).then(function (response_and_data) {
101
280
  return response_and_data.data;
102
281
  });
103
282
  }
@@ -46,10 +46,10 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
46
46
  }
47
47
 
48
48
  /**
49
- * create auto sweep task
50
- * This operation create a new auto sweep task.
49
+ * Create auto-sweep task
50
+ * 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.
51
51
  * @param {Object} opts Optional parameters
52
- * @param {module:model/CreateAutoSweepTask} [CreateAutoSweepTask] The request body to generates a new sweep to addresses within a specified wallet.
52
+ * @param {module:model/CreateAutoSweepTask} [CreateAutoSweepTask] The request body to create an auto-sweep task.
53
53
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AutoSweepTask} and HTTP response
54
54
  */
55
55
  return _createClass(AutoSweepApi, [{
@@ -72,10 +72,10 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
72
72
  }
73
73
 
74
74
  /**
75
- * create auto sweep task
76
- * This operation create a new auto sweep task.
75
+ * Create auto-sweep task
76
+ * 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.
77
77
  * @param {Object} opts Optional parameters
78
- * @param {module:model/CreateAutoSweepTask} opts.CreateAutoSweepTask The request body to generates a new sweep to addresses within a specified wallet.
78
+ * @param {module:model/CreateAutoSweepTask} opts.CreateAutoSweepTask The request body to create an auto-sweep task.
79
79
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AutoSweepTask}
80
80
  */
81
81
  }, {
@@ -87,10 +87,10 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
87
87
  }
88
88
 
89
89
  /**
90
- * create wallet sweep to addresses
91
- * This operation create a new sweep to address for the wallet. The old sweep to address will become invalid.
90
+ * create sweep-to address
91
+ * 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>
92
92
  * @param {Object} opts Optional parameters
93
- * @param {module:model/CreateSweepToAddress} [CreateSweepToAddress] The request body to generates a new sweep to addresses within a specified wallet.
93
+ * @param {module:model/CreateSweepToAddress} [CreateSweepToAddress] The request body to generates a new sweep-to address within a specified wallet.
94
94
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SweepToAddress} and HTTP response
95
95
  */
96
96
  }, {
@@ -113,10 +113,10 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
113
113
  }
114
114
 
115
115
  /**
116
- * create wallet sweep to addresses
117
- * This operation create a new sweep to address for the wallet. The old sweep to address will become invalid.
116
+ * create sweep-to address
117
+ * 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>
118
118
  * @param {Object} opts Optional parameters
119
- * @param {module:model/CreateSweepToAddress} opts.CreateSweepToAddress The request body to generates a new sweep to addresses within a specified wallet.
119
+ * @param {module:model/CreateSweepToAddress} opts.CreateSweepToAddress The request body to generates a new sweep-to address within a specified wallet.
120
120
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SweepToAddress}
121
121
  */
122
122
  }, {
@@ -128,8 +128,8 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
128
128
  }
129
129
 
130
130
  /**
131
- * Get auto sweep task information
132
- * This operation retrieves detailed information about a specified auto sweep task.
131
+ * Get auto-sweep task details
132
+ * This operation retrieves detailed information about a specified auto-sweep task.
133
133
  * @param {String} task_id The auto sweep task ID.
134
134
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AutoSweepTask} and HTTP response
135
135
  */
@@ -158,8 +158,8 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
158
158
  }
159
159
 
160
160
  /**
161
- * Get auto sweep task information
162
- * This operation retrieves detailed information about a specified auto sweep task.
161
+ * Get auto-sweep task details
162
+ * This operation retrieves detailed information about a specified auto-sweep task.
163
163
  * @param {String} task_id The auto sweep task ID.
164
164
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AutoSweepTask}
165
165
  */
@@ -172,12 +172,12 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
172
172
  }
173
173
 
174
174
  /**
175
- * List wallet auto sweep task
176
- * This operation retrieves a list of auto sweep task.
175
+ * List auto-sweep tasks
176
+ * 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.
177
177
  * @param {String} wallet_id The wallet ID.
178
178
  * @param {Object} opts Optional parameters
179
179
  * @param {String} [token_id] 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).
180
- * @param {String} [task_ids] A list of auto sweep task IDs, separated by comma.
180
+ * @param {String} [task_ids] A list of auto-sweep task IDs, separated by comma.
181
181
  * @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.
182
182
  * @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.
183
183
  * @param {Number} [limit = 10)] The maximum number of objects to return. For most operations, the value range is [1, 50].
@@ -220,12 +220,12 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
220
220
  }
221
221
 
222
222
  /**
223
- * List wallet auto sweep task
224
- * This operation retrieves a list of auto sweep task.
223
+ * List auto-sweep tasks
224
+ * 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.
225
225
  * @param {String} wallet_id The wallet ID.
226
226
  * @param {Object} opts Optional parameters
227
227
  * @param {String} opts.token_id 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).
228
- * @param {String} opts.task_ids A list of auto sweep task IDs, separated by comma.
228
+ * @param {String} opts.task_ids A list of auto-sweep task IDs, separated by comma.
229
229
  * @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.
230
230
  * @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.
231
231
  * @param {Number} opts.limit The maximum number of objects to return. For most operations, the value range is [1, 50]. (default to 10)
@@ -243,8 +243,8 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
243
243
  }
244
244
 
245
245
  /**
246
- * List wallet sweep to addresses
247
- * This operation retrieves a list of sweep to addresses within your wallet.
246
+ * List sweep-to addresses
247
+ * 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>
248
248
  * @param {String} wallet_id The wallet ID.
249
249
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListWalletSweepToAddresses200Response} and HTTP response
250
250
  */
@@ -273,8 +273,8 @@ var AutoSweepApi = exports["default"] = /*#__PURE__*/function () {
273
273
  }
274
274
 
275
275
  /**
276
- * List wallet sweep to addresses
277
- * This operation retrieves a list of sweep to addresses within your wallet.
276
+ * List sweep-to addresses
277
+ * 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>
278
278
  * @param {String} wallet_id The wallet ID.
279
279
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListWalletSweepToAddresses200Response}
280
280
  */