@cobo/cobo-waas2 1.7.0 → 1.9.0

package/docs/OAuthApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 Get Org Access Token
 
-<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the Cobo OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to get an Org Access Token and a Refresh Token with a specified client 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 Org Access Token and a Refresh Token.  For security purposes, Org Access Tokens expire after a certain period. Once they expire, the app needs to call [Refresh token](/v2/api-references/oauth/refresh-org-access-token) to get a new Org Access Token and a new Refresh Token.  
+<Note>This operation is only applicable to Cobo Portal App developers. To call this operation, you need to use the Cobo OAuth authentication method that requires an app key.</Note> This operation allows Cobo Portal Apps to get an Org Access Token and a Refresh Token with a specified client 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 Org Access Token and a Refresh Token.  For security purposes, Org Access Tokens expire after a certain period. Once they expire, the app needs to call [Refresh token](https://www.cobo.com/developers/v2/api-references/oauth/refresh-org-access-token) to get a new Org Access Token and a new Refresh Token.  
 
 ### Example
 

package/docs/OrgInfo.md

@@ -0,0 +1,11 @@
+# CoboWaas2.OrgInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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/Pagination.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**before** | **String** | An object ID that serves as a starting point for retrieving data in reverse chronological order for the next request.   If this property is empty, it means that you have reached the start of the data records.  | 
-**after** | **String** | An object ID that acts as a starting point for retrieving data in chronological order for the next request.  If this property is empty, it means that you have reached the end of the data records.  | 
+**before** | **String** | An object ID used to retrieve records before the specified object, indicating earlier or smaller records relative to the current dataset. You can use it to paginate backwards.   If empty, it means you have reached the start of the data.    Most API endpoints sort by object ID, but some use other fields depending on the endpoint.  | 
+**after** | **String** | An object ID used to retrieve records after the specified object, indicating newer or larger records relative to the current dataset. You can use it to paginate forwards.    If empty, it means you have reached the end of the data.    Most API endpoints sort by object ID, but some use other fields depending on the endpoint.  | 
 **total_count** | **Number** | The total number of records that match the query criteria, unaffected by the pagination parameters (`before` , `after`, and `limit`). | 
 
 

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/RetryCallbackMessage201Response.md

@@ -0,0 +1,9 @@
+# CoboWaas2.RetryCallbackMessage201Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**retried** | **Boolean** | Whether the callback message has been successfully resent: - `true`: The callback message has been successfully resent. - `false`: The callback message has not been successfully resent.  | [optional] 
+
+

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/SelectedEntityType.md

@@ -0,0 +1,12 @@
+# CoboWaas2.SelectedEntityType
+
+## Enum
+
+
+* `LEGAL` (value: `"LEGAL"`)
+
+* `NATURAL` (value: `"NATURAL"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+

package/docs/SelfCustodyWallet.md

@@ -0,0 +1,12 @@
+# CoboWaas2.SelfCustodyWallet
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
+**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/SourceGroup.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **key_share_holder_group_id** | **String** | The source key share holder group ID. | 
-**tss_node_ids** | **[String]** | The TSS Node IDs participating in creating a new key share holder group when `type` is set to either `KeyGenFromKeyGroup` or `Recovery`.   **Note:** In any [Threshold Signature Schemes (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss) such as the 2-2, 2-3, and 3-3 schemes (in the \"threshold - participants\" format), for `tss_node_ids`, you only need to fill in 1 Cobo TSS Node ID and enough non-Cobo TSS Node IDs to satisfy the number of approvers specified in `threshold`. To obtain the Cobo TSS Node ID, run [List all Cobo key share holders](/v2/api-references/wallets--mpc-wallets/list-all-cobo-key-share-holders).  | [optional] 
+**tss_node_ids** | **[String]** | The TSS Node IDs participating in creating a new key share holder group when `type` is set to either `KeyGenFromKeyGroup` or `Recovery`.   **Note:** In any [Threshold Signature Schemes (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss) such as the 2-2, 2-3, and 3-3 schemes (in the \"threshold - participants\" format), for `tss_node_ids`, you only need to fill in 1 Cobo TSS Node ID and enough non-Cobo TSS Node IDs to satisfy the number of approvers specified in `threshold`. To obtain the Cobo TSS Node ID, run [List all Cobo key share holders](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-cobo-key-share-holders).  | [optional] 
 
 

package/docs/StakingPoolId.md

@@ -15,6 +15,8 @@
 
 * `core_xtn` (value: `"core_xtn"`)
 
+* `sky_farm_eth_usdc` (value: `"sky_farm_eth_usdc"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)
 
 

package/docs/StakingPoolType.md

@@ -9,6 +9,8 @@
 
 * `CoreBTC` (value: `"CoreBTC"`)
 
+* `SkyFarm` (value: `"SkyFarm"`)
+
 * `unknown_default_open_api` (value: `"unknown_default_open_api"`)