@cobo/cobo-waas2 1.1.1 → 1.2.0

package/docs/ListSupportedAssetsForExchange200Response.md

@@ -0,0 +1,10 @@
+# CoboWaas2.ListSupportedAssetsForExchange200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[AssetInfo]**](AssetInfo.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

package/docs/MPCWalletInfo.md

@@ -10,6 +10,8 @@ Name | Type | Description | Notes
 **name** | **String** | The wallet name. | 
 **org_id** | **String** | The ID of the owning organization. | 
 **project_id** | **String** | The project ID. | [optional] 
+**project_name** | **String** | The project name. | [optional] 
 **vault_id** | **String** | The ID of the owning vault. | 
+**vault_name** | **String** | The vault name. | [optional] 
 
 

package/docs/OAuthApi.md

@@ -4,8 +4,8 @@ All URIs are relative to *https://api.dev.cobo.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**getToken**](OAuthApi.md#getToken) | **GET** /oauth/token | Get Access Token
-[**refreshToken**](OAuthApi.md#refreshToken) | **POST** /oauth/token | Refresh Access Token
+[**getToken**](OAuthApi.md#getToken) | **GET** /oauth/token | Get access token
+[**refreshToken**](OAuthApi.md#refreshToken) | **POST** /oauth/token | Refresh access token
 
 
 
@@ -13,24 +13,25 @@ Method | HTTP request | Description
 
 > GetToken200Response getToken(client_id, org_id, grant_type)
 
-Get Access Token
+Get access token
 
-<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the OAuth authentication method that requires an App Key.</Note> This operation allows Cobo Portal Apps to get an access token and a refresh token with a specified App ID, Org ID, and grant type.   Access tokens allow the app to signal to the WaaS service that it has received permission from the organization admin to access specific resources. Once the app has been granted permission by an organization admin, it can use this operation to obtain both an access token and a refresh token.  For security purposes, access tokens expire after a certain period. Once they expire, the app need to [Refresh token](/v2/api-references/oauth/refresh-access-token) to get a new access token and a new fresh token. 
+<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to get an access token and a refresh token with a specified App ID, Organization ID, and grant type.   Access tokens allow the app to signal to the WaaS service that it has received permission to access specific resources of the app user's [organization](https://manuals.cobo.com/en/portal/organization/introduction). Once the app has been granted permission by the organization's admin, it can use this operation to obtain both an access token and a refresh token.  For security purposes, access tokens expire after a certain period. Once they expire, the app needs to call [Refresh token](/v2/api-references/oauth/refresh-access-token) to get a new access token and a new refresh token. 
 
 ### Example
 
 ```javascript
 const CoboWaas2 = require('@cobo/cobo-waas2');
-// initial default api client
+// Initialize the API client
 const apiClient = CoboWaas2.ApiClient.instance
-// for dev env
-// apiClient.setEnv(CoboWaas2.Env.DEV);
-apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
-// call api
+// 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.OAuthApi();
-const client_id = "pvSwS8iFrfK0oZrB0ugG54XPDOLEv0Ij"; // String | The App ID, a unique identifier to distinguish Cobo Portal Apps. You can get the App ID by retrieving the Manifest file after receiving the notification of app launch approval.
-const org_id = "e3986401-4aec-480a-973d-e775a4518413"; // String | Org ID, a unique identifier to distinguish different organizations. You can get the Org ID by retrieving the Manifest file after receiving the notification of app launch approval.
-const grant_type = "org_implicit"; // String | The type of the permission granting. To get an access token, you need to set the value as `org_implicit`.
+const client_id = "pvSwS8iFrfK0oZrB0ugG54XPDOLEv0Ij";
+const org_id = "e3986401-4aec-480a-973d-e775a4518413";
+const grant_type = "org_implicit";
 apiInstance.getToken(client_id, org_id, grant_type).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
@@ -45,8 +46,8 @@ apiInstance.getToken(client_id, org_id, grant_type).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **client_id** | **String**| The App ID, a unique identifier to distinguish Cobo Portal Apps. You can get the App ID by retrieving the Manifest file after receiving the notification of app launch approval. | 
- **org_id** | **String**| Org ID, a unique identifier to distinguish different organizations. You can get the Org ID by retrieving the Manifest file after receiving the notification of app launch approval. | 
- **grant_type** | **String**| The type of the permission granting. To get an access token, you need to set the value as &#x60;org_implicit&#x60;. | 
+ **org_id** | **String**| Organization ID, a unique identifier to distinguish different organizations. You can get the Organization ID by retrieving the Manifest file after receiving the notification of app launch approval. | 
+ **grant_type** | **String**| The OAuth grant type. Set the value as &#x60;org_implicit&#x60;. | 
 
 ### Return type
 
@@ -64,24 +65,25 @@ Name | Type | Description  | Notes
 
 ## refreshToken
 
-> GetToken200Response refreshToken(RefreshTokenRequest)
+> RefreshToken200Response refreshToken(RefreshTokenRequest)
 
-Refresh Access Token
+Refresh access token
 
-&lt;Note&gt;This operation is only applicable to Cobo Portal Apps developers. To call this operation, you need to use the OAuth authentication method that requires an App Key.&lt;/Note&gt; This operation allows Cobo Portal Apps to obtain a new access token with a specified App ID, grant type and a refresh token. For security purposes, access tokens expire after a certain period. Once they expire, the app need to use this operation to get a new access token and a new fresh token. 
+&lt;Note&gt;This operation is only applicable to Cobo Portal Apps developers. To call this operation, you need to use the OAuth authentication method that requires an app key.&lt;/Note&gt; This operation allows Cobo Portal Apps to obtain a new access token with a specified App ID, grant type and a refresh token.   For security purposes, access tokens expire after a certain period. Once they expire, the app needs to call this operation to get a new access token and a new refresh token. 
 
 ### Example
 
 ```javascript
 const CoboWaas2 = require('@cobo/cobo-waas2');
-// initial default api client
+// Initialize the API client
 const apiClient = CoboWaas2.ApiClient.instance
-// for dev env
-// apiClient.setEnv(CoboWaas2.Env.DEV);
-apiClient.setPrivateKey("<YOUR_API_PRIVATE_KEY_IN_HEX>");
-// call api
+// 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.OAuthApi();
-const RefreshTokenRequest = new CoboWaas2.RefreshTokenRequest(); // RefreshTokenRequest | The request body for refreshing an access token.
+const RefreshTokenRequest = new CoboWaas2.RefreshTokenRequest();
 apiInstance.refreshToken(RefreshTokenRequest).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
@@ -99,7 +101,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**GetToken200Response**](GetToken200Response.md)
+[**RefreshToken200Response**](RefreshToken200Response.md)
 
 ### Authorization
 

package/docs/RefreshToken200Response.md

@@ -0,0 +1,13 @@
+# CoboWaas2.RefreshToken200Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **String** | The new access token. | [optional] 
+**token_type** | **String** | The type of the tokens, which is Bearer. | [optional] 
+**scope** | **String** | The scope of the access token to limit the app's access to the organization's resources. **Note**: Currently this property value is empty. The scope of the access token is based on the permissions granted when the app user installs the app.  | [optional] 
+**expires_in** | **Number** | The time in seconds in which the new access token expires. | [optional] 
+**refresh_token** | **String** | The refresh token, used to obtain another access token when the new access token expires. | [optional] 
+
+

package/docs/RefreshTokenRequest.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_id** | **String** | The App ID, a unique identifier to distinguish Cobo Portal Apps. You can get the App ID by retrieving the Manifest file after receiving the notification of app launch approval. | [optional] 
-**grant_type** | **String** | The type of the permission granting. To refresh an access token, you need to set the value as `refresh_token`. | [optional] 
-**refresh_token** | **String** | The refresh token of the expired or expiring access token. | [optional] 
+**grant_type** | **String** | The OAuth grant type. Set the value as `refresh_token`. | [optional] 
+**refresh_token** | **String** | The refresh token of the current access token. | [optional] 
 
 

package/docs/SmartContractWalletType.md

@@ -3,7 +3,7 @@
 ## Enum
 
 
-* `SafeWallet` (value: `"SafeWallet"`)
+* `Safe{Wallet}` (value: `"Safe{Wallet}"`)
 
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 

package/docs/SubWalletAssetBalance.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sub_wallet_id** | **String** | The exchange trading account or a sub-wallet ID. | [optional] 
-**asset_id** | **String** | (This concept applies to Exchange Wallets only) The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. | 
+**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) |  | 
 
 

package/docs/TSSRequest.md

@@ -9,5 +9,7 @@ Name | Type | Description | Notes
 **target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional] 
 **type** | [**TSSRequestType**](TSSRequestType.md) |  | [optional] 
 **status** | [**TSSRequestStatus**](TSSRequestStatus.md) |  | [optional] 
+**description** | **String** | The description of the TSS request. | [optional] 
+**created_timestamp** | **Number** | The TSS request's creation time in Unix timestamp format, measured in milliseconds. | [optional] 
 
 

package/docs/TSSRequestWebhookEventData.md

@@ -0,0 +1,29 @@
+# CoboWaas2.TSSRequestWebhookEventData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. | 
+**tss_request_id** | **String** | The TSS request ID. | [optional] 
+**source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) |  | [optional] 
+**target_key_share_holder_group_id** | **String** | The target key share holder group ID. | [optional] 
+**type** | [**TSSRequestType**](TSSRequestType.md) |  | [optional] 
+**status** | [**TSSRequestStatus**](TSSRequestStatus.md) |  | [optional] 
+**description** | **String** | The description of the TSS request. | [optional] 
+**created_timestamp** | **Number** | The TSS request's creation time in Unix timestamp format, measured in milliseconds. | [optional] 
+
+
+
+## Enum: DataTypeEnum
+
+
+* `Transaction` (value: `"Transaction"`)
+
+* `TSSRequest` (value: `"TSSRequest"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/TransactionDepositFromWalletSource.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **wallet_id** | **String** | The wallet ID. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**sub_wallet_id** | **String** | The exchange trading account or a sub-wallet ID. | [optional] 
+**trading_account_type** | **String** | The exchange trading account or a sub-wallet ID. | [optional] 
 
 

package/docs/TransactionDepositToAddressDestination.md

@@ -10,6 +10,6 @@ Name | Type | Description | Notes
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | [optional] 
 **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 quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
 
 

package/docs/TransactionDepositToWalletDestination.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 **wallet_id** | **String** | The wallet ID. | 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
-**sub_wallet_id** | **String** | The exchange trading account or the sub-wallet ID. | [optional] 
+**trading_account_type** | **String** | The trading account type. | [optional] 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | [optional] 
-**amount** | **String** | The quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
 
 

package/docs/TransactionDestination.md

@@ -11,11 +11,11 @@ Name | Type | Description | Notes
 **force_internal** | **Boolean** | Whether the transaction request must be executed as a Loop transfer. For more information about Loop, see [Loop's website](https://loop.top/).   - `true`: The transaction request must be executed as a Loop transfer.   - `false`: The transaction request may not be executed as a Loop transfer.  | [optional] 
 **force_external** | **Boolean** | Whether the transaction request must not be executed as a Loop transfer. For more information about Loop, see [Loop's website](https://loop.top/).   - `true`: The transaction request must not be executed as a Loop transfer.   - `false`: The transaction request can be executed as a Loop transfer.  | [optional] 
 **wallet_id** | **String** | The wallet ID. | 
-**sub_wallet_id** | **String** | The exchange trading account or the sub-wallet ID. | [optional] 
+**trading_account_type** | **String** | The trading account type. | [optional] 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | [optional] 
-**amount** | **String** | The quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
 **address** | **String** | The destination address. | 
-**value** | **String** | The quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
+**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
 **calldata** | **Blob** | The data that is used to invoke a specific function or method within the specified contract at the destination address.  | 
 **message** | **String** | The raw data of the message to be signed, encoded in Base64 format. | 
 **structured_data** | **{String: Object}** | The structured data to be signed, formatted as a JSON object according to the EIP-712 standard. | 

package/docs/TransactionEvmContractDestination.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) |  | 
 **address** | **String** | The destination address. | 
-**value** | **String** | The quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
+**value** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
 **calldata** | **Blob** | The data that is used to invoke a specific function or method within the specified contract at the destination address.  | 
 
 

package/docs/TransactionExchangeWalletSource.md

@@ -7,6 +7,6 @@ Name | Type | Description | Notes
 **source_type** | [**TransactionSourceType**](TransactionSourceType.md) |  | 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
-**sub_wallet_id** | **String** | The exchange trading account or a sub-wallet ID. | [optional] 
+**trading_account_type** | **String** | The exchange trading account or a sub-wallet ID. | [optional] 
 
 

package/docs/TransactionMPCWalletSource.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **address** | **String** | The wallet address. | [optional] 
 **included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
 **excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
+**signer_key_share_holder_group_id** | **String** | The ID of the key share holder group that is selected to sign the transaction. | [optional] 
 
 

package/docs/TransactionSource.md

@@ -9,9 +9,10 @@ Name | Type | Description | Notes
 **address** | **String** | The wallet address. | 
 **included_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
 **excluded_utxos** | [**[TransactionUtxo]**](TransactionUtxo.md) |  | [optional] 
+**signer_key_share_holder_group_id** | **String** | The ID of the key share holder group that is selected to sign the transaction. | [optional] 
 **delegate** | [**CoboSafeDelegate**](CoboSafeDelegate.md) |  | 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | 
-**sub_wallet_id** | **String** | The exchange trading account or a sub-wallet ID. | [optional] 
+**trading_account_type** | **String** | The exchange trading account or a sub-wallet ID. | [optional] 
 **wallet_type** | [**WalletType**](WalletType.md) |  | 
 **wallet_subtype** | [**WalletSubtype**](WalletSubtype.md) |  | 
 **addresses** | **[String]** | A list of addresses. | 

package/docs/TransactionSubStatus.md

@@ -31,6 +31,8 @@
 
 * `PendingWaitSigner` (value: `"PendingWaitSigner"`)
 
+* `PendingApprovalStart` (value: `"PendingApprovalStart"`)
+
 * `FailedBySigner` (value: `"FailedBySigner"`)
 
 * `FailedBroadcasting` (value: `"FailedBroadcasting"`)

package/docs/TransactionTransferToAddressDestinationAccountOutput.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **address** | **String** | The destination address. | [optional] 
 **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 quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
 
 

package/docs/TransactionTransferToAddressDestinationUtxoOutputsInner.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **address** | **String** | The destination address. | [optional] 
-**amount** | **String** | The quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | [optional] 
 **script** | **String** | The script of the output. It is a programmable code fragment that defines the conditions under which the UTXO can be spent. | [optional] 
 
 

package/docs/TransactionTransferToWalletDestination.md

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **destination_type** | [**TransactionDestinationType**](TransactionDestinationType.md) |  | 
 **wallet_id** | **String** | The wallet ID. | 
-**sub_wallet_id** | **String** | The exchange trading account or the sub-wallet ID. | [optional] 
+**trading_account_type** | **String** | The trading account type. | [optional] 
 **exchange_id** | [**ExchangeId**](ExchangeId.md) |  | [optional] 
-**amount** | **String** | The quantity of the token in the transaction. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
+**amount** | **String** | The transfer amount. For example, if you trade 1.5 ETH, then the value is `1.5`.  | 
 
 

package/docs/TransactionWebhookEventData.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**data_type** | **String** | The data type of the event. When `data_type` is `Transaction`, it means the event uses the `transaction` schema as its data type. | 
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. | 
 **transaction_id** | **String** | The transaction ID. | 
 **cobo_id** | **String** | The Cobo ID, which can be used to track a transaction. | [optional] 
 **request_id** | **String** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional] 
@@ -41,6 +41,8 @@ Name | Type | Description | Notes
 
 * `Transaction` (value: `"Transaction"`)
 
+* `TSSRequest` (value: `"TSSRequest"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)