@cobo/cobo-waas2 1.14.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +70 -5
- package/dist/ApiClient.js +2 -3
- package/dist/PreRequestScript.js +1 -1
- package/dist/api/AddressBooksApi.js +4 -4
- package/dist/api/AppWorkflowsApi.js +275 -0
- package/dist/api/DevelopersApi.js +4 -4
- package/dist/api/DevelopersWebhooksApi.js +12 -12
- package/dist/api/FeeStationApi.js +26 -26
- package/dist/api/PaymentApi.js +16 -16
- package/dist/api/StakingsApi.js +28 -28
- package/dist/api/TransactionsApi.js +16 -8
- package/dist/api/WalletsApi.js +121 -70
- package/dist/api/WalletsExchangeWalletApi.js +8 -8
- package/dist/api/WalletsMPCWalletsApi.js +20 -20
- package/dist/crypto/ApiSigner.js +1 -2
- package/dist/index.js +420 -0
- package/dist/model/AddressBook.js +18 -0
- package/dist/model/AppWorkflow.js +173 -0
- package/dist/model/AppWorkflowField.js +137 -0
- package/dist/model/AppWorkflowPolicy.js +144 -0
- package/dist/model/ApprovalEntry.js +148 -0
- package/dist/model/ApprovalRequest.js +178 -0
- package/dist/model/ApprovalRequestDetail.js +176 -0
- package/dist/model/ApprovalStatus.js +71 -0
- package/dist/model/ApprovalUser.js +146 -0
- package/dist/model/BabylonStakeExtra.js +16 -0
- package/dist/model/BankAccount.js +18 -0
- package/dist/model/BatchCheckUtxo201Response.js +107 -0
- package/dist/model/BatchCheckUtxoRequest.js +142 -0
- package/dist/model/BatchUTXOParam.js +123 -0
- package/dist/model/ChainInfo.js +9 -0
- package/dist/model/CreateApprovalRequest201Response.js +109 -0
- package/dist/model/CreateSettlement.js +4 -29
- package/dist/model/CreateStakeActivityExtra.js +6 -0
- package/dist/model/CreateTokenListingRequest201Response.js +2 -2
- package/dist/model/CreateTokenListingRequestRequest.js +4 -4
- package/dist/model/CustodialWeb3TransferSource.js +1 -1
- package/dist/model/EstimateContractCallFeeParams.js +13 -0
- package/dist/model/EstimateFeeParams.js +6 -0
- package/dist/model/EstimateTransferFeeParams.js +13 -0
- package/dist/model/FeeStationTransfer.js +1 -1
- package/dist/model/ListApprovalRequests200Response.js +123 -0
- package/dist/model/Merchant.js +18 -0
- package/dist/model/MpcTransferSource.js +1 -1
- package/dist/model/Order.js +49 -0
- package/dist/model/PaymentOrderEventData.js +64 -0
- package/dist/model/PaymentRefundEventData.js +77 -0
- package/dist/model/PaymentSettlementEvent.js +46 -0
- package/dist/model/PaymentTransaction.js +13 -0
- package/dist/model/PolicyAction.js +123 -0
- package/dist/model/PolicyActionContent.js +167 -0
- package/dist/model/PolicyActionType.js +66 -0
- package/dist/model/PolicyCondition.js +148 -0
- package/dist/model/PolicyFieldOperator.js +76 -0
- package/dist/model/PolicyFieldValueType.js +61 -0
- package/dist/model/Refund.js +53 -0
- package/dist/model/RequestApproval.js +188 -0
- package/dist/model/RevokeApprovalRequest201Response.js +118 -0
- package/dist/model/RevokeApprovalRequestRequest.js +110 -0
- package/dist/model/Settlement.js +31 -0
- package/dist/model/SettlementDetail.js +57 -0
- package/dist/model/SettlementInfo.js +31 -0
- package/dist/model/SwapActivity.js +3 -3
- package/dist/model/SwapActivityApprovers.js +122 -0
- package/dist/model/SwapActivityDetail.js +36 -6
- package/dist/model/SwapApproversStatus.js +66 -0
- package/dist/model/SwapQuote.js +49 -4
- package/dist/model/SwapToken.js +2 -2
- package/dist/model/TSSBaseRequestEventData.js +163 -0
- package/dist/model/TSSCallbackActionType.js +61 -0
- package/dist/model/TSSCallbackRequest.js +122 -0
- package/dist/model/TSSCallbackRequestType.js +76 -0
- package/dist/model/TSSCallbackResponse.js +118 -0
- package/dist/model/TSSCurve.js +61 -0
- package/dist/model/TSSCurveType.js +61 -0
- package/dist/model/TSSEvent.js +158 -0
- package/dist/model/TSSEventData.js +278 -0
- package/dist/model/TSSEventDataType.js +71 -0
- package/dist/model/TSSEventType.js +136 -0
- package/dist/model/TSSGroup.js +221 -0
- package/dist/model/TSSGroupType.js +61 -0
- package/dist/model/TSSGroups.js +1 -1
- package/dist/model/TSSKeyGenEventData.js +228 -0
- package/dist/model/TSSKeyGenExtra.js +154 -0
- package/dist/model/TSSKeyGenRequest.js +130 -0
- package/dist/model/TSSKeyReshareEventData.js +228 -0
- package/dist/model/TSSKeyReshareExtra.js +169 -0
- package/dist/model/TSSKeyReshareRequest.js +177 -0
- package/dist/model/TSSKeyShareSignDetail.js +100 -0
- package/dist/model/TSSKeyShareSignEventData.js +228 -0
- package/dist/model/TSSKeyShareSignExtra.js +171 -0
- package/dist/model/TSSKeyShareSignRequest.js +146 -0
- package/dist/model/TSSKeyShareSignSignature.js +126 -0
- package/dist/model/TSSKeyShareSignSignatures.js +107 -0
- package/dist/model/TSSKeySignEventData.js +228 -0
- package/dist/model/TSSKeySignExtra.js +203 -0
- package/dist/model/TSSKeySignRequest.js +192 -0
- package/dist/model/TSSParticipant.js +113 -0
- package/dist/model/TSSProtocol.js +66 -0
- package/dist/model/TSSRequestTypeEenum.js +71 -0
- package/dist/model/TSSSignature.js +139 -0
- package/dist/model/TSSSignatureType.js +66 -0
- package/dist/model/TSSSignatures.js +125 -0
- package/dist/model/TSSStatus.js +96 -0
- package/dist/model/TokenListing.js +10 -10
- package/dist/model/TokenListingEventData.js +15 -15
- package/dist/model/TransactionCoboCategory.js +102 -7
- package/dist/model/TransactionRbfSource.js +1 -1
- package/dist/model/TransactionSubStatus.js +35 -0
- package/dist/model/UTXO.js +9 -0
- package/dist/model/WebhookEventData.js +15 -9
- package/docs/AddressBook.md +2 -0
- package/docs/AddressBooksApi.md +2 -2
- package/docs/AppWorkflow.md +12 -0
- package/docs/AppWorkflowField.md +11 -0
- package/docs/AppWorkflowPolicy.md +10 -0
- package/docs/AppWorkflowsApi.md +273 -0
- package/docs/ApprovalEntry.md +11 -0
- package/docs/ApprovalRequest.md +13 -0
- package/docs/ApprovalRequestDetail.md +13 -0
- package/docs/ApprovalStatus.md +16 -0
- package/docs/ApprovalUser.md +12 -0
- package/docs/BabylonStakeExtra.md +1 -0
- package/docs/BankAccount.md +2 -0
- package/docs/BatchCheckUtxo201Response.md +9 -0
- package/docs/BatchCheckUtxoRequest.md +10 -0
- package/docs/BatchUTXOParam.md +10 -0
- package/docs/ChainInfo.md +1 -0
- package/docs/CreateApprovalRequest201Response.md +9 -0
- package/docs/CreateSettlement.md +2 -2
- package/docs/CreateStakeActivityExtra.md +1 -0
- package/docs/CreateTokenListingRequest201Response.md +1 -1
- package/docs/CreateTokenListingRequestRequest.md +2 -2
- package/docs/CustodialWeb3TransferSource.md +1 -1
- package/docs/DevelopersApi.md +2 -2
- package/docs/DevelopersWebhooksApi.md +6 -6
- package/docs/EstimateContractCallFeeParams.md +1 -0
- package/docs/EstimateFeeParams.md +1 -0
- package/docs/EstimateTransferFeeParams.md +1 -0
- package/docs/FeeStationApi.md +14 -14
- package/docs/ListApprovalRequests200Response.md +10 -0
- package/docs/Merchant.md +2 -0
- package/docs/MpcTransferSource.md +1 -1
- package/docs/Order.md +3 -0
- package/docs/PaymentApi.md +8 -8
- package/docs/PaymentOrderEventData.md +3 -0
- package/docs/PaymentRefundEventData.md +5 -0
- package/docs/PaymentSettlementEvent.md +3 -0
- package/docs/PaymentTransaction.md +1 -0
- package/docs/PolicyAction.md +10 -0
- package/docs/PolicyActionContent.md +25 -0
- package/docs/PolicyActionType.md +14 -0
- package/docs/PolicyCondition.md +12 -0
- package/docs/PolicyFieldOperator.md +18 -0
- package/docs/PolicyFieldValueType.md +12 -0
- package/docs/Refund.md +5 -0
- package/docs/RequestApproval.md +13 -0
- package/docs/RevokeApprovalRequest201Response.md +10 -0
- package/docs/RevokeApprovalRequestRequest.md +9 -0
- package/docs/Settlement.md +3 -0
- package/docs/SettlementDetail.md +5 -0
- package/docs/SettlementInfo.md +3 -0
- package/docs/StakingsApi.md +14 -14
- package/docs/SwapActivity.md +3 -3
- package/docs/SwapActivityApprovers.md +10 -0
- package/docs/SwapActivityDetail.md +4 -3
- package/docs/SwapApproversStatus.md +14 -0
- package/docs/SwapQuote.md +3 -0
- package/docs/SwapToken.md +2 -2
- package/docs/TSSBaseRequestEventData.md +14 -0
- package/docs/TSSCallbackActionType.md +12 -0
- package/docs/TSSCallbackRequest.md +12 -0
- package/docs/TSSCallbackRequestType.md +18 -0
- package/docs/TSSCallbackResponse.md +12 -0
- package/docs/TSSCurve.md +12 -0
- package/docs/TSSCurveType.md +12 -0
- package/docs/TSSEvent.md +13 -0
- package/docs/TSSEventData.md +16 -0
- package/docs/TSSEventDataType.md +16 -0
- package/docs/TSSEventType.md +42 -0
- package/docs/TSSGroup.md +19 -0
- package/docs/TSSGroupType.md +12 -0
- package/docs/TSSKeyGenEventData.md +16 -0
- package/docs/TSSKeyGenExtra.md +13 -0
- package/docs/TSSKeyGenRequest.md +13 -0
- package/docs/TSSKeyReshareEventData.md +16 -0
- package/docs/TSSKeyReshareExtra.md +14 -0
- package/docs/TSSKeyReshareRequest.md +17 -0
- package/docs/TSSKeyShareSignDetail.md +10 -0
- package/docs/TSSKeyShareSignEventData.md +16 -0
- package/docs/TSSKeyShareSignExtra.md +13 -0
- package/docs/TSSKeyShareSignRequest.md +12 -0
- package/docs/TSSKeyShareSignSignature.md +12 -0
- package/docs/TSSKeyShareSignSignatures.md +9 -0
- package/docs/TSSKeySignEventData.md +16 -0
- package/docs/TSSKeySignExtra.md +15 -0
- package/docs/TSSKeySignRequest.md +18 -0
- package/docs/TSSParticipant.md +11 -0
- package/docs/TSSProtocol.md +14 -0
- package/docs/TSSRequestTypeEenum.md +16 -0
- package/docs/TSSSignature.md +13 -0
- package/docs/TSSSignatureType.md +14 -0
- package/docs/TSSSignatures.md +11 -0
- package/docs/TSSStatus.md +26 -0
- package/docs/TokenListing.md +6 -6
- package/docs/TokenListingEventData.md +6 -6
- package/docs/TransactionCoboCategory.md +41 -3
- package/docs/TransactionRbfSource.md +1 -1
- package/docs/TransactionSubStatus.md +14 -0
- package/docs/TransactionsApi.md +8 -4
- package/docs/UTXO.md +1 -0
- package/docs/WalletsApi.md +91 -36
- package/docs/WalletsExchangeWalletApi.md +4 -4
- package/docs/WalletsMPCWalletsApi.md +10 -10
- package/docs/WebhookEventData.md +8 -7
- package/package.json +1 -1
package/docs/FeeStationApi.md
CHANGED
|
@@ -4,7 +4,7 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**estimateFeeStationFee**](FeeStationApi.md#estimateFeeStationFee) | **POST** /fee_station/transactions/estimate_fee | Estimate transaction
|
|
7
|
+
[**estimateFeeStationFee**](FeeStationApi.md#estimateFeeStationFee) | **POST** /fee_station/transactions/estimate_fee | Estimate fee for Fee Station transaction
|
|
8
8
|
[**getFeeStationTransactionById**](FeeStationApi.md#getFeeStationTransactionById) | **GET** /fee_station/transactions/{transaction_id} | Get Fee Station transaction information
|
|
9
9
|
[**listFeeStationAddresses**](FeeStationApi.md#listFeeStationAddresses) | **GET** /fee_station/addresses | List Fee Station addresses
|
|
10
10
|
[**listFeeStationTransactions**](FeeStationApi.md#listFeeStationTransactions) | **GET** /fee_station/transactions | List all Fee Station transactions
|
|
@@ -16,9 +16,9 @@ Method | HTTP request | Description
|
|
|
16
16
|
|
|
17
17
|
> EstimatedFixedFee estimateFeeStationFee(opts)
|
|
18
18
|
|
|
19
|
-
Estimate transaction
|
|
19
|
+
Estimate fee for Fee Station transaction
|
|
20
20
|
|
|
21
|
-
This operation estimates the
|
|
21
|
+
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).
|
|
22
22
|
|
|
23
23
|
### Example
|
|
24
24
|
|
|
@@ -48,7 +48,7 @@ apiInstance.estimateFeeStationFee(opts).then((data) => {
|
|
|
48
48
|
|
|
49
49
|
Name | Type | Description | Notes
|
|
50
50
|
------------- | ------------- | ------------- | -------------
|
|
51
|
-
**FeeStationTransfer** | [**FeeStationTransfer**](FeeStationTransfer.md)| The information about a
|
|
51
|
+
**FeeStationTransfer** | [**FeeStationTransfer**](FeeStationTransfer.md)| The information about a Fee Station top-up transaction. | [optional]
|
|
52
52
|
|
|
53
53
|
### Return type
|
|
54
54
|
|
|
@@ -70,7 +70,7 @@ Name | Type | Description | Notes
|
|
|
70
70
|
|
|
71
71
|
Get Fee Station transaction information
|
|
72
72
|
|
|
73
|
-
This operation retrieves detailed information about a specified Fee Station transaction, such as the transaction status, source address, destination address, and timestamp.
|
|
73
|
+
This operation retrieves detailed information about a specified Fee Station transaction record, such as the transaction status, source address, destination address, and timestamp.
|
|
74
74
|
|
|
75
75
|
### Example
|
|
76
76
|
|
|
@@ -120,7 +120,7 @@ Name | Type | Description | Notes
|
|
|
120
120
|
|
|
121
121
|
List Fee Station addresses
|
|
122
122
|
|
|
123
|
-
This operation retrieves a list of addresses
|
|
123
|
+
This operation retrieves a list of deposit addresses of your Fee Station, including the chain ID, address, and additional information. You can filter the result by chain ID and address.
|
|
124
124
|
|
|
125
125
|
### Example
|
|
126
126
|
|
|
@@ -157,8 +157,8 @@ Name | Type | Description | Notes
|
|
|
157
157
|
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
158
158
|
**addresses** | **String**| A list of wallet addresses, separated by comma. For addresses requiring a memo, append the memo after the address using the '|' separator (e.g., \"address|memo\"). | [optional]
|
|
159
159
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
160
|
-
**before** | **String**|
|
|
161
|
-
**after** | **String**|
|
|
160
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
161
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
162
162
|
|
|
163
163
|
### Return type
|
|
164
164
|
|
|
@@ -233,11 +233,11 @@ Name | Type | Description | Notes
|
|
|
233
233
|
**chain_ids** | **String**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional]
|
|
234
234
|
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
235
235
|
**asset_ids** | **String**| (This concept applies to Exchange Wallets only) A list of asset IDs, separated by comma. An asset ID is the unique identifier of the asset held within your linked exchange account. | [optional]
|
|
236
|
-
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. | [optional]
|
|
237
|
-
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. | [optional]
|
|
236
|
+
**min_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or after the specified time. If not provided, the default value is 90 days before the current time. This default value is subject to change. | [optional]
|
|
237
|
+
**max_created_timestamp** | **Number**| The time when the transaction was created, in Unix timestamp format, measured in milliseconds. You can use this parameter to filter transactions created on or before the specified time. If not provided, the default value is the current time. This default value is subject to change. | [optional]
|
|
238
238
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
239
|
-
**before** | **String**|
|
|
240
|
-
**after** | **String**|
|
|
239
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
240
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
241
241
|
**direction** | **String**| The sort direction. Possible values include: - `ASC`: Sort the results in ascending order. - `DESC`: Sort the results in descending order. | [optional] [default to '']
|
|
242
242
|
|
|
243
243
|
### Return type
|
|
@@ -295,8 +295,8 @@ Name | Type | Description | Notes
|
|
|
295
295
|
------------- | ------------- | ------------- | -------------
|
|
296
296
|
**token_ids** | **String**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional]
|
|
297
297
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
298
|
-
**before** | **String**|
|
|
299
|
-
**after** | **String**|
|
|
298
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
299
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
300
300
|
|
|
301
301
|
### Return type
|
|
302
302
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.ListApprovalRequests200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**[ApprovalRequest]**](ApprovalRequest.md) | | [optional]
|
|
8
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
package/docs/Merchant.md
CHANGED
|
@@ -7,5 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**merchant_id** | **String** | The merchant ID. |
|
|
8
8
|
**name** | **String** | The merchant name. |
|
|
9
9
|
**wallet_id** | **String** | The ID of the linked wallet. |
|
|
10
|
+
**created_timestamp** | **Number** | The created time of the merchant, represented as a UNIX timestamp in seconds. | [optional]
|
|
11
|
+
**updated_timestamp** | **Number** | The updated time of the merchant, represented as a UNIX timestamp in seconds. | [optional]
|
|
10
12
|
|
|
11
13
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**source_type** | [**WalletSubtype**](WalletSubtype.md) | |
|
|
8
8
|
**wallet_id** | **String** | The wallet ID. |
|
|
9
|
-
**address** | **String** | The wallet address. If you want to specify the UTXOs to be used, please provide the `included_utxos` property. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing. You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail. | [optional]
|
|
9
|
+
**address** | **String** | The wallet address. If you want to specify the UTXOs to be used, please provide the `included_utxos` property. When `included_utxos` is specified, only these specified UTXOs will be used for the transaction. If you specify both the `address` and `included_utxos` properties, the specified included UTXOs must belong to the address. It is recommended to specify no more than 100 included UTXOs to ensure optimal transaction processing. You need to provide either the `address` or `included_utxos` property. If neither property is provided, the transfer will fail. | [optional]
|
|
10
10
|
**included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
|
|
11
11
|
**excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
|
|
12
12
|
**mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) | | [optional]
|
package/docs/Order.md
CHANGED
|
@@ -19,5 +19,8 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
20
20
|
**status** | [**OrderStatus**](OrderStatus.md) | |
|
|
21
21
|
**received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
|
22
|
+
**created_timestamp** | **Number** | The created time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
23
|
+
**updated_timestamp** | **Number** | The updated time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
24
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the settlement process. | [optional]
|
|
22
25
|
|
|
23
26
|
|
package/docs/PaymentApi.md
CHANGED
|
@@ -478,8 +478,8 @@ apiInstance.getRefunds(opts).then((data) => {
|
|
|
478
478
|
Name | Type | Description | Notes
|
|
479
479
|
------------- | ------------- | ------------- | -------------
|
|
480
480
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
481
|
-
**before** | **String**|
|
|
482
|
-
**after** | **String**|
|
|
481
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
482
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
483
483
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
484
484
|
**request_id** | **String**| The request ID. | [optional]
|
|
485
485
|
|
|
@@ -688,8 +688,8 @@ apiInstance.listMerchants(opts).then((data) => {
|
|
|
688
688
|
Name | Type | Description | Notes
|
|
689
689
|
------------- | ------------- | ------------- | -------------
|
|
690
690
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
691
|
-
**before** | **String**|
|
|
692
|
-
**after** | **String**|
|
|
691
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
692
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
693
693
|
**keyword** | **String**| A search term used for fuzzy matching of merchant names. | [optional]
|
|
694
694
|
**wallet_id** | **String**| The wallet ID. | [optional]
|
|
695
695
|
|
|
@@ -747,8 +747,8 @@ apiInstance.listPaymentOrders(opts).then((data) => {
|
|
|
747
747
|
Name | Type | Description | Notes
|
|
748
748
|
------------- | ------------- | ------------- | -------------
|
|
749
749
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
750
|
-
**before** | **String**|
|
|
751
|
-
**after** | **String**|
|
|
750
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
751
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
752
752
|
**merchant_id** | **String**| The merchant ID. | [optional]
|
|
753
753
|
|
|
754
754
|
### Return type
|
|
@@ -805,8 +805,8 @@ apiInstance.listSettlementRequests(opts).then((data) => {
|
|
|
805
805
|
Name | Type | Description | Notes
|
|
806
806
|
------------- | ------------- | ------------- | -------------
|
|
807
807
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
808
|
-
**before** | **String**|
|
|
809
|
-
**after** | **String**|
|
|
808
|
+
**before** | **String**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional]
|
|
809
|
+
**after** | **String**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional]
|
|
810
810
|
**request_id** | **String**| The request ID. | [optional]
|
|
811
811
|
|
|
812
812
|
### Return type
|
|
@@ -20,6 +20,9 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**psp_order_code** | **String** | A unique reference code assigned by the developer to identify this order in their system. |
|
|
21
21
|
**status** | [**OrderStatus**](OrderStatus.md) | |
|
|
22
22
|
**received_token_amount** | **String** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
|
23
|
+
**created_timestamp** | **Number** | The created time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
24
|
+
**updated_timestamp** | **Number** | The updated time of the order, represented as a UNIX timestamp in seconds. | [optional]
|
|
25
|
+
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this pay-in order. Each transaction represents a separate blockchain operation related to the settlement process. | [optional]
|
|
23
26
|
|
|
24
27
|
|
|
25
28
|
|
|
@@ -7,12 +7,17 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**data_type** | **String** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. |
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the refund request. | [optional]
|
|
9
9
|
**refund_id** | **String** | The refund order ID. |
|
|
10
|
+
**order_id** | **String** | The order ID corresponding to this refund. | [optional]
|
|
10
11
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
11
12
|
**token_id** | **String** | The ID of the cryptocurrency used for refund. |
|
|
12
13
|
**chain_id** | **String** | The ID of the blockchain network on which the refund transaction occurs. |
|
|
13
14
|
**amount** | **String** | The amount in cryptocurrency to be returned for this refund order. |
|
|
14
15
|
**to_address** | **String** | The recipient's wallet address where the refund will be sent. |
|
|
15
16
|
**status** | [**RefundStatus**](RefundStatus.md) | |
|
|
17
|
+
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
18
|
+
**created_timestamp** | **Number** | The created time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
19
|
+
**updated_timestamp** | **Number** | The updated time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
20
|
+
**initiator** | **String** | The initiator of this refund order, usually the user's API key. | [optional]
|
|
16
21
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional]
|
|
17
22
|
|
|
18
23
|
|
|
@@ -9,6 +9,9 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
10
10
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
11
11
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
12
|
+
**created_timestamp** | **Number** | The created time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
**updated_timestamp** | **Number** | The updated time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
14
|
+
**initiator** | **String** | The initiator of this settlement request, usually the user's API key. | [optional]
|
|
12
15
|
|
|
13
16
|
|
|
14
17
|
|
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**tx_id** | **String** | The transaction ID. |
|
|
8
8
|
**tx_hash** | **String** | The transaction hash. | [optional]
|
|
9
|
+
**token_id** | **String** | The ID of the cryptocurrency. | [optional]
|
|
9
10
|
**from_address** | **String** | The source address of the transaction. |
|
|
10
11
|
**to_address** | **String** | The destination address of the transaction. |
|
|
11
12
|
**amount** | **String** | The amount of cryptocurrency transferred, as a decimal string. |
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.PolicyAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**action_type** | [**PolicyActionType**](PolicyActionType.md) | |
|
|
8
|
+
**content** | [**PolicyActionContent**](PolicyActionContent.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# CoboWaas2.PolicyActionContent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | The quorum action content type. Possible values include: - `FULL_APPROVAL`: The content type is approved by all persons. - `PART_APPROVAL`: The content type is approved by some persons. |
|
|
8
|
+
**roles** | **[String]** | | [optional]
|
|
9
|
+
**user_ids** | **[String]** | | [optional]
|
|
10
|
+
**threshold** | **Number** | The number of persons need approved, such as 2. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## Enum: TypeEnum
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
* `FULL_APPROVAL` (value: `"FULL_APPROVAL"`)
|
|
18
|
+
|
|
19
|
+
* `PART_APPROVAL` (value: `"PART_APPROVAL"`)
|
|
20
|
+
|
|
21
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# CoboWaas2.PolicyCondition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**field** | **String** | The app workflow field name. |
|
|
8
|
+
**value_type** | [**PolicyFieldValueType**](PolicyFieldValueType.md) | |
|
|
9
|
+
**value** | **String** | The app workflow field value. |
|
|
10
|
+
**operator** | [**PolicyFieldOperator**](PolicyFieldOperator.md) | |
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# CoboWaas2.PolicyFieldOperator
|
|
2
|
+
|
|
3
|
+
## Enum
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
* `GREATER_THAN` (value: `">"`)
|
|
7
|
+
|
|
8
|
+
* `GREATER_THAN_OR_EQUAL_TO` (value: `">="`)
|
|
9
|
+
|
|
10
|
+
* `LESS_THAN` (value: `"<"`)
|
|
11
|
+
|
|
12
|
+
* `LESS_THAN_OR_EQUAL_TO` (value: `"<="`)
|
|
13
|
+
|
|
14
|
+
* `EQUAL` (value: `"="`)
|
|
15
|
+
|
|
16
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
17
|
+
|
|
18
|
+
|
package/docs/Refund.md
CHANGED
|
@@ -6,12 +6,17 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**request_id** | **String** | The request ID provided by you when creating the refund request. | [optional]
|
|
8
8
|
**refund_id** | **String** | The refund order ID. |
|
|
9
|
+
**order_id** | **String** | The order ID corresponding to this refund. | [optional]
|
|
9
10
|
**merchant_id** | **String** | The merchant ID. | [optional]
|
|
10
11
|
**token_id** | **String** | The ID of the cryptocurrency used for refund. |
|
|
11
12
|
**chain_id** | **String** | The ID of the blockchain network on which the refund transaction occurs. |
|
|
12
13
|
**amount** | **String** | The amount in cryptocurrency to be returned for this refund order. |
|
|
13
14
|
**to_address** | **String** | The recipient's wallet address where the refund will be sent. |
|
|
14
15
|
**status** | [**RefundStatus**](RefundStatus.md) | |
|
|
16
|
+
**refund_type** | [**RefundType**](RefundType.md) | | [optional]
|
|
17
|
+
**created_timestamp** | **Number** | The created time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
|
+
**updated_timestamp** | **Number** | The updated time of the refund order, represented as a UNIX timestamp in seconds. | [optional]
|
|
19
|
+
**initiator** | **String** | The initiator of this refund order, usually the user's API key. | [optional]
|
|
15
20
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional]
|
|
16
21
|
|
|
17
22
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# CoboWaas2.RequestApproval
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**operation_id** | **String** | The operation id of workflow approval request. |
|
|
8
|
+
**request_id** | **String** | The request id of workflow approval request. |
|
|
9
|
+
**initiator_email** | **String** | The initiator email of workflow approval request. |
|
|
10
|
+
**fields** | [**[AppWorkflowField]**](AppWorkflowField.md) | |
|
|
11
|
+
**guard_template** | **String** | The guard template content of workflow approval request, need to connect cobo. |
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CoboWaas2.RevokeApprovalRequest201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**approval_id** | **String** | |
|
|
8
|
+
**status** | [**ApprovalStatus**](ApprovalStatus.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
package/docs/Settlement.md
CHANGED
|
@@ -8,5 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**request_id** | **String** | The request ID provided by you when creating the settlement request. |
|
|
9
9
|
**status** | [**SettleRequestStatus**](SettleRequestStatus.md) | |
|
|
10
10
|
**settlements** | [**[SettlementDetail]**](SettlementDetail.md) | |
|
|
11
|
+
**created_timestamp** | **Number** | The created time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
12
|
+
**updated_timestamp** | **Number** | The updated time of the settlement request, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
|
+
**initiator** | **String** | The initiator of this settlement request, usually the user's API key. | [optional]
|
|
11
14
|
|
|
12
15
|
|
package/docs/SettlementDetail.md
CHANGED
|
@@ -7,9 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**currency** | **String** | The fiat currency for the settlement. | [optional]
|
|
8
8
|
**token_id** | **String** | The ID of the cryptocurrency settled. | [optional]
|
|
9
9
|
**chain_id** | **String** | The ID of the blockchain network on which the settlement occurred. | [optional]
|
|
10
|
+
**merchant_id** | **String** | The Merchant ID associated with this settlement. | [optional]
|
|
10
11
|
**amount** | **String** | The settlement amount. - If `token_id` is specified, this represents the settlement amount in the specified cryptocurrency. - If `token_id` is not specified, this represents the settlement amount in the specified fiat currency. | [optional]
|
|
12
|
+
**settled_amount** | **String** | The settled amount of this settlement detail. - If `token_id` is specified, this represents the actual settled amount in the specified cryptocurrency. - If `token_id` is not specified, this represents the actual settled amount in the specified fiat currency. | [optional]
|
|
11
13
|
**status** | [**SettleStatus**](SettleStatus.md) | | [optional]
|
|
12
14
|
**bank_account** | [**BankAccount**](BankAccount.md) | | [optional]
|
|
13
15
|
**transactions** | [**[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this settlement request. Each transaction represents a separate blockchain operation related to the settlement process. | [optional]
|
|
16
|
+
**created_timestamp** | **Number** | The created time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
17
|
+
**updated_timestamp** | **Number** | The updated time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
18
|
+
**crypto_address_id** | **String** | Unique identifier for the pre-approved crypto address, used to reference the address securely in requests. | [optional]
|
|
14
19
|
|
|
15
20
|
|
package/docs/SettlementInfo.md
CHANGED
|
@@ -10,5 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**available_currency_balance** | **String** | The amount available for settlement or refund, in the specified fiat currency. | [optional]
|
|
11
11
|
**pending_amount** | **String** | The amount unavailable for settlement or refund, in the specified cryptocurrency. | [optional]
|
|
12
12
|
**pending_currency_balance** | **String** | The amount unavailable for settlement or refund, in the specified fiat currency. | [optional]
|
|
13
|
+
**settled_amount** | **String** | The amount already settled, in the specified cryptocurrency. | [optional]
|
|
14
|
+
**created_timestamp** | **Number** | The created time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
15
|
+
**updated_timestamp** | **Number** | The updated time of the settlement, represented as a UNIX timestamp in seconds. | [optional]
|
|
13
16
|
|
|
14
17
|
|