@cobo/cobo-waas2 1.8.0 → 1.9.0

package/docs/OrgInfo.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**org_id** | **String** | The ID of the owning organization. | 
+**org_id** | **String** | The organization ID. | 
 **name** | **String** | The organization name. | [optional] 
 **created_timestamp** | **Number** | The organization's creation time in Unix timestamp format, measured in milliseconds. | [optional] 
 

package/docs/PrimeBrokerApi.md

@@ -0,0 +1,318 @@
+# CoboWaas2.PrimeBrokerApi
+
+All URIs are relative to *https://api.dev.cobo.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**changeGuardPubkey**](PrimeBrokerApi.md#changeGuardPubkey) | **PUT** /prime_broker/user/{user_id}/guard_pubkey | Change Guard pubkey binding
+[**createGuardPubkey**](PrimeBrokerApi.md#createGuardPubkey) | **POST** /prime_broker/user/{user_id}/guard_pubkey | Create Guard pubkey binding
+[**createPrimeBrokerAddress**](PrimeBrokerApi.md#createPrimeBrokerAddress) | **POST** /prime_broker/user/{user_id}/addresses | Bind addresses to a broker user
+[**deleteGuardPubkey**](PrimeBrokerApi.md#deleteGuardPubkey) | **POST** /prime_broker/user/{user_id}/guard_pubkey/delete | Delete Guard pubkey binding
+[**queryApprovalStatement**](PrimeBrokerApi.md#queryApprovalStatement) | **GET** /prime_broker/approval_statement/{statement_id} | Query approval statement
+[**queryGuardPubkey**](PrimeBrokerApi.md#queryGuardPubkey) | **GET** /prime_broker/user/{user_id}/guard_pubkey | Query a Guard pubkey
+
+
+
+## changeGuardPubkey
+
+> ChangeGuardPubkey200Response changeGuardPubkey(user_id)
+
+Change Guard pubkey binding
+
+This operation updates an existing binding to associate a broker user ID with a new Cobo Guard public key. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.changeGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**ChangeGuardPubkey200Response**](ChangeGuardPubkey200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## createGuardPubkey
+
+> ChangeGuardPubkey200Response createGuardPubkey(user_id)
+
+Create Guard pubkey binding
+
+This operation creates a binding between a broker user ID and a Cobo Guard public key.  
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.createGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**ChangeGuardPubkey200Response**](ChangeGuardPubkey200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## createPrimeBrokerAddress
+
+> CreatePrimeBrokerAddress201Response createPrimeBrokerAddress(user_id, opts)
+
+Bind addresses to a broker user
+
+This operation binds addresses to a broker user. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+const opts = {
+  'CreatePrimeBrokerAddressRequest': new CoboWaas2.CreatePrimeBrokerAddressRequest()
+};
+apiInstance.createPrimeBrokerAddress(user_id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+ **CreatePrimeBrokerAddressRequest** | [**CreatePrimeBrokerAddressRequest**](CreatePrimeBrokerAddressRequest.md)| The request body to bind addresses to a broker user. | [optional] 
+
+### Return type
+
+[**CreatePrimeBrokerAddress201Response**](CreatePrimeBrokerAddress201Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deleteGuardPubkey
+
+> DeleteGuardPubkey201Response deleteGuardPubkey(user_id)
+
+Delete Guard pubkey binding
+
+This operation deletes a binding between a broker user ID and a Cobo Guard public key. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.deleteGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**DeleteGuardPubkey201Response**](DeleteGuardPubkey201Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## queryApprovalStatement
+
+> QueryApprovalStatement200Response queryApprovalStatement(statement_id)
+
+Query approval statement
+
+This operation queries an approval statement. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const statement_id = "168108513539918";
+apiInstance.queryApprovalStatement(statement_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **statement_id** | **String**| The approval statement ID. | 
+
+### Return type
+
+[**QueryApprovalStatement200Response**](QueryApprovalStatement200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## queryGuardPubkey
+
+> QueryGuardPubkey200Response queryGuardPubkey(user_id)
+
+Query a Guard pubkey
+
+This operation retrieves the current Cobo Guard public key binding details for a broker user. 
+
+### Example
+
+```javascript
+const CoboWaas2 = require('@cobo/cobo-waas2');
+// Initialize the API client
+const apiClient = CoboWaas2.ApiClient.instance
+// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
+apiClient.setEnv(CoboWaas2.Env.DEV);
+// Replace `<YOUR_PRIVATE_KEY>` with your private key
+apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
+// Call the API
+const apiInstance = new CoboWaas2.PrimeBrokerApi();
+const user_id = "168108513539918";
+apiInstance.queryGuardPubkey(user_id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The user ID. | 
+
+### Return type
+
+[**QueryGuardPubkey200Response**](QueryGuardPubkey200Response.md)
+
+### Authorization
+
+[CoboAuth](../README.md#CoboAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/docs/QueryApprovalStatement200Response.md

@@ -0,0 +1,12 @@
+# CoboWaas2.QueryApprovalStatement200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The approval statement ID. | [optional] 
+**user_id** | **String** | The user ID of the approver. | [optional] 
+**pubkey** | **String** | The Cobo Guard public key of the approver. | [optional] 
+**status** | [**ApprovalStatementStatus**](ApprovalStatementStatus.md) |  | [optional] 
+
+

package/docs/QueryGuardPubkey200Response.md

@@ -0,0 +1,11 @@
+# CoboWaas2.QueryGuardPubkey200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pubkey** | **String** | The Cobo Guard's public key. | [optional] 
+**status** | [**GuardPubkeyStatus**](GuardPubkeyStatus.md) |  | [optional] 
+**addresses** | [**[QueryGuardPubkey200ResponseAddressesInner]**](QueryGuardPubkey200ResponseAddressesInner.md) |  | [optional] 
+
+

package/docs/QueryGuardPubkey200ResponseAddressesInner.md

@@ -0,0 +1,10 @@
+# CoboWaas2.QueryGuardPubkey200ResponseAddressesInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | **String** | The wallet address. | 
+**chain_id** | **String** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](/v2/api-references/wallets/list-enabled-chains). | 
+
+

package/docs/RootPubkey.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**root_pubkey** | **String** | The vault's [root extended public key](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/tss-node-deployment#tss-node-on-cobo-portal-and-mpc-root-extended-public-key). | [optional] 
+**root_pubkey** | **String** | The vault's [root extended public key](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#root-extended-public-keys). | [optional] 
 **curve** | [**CurveType**](CurveType.md) |  | [optional] 
 
 

package/docs/SelfCustodyWallet.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
-**self_custody_wallet_challenge** | **String** | The challenge obtained from a previous operation. | 
-**self_custody_wallet_address** | **String** | The address of the self-custodial wallet. | 
-**self_custody_wallet_sign** | **String** | The signed message from the self-custodial wallet. | 
+**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. | 
+**self_custody_wallet_address** | **String** | The address of the self-custody wallet. | 
+**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. | 
 
 

package/docs/StakingsApi.md

@@ -63,7 +63,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -115,7 +115,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -167,7 +167,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -219,7 +219,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -269,7 +269,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -319,7 +319,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -371,7 +371,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -423,7 +423,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -473,7 +473,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -545,7 +545,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -605,7 +605,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 
@@ -669,7 +669,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[CoboAuth](../README.md#CoboAuth)
+[OAuth2](../README.md#OAuth2)
 
 ### HTTP request headers
 

package/docs/SubWalletAssetBalance.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **trading_account_type** | **String** | The trading account type. | [optional] 
 **asset_id** | **String** | The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. | 
-**balance** | [**TokenBalanceBalance**](TokenBalanceBalance.md) |  | 
+**balance** | [**Balance**](Balance.md) |  | 
 
 

package/docs/SubmitDepositTravelRuleInfo201Response.md

@@ -4,6 +4,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**submitted** | **Boolean** | Whether the submitted Travel Rule info has been successfully executed. - `true`: The operation has been successfully executed. - `false`: The operation has not been executed.  | [optional] 
+**submitted** | **Boolean** | Whether the Travel Rule information has been successfully submitted. - `true`: The information has been successfully submitted. - `false`: The information has not been submitted.  | [optional] 
 
 

package/docs/TSSGroups.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **tss_key_share_group_id** | **String** | The TSS key share group ID. | [optional] 
 **curve** | [**CurveType**](CurveType.md) |  | [optional] 
-**root_pubkey** | **String** | The vault's [root extended public key](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/tss-node-deployment#tss-node-on-cobo-portal-and-mpc-root-extended-public-key). | [optional] 
+**root_pubkey** | **String** | The vault's [root extended public key](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#root-extended-public-keys). | [optional] 
 
 

package/docs/TokenBalance.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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). | 
-**balance** | [**TokenBalanceBalance**](TokenBalanceBalance.md) |  | 
+**balance** | [**Balance**](Balance.md) |  | 
 
 

package/docs/TransactionDepositToAddressDestination.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **address** | **String** | The destination address. | 
 **memo** | **String** | The memo that identifies a transaction in order to credit the correct account. For transfers out of Cobo Portal, it is highly recommended to include a memo for the chains such as XRP, EOS, XLM, IOST, BNB_BNB, ATOM, LUNA, and TON. | [optional] 
 **amount** | **String** | The transfer amount. For example, if you trade 1.5 BTC, then the value is `1.5`.  | 
+**tx_info** | [**TransactionDepositToAddressDestinationTxInfo**](TransactionDepositToAddressDestinationTxInfo.md) |  | [optional] 
 
 

package/docs/TransactionDepositToAddressDestinationTxInfo.md

@@ -0,0 +1,9 @@
+# CoboWaas2.TransactionDepositToAddressDestinationTxInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vout_n** | **Number** | The output index of the UTXO. | [optional] 
+
+

package/docs/TransactionDestination.md

@@ -24,5 +24,6 @@ Name | Type | Description | Notes
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **memo** | **String** | The memo that identifies a transaction in order to credit the correct account. For transfers out of Cobo Portal, it is highly recommended to include a memo for the chains such as XRP, EOS, XLM, IOST, BNB_BNB, ATOM, LUNA, and TON. | [optional] 
+**tx_info** | [**TransactionDepositToAddressDestinationTxInfo**](TransactionDepositToAddressDestinationTxInfo.md) |  | [optional] 
 
 

package/docs/TransactionRawTxInfo.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **used_nonce** | **Number** | The transaction nonce. | [optional] 
 **selected_utxos** | [**[TransactionSelectedUtxo]**](TransactionSelectedUtxo.md) | The selected UTXOs to be consumed in the transaction. | [optional] 
 **raw_tx** | **String** | The raw transaction data. | [optional] 
+**unsigned_raw_tx** | **String** | The unsigned raw transaction data. | [optional] 
 
 

package/docs/TransactionSubStatus.md

@@ -27,6 +27,8 @@
 
 * `RejectedbyMobileCosigner` (value: `"RejectedbyMobileCosigner"`)
 
+* `Built` (value: `"Built"`)
+
 * `PendingWaitSigner` (value: `"PendingWaitSigner"`)
 
 * `PendingApprovalStart` (value: `"PendingApprovalStart"`)

package/docs/TransactionUserApprovalDetail.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**pubkey** | **String** | The gaurd pubkey of the user who audited the message. | [optional] 
+**pubkey** | **String** | The Cobo Guard public key of the user who audited this message. | [optional] 
 **result** | [**TransactionApprovalResult**](TransactionApprovalResult.md) |  | [optional] 
-**signature** | **String** | Signature of the audited message. | [optional] 
+**signature** | **String** | The signature of the audited message. | [optional] 
 **language** | **String** | The language of the audited message. | [optional] 
-**message_version** | **String** | Version of the audited message. | [optional] 
+**message_version** | **String** | The version of the audited message. | [optional] 
 **message** | **String** | The audited message. | [optional] 
 **extra_message** | **String** | The extra audited message. | [optional]