@cobo/cobo-waas2 1.22.0 → 1.24.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 (285) hide show
  1. package/README.md +81 -17
  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/FeeStationApi.js +47 -4
  7. package/dist/api/PaymentApi.js +204 -57
  8. package/dist/api/SwapsApi.js +374 -0
  9. package/dist/api/TokenizationApi.js +2 -2
  10. package/dist/api/TransactionsApi.js +18 -18
  11. package/dist/api/WalletsApi.js +4 -4
  12. package/dist/api/WalletsMPCWalletsApi.js +2 -2
  13. package/dist/index.js +329 -21
  14. package/dist/model/AddressBook.js +12 -12
  15. package/dist/model/AddressInfo.js +13 -0
  16. package/dist/model/AddressesEventData.js +8 -3
  17. package/dist/model/AddressesEventDataAllOfAddresses.js +18 -0
  18. package/dist/model/ApprovalDetail.js +4 -4
  19. package/dist/model/ApprovalResult.js +6 -11
  20. package/dist/model/ApprovalTemplate.js +4 -4
  21. package/dist/model/ApprovalTransactionResult.js +8 -8
  22. package/dist/model/ApprovalUserDetail.js +95 -24
  23. package/dist/model/AutoSweepTask.js +9 -9
  24. package/dist/model/BalanceUpdateInfoEventData.js +8 -3
  25. package/dist/model/BridgingFee.js +136 -0
  26. package/dist/model/ChainInfo.js +14 -1
  27. package/dist/model/ChainsEventData.js +8 -3
  28. package/dist/model/CommissionFee.js +110 -0
  29. package/dist/model/ComplianceDispositionUpdateEventData.js +321 -0
  30. package/dist/model/ContractCallDestination.js +48 -8
  31. package/dist/model/ContractCallDestinationType.js +5 -0
  32. package/dist/model/CreateAddressBookParam.js +165 -0
  33. package/dist/model/CreateAddressBooks201Response.js +107 -0
  34. package/dist/model/CreateAddressBooksParam.js +128 -0
  35. package/dist/model/CreateAutoSweepTask.js +5 -5
  36. package/dist/model/CreateCustodialWalletParams.js +1 -1
  37. package/dist/model/CreateExchangeWalletParams.js +2 -2
  38. package/dist/model/CreateMerchantRequest.js +14 -7
  39. package/dist/model/CreateMpcWalletParams.js +2 -2
  40. package/dist/model/CreatePaymentOrderRequest.js +17 -4
  41. package/dist/model/CreateRefundRequest.js +2 -2
  42. package/dist/model/CreateSafeWalletParams.js +1 -1
  43. package/dist/model/CreateSettlement.js +3 -3
  44. package/dist/model/CreateSettlementRequestRequest.js +39 -0
  45. package/dist/model/CreateSmartContractWalletParams.js +1 -1
  46. package/dist/model/CreateSwapActivityRequest.js +193 -0
  47. package/dist/model/CreateSweepToAddress.js +1 -1
  48. package/dist/model/CreateWalletParams.js +1 -1
  49. package/dist/model/CustodialTransferDestination.js +1 -1
  50. package/dist/model/DeleteAddressBookById201Response.js +106 -0
  51. package/dist/model/DispositionEventData.js +170 -0
  52. package/dist/model/DispositionQueryResponse.js +146 -0
  53. package/dist/model/DispositionResponse.js +122 -0
  54. package/dist/model/DispositionStatus.js +116 -0
  55. package/dist/model/DispositionType.js +66 -0
  56. package/dist/model/EstimateContractCallFeeParams.js +1 -1
  57. package/dist/model/EstimateFeeParams.js +1 -1
  58. package/dist/model/EstimateTransferFeeParams.js +1 -1
  59. package/dist/model/EstimatedEvmEip1559Fee.js +1 -1
  60. package/dist/model/EstimatedEvmLegacyFee.js +1 -1
  61. package/dist/model/EstimatedFILFee.js +1 -1
  62. package/dist/model/EstimatedFixedFee.js +1 -1
  63. package/dist/model/EstimatedSOLFee.js +1 -1
  64. package/dist/model/EstimatedUtxoFee.js +1 -1
  65. package/dist/model/FeeStationCheckFeeStationUsage.js +186 -0
  66. package/dist/model/FeeStationCheckFeeStationUsageResponse.js +200 -0
  67. package/dist/model/FeeStationGasStationType.js +61 -0
  68. package/dist/model/IsolateDisposition.js +167 -0
  69. package/dist/model/ListSwapActivities200Response.js +123 -0
  70. package/dist/model/ListSwapEnabledTokens200Response.js +123 -0
  71. package/dist/model/ListTopUpPayerAccounts200Response.js +123 -0
  72. package/dist/model/MPCVaultEventData.js +8 -3
  73. package/dist/model/Merchant.js +10 -1
  74. package/dist/model/MerchantBalance.js +7 -7
  75. package/dist/model/MessageSignDestination.js +8 -70
  76. package/dist/model/OrgInfo.js +9 -0
  77. package/dist/model/OtcFee.js +123 -0
  78. package/dist/model/PaymentAddressUpdateEventData.js +8 -3
  79. package/dist/model/PaymentEstimateFee.js +125 -0
  80. package/dist/model/PaymentEstimateFee201Response.js +107 -0
  81. package/dist/model/{RawMessageSignDestination.js → PaymentEstimateFeeRequest.js} +51 -37
  82. package/dist/model/PaymentEstimatedFee.js +173 -0
  83. package/dist/model/PaymentFeeType.js +71 -0
  84. package/dist/model/PaymentOrderEventData.js +8 -3
  85. package/dist/model/PaymentRefundEventData.js +30 -5
  86. package/dist/model/PaymentSettlementEvent.js +70 -9
  87. package/dist/model/PaymentTransactionEventData.js +8 -3
  88. package/dist/model/PaymentWalletBalance.js +6 -6
  89. package/dist/model/PspBalance.js +7 -7
  90. package/dist/model/ReceivedAmountPerAddress.js +5 -5
  91. package/dist/model/Refund.js +17 -1
  92. package/dist/model/RefundDisposition.js +167 -0
  93. package/dist/model/RoleDetail.js +41 -6
  94. package/dist/model/SettleRequestStatus.js +5 -0
  95. package/dist/model/Settlement.js +45 -3
  96. package/dist/model/SettlementDetail.js +33 -1
  97. package/dist/model/SettlementInfo.js +7 -7
  98. package/dist/model/SolContractCallAddressLookupTableAccount.js +126 -0
  99. package/dist/model/SolContractCallDestination.js +30 -0
  100. package/dist/model/StellarContractCallContractParam.js +164 -0
  101. package/dist/model/StellarContractCallContractType.js +56 -0
  102. package/dist/model/StellarContractCallDestination.js +125 -0
  103. package/dist/model/StellarContractCallTrustLineOperationType.js +56 -0
  104. package/dist/model/StellarContractCallTrustLineParam.js +133 -0
  105. package/dist/model/SupportedToken.js +9 -0
  106. package/dist/model/SuspendedTokenEventData.js +8 -3
  107. package/dist/model/SwapActivity.js +9 -9
  108. package/dist/model/SwapActivityApprovers.js +1 -1
  109. package/dist/model/SwapActivityDetail.js +34 -18
  110. package/dist/model/SwapActivitySigners.js +2 -2
  111. package/dist/model/SwapActivityTimeline.js +5 -5
  112. package/dist/model/SwapEstimateFee.js +147 -0
  113. package/dist/model/SwapQuote.js +18 -31
  114. package/dist/model/SwapReceivingTransaction.js +133 -0
  115. package/dist/model/SwapToken.js +9 -9
  116. package/dist/model/SweepToAddress.js +1 -1
  117. package/dist/model/TSSRequestWebhookEventData.js +8 -3
  118. package/dist/model/TokenListingEventData.js +8 -3
  119. package/dist/model/TokensEventData.js +8 -3
  120. package/dist/model/TransactionCoboCategory.js +5 -0
  121. package/dist/model/TransactionDestination.js +48 -8
  122. package/dist/model/TransactionDestinationType.js +5 -0
  123. package/dist/model/TransactionEvmEip1559Fee.js +1 -1
  124. package/dist/model/TransactionEvmLegacyFee.js +1 -1
  125. package/dist/model/TransactionFILFee.js +1 -1
  126. package/dist/model/TransactionFixedFee.js +1 -1
  127. package/dist/model/TransactionFuelingInfo.js +13 -0
  128. package/dist/model/TransactionRequestEvmEip1559Fee.js +1 -1
  129. package/dist/model/TransactionRequestEvmLegacyFee.js +1 -1
  130. package/dist/model/TransactionRequestFILFee.js +1 -1
  131. package/dist/model/TransactionRequestSOLFee.js +1 -1
  132. package/dist/model/TransactionRequestUtxoFee.js +1 -1
  133. package/dist/model/TransactionSOLFee.js +1 -1
  134. package/dist/model/TransactionSolContractAddressLookupTableAccount.js +126 -0
  135. package/dist/model/TransactionSolContractDestination.js +30 -0
  136. package/dist/model/TransactionStellarContractParam.js +164 -0
  137. package/dist/model/TransactionStellarContractType.js +56 -0
  138. package/dist/model/{BTCEIP191MessageSignDestination.js → TransactionStellarDestination.js} +38 -35
  139. package/dist/model/TransactionStellarTrustLineOperationType.js +56 -0
  140. package/dist/model/TransactionStellarTrustLineParam.js +133 -0
  141. package/dist/model/TransactionUtxoFee.js +1 -1
  142. package/dist/model/TransactionWebhookEventData.js +8 -3
  143. package/dist/model/UnfreezeDisposition.js +111 -0
  144. package/dist/model/UpdateAddressBookParam.js +150 -0
  145. package/dist/model/UpdateBankAccountByIdRequest.js +108 -0
  146. package/dist/model/UpdateMerchantByIdRequest.js +1 -1
  147. package/dist/model/UpdateTopUpAddress.js +4 -6
  148. package/dist/model/WalletInfoEventData.js +8 -3
  149. package/dist/model/WalletSetup.js +66 -0
  150. package/dist/model/WebhookEventData.js +81 -11
  151. package/dist/model/WebhookEventDataType.js +7 -2
  152. package/dist/model/WebhookEventType.js +5 -0
  153. package/docs/AddressBook.md +7 -7
  154. package/docs/AddressBooksApi.md +218 -8
  155. package/docs/AddressInfo.md +1 -0
  156. package/docs/AddressesEventData.md +3 -1
  157. package/docs/AddressesEventDataAllOfAddresses.md +1 -0
  158. package/docs/ApprovalDetail.md +3 -3
  159. package/docs/ApprovalResult.md +3 -5
  160. package/docs/ApprovalTemplate.md +3 -3
  161. package/docs/ApprovalTransactionResult.md +4 -4
  162. package/docs/ApprovalUserDetail.md +15 -9
  163. package/docs/AutoSweepApi.md +18 -18
  164. package/docs/AutoSweepTask.md +5 -5
  165. package/docs/BalanceUpdateInfoEventData.md +3 -1
  166. package/docs/BridgingFee.md +11 -0
  167. package/docs/ChainInfo.md +2 -1
  168. package/docs/ChainsEventData.md +3 -1
  169. package/docs/CommissionFee.md +9 -0
  170. package/docs/ComplianceApi.md +218 -0
  171. package/docs/ComplianceDispositionUpdateEventData.md +56 -0
  172. package/docs/ContractCallDestination.md +2 -0
  173. package/docs/ContractCallDestinationType.md +2 -0
  174. package/docs/CreateAddressBookParam.md +13 -0
  175. package/docs/CreateAddressBooks201Response.md +9 -0
  176. package/docs/CreateAddressBooksParam.md +9 -0
  177. package/docs/CreateAutoSweepTask.md +2 -2
  178. package/docs/CreateCustodialWalletParams.md +1 -1
  179. package/docs/CreateExchangeWalletParams.md +1 -1
  180. package/docs/CreateMerchantRequest.md +3 -2
  181. package/docs/CreateMpcWalletParams.md +1 -1
  182. package/docs/CreatePaymentOrderRequest.md +4 -3
  183. package/docs/CreateRefundRequest.md +1 -1
  184. package/docs/CreateSafeWalletParams.md +1 -1
  185. package/docs/CreateSettlement.md +3 -3
  186. package/docs/CreateSettlementRequestRequest.md +3 -0
  187. package/docs/CreateSmartContractWalletParams.md +1 -1
  188. package/docs/CreateSwapActivityRequest.md +15 -0
  189. package/docs/CreateWalletParams.md +1 -1
  190. package/docs/DeleteAddressBookById201Response.md +9 -0
  191. package/docs/DispositionEventData.md +14 -0
  192. package/docs/DispositionQueryResponse.md +12 -0
  193. package/docs/DispositionResponse.md +10 -0
  194. package/docs/DispositionStatus.md +34 -0
  195. package/docs/DispositionType.md +14 -0
  196. package/docs/EstimateContractCallFeeParams.md +1 -1
  197. package/docs/EstimateFeeParams.md +1 -1
  198. package/docs/EstimateTransferFeeParams.md +1 -1
  199. package/docs/FeeStationApi.md +53 -0
  200. package/docs/FeeStationCheckFeeStationUsage.md +14 -0
  201. package/docs/FeeStationCheckFeeStationUsageResponse.md +16 -0
  202. package/docs/FeeStationGasStationType.md +12 -0
  203. package/docs/IsolateDisposition.md +13 -0
  204. package/docs/ListSwapActivities200Response.md +10 -0
  205. package/docs/ListSwapEnabledTokens200Response.md +10 -0
  206. package/docs/ListTopUpPayerAccounts200Response.md +10 -0
  207. package/docs/MPCVaultEventData.md +3 -1
  208. package/docs/Merchant.md +2 -1
  209. package/docs/MerchantBalance.md +6 -6
  210. package/docs/MessageSignDestination.md +0 -1
  211. package/docs/OrgInfo.md +1 -0
  212. package/docs/OtcFee.md +10 -0
  213. package/docs/PaymentAddressUpdateEventData.md +3 -1
  214. package/docs/PaymentApi.md +203 -28
  215. package/docs/PaymentEstimateFee.md +10 -0
  216. package/docs/PaymentEstimateFee201Response.md +9 -0
  217. package/docs/PaymentEstimateFeeRequest.md +10 -0
  218. package/docs/PaymentEstimatedFee.md +13 -0
  219. package/docs/PaymentFeeType.md +16 -0
  220. package/docs/PaymentOrderEventData.md +3 -1
  221. package/docs/PaymentRefundEventData.md +5 -2
  222. package/docs/PaymentSettlementEvent.md +9 -4
  223. package/docs/PaymentTransactionEventData.md +3 -1
  224. package/docs/PaymentWalletBalance.md +5 -5
  225. package/docs/PspBalance.md +6 -6
  226. package/docs/ReceivedAmountPerAddress.md +2 -2
  227. package/docs/Refund.md +2 -1
  228. package/docs/RefundDisposition.md +13 -0
  229. package/docs/RoleDetail.md +4 -1
  230. package/docs/SettleRequestStatus.md +2 -0
  231. package/docs/Settlement.md +6 -3
  232. package/docs/SettlementDetail.md +3 -1
  233. package/docs/SettlementInfo.md +6 -6
  234. package/docs/SolContractCallAddressLookupTableAccount.md +10 -0
  235. package/docs/SolContractCallDestination.md +1 -0
  236. package/docs/StellarContractCallContractParam.md +11 -0
  237. package/docs/StellarContractCallContractType.md +10 -0
  238. package/docs/StellarContractCallDestination.md +10 -0
  239. package/docs/StellarContractCallTrustLineOperationType.md +10 -0
  240. package/docs/StellarContractCallTrustLineParam.md +11 -0
  241. package/docs/SupportedToken.md +1 -0
  242. package/docs/SuspendedTokenEventData.md +3 -1
  243. package/docs/SwapActivity.md +9 -9
  244. package/docs/SwapActivityDetail.md +10 -9
  245. package/docs/SwapActivitySigners.md +1 -1
  246. package/docs/SwapActivityTimeline.md +3 -3
  247. package/docs/SwapEstimateFee.md +12 -0
  248. package/docs/SwapQuote.md +10 -11
  249. package/docs/SwapReceivingTransaction.md +11 -0
  250. package/docs/SwapToken.md +6 -6
  251. package/docs/SwapsApi.md +356 -0
  252. package/docs/TSSRequestWebhookEventData.md +3 -1
  253. package/docs/TokenListingEventData.md +3 -1
  254. package/docs/TokenizationApi.md +2 -2
  255. package/docs/TokensEventData.md +3 -1
  256. package/docs/TransactionCoboCategory.md +2 -0
  257. package/docs/TransactionDestination.md +2 -0
  258. package/docs/TransactionDestinationType.md +2 -0
  259. package/docs/TransactionFuelingInfo.md +1 -0
  260. package/docs/TransactionSolContractAddressLookupTableAccount.md +10 -0
  261. package/docs/TransactionSolContractDestination.md +1 -0
  262. package/docs/TransactionStellarContractParam.md +11 -0
  263. package/docs/TransactionStellarContractType.md +10 -0
  264. package/docs/TransactionStellarDestination.md +10 -0
  265. package/docs/TransactionStellarTrustLineOperationType.md +10 -0
  266. package/docs/TransactionStellarTrustLineParam.md +11 -0
  267. package/docs/TransactionWebhookEventData.md +3 -1
  268. package/docs/TransactionsApi.md +11 -11
  269. package/docs/UnfreezeDisposition.md +9 -0
  270. package/docs/UpdateAddressBookParam.md +12 -0
  271. package/docs/UpdateBankAccountByIdRequest.md +9 -0
  272. package/docs/UpdateMerchantByIdRequest.md +1 -1
  273. package/docs/UpdateTopUpAddress.md +1 -1
  274. package/docs/WalletInfoEventData.md +3 -1
  275. package/docs/WalletSetup.md +14 -0
  276. package/docs/WalletsApi.md +2 -2
  277. package/docs/WalletsMPCWalletsApi.md +1 -1
  278. package/docs/WebhookEventData.md +12 -3
  279. package/docs/WebhookEventDataType.md +3 -1
  280. package/docs/WebhookEventType.md +2 -0
  281. package/package.json +1 -1
  282. package/dist/model/ApprovalShowInfo.js +0 -140
  283. package/docs/ApprovalShowInfo.md +0 -13
  284. package/docs/BTCEIP191MessageSignDestination.md +0 -10
  285. package/docs/RawMessageSignDestination.md +0 -10
@@ -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
  */
@@ -0,0 +1,214 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _DispositionQueryResponse = _interopRequireDefault(require("../model/DispositionQueryResponse"));
9
+ var _DispositionResponse = _interopRequireDefault(require("../model/DispositionResponse"));
10
+ var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
11
+ var _IsolateDisposition = _interopRequireDefault(require("../model/IsolateDisposition"));
12
+ var _RefundDisposition = _interopRequireDefault(require("../model/RefundDisposition"));
13
+ var _UnfreezeDisposition = _interopRequireDefault(require("../model/UnfreezeDisposition"));
14
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
15
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
16
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
17
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
18
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
19
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
20
+ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
21
+ * Cobo Wallet as a Service 2.0
22
+ *
23
+ * Contact: help@cobo.com
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * Compliance service.
32
+ * @module api/ComplianceApi
33
+ */
34
+ var ComplianceApi = exports["default"] = /*#__PURE__*/function () {
35
+ /**
36
+ * Constructs a new ComplianceApi.
37
+ * @alias module:api/ComplianceApi
38
+ * @class
39
+ * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
40
+ * default to {@link module:ApiClient#instance} if unspecified.
41
+ */
42
+ function ComplianceApi(apiClient) {
43
+ _classCallCheck(this, ComplianceApi);
44
+ this.apiClient = apiClient || _ApiClient["default"].instance;
45
+ }
46
+
47
+ /**
48
+ * Get disposition status
49
+ * This operation retrieves the current status of a disposition request for a specific transaction. You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze) that has been initiated for a transaction. The response includes the disposition type, current status, and the disposition transaction ID if applicable. <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note>
50
+ * @param {String} transaction_id The UUID of the transaction to query for disposition status.
51
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionQueryResponse} and HTTP response
52
+ */
53
+ return _createClass(ComplianceApi, [{
54
+ key: "getDispositionStatusWithHttpInfo",
55
+ value: function getDispositionStatusWithHttpInfo(transaction_id) {
56
+ var postBody = null;
57
+ if (postBody && postBody.toJSON) {
58
+ postBody = postBody.toJSON();
59
+ }
60
+ // verify the required parameter 'transaction_id' is set
61
+ if (transaction_id === undefined || transaction_id === null) {
62
+ throw new Error("Missing the required parameter 'transaction_id' when calling getDispositionStatus");
63
+ }
64
+ var pathParams = {};
65
+ var queryParams = {
66
+ 'transaction_id': transaction_id
67
+ };
68
+ var headerParams = {};
69
+ var formParams = {};
70
+ var authNames = ['OAuth2', 'CoboAuth'];
71
+ var contentTypes = [];
72
+ var accepts = ['application/json'];
73
+ var returnType = _DispositionQueryResponse["default"];
74
+ return this.apiClient.callApi('/compliance/funds/disposition', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
75
+ }
76
+
77
+ /**
78
+ * Get disposition status
79
+ * This operation retrieves the current status of a disposition request for a specific transaction. You can use this endpoint to check the status of any disposition operation (Refund, Isolate, or Unfreeze) that has been initiated for a transaction. The response includes the disposition type, current status, and the disposition transaction ID if applicable. <Note>Use this endpoint to monitor the progress of disposition operations and verify their completion.</Note>
80
+ * @param {String} transaction_id The UUID of the transaction to query for disposition status.
81
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionQueryResponse}
82
+ */
83
+ }, {
84
+ key: "getDispositionStatus",
85
+ value: function getDispositionStatus(transaction_id) {
86
+ return this.getDispositionStatusWithHttpInfo(transaction_id).then(function (response_and_data) {
87
+ return response_and_data.data;
88
+ });
89
+ }
90
+
91
+ /**
92
+ * Isolate funds
93
+ * This operation creates a request to isolate funds for a specific transaction. The funds will be sent to a designated isolation address for compliance purposes. You need to specify the transaction ID to be isolated and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The isolation will initiate a withdrawal transaction from the compliance-managed address to the specified isolation address.</Note>
94
+ * @param {Object} opts Optional parameters
95
+ * @param {module:model/IsolateDisposition} [IsolateDisposition] The request body to isolate funds.
96
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionResponse} and HTTP response
97
+ */
98
+ }, {
99
+ key: "isolateFundsWithHttpInfo",
100
+ value: function isolateFundsWithHttpInfo(opts) {
101
+ opts = opts || {};
102
+ var postBody = opts['IsolateDisposition'];
103
+ if (postBody && postBody.toJSON) {
104
+ postBody = postBody.toJSON();
105
+ }
106
+ var pathParams = {};
107
+ var queryParams = {};
108
+ var headerParams = {};
109
+ var formParams = {};
110
+ var authNames = ['OAuth2', 'CoboAuth'];
111
+ var contentTypes = ['application/json'];
112
+ var accepts = ['application/json'];
113
+ var returnType = _DispositionResponse["default"];
114
+ return this.apiClient.callApi('/compliance/funds/disposition/isolate', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
115
+ }
116
+
117
+ /**
118
+ * Isolate funds
119
+ * This operation creates a request to isolate funds for a specific transaction. The funds will be sent to a designated isolation address for compliance purposes. You need to specify the transaction ID to be isolated and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The isolation will initiate a withdrawal transaction from the compliance-managed address to the specified isolation address.</Note>
120
+ * @param {Object} opts Optional parameters
121
+ * @param {module:model/IsolateDisposition} opts.IsolateDisposition The request body to isolate funds.
122
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionResponse}
123
+ */
124
+ }, {
125
+ key: "isolateFunds",
126
+ value: function isolateFunds(opts) {
127
+ return this.isolateFundsWithHttpInfo(opts).then(function (response_and_data) {
128
+ return response_and_data.data;
129
+ });
130
+ }
131
+
132
+ /**
133
+ * Refund funds
134
+ * This operation creates a request to refund funds for a specific transaction. The funds will be sent to the specified destination address. You need to specify the transaction ID to be refunded and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The refund will initiate a withdrawal transaction from the compliance-managed address to the specified destination.</Note>
135
+ * @param {Object} opts Optional parameters
136
+ * @param {module:model/RefundDisposition} [RefundDisposition] The request body to refund funds.
137
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionResponse} and HTTP response
138
+ */
139
+ }, {
140
+ key: "refundFundsWithHttpInfo",
141
+ value: function refundFundsWithHttpInfo(opts) {
142
+ opts = opts || {};
143
+ var postBody = opts['RefundDisposition'];
144
+ if (postBody && postBody.toJSON) {
145
+ postBody = postBody.toJSON();
146
+ }
147
+ var pathParams = {};
148
+ var queryParams = {};
149
+ var headerParams = {};
150
+ var formParams = {};
151
+ var authNames = ['OAuth2', 'CoboAuth'];
152
+ var contentTypes = ['application/json'];
153
+ var accepts = ['application/json'];
154
+ var returnType = _DispositionResponse["default"];
155
+ return this.apiClient.callApi('/compliance/funds/disposition/refund', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
156
+ }
157
+
158
+ /**
159
+ * Refund funds
160
+ * This operation creates a request to refund funds for a specific transaction. The funds will be sent to the specified destination address. You need to specify the transaction ID to be refunded and the destination address. Optional parameters include custom categories for tracking purposes. <Note>The refund will initiate a withdrawal transaction from the compliance-managed address to the specified destination.</Note>
161
+ * @param {Object} opts Optional parameters
162
+ * @param {module:model/RefundDisposition} opts.RefundDisposition The request body to refund funds.
163
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionResponse}
164
+ */
165
+ }, {
166
+ key: "refundFunds",
167
+ value: function refundFunds(opts) {
168
+ return this.refundFundsWithHttpInfo(opts).then(function (response_and_data) {
169
+ return response_and_data.data;
170
+ });
171
+ }
172
+
173
+ /**
174
+ * Unfreeze frozen funds
175
+ * This operation creates a request to unfreeze funds for a previously frozen transaction. It releases the frozen funds back to their original state. You only need to specify the transaction ID to be unfrozen. Once unfrozen, the funds will be available for normal operations. <Note>The unfreeze process will release the compliance hold on the transaction, allowing it to proceed normally.</Note>
176
+ * @param {Object} opts Optional parameters
177
+ * @param {module:model/UnfreezeDisposition} [UnfreezeDisposition] The request body to unfreeze funds.
178
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DispositionResponse} and HTTP response
179
+ */
180
+ }, {
181
+ key: "unfreezeFundsWithHttpInfo",
182
+ value: function unfreezeFundsWithHttpInfo(opts) {
183
+ opts = opts || {};
184
+ var postBody = opts['UnfreezeDisposition'];
185
+ if (postBody && postBody.toJSON) {
186
+ postBody = postBody.toJSON();
187
+ }
188
+ var pathParams = {};
189
+ var queryParams = {};
190
+ var headerParams = {};
191
+ var formParams = {};
192
+ var authNames = ['OAuth2', 'CoboAuth'];
193
+ var contentTypes = ['application/json'];
194
+ var accepts = ['application/json'];
195
+ var returnType = _DispositionResponse["default"];
196
+ return this.apiClient.callApi('/compliance/funds/disposition/unfreeze', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
197
+ }
198
+
199
+ /**
200
+ * Unfreeze frozen funds
201
+ * This operation creates a request to unfreeze funds for a previously frozen transaction. It releases the frozen funds back to their original state. You only need to specify the transaction ID to be unfrozen. Once unfrozen, the funds will be available for normal operations. <Note>The unfreeze process will release the compliance hold on the transaction, allowing it to proceed normally.</Note>
202
+ * @param {Object} opts Optional parameters
203
+ * @param {module:model/UnfreezeDisposition} opts.UnfreezeDisposition The request body to unfreeze funds.
204
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DispositionResponse}
205
+ */
206
+ }, {
207
+ key: "unfreezeFunds",
208
+ value: function unfreezeFunds(opts) {
209
+ return this.unfreezeFundsWithHttpInfo(opts).then(function (response_and_data) {
210
+ return response_and_data.data;
211
+ });
212
+ }
213
+ }]);
214
+ }();
@@ -7,6 +7,8 @@ exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
8
  var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
9
9
  var _EstimatedFixedFee = _interopRequireDefault(require("../model/EstimatedFixedFee"));
10
+ var _FeeStationCheckFeeStationUsage = _interopRequireDefault(require("../model/FeeStationCheckFeeStationUsage"));
11
+ var _FeeStationCheckFeeStationUsageResponse = _interopRequireDefault(require("../model/FeeStationCheckFeeStationUsageResponse"));
10
12
  var _FeeStationTransfer = _interopRequireDefault(require("../model/FeeStationTransfer"));
11
13
  var _ListAddresses200Response = _interopRequireDefault(require("../model/ListAddresses200Response"));
12
14
  var _ListTokenBalancesForFeeStation200Response = _interopRequireDefault(require("../model/ListTokenBalancesForFeeStation200Response"));
@@ -46,13 +48,54 @@ var FeeStationApi = exports["default"] = /*#__PURE__*/function () {
46
48
  }
47
49
 
48
50
  /**
49
- * Estimate fee for Fee Station transaction
50
- * This operation estimates the gas fee required for a top-up transaction sent by [Fee Station](https://manuals.cobo.com/en/portal/fee-station/introduction) to provide gas to the sender of the original transaction. You need to provide the token ID and transfer amount. For more information about transaction fee models and how fees are calculated, refer to [Estimate transaction fee](https://www.cobo.com/developers/v2/guides/transactions/estimate-fees).
51
+ * Check Fee Station usage
52
+ * This operation evaluates Fee Station usage for the current transaction. It determines whether Fee station can be used, checks if the Fee Station balance is sufficient, and returns a breakdown of the amounts involved, including any portion that must be covered by the user or sponsored in USDT (U).
51
53
  * @param {Object} opts Optional parameters
52
- * @param {module:model/FeeStationTransfer} [FeeStationTransfer] The information about a Fee Station top-up transaction.
53
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EstimatedFixedFee} and HTTP response
54
+ * @param {module:model/FeeStationCheckFeeStationUsage} [FeeStationCheckFeeStationUsage] The information for evaluating Fee Station usage.
55
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/FeeStationCheckFeeStationUsageResponse} and HTTP response
54
56
  */
55
57
  return _createClass(FeeStationApi, [{
58
+ key: "checkFeeStationUsageWithHttpInfo",
59
+ value: function checkFeeStationUsageWithHttpInfo(opts) {
60
+ opts = opts || {};
61
+ var postBody = opts['FeeStationCheckFeeStationUsage'];
62
+ if (postBody && postBody.toJSON) {
63
+ postBody = postBody.toJSON();
64
+ }
65
+ var pathParams = {};
66
+ var queryParams = {};
67
+ var headerParams = {};
68
+ var formParams = {};
69
+ var authNames = ['OAuth2', 'CoboAuth'];
70
+ var contentTypes = ['application/json'];
71
+ var accepts = ['application/json'];
72
+ var returnType = _FeeStationCheckFeeStationUsageResponse["default"];
73
+ return this.apiClient.callApi('/fee_station/check_fee_station_usage', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
74
+ }
75
+
76
+ /**
77
+ * Check Fee Station usage
78
+ * This operation evaluates Fee Station usage for the current transaction. It determines whether Fee station can be used, checks if the Fee Station balance is sufficient, and returns a breakdown of the amounts involved, including any portion that must be covered by the user or sponsored in USDT (U).
79
+ * @param {Object} opts Optional parameters
80
+ * @param {module:model/FeeStationCheckFeeStationUsage} opts.FeeStationCheckFeeStationUsage The information for evaluating Fee Station usage.
81
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/FeeStationCheckFeeStationUsageResponse}
82
+ */
83
+ }, {
84
+ key: "checkFeeStationUsage",
85
+ value: function checkFeeStationUsage(opts) {
86
+ return this.checkFeeStationUsageWithHttpInfo(opts).then(function (response_and_data) {
87
+ return response_and_data.data;
88
+ });
89
+ }
90
+
91
+ /**
92
+ * Estimate fee for Fee Station transaction
93
+ * This operation estimates the gas fee required for a top-up transaction sent by [Fee Station](https://manuals.cobo.com/en/portal/fee-station/introduction) to provide gas to the sender of the original transaction. You need to provide the token ID and transfer amount. For more information about transaction fee models and how fees are calculated, refer to [Estimate transaction fee](https://www.cobo.com/developers/v2/guides/transactions/estimate-fees).
94
+ * @param {Object} opts Optional parameters
95
+ * @param {module:model/FeeStationTransfer} [FeeStationTransfer] The information about a Fee Station top-up transaction.
96
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EstimatedFixedFee} and HTTP response
97
+ */
98
+ }, {
56
99
  key: "estimateFeeStationFeeWithHttpInfo",
57
100
  value: function estimateFeeStationFeeWithHttpInfo(opts) {
58
101
  opts = opts || {};