@cobo/cobo-waas2 1.8.0 → 1.10.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 +117 -33
- package/dist/ApiClient.js +11 -1
- package/dist/api/AddressBooksApi.js +1 -1
- package/dist/api/DevelopersApi.js +7 -7
- package/dist/api/DevelopersWebhooksApi.js +8 -8
- package/dist/api/PrimeBrokerApi.js +317 -0
- package/dist/api/StakingsApi.js +412 -18
- package/dist/api/SwapsApi.js +360 -0
- package/dist/api/TransactionsApi.js +64 -20
- package/dist/api/TravelRuleApi.js +18 -18
- package/dist/api/WalletsApi.js +84 -13
- package/dist/api/WalletsExchangeWalletApi.js +1 -1
- package/dist/api/WalletsMPCWalletsApi.js +151 -39
- package/dist/api/WalletsSmartContractWalletsApi.js +1 -1
- package/dist/index.js +276 -10
- package/dist/model/ActivityExtra.js +5 -5
- package/dist/model/AddressBalance.js +129 -0
- package/dist/model/AddressTransferDestination.js +36 -0
- package/dist/model/AddressesEventData.js +4 -4
- package/dist/model/AddressesEventDataAllOfAddresses.js +295 -0
- package/dist/model/ApprovalStatementStatus.js +81 -0
- package/dist/model/AssetBalance.js +6 -6
- package/dist/model/BTCEIP191MessageSignDestination.js +122 -0
- package/dist/model/BabylonAirdropPop.js +186 -0
- package/dist/model/BabylonAirdropRegistration.js +172 -0
- package/dist/model/BabylonEligibleAirdrop.js +157 -0
- package/dist/model/BabylonRegistrationRequestStatus.js +66 -0
- package/dist/model/BabylonRegistrationStatus.js +66 -0
- package/dist/model/BabylonStakingActivityDetailExtra.js +1 -1
- package/dist/model/BabylonStakingRegistration.js +185 -0
- package/dist/model/{TokenBalanceBalance.js → Balance.js} +22 -22
- package/dist/model/{SwapSummary.js → ChangeGuardPubkey200Response.js} +28 -39
- package/dist/model/ContractCallParams.js +36 -0
- package/dist/model/ContractCallSource.js +6 -0
- package/dist/model/CoreStakingActivityDetailExtra.js +3 -3
- package/dist/model/CreateAddressRequest.js +28 -2
- package/dist/model/CreateBabylonAirdropRegistration201Response.js +87 -0
- package/dist/model/CreateBabylonAirdropRegistrationRequest.js +105 -0
- package/dist/model/CreateBabylonStakingRegistration201Response.js +87 -0
- package/dist/model/CreateBabylonStakingRegistrationRequest.js +103 -0
- package/dist/model/CreatePrimeBrokerAddress201Response.js +140 -0
- package/dist/model/CreatePrimeBrokerAddressRequest.js +107 -0
- package/dist/model/CreateSwapActivityRequest.js +153 -0
- package/dist/model/CreateSwapQuote201Response.js +264 -0
- package/dist/model/CreateSwapQuoteRequest.js +166 -0
- package/dist/model/DeleteGuardPubkey201Response.js +110 -0
- package/dist/model/EthStakeEstimatedFee.js +1 -1
- package/dist/model/EthStakingActivityDetailExtra.js +1 -1
- package/dist/model/GetStakingEstimationFee201Response.js +1 -1
- package/dist/model/GetTransactionLimitation200Response.js +4 -4
- package/dist/model/GuardPubkeyStatus.js +91 -0
- package/dist/model/ListAddressBalancesByToken200Response.js +123 -0
- package/dist/model/ListBabylonAirdropRegistrations200Response.js +123 -0
- package/dist/model/ListBabylonEligibleAirdrops200Response.js +123 -0
- package/dist/model/ListBabylonEligibleStakings200Response.js +123 -0
- package/dist/model/ListBabylonEligibleStakings200ResponseDataInner.js +141 -0
- package/dist/model/ListBabylonStakingRegistrations200Response.js +123 -0
- package/dist/model/ListEnableTokenPairs200Response.js +123 -0
- package/dist/model/ListKeyShareHolders200Response.js +123 -0
- package/dist/model/ListSwapActivities200Response.js +123 -0
- package/dist/model/MessageSignDestination.js +70 -8
- package/dist/model/MessageSignDestinationType.js +12 -2
- package/dist/model/MessageSignSource.js +6 -0
- package/dist/model/MpcContractCallSource.js +16 -0
- package/dist/model/MpcMessageSignSource.js +16 -0
- package/dist/model/MpcSigningGroup.js +27 -4
- package/dist/model/MpcTransferSource.js +16 -0
- package/dist/model/OrgInfo.js +3 -3
- package/dist/model/QueryApprovalStatement200Response.js +122 -0
- package/dist/model/QueryGuardPubkey200Response.js +129 -0
- package/dist/model/QueryGuardPubkey200ResponseAddressesInner.js +125 -0
- package/dist/model/RootPubkey.js +1 -1
- package/dist/model/SelfCustodyWallet.js +7 -7
- package/dist/model/StakingPoolId.js +30 -0
- package/dist/model/StakingPoolType.js +15 -0
- package/dist/model/SubWalletAssetBalance.js +6 -6
- package/dist/model/SubmitDepositTravelRuleInfo201Response.js +1 -1
- package/dist/model/SwapQuote.js +203 -0
- package/dist/model/TSSGroups.js +1 -1
- package/dist/model/TokenBalance.js +6 -6
- package/dist/model/TransactionDepositToAddressDestination.js +16 -0
- package/dist/model/TransactionDepositToAddressDestinationTxInfo.js +83 -0
- package/dist/model/TransactionDestination.js +10 -4
- package/dist/model/TransactionRawTxInfo.js +29 -0
- package/dist/model/TransactionRbfSource.js +6 -0
- package/dist/model/TransactionSubStatus.js +5 -0
- package/dist/model/TransactionUserApprovalDetail.js +3 -3
- package/dist/model/TransactionUtxoChange.js +101 -0
- package/dist/model/TransferDestination.js +6 -0
- package/dist/model/TransferParams.js +36 -0
- package/dist/model/TransferSource.js +6 -0
- package/dist/model/TravelRuleDepositExchangesOrVASP.js +4 -4
- package/dist/model/TravelRuleDepositExchangesOrVASPEntityInfo.js +7 -7
- package/dist/model/TravelRuleDepositLegalEntity.js +5 -5
- package/dist/model/TravelRuleDepositNaturalEntity.js +9 -9
- package/dist/model/TravelRuleDepositRequestTravelRuleInfo.js +5 -5
- package/dist/model/TravelRuleWithdrawExchangesOrVASP.js +3 -3
- package/dist/model/TravelRuleWithdrawExchangesOrVASPEntityInfo.js +5 -5
- package/dist/model/TravelRuleWithdrawLegalEntity.js +2 -2
- package/dist/model/TravelRuleWithdrawNaturalEntity.js +7 -7
- package/dist/model/TravelRuleWithdrawRequestTravelRuleInfo.js +4 -4
- package/dist/model/Vasp.js +7 -7
- package/dist/model/WebhookEventData.js +2 -2
- package/docs/ActivityExtra.md +5 -5
- package/docs/AddressBalance.md +10 -0
- package/docs/AddressBooksApi.md +1 -1
- package/docs/AddressTransferDestination.md +14 -0
- package/docs/AddressesEventData.md +1 -1
- package/docs/AddressesEventDataAllOfAddresses.md +19 -0
- package/docs/ApprovalStatementStatus.md +20 -0
- package/docs/AssetBalance.md +1 -1
- package/docs/BTCEIP191MessageSignDestination.md +10 -0
- package/docs/BabylonAirdropPop.md +14 -0
- package/docs/BabylonAirdropRegistration.md +16 -0
- package/docs/BabylonEligibleAirdrop.md +14 -0
- package/docs/BabylonRegistrationRequestStatus.md +14 -0
- package/docs/BabylonRegistrationStatus.md +14 -0
- package/docs/BabylonStakingActivityDetailExtra.md +1 -1
- package/docs/BabylonStakingRegistration.md +17 -0
- package/docs/{TokenBalanceBalance.md → Balance.md} +1 -1
- package/docs/ChangeGuardPubkey200Response.md +9 -0
- package/docs/ContractCallParams.md +14 -0
- package/docs/ContractCallSource.md +1 -0
- package/docs/CoreStakingActivityDetailExtra.md +3 -3
- package/docs/CreateAddressRequest.md +3 -1
- package/docs/CreateBabylonAirdropRegistration201Response.md +9 -0
- package/docs/CreateBabylonAirdropRegistrationRequest.md +10 -0
- package/docs/CreateBabylonStakingRegistration201Response.md +9 -0
- package/docs/CreateBabylonStakingRegistrationRequest.md +10 -0
- package/docs/CreatePrimeBrokerAddress201Response.md +10 -0
- package/docs/CreatePrimeBrokerAddressRequest.md +9 -0
- package/docs/CreateSwapActivityRequest.md +12 -0
- package/docs/CreateSwapQuote201Response.md +17 -0
- package/docs/CreateSwapQuoteRequest.md +13 -0
- package/docs/DeleteGuardPubkey201Response.md +9 -0
- package/docs/DevelopersApi.md +5 -5
- package/docs/DevelopersWebhooksApi.md +8 -8
- package/docs/EthStakeEstimatedFee.md +1 -1
- package/docs/EthStakingActivityDetailExtra.md +1 -1
- package/docs/GetStakingEstimationFee201Response.md +1 -1
- package/docs/GetTransactionLimitation200Response.md +4 -4
- package/docs/GuardPubkeyStatus.md +24 -0
- package/docs/ListAddressBalancesByToken200Response.md +10 -0
- package/docs/ListBabylonAirdropRegistrations200Response.md +10 -0
- package/docs/ListBabylonEligibleAirdrops200Response.md +10 -0
- package/docs/ListBabylonEligibleStakings200Response.md +10 -0
- package/docs/ListBabylonEligibleStakings200ResponseDataInner.md +13 -0
- package/docs/ListBabylonStakingRegistrations200Response.md +10 -0
- package/docs/ListEnableTokenPairs200Response.md +10 -0
- package/docs/ListKeyShareHolders200Response.md +10 -0
- package/docs/ListSwapActivities200Response.md +10 -0
- package/docs/MessageSignDestination.md +1 -0
- package/docs/MessageSignDestinationType.md +6 -2
- package/docs/MessageSignSource.md +1 -0
- package/docs/MpcContractCallSource.md +1 -0
- package/docs/MpcMessageSignSource.md +1 -0
- package/docs/MpcSigningGroup.md +1 -1
- package/docs/MpcTransferSource.md +1 -0
- package/docs/OrgInfo.md +1 -1
- package/docs/PrimeBrokerApi.md +318 -0
- package/docs/QueryApprovalStatement200Response.md +12 -0
- package/docs/QueryGuardPubkey200Response.md +11 -0
- package/docs/QueryGuardPubkey200ResponseAddressesInner.md +10 -0
- package/docs/RootPubkey.md +1 -1
- package/docs/SelfCustodyWallet.md +3 -3
- package/docs/StakingPoolId.md +12 -0
- package/docs/StakingPoolType.md +6 -0
- package/docs/StakingsApi.md +460 -12
- package/docs/SubWalletAssetBalance.md +1 -1
- package/docs/SubmitDepositTravelRuleInfo201Response.md +1 -1
- package/docs/SwapQuote.md +16 -0
- package/docs/SwapsApi.md +348 -0
- package/docs/TSSGroups.md +1 -1
- package/docs/TokenBalance.md +1 -1
- package/docs/TransactionDepositToAddressDestination.md +1 -0
- package/docs/TransactionDepositToAddressDestinationTxInfo.md +9 -0
- package/docs/TransactionDestination.md +1 -0
- package/docs/TransactionRawTxInfo.md +2 -0
- package/docs/TransactionRbfSource.md +1 -0
- package/docs/TransactionSubStatus.md +2 -0
- package/docs/TransactionUserApprovalDetail.md +3 -3
- package/docs/TransactionUtxoChange.md +10 -0
- package/docs/TransactionsApi.md +68 -17
- package/docs/TransferDestination.md +14 -0
- package/docs/TransferParams.md +14 -0
- package/docs/TransferSource.md +1 -0
- package/docs/TravelRuleApi.md +13 -13
- package/docs/TravelRuleDepositExchangesOrVASP.md +2 -2
- package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md +7 -7
- package/docs/TravelRuleDepositLegalEntity.md +3 -3
- package/docs/TravelRuleDepositNaturalEntity.md +5 -5
- package/docs/TravelRuleDepositRequestTravelRuleInfo.md +5 -5
- package/docs/TravelRuleWithdrawExchangesOrVASP.md +1 -1
- package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md +5 -5
- package/docs/TravelRuleWithdrawLegalEntity.md +1 -1
- package/docs/TravelRuleWithdrawNaturalEntity.md +4 -4
- package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md +4 -4
- package/docs/Vasp.md +3 -3
- package/docs/WalletsApi.md +78 -13
- package/docs/WalletsExchangeWalletApi.md +1 -1
- package/docs/WalletsMPCWalletsApi.md +141 -27
- package/docs/WalletsSmartContractWalletsApi.md +1 -1
- package/docs/WebhookEventData.md +1 -1
- package/package.json +2 -2
- package/docs/SwapSummary.md +0 -10
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**account_output** | [**AddressTransferDestinationAccountOutput**](AddressTransferDestinationAccountOutput.md) | | [optional]
|
|
9
9
|
**utxo_outputs** | [**[AddressTransferDestinationUtxoOutputsInner]**](AddressTransferDestinationUtxoOutputsInner.md) | | [optional]
|
|
10
10
|
**change_address** | **String** | The address used to receive the remaining funds or change from the transaction. | [optional]
|
|
11
|
+
**change_output_type** | **String** | The position of the change output in the transaction's outputs. Possible values are: - `Last`: The change output is placed at the end of the transaction's outputs. - `First`: The change output is placed at the beginning of the transaction's outputs. | [optional]
|
|
11
12
|
**force_internal** | **Boolean** | Whether the transaction request must be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction request must be executed as a Cobo Loop transfer. - `false`: The transaction request may not be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. | [optional]
|
|
12
13
|
**force_external** | **Boolean** | Whether the transaction request must not be executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction request must not be executed as a Cobo Loop transfer. - `false`: The transaction request can be executed as a Cobo Loop transfer. Please do not set both `force_internal` and `force_external` as `true`. | [optional]
|
|
13
14
|
**wallet_id** | **String** | The wallet ID. |
|
|
@@ -15,3 +16,16 @@ Name | Type | Description | Notes
|
|
|
15
16
|
**amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`. |
|
|
16
17
|
|
|
17
18
|
|
|
19
|
+
|
|
20
|
+
## Enum: ChangeOutputTypeEnum
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
* `Last` (value: `"Last"`)
|
|
24
|
+
|
|
25
|
+
* `First` (value: `"First"`)
|
|
26
|
+
|
|
27
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
package/docs/TransferParams.md
CHANGED
|
@@ -11,6 +11,20 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**category_names** | **[String]** | The custom category for you to identify your transactions. | [optional]
|
|
12
12
|
**description** | **String** | The description of the transfer. | [optional]
|
|
13
13
|
**fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional]
|
|
14
|
+
**transaction_process_type** | **String** | Transaction processing type. Possible values are: - `AutoProcess` (default): After the transaction is constructed, it will be automatically signed and broadcast. - `BuildOnly`: Set to this value if you want to build the transaction first without automatically signing and broadcasting it. You can manually call the [Sign and broadcast transaction](https://www.cobo.com/developers/v2/api-references/transactions/sign-and-broadcast-transaction) operation to complete the signing and broadcasting process. | [optional]
|
|
14
15
|
**auto_fuel** | [**AutoFuelType**](AutoFuelType.md) | | [optional]
|
|
15
16
|
|
|
16
17
|
|
|
18
|
+
|
|
19
|
+
## Enum: TransactionProcessTypeEnum
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
* `AutoProcess` (value: `"AutoProcess"`)
|
|
23
|
+
|
|
24
|
+
* `BuildOnly` (value: `"BuildOnly"`)
|
|
25
|
+
|
|
26
|
+
* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
package/docs/TransferSource.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**address** | **String** | The wallet address. |
|
|
10
10
|
**included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
|
|
11
11
|
**excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) | | [optional]
|
|
12
|
+
**mpc_used_key_share_holder_group** | [**MpcSigningGroup**](MpcSigningGroup.md) | | [optional]
|
|
12
13
|
**delegate** | [**CoboSafeDelegate**](CoboSafeDelegate.md) | |
|
|
13
14
|
**trading_account_type** | **String** | The trading account type. |
|
|
14
15
|
|
package/docs/TravelRuleApi.md
CHANGED
|
@@ -6,8 +6,8 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**getTransactionLimitation**](TravelRuleApi.md#getTransactionLimitation) | **GET** /travel_rule/transaction/limitation | Retrieve transaction limitations
|
|
8
8
|
[**listSupportedCountries**](TravelRuleApi.md#listSupportedCountries) | **GET** /travel_rule/transaction/countries | List supported countries
|
|
9
|
-
[**submitDepositTravelRuleInfo**](TravelRuleApi.md#submitDepositTravelRuleInfo) | **POST** /travel_rule/transaction/deposit/travel_rule_info | Submit
|
|
10
|
-
[**submitWithdrawTravelRuleInfo**](TravelRuleApi.md#submitWithdrawTravelRuleInfo) | **POST** /travel_rule/transaction/withdraw/travel_rule_info | Submit
|
|
9
|
+
[**submitDepositTravelRuleInfo**](TravelRuleApi.md#submitDepositTravelRuleInfo) | **POST** /travel_rule/transaction/deposit/travel_rule_info | Submit Travel Rule information for deposits
|
|
10
|
+
[**submitWithdrawTravelRuleInfo**](TravelRuleApi.md#submitWithdrawTravelRuleInfo) | **POST** /travel_rule/transaction/withdraw/travel_rule_info | Submit Travel Rule information for withdrawals
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
|
|
18
18
|
Retrieve transaction limitations
|
|
19
19
|
|
|
20
|
-
This
|
|
20
|
+
This operation retrieves Travel Rule requirements and available options for a transaction based on its transaction type and ID. Use this endpoint before submitting Travel Rule information to understand the requirements and available options for your transaction.
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
|
|
@@ -47,7 +47,7 @@ apiInstance.getTransactionLimitation(transaction_type, transaction_id).then((dat
|
|
|
47
47
|
Name | Type | Description | Notes
|
|
48
48
|
------------- | ------------- | ------------- | -------------
|
|
49
49
|
**transaction_type** | **String**| The transaction type. Possible values include: - `DEPOSIT`: A deposit transaction. - `WITHDRAW`: A withdrawal transaction. |
|
|
50
|
-
**transaction_id** | **String**| The transaction ID |
|
|
50
|
+
**transaction_id** | **String**| The transaction ID. |
|
|
51
51
|
|
|
52
52
|
### Return type
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ Name | Type | Description | Notes
|
|
|
55
55
|
|
|
56
56
|
### Authorization
|
|
57
57
|
|
|
58
|
-
[OAuth2](../README.md#OAuth2)
|
|
58
|
+
[OAuth2](../README.md#OAuth2)
|
|
59
59
|
|
|
60
60
|
### HTTP request headers
|
|
61
61
|
|
|
@@ -69,7 +69,7 @@ Name | Type | Description | Notes
|
|
|
69
69
|
|
|
70
70
|
List supported countries
|
|
71
71
|
|
|
72
|
-
This operation retrieves
|
|
72
|
+
This operation retrieves a list of supported countries that can be used when submitting Travel Rule information. Use this endpoint to obtain valid country values for: - Place of incorporation of a legal entity - Place of birth of a natural person
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -101,7 +101,7 @@ This endpoint does not need any parameter.
|
|
|
101
101
|
|
|
102
102
|
### Authorization
|
|
103
103
|
|
|
104
|
-
[OAuth2](../README.md#OAuth2)
|
|
104
|
+
[OAuth2](../README.md#OAuth2)
|
|
105
105
|
|
|
106
106
|
### HTTP request headers
|
|
107
107
|
|
|
@@ -113,9 +113,9 @@ This endpoint does not need any parameter.
|
|
|
113
113
|
|
|
114
114
|
> SubmitDepositTravelRuleInfo201Response submitDepositTravelRuleInfo(opts)
|
|
115
115
|
|
|
116
|
-
Submit
|
|
116
|
+
Submit Travel Rule information for deposits
|
|
117
117
|
|
|
118
|
-
This operation
|
|
118
|
+
This operation submits Travel Rule information for a deposit transaction.
|
|
119
119
|
|
|
120
120
|
### Example
|
|
121
121
|
|
|
@@ -153,7 +153,7 @@ Name | Type | Description | Notes
|
|
|
153
153
|
|
|
154
154
|
### Authorization
|
|
155
155
|
|
|
156
|
-
[OAuth2](../README.md#OAuth2)
|
|
156
|
+
[OAuth2](../README.md#OAuth2)
|
|
157
157
|
|
|
158
158
|
### HTTP request headers
|
|
159
159
|
|
|
@@ -165,9 +165,9 @@ Name | Type | Description | Notes
|
|
|
165
165
|
|
|
166
166
|
> SubmitDepositTravelRuleInfo201Response submitWithdrawTravelRuleInfo(opts)
|
|
167
167
|
|
|
168
|
-
Submit
|
|
168
|
+
Submit Travel Rule information for withdrawals
|
|
169
169
|
|
|
170
|
-
This operation
|
|
170
|
+
This operation submits Travel Rule information for a withdrawal transaction.
|
|
171
171
|
|
|
172
172
|
### Example
|
|
173
173
|
|
|
@@ -205,7 +205,7 @@ Name | Type | Description | Notes
|
|
|
205
205
|
|
|
206
206
|
### Authorization
|
|
207
207
|
|
|
208
|
-
[OAuth2](../README.md#OAuth2)
|
|
208
|
+
[OAuth2](../README.md#OAuth2)
|
|
209
209
|
|
|
210
210
|
### HTTP request headers
|
|
211
211
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
-
**vendor_code** | **String** | The vendor code
|
|
8
|
+
**vendor_code** | **String** | The vendor code of the VASP. |
|
|
9
9
|
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
10
|
-
**vendor_vasp_name** | **String** | The vendor name
|
|
10
|
+
**vendor_vasp_name** | **String** | The vendor name. Use this field to specify the name of a vendor not listed. | [optional]
|
|
11
11
|
**entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) | |
|
|
12
12
|
|
|
13
13
|
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. |
|
|
7
|
+
**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. - `LEGAL`: Legal entity. - `NATURAL`: Natural person. |
|
|
8
8
|
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
-
**date_of_incorporation** | **Date** | The
|
|
10
|
-
**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when: -
|
|
11
|
-
**first_name** | **String** | The first name of the
|
|
12
|
-
**last_name** | **String** | The last name of the
|
|
13
|
-
**date_of_birth** | **Date** | The date of birth of the
|
|
14
|
-
**place_of_birth** | **String** | The place of birth of the
|
|
9
|
+
**date_of_incorporation** | **Date** | The date of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`. | [optional]
|
|
10
|
+
**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`. | [optional]
|
|
11
|
+
**first_name** | **String** | The first name of the natural person. |
|
|
12
|
+
**last_name** | **String** | The last name of the natural person. |
|
|
13
|
+
**date_of_birth** | **Date** | The date of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`. | [optional]
|
|
14
|
+
**place_of_birth** | **String** | The place of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`. | [optional]
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**selected_entity_type** | **String** |
|
|
7
|
+
**selected_entity_type** | **String** | The entity type. Possible values include: - `LEGAL`: Legal entity. - `NATURAL`: Natural person. |
|
|
8
8
|
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
-
**date_of_incorporation** | **Date** | The
|
|
10
|
-
**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when: -
|
|
9
|
+
**date_of_incorporation** | **Date** | The date of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`. | [optional]
|
|
10
|
+
**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`. | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. |
|
|
8
|
-
**first_name** | **String** | The first name of the
|
|
9
|
-
**last_name** | **String** | The last name of the
|
|
10
|
-
**date_of_birth** | **Date** | The date of birth of the
|
|
11
|
-
**place_of_birth** | **String** | The place of birth of the
|
|
7
|
+
**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. - `LEGAL`: Legal entity. - `NATURAL`: Natural person. |
|
|
8
|
+
**first_name** | **String** | The first name of the natural person. |
|
|
9
|
+
**last_name** | **String** | The last name of the natural person. |
|
|
10
|
+
**date_of_birth** | **Date** | The date of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`. | [optional]
|
|
11
|
+
**place_of_birth** | **String** | The place of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`. | [optional]
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
-
**vendor_code** | **String** | The vendor code
|
|
8
|
+
**vendor_code** | **String** | The vendor code of the VASP. |
|
|
9
9
|
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
10
|
-
**vendor_vasp_name** | **String** | The vendor name
|
|
10
|
+
**vendor_vasp_name** | **String** | The vendor name. Use this field to specify the name of a vendor not listed. | [optional]
|
|
11
11
|
**entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) | |
|
|
12
|
-
**self_custody_wallet_challenge** | **String** | The
|
|
13
|
-
**self_custody_wallet_address** | **String** | The address of the self-
|
|
14
|
-
**self_custody_wallet_sign** | **String** | The
|
|
12
|
+
**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. |
|
|
13
|
+
**self_custody_wallet_address** | **String** | The address of the self-custody wallet. |
|
|
14
|
+
**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. |
|
|
15
15
|
|
|
16
16
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
-
**vendor_code** | **String** | The vendor code
|
|
8
|
+
**vendor_code** | **String** | The vendor code of the exchange or virtual asset service provider (VASP). |
|
|
9
9
|
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
10
10
|
**entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) | |
|
|
11
11
|
|
|
@@ -6,11 +6,11 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) | |
|
|
8
8
|
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
-
**date_of_incorporation** | **Date** | The
|
|
9
|
+
**date_of_incorporation** | **Date** | The date of incorporation of the entity. | [optional]
|
|
10
10
|
**place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional]
|
|
11
|
-
**first_name** | **String** | The first name of the
|
|
12
|
-
**last_name** | **String** | The last name of the
|
|
13
|
-
**date_of_birth** | **Date** | The date of birth of the
|
|
14
|
-
**place_of_birth** | **String** | The place of birth of the
|
|
11
|
+
**first_name** | **String** | The first name of the natural person. |
|
|
12
|
+
**last_name** | **String** | The last name of the natural person. |
|
|
13
|
+
**date_of_birth** | **Date** | The date of birth of the natural person. | [optional]
|
|
14
|
+
**place_of_birth** | **String** | The place of birth of the natural person. | [optional]
|
|
15
15
|
|
|
16
16
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) | |
|
|
8
8
|
**legal_name** | **String** | The legal name of the entity. |
|
|
9
|
-
**date_of_incorporation** | **Date** | The
|
|
9
|
+
**date_of_incorporation** | **Date** | The date of incorporation of the entity. | [optional]
|
|
10
10
|
**place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional]
|
|
11
11
|
|
|
12
12
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) | |
|
|
8
|
-
**first_name** | **String** | The first name of the
|
|
9
|
-
**last_name** | **String** | The last name of the
|
|
10
|
-
**date_of_birth** | **Date** | The date of birth of the
|
|
11
|
-
**place_of_birth** | **String** | The place of birth of the
|
|
8
|
+
**first_name** | **String** | The first name of the natural person. |
|
|
9
|
+
**last_name** | **String** | The last name of the natural person. |
|
|
10
|
+
**date_of_birth** | **Date** | The date of birth of the natural person. | [optional]
|
|
11
|
+
**place_of_birth** | **String** | The place of birth of the natural person. | [optional]
|
|
12
12
|
|
|
13
13
|
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) | |
|
|
8
|
-
**self_custody_wallet_challenge** | **String** | The
|
|
9
|
-
**self_custody_wallet_address** | **String** | The address of the self-
|
|
10
|
-
**self_custody_wallet_sign** | **String** | The
|
|
11
|
-
**vendor_code** | **String** | The vendor code
|
|
8
|
+
**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. |
|
|
9
|
+
**self_custody_wallet_address** | **String** | The address of the self-custody wallet. |
|
|
10
|
+
**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. |
|
|
11
|
+
**vendor_code** | **String** | The vendor code of the exchange or virtual asset service provider (VASP). |
|
|
12
12
|
**vendor_vasp_id** | **String** | The unique identifier of the VASP. |
|
|
13
13
|
**entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) | |
|
|
14
14
|
|
package/docs/Vasp.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** | The name
|
|
8
|
-
**vendor_code** | **String** | The
|
|
9
|
-
**vendor_vasp_id** | **String** | The
|
|
7
|
+
**name** | **String** | The VASP name. |
|
|
8
|
+
**vendor_code** | **String** | The vendor code of the VASP. |
|
|
9
|
+
**vendor_vasp_id** | **String** | The VASP ID. |
|
|
10
10
|
|
|
11
11
|
|
package/docs/WalletsApi.md
CHANGED
|
@@ -14,6 +14,7 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**getMaxTransferableValue**](WalletsApi.md#getMaxTransferableValue) | **GET** /wallets/{wallet_id}/max_transferable_value | Get maximum transferable value
|
|
15
15
|
[**getTokenById**](WalletsApi.md#getTokenById) | **GET** /wallets/tokens/{token_id} | Get token information
|
|
16
16
|
[**getWalletById**](WalletsApi.md#getWalletById) | **GET** /wallets/{wallet_id} | Get wallet information
|
|
17
|
+
[**listAddressBalancesByToken**](WalletsApi.md#listAddressBalancesByToken) | **GET** /wallets/{wallet_id}/tokens/{token_id} | List address balances by token
|
|
17
18
|
[**listAddresses**](WalletsApi.md#listAddresses) | **GET** /wallets/{wallet_id}/addresses | List wallet addresses
|
|
18
19
|
[**listEnabledChains**](WalletsApi.md#listEnabledChains) | **GET** /wallets/enabled_chains | List enabled chains
|
|
19
20
|
[**listEnabledTokens**](WalletsApi.md#listEnabledTokens) | **GET** /wallets/enabled_tokens | List enabled tokens
|
|
@@ -231,7 +232,7 @@ Name | Type | Description | Notes
|
|
|
231
232
|
|
|
232
233
|
### Authorization
|
|
233
234
|
|
|
234
|
-
[OAuth2](../README.md#OAuth2)
|
|
235
|
+
[OAuth2](../README.md#OAuth2)
|
|
235
236
|
|
|
236
237
|
### HTTP request headers
|
|
237
238
|
|
|
@@ -283,7 +284,7 @@ Name | Type | Description | Notes
|
|
|
283
284
|
|
|
284
285
|
### Authorization
|
|
285
286
|
|
|
286
|
-
[OAuth2](../README.md#OAuth2)
|
|
287
|
+
[OAuth2](../README.md#OAuth2)
|
|
287
288
|
|
|
288
289
|
### HTTP request headers
|
|
289
290
|
|
|
@@ -333,7 +334,7 @@ Name | Type | Description | Notes
|
|
|
333
334
|
|
|
334
335
|
### Authorization
|
|
335
336
|
|
|
336
|
-
[
|
|
337
|
+
[OAuth2](../README.md#OAuth2)
|
|
337
338
|
|
|
338
339
|
### HTTP request headers
|
|
339
340
|
|
|
@@ -443,7 +444,7 @@ Name | Type | Description | Notes
|
|
|
443
444
|
|
|
444
445
|
### Authorization
|
|
445
446
|
|
|
446
|
-
[
|
|
447
|
+
[OAuth2](../README.md#OAuth2)
|
|
447
448
|
|
|
448
449
|
### HTTP request headers
|
|
449
450
|
|
|
@@ -543,7 +544,69 @@ Name | Type | Description | Notes
|
|
|
543
544
|
|
|
544
545
|
### Authorization
|
|
545
546
|
|
|
546
|
-
[
|
|
547
|
+
[OAuth2](../README.md#OAuth2)
|
|
548
|
+
|
|
549
|
+
### HTTP request headers
|
|
550
|
+
|
|
551
|
+
- **Content-Type**: Not defined
|
|
552
|
+
- **Accept**: application/json
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
## listAddressBalancesByToken
|
|
556
|
+
|
|
557
|
+
> ListAddressBalancesByToken200Response listAddressBalancesByToken(wallet_id, token_id, opts)
|
|
558
|
+
|
|
559
|
+
List address balances by token
|
|
560
|
+
|
|
561
|
+
This operation retrieves a list of address balances for a specified token within a wallet. <Note>This operation is applicable to MPC Wallets only.</Note>
|
|
562
|
+
|
|
563
|
+
### Example
|
|
564
|
+
|
|
565
|
+
```javascript
|
|
566
|
+
const CoboWaas2 = require('@cobo/cobo-waas2');
|
|
567
|
+
// Initialize the API client
|
|
568
|
+
const apiClient = CoboWaas2.ApiClient.instance
|
|
569
|
+
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
|
|
570
|
+
apiClient.setEnv(CoboWaas2.Env.DEV);
|
|
571
|
+
// Replace `<YOUR_PRIVATE_KEY>` with your private key
|
|
572
|
+
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
|
|
573
|
+
// Call the API
|
|
574
|
+
const apiInstance = new CoboWaas2.WalletsApi();
|
|
575
|
+
const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
576
|
+
const token_id = "ETH_USDT";
|
|
577
|
+
const opts = {
|
|
578
|
+
'addresses': "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045,0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f97",
|
|
579
|
+
'limit': 10,
|
|
580
|
+
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
581
|
+
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
582
|
+
};
|
|
583
|
+
apiInstance.listAddressBalancesByToken(wallet_id, token_id, opts).then((data) => {
|
|
584
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
585
|
+
}, (error) => {
|
|
586
|
+
console.error(error);
|
|
587
|
+
});
|
|
588
|
+
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
### Parameters
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
Name | Type | Description | Notes
|
|
595
|
+
------------- | ------------- | ------------- | -------------
|
|
596
|
+
**wallet_id** | **String**| The wallet ID. |
|
|
597
|
+
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
598
|
+
**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]
|
|
599
|
+
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
600
|
+
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
601
|
+
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
602
|
+
|
|
603
|
+
### Return type
|
|
604
|
+
|
|
605
|
+
[**ListAddressBalancesByToken200Response**](ListAddressBalancesByToken200Response.md)
|
|
606
|
+
|
|
607
|
+
### Authorization
|
|
608
|
+
|
|
609
|
+
[OAuth2](../README.md#OAuth2)
|
|
547
610
|
|
|
548
611
|
### HTTP request headers
|
|
549
612
|
|
|
@@ -605,7 +668,7 @@ Name | Type | Description | Notes
|
|
|
605
668
|
|
|
606
669
|
### Authorization
|
|
607
670
|
|
|
608
|
-
[
|
|
671
|
+
[OAuth2](../README.md#OAuth2)
|
|
609
672
|
|
|
610
673
|
### HTTP request headers
|
|
611
674
|
|
|
@@ -915,7 +978,7 @@ Name | Type | Description | Notes
|
|
|
915
978
|
|
|
916
979
|
### Authorization
|
|
917
980
|
|
|
918
|
-
[
|
|
981
|
+
[OAuth2](../README.md#OAuth2)
|
|
919
982
|
|
|
920
983
|
### HTTP request headers
|
|
921
984
|
|
|
@@ -975,7 +1038,7 @@ Name | Type | Description | Notes
|
|
|
975
1038
|
|
|
976
1039
|
### Authorization
|
|
977
1040
|
|
|
978
|
-
[
|
|
1041
|
+
[OAuth2](../README.md#OAuth2)
|
|
979
1042
|
|
|
980
1043
|
### HTTP request headers
|
|
981
1044
|
|
|
@@ -1007,6 +1070,7 @@ const wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
|
|
|
1007
1070
|
const token_id = "ETH_USDT";
|
|
1008
1071
|
const opts = {
|
|
1009
1072
|
'address': "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
|
|
1073
|
+
'tx_hash': "dd7e1cecf6bbde1844ee1815b780711a1e306a718bcd23cd64401b48ef88eb83",
|
|
1010
1074
|
'limit': 10,
|
|
1011
1075
|
'before': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
|
|
1012
1076
|
'after': "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
|
|
@@ -1027,6 +1091,7 @@ Name | Type | Description | Notes
|
|
|
1027
1091
|
**wallet_id** | **String**| The wallet ID. |
|
|
1028
1092
|
**token_id** | **String**| The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). |
|
|
1029
1093
|
**address** | **String**| The wallet address. | [optional]
|
|
1094
|
+
**tx_hash** | **String**| | [optional]
|
|
1030
1095
|
**limit** | **Number**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10]
|
|
1031
1096
|
**before** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data before the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `before` to the ID of Object C (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object A. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. - If you set it to `infinity`, the last page of data is returned. | [optional]
|
|
1032
1097
|
**after** | **String**| This parameter specifies an object ID as a starting point for pagination, retrieving data after the specified object relative to the current dataset. Suppose the current data is ordered as Object A, Object B, and Object C. If you set `after` to the ID of Object A (`RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk`), the response will include Object B and Object C. **Notes**: - If you set both `after` and `before`, an error will occur. - If you leave both `before` and `after` empty, the first page of data is returned. | [optional]
|
|
@@ -1037,7 +1102,7 @@ Name | Type | Description | Notes
|
|
|
1037
1102
|
|
|
1038
1103
|
### Authorization
|
|
1039
1104
|
|
|
1040
|
-
[
|
|
1105
|
+
[OAuth2](../README.md#OAuth2)
|
|
1041
1106
|
|
|
1042
1107
|
### HTTP request headers
|
|
1043
1108
|
|
|
@@ -1101,7 +1166,7 @@ Name | Type | Description | Notes
|
|
|
1101
1166
|
|
|
1102
1167
|
### Authorization
|
|
1103
1168
|
|
|
1104
|
-
[
|
|
1169
|
+
[OAuth2](../README.md#OAuth2)
|
|
1105
1170
|
|
|
1106
1171
|
### HTTP request headers
|
|
1107
1172
|
|
|
@@ -1155,7 +1220,7 @@ Name | Type | Description | Notes
|
|
|
1155
1220
|
|
|
1156
1221
|
### Authorization
|
|
1157
1222
|
|
|
1158
|
-
[OAuth2](../README.md#OAuth2)
|
|
1223
|
+
[OAuth2](../README.md#OAuth2)
|
|
1159
1224
|
|
|
1160
1225
|
### HTTP request headers
|
|
1161
1226
|
|
|
@@ -1209,7 +1274,7 @@ Name | Type | Description | Notes
|
|
|
1209
1274
|
|
|
1210
1275
|
### Authorization
|
|
1211
1276
|
|
|
1212
|
-
[OAuth2](../README.md#OAuth2)
|
|
1277
|
+
[OAuth2](../README.md#OAuth2)
|
|
1213
1278
|
|
|
1214
1279
|
### HTTP request headers
|
|
1215
1280
|
|
|
@@ -1263,7 +1328,7 @@ Name | Type | Description | Notes
|
|
|
1263
1328
|
|
|
1264
1329
|
### Authorization
|
|
1265
1330
|
|
|
1266
|
-
[OAuth2](../README.md#OAuth2)
|
|
1331
|
+
[OAuth2](../README.md#OAuth2)
|
|
1267
1332
|
|
|
1268
1333
|
### HTTP request headers
|
|
1269
1334
|
|