Version 1.0.0

.openapi-generator/FILES

@@ -107,11 +107,14 @@ docs/CreateMultipleAccountsRequest.md
 docs/CreateNcwConnectionRequest.md
 docs/CreateNetworkIdRequest.md
 docs/CreatePayoutRequest.md
+docs/CreateSigningKeyDto.md
 docs/CreateTokenRequestDto.md
 docs/CreateTokenRequestDtoCreateParams.md
 docs/CreateTransactionResponse.md
 docs/CreateTransferConfigOperationRequest.md
 docs/CreateUserGroupResponse.md
+docs/CreateValidationKeyDto.md
+docs/CreateValidationKeyResponseDto.md
 docs/CreateVaultAccountConnectionRequest.md
 docs/CreateVaultAccountRequest.md
 docs/CreateVaultAssetResponse.md
@@ -197,7 +200,9 @@ docs/GetMaxSpendableAmountResponse.md
 docs/GetNFTsResponse.md
 docs/GetOtaStatusResponse.md
 docs/GetOwnershipTokensResponse.md
+docs/GetSigningKeyResponseDto.md
 docs/GetTransactionOperation.md
+docs/GetValidationKeyResponseDto.md
 docs/GetWhitelistIpAddressesResponse.md
 docs/GetWorkspaceStatusResponse.md
 docs/HttpContractDoesNotExistError.md
@@ -207,12 +212,16 @@ docs/InternalWalletsApi.md
 docs/Job.md
 docs/JobCreated.md
 docs/JobManagementApi.md
+docs/KeyLinkBetaApi.md
 docs/LeanAbiFunction.md
 docs/LeanContractDto.md
 docs/LeanDeployedContractResponseDto.md
 docs/ListOwnedCollectionsResponse.md
 docs/ListOwnedTokensResponse.md
 docs/MediaEntityResponse.md
+docs/ModifySigningKeyAgentIdDto.md
+docs/ModifySigningKeyDto.md
+docs/ModifyValidationKeyDto.md
 docs/NFTsApi.md
 docs/NetworkChannel.md
 docs/NetworkConnection.md
@@ -329,6 +338,7 @@ docs/SettlementRequestBody.md
 docs/SettlementResponse.md
 docs/SignedMessage.md
 docs/SignedMessageSignature.md
+docs/SigningKeyDto.md
 docs/SmartTransferApi.md
 docs/SmartTransferBadRequestResponse.md
 docs/SmartTransferCreateTicket.md
@@ -441,6 +451,7 @@ docs/UserStatus.md
 docs/UserType.md
 docs/UsersApi.md
 docs/ValidateAddressResponse.md
+docs/ValidationKeyDto.md
 docs/ValidatorDto.md
 docs/VaultAccount.md
 docs/VaultAccountsPagedResponse.md
@@ -484,6 +495,7 @@ fireblocks/api/fiat_accounts_api.py
 fireblocks/api/gas_stations_api.py
 fireblocks/api/internal_wallets_api.py
 fireblocks/api/job_management_api.py
+fireblocks/api/key_link_beta_api.py
 fireblocks/api/network_connections_api.py
 fireblocks/api/nfts_api.py
 fireblocks/api/off_exchanges_api.py
@@ -607,11 +619,14 @@ fireblocks/models/create_multiple_accounts_request.py
 fireblocks/models/create_ncw_connection_request.py
 fireblocks/models/create_network_id_request.py
 fireblocks/models/create_payout_request.py
+fireblocks/models/create_signing_key_dto.py
 fireblocks/models/create_token_request_dto.py
 fireblocks/models/create_token_request_dto_create_params.py
 fireblocks/models/create_transaction_response.py
 fireblocks/models/create_transfer_config_operation_request.py
 fireblocks/models/create_user_group_response.py
+fireblocks/models/create_validation_key_dto.py
+fireblocks/models/create_validation_key_response_dto.py
 fireblocks/models/create_vault_account_connection_request.py
 fireblocks/models/create_vault_account_request.py
 fireblocks/models/create_vault_asset_response.py
@@ -692,7 +707,9 @@ fireblocks/models/get_max_spendable_amount_response.py
 fireblocks/models/get_nfts_response.py
 fireblocks/models/get_ota_status_response.py
 fireblocks/models/get_ownership_tokens_response.py
+fireblocks/models/get_signing_key_response_dto.py
 fireblocks/models/get_transaction_operation.py
+fireblocks/models/get_validation_key_response_dto.py
 fireblocks/models/get_whitelist_ip_addresses_response.py
 fireblocks/models/get_workspace_status_response.py
 fireblocks/models/http_contract_does_not_exist_error.py
@@ -706,6 +723,9 @@ fireblocks/models/lean_deployed_contract_response_dto.py
 fireblocks/models/list_owned_collections_response.py
 fireblocks/models/list_owned_tokens_response.py
 fireblocks/models/media_entity_response.py
+fireblocks/models/modify_signing_key_agent_id_dto.py
+fireblocks/models/modify_signing_key_dto.py
+fireblocks/models/modify_validation_key_dto.py
 fireblocks/models/network_channel.py
 fireblocks/models/network_connection.py
 fireblocks/models/network_connection_response.py
@@ -815,6 +835,7 @@ fireblocks/models/settlement_request_body.py
 fireblocks/models/settlement_response.py
 fireblocks/models/signed_message.py
 fireblocks/models/signed_message_signature.py
+fireblocks/models/signing_key_dto.py
 fireblocks/models/smart_transfer_bad_request_response.py
 fireblocks/models/smart_transfer_create_ticket.py
 fireblocks/models/smart_transfer_create_ticket_term.py
@@ -920,6 +941,7 @@ fireblocks/models/user_role.py
 fireblocks/models/user_status.py
 fireblocks/models/user_type.py
 fireblocks/models/validate_address_response.py
+fireblocks/models/validation_key_dto.py
 fireblocks/models/validator_dto.py
 fireblocks/models/vault_account.py
 fireblocks/models/vault_accounts_paged_response.py
@@ -1064,11 +1086,14 @@ test/test_create_multiple_accounts_request.py
 test/test_create_ncw_connection_request.py
 test/test_create_network_id_request.py
 test/test_create_payout_request.py
+test/test_create_signing_key_dto.py
 test/test_create_token_request_dto.py
 test/test_create_token_request_dto_create_params.py
 test/test_create_transaction_response.py
 test/test_create_transfer_config_operation_request.py
 test/test_create_user_group_response.py
+test/test_create_validation_key_dto.py
+test/test_create_validation_key_response_dto.py
 test/test_create_vault_account_connection_request.py
 test/test_create_vault_account_request.py
 test/test_create_vault_asset_response.py
@@ -1154,7 +1179,9 @@ test/test_get_max_spendable_amount_response.py
 test/test_get_nfts_response.py
 test/test_get_ota_status_response.py
 test/test_get_ownership_tokens_response.py
+test/test_get_signing_key_response_dto.py
 test/test_get_transaction_operation.py
+test/test_get_validation_key_response_dto.py
 test/test_get_whitelist_ip_addresses_response.py
 test/test_get_workspace_status_response.py
 test/test_http_contract_does_not_exist_error.py
@@ -1164,12 +1191,16 @@ test/test_internal_wallets_api.py
 test/test_job.py
 test/test_job_created.py
 test/test_job_management_api.py
+test/test_key_link_beta_api.py
 test/test_lean_abi_function.py
 test/test_lean_contract_dto.py
 test/test_lean_deployed_contract_response_dto.py
 test/test_list_owned_collections_response.py
 test/test_list_owned_tokens_response.py
 test/test_media_entity_response.py
+test/test_modify_signing_key_agent_id_dto.py
+test/test_modify_signing_key_dto.py
+test/test_modify_validation_key_dto.py
 test/test_network_channel.py
 test/test_network_connection.py
 test/test_network_connection_response.py
@@ -1286,6 +1317,7 @@ test/test_settlement_request_body.py
 test/test_settlement_response.py
 test/test_signed_message.py
 test/test_signed_message_signature.py
+test/test_signing_key_dto.py
 test/test_smart_transfer_api.py
 test/test_smart_transfer_bad_request_response.py
 test/test_smart_transfer_create_ticket.py
@@ -1398,6 +1430,7 @@ test/test_user_status.py
 test/test_user_type.py
 test/test_users_api.py
 test/test_validate_address_response.py
+test/test_validation_key_dto.py
 test/test_validator_dto.py
 test/test_vault_account.py
 test/test_vault_accounts_paged_response.py

README.md

@@ -1,15 +1,10 @@
-# Fireblocks Python SDK (beta)
+# Official Fireblocks Python SDK
 [![PyPI version](https://badge.fury.io/py/fireblocks.svg)](https://badge.fury.io/py/fireblocks)
 
 The Fireblocks SDK allows developers to seamlessly integrate with the Fireblocks platform and perform a variety of operations, including managing vault accounts and executing transactions securely.
 
 For detailed API documentation please refer to the [Fireblocks API Reference](https://developers.fireblocks.com/reference/).
 
-> **Warning**
-> This package is currently in a beta stage and should be used at your own risk.
-> The provided interfaces might go through backwards-incompatibale changes.
-> For a more stable SDK, please use the [Fireblocks Python SDK](https://github.com/fireblocks/fireblocks-sdk-py)
-
 ## Requirements.
 
 Python 3.8+
@@ -25,7 +20,6 @@ If the python package is hosted on a repository, you can install directly using:
 ```sh
 pip install fireblocks
 ```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/fireblocks/py-sdk.git`)
 
 Then import the package:
 ```python
@@ -317,6 +311,15 @@ Class | Method | HTTP request | Description
 *JobManagementApi* | [**get_job_tasks**](docs/JobManagementApi.md#get_job_tasks) | **GET** /batch/{jobId}/tasks | Return a list of tasks for given job
 *JobManagementApi* | [**get_jobs**](docs/JobManagementApi.md#get_jobs) | **GET** /batch/jobs | Return a list of jobs belonging to tenant
 *JobManagementApi* | [**pause_job**](docs/JobManagementApi.md#pause_job) | **POST** /batch/{jobId}/pause | Pause a job
+*KeyLinkBetaApi* | [**create_signing_key**](docs/KeyLinkBetaApi.md#create_signing_key) | **POST** /key_link/signing_keys | Add a new signing key
+*KeyLinkBetaApi* | [**create_validation_key**](docs/KeyLinkBetaApi.md#create_validation_key) | **POST** /key_link/validation_keys | Add a new validation key
+*KeyLinkBetaApi* | [**disable_validation_key**](docs/KeyLinkBetaApi.md#disable_validation_key) | **PATCH** /key_link/validation_keys/{keyId} | Disables a validation key
+*KeyLinkBetaApi* | [**get_signing_key**](docs/KeyLinkBetaApi.md#get_signing_key) | **GET** /key_link/signing_keys/{keyId} | Get a signing key by `keyId`
+*KeyLinkBetaApi* | [**get_signing_keys_list**](docs/KeyLinkBetaApi.md#get_signing_keys_list) | **GET** /key_link/signing_keys | Get list of signing keys
+*KeyLinkBetaApi* | [**get_validation_key**](docs/KeyLinkBetaApi.md#get_validation_key) | **GET** /key_link/validation_keys/{keyId} | Get a validation key by `keyId`
+*KeyLinkBetaApi* | [**get_validation_keys_list**](docs/KeyLinkBetaApi.md#get_validation_keys_list) | **GET** /key_link/validation_keys | Get list of registered validation keys
+*KeyLinkBetaApi* | [**set_agent_id**](docs/KeyLinkBetaApi.md#set_agent_id) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id that can sign with the signing key identified by the Fireblocks provided `keyId`
+*KeyLinkBetaApi* | [**update_signing_key**](docs/KeyLinkBetaApi.md#update_signing_key) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing by Fireblocks provided `keyId`
 *NFTsApi* | [**get_nft**](docs/NFTsApi.md#get_nft) | **GET** /nfts/tokens/{id} | List token data by ID
 *NFTsApi* | [**get_nfts**](docs/NFTsApi.md#get_nfts) | **GET** /nfts/tokens | List tokens by IDs
 *NFTsApi* | [**get_ownership_tokens**](docs/NFTsApi.md#get_ownership_tokens) | **GET** /nfts/ownership/tokens | List all owned tokens (paginated)
@@ -543,11 +546,14 @@ Class | Method | HTTP request | Description
  - [CreateNcwConnectionRequest](docs/CreateNcwConnectionRequest.md)
  - [CreateNetworkIdRequest](docs/CreateNetworkIdRequest.md)
  - [CreatePayoutRequest](docs/CreatePayoutRequest.md)
+ - [CreateSigningKeyDto](docs/CreateSigningKeyDto.md)
  - [CreateTokenRequestDto](docs/CreateTokenRequestDto.md)
  - [CreateTokenRequestDtoCreateParams](docs/CreateTokenRequestDtoCreateParams.md)
  - [CreateTransactionResponse](docs/CreateTransactionResponse.md)
  - [CreateTransferConfigOperationRequest](docs/CreateTransferConfigOperationRequest.md)
  - [CreateUserGroupResponse](docs/CreateUserGroupResponse.md)
+ - [CreateValidationKeyDto](docs/CreateValidationKeyDto.md)
+ - [CreateValidationKeyResponseDto](docs/CreateValidationKeyResponseDto.md)
  - [CreateVaultAccountConnectionRequest](docs/CreateVaultAccountConnectionRequest.md)
  - [CreateVaultAccountRequest](docs/CreateVaultAccountRequest.md)
  - [CreateVaultAssetResponse](docs/CreateVaultAssetResponse.md)
@@ -628,7 +634,9 @@ Class | Method | HTTP request | Description
  - [GetNFTsResponse](docs/GetNFTsResponse.md)
  - [GetOtaStatusResponse](docs/GetOtaStatusResponse.md)
  - [GetOwnershipTokensResponse](docs/GetOwnershipTokensResponse.md)
+ - [GetSigningKeyResponseDto](docs/GetSigningKeyResponseDto.md)
  - [GetTransactionOperation](docs/GetTransactionOperation.md)
+ - [GetValidationKeyResponseDto](docs/GetValidationKeyResponseDto.md)
  - [GetWhitelistIpAddressesResponse](docs/GetWhitelistIpAddressesResponse.md)
  - [GetWorkspaceStatusResponse](docs/GetWorkspaceStatusResponse.md)
  - [HttpContractDoesNotExistError](docs/HttpContractDoesNotExistError.md)
@@ -642,6 +650,9 @@ Class | Method | HTTP request | Description
  - [ListOwnedCollectionsResponse](docs/ListOwnedCollectionsResponse.md)
  - [ListOwnedTokensResponse](docs/ListOwnedTokensResponse.md)
  - [MediaEntityResponse](docs/MediaEntityResponse.md)
+ - [ModifySigningKeyAgentIdDto](docs/ModifySigningKeyAgentIdDto.md)
+ - [ModifySigningKeyDto](docs/ModifySigningKeyDto.md)
+ - [ModifyValidationKeyDto](docs/ModifyValidationKeyDto.md)
  - [NetworkChannel](docs/NetworkChannel.md)
  - [NetworkConnection](docs/NetworkConnection.md)
  - [NetworkConnectionResponse](docs/NetworkConnectionResponse.md)
@@ -751,6 +762,7 @@ Class | Method | HTTP request | Description
  - [SettlementResponse](docs/SettlementResponse.md)
  - [SignedMessage](docs/SignedMessage.md)
  - [SignedMessageSignature](docs/SignedMessageSignature.md)
+ - [SigningKeyDto](docs/SigningKeyDto.md)
  - [SmartTransferBadRequestResponse](docs/SmartTransferBadRequestResponse.md)
  - [SmartTransferCreateTicket](docs/SmartTransferCreateTicket.md)
  - [SmartTransferCreateTicketTerm](docs/SmartTransferCreateTicketTerm.md)
@@ -856,6 +868,7 @@ Class | Method | HTTP request | Description
  - [UserStatus](docs/UserStatus.md)
  - [UserType](docs/UserType.md)
  - [ValidateAddressResponse](docs/ValidateAddressResponse.md)
+ - [ValidationKeyDto](docs/ValidationKeyDto.md)
  - [ValidatorDto](docs/ValidatorDto.md)
  - [VaultAccount](docs/VaultAccount.md)
  - [VaultAccountsPagedResponse](docs/VaultAccountsPagedResponse.md)

docs/BlockchainsAssetsApi.md

@@ -83,7 +83,7 @@ No authorization required
 
 Register an asset
 
-Register a new asset to a workspace and return the newly created asset's details. Currently supported for EVM based chains only.
+Register a new asset to a workspace and return the newly created asset's details. Currently supported chains are: - EVM based chains - Stellar - Algorand - TRON - NEAR 
 
 ### Example
 

docs/CreateSigningKeyDto.md

@@ -0,0 +1,31 @@
+# CreateSigningKeyDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signing_device_key_id** | **str** | The ID, name or label of the key specified on the customer's signing device. | 
+**signed_cert_pem** | **str** | The signed certificate that includes the public key PEM of the signing key, signed by a validation key. | 
+**agent_user_id** | **str** | Id of user to which this key belongs | 
+
+## Example
+
+```python
+from fireblocks.models.create_signing_key_dto import CreateSigningKeyDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateSigningKeyDto from a JSON string
+create_signing_key_dto_instance = CreateSigningKeyDto.from_json(json)
+# print the JSON string representation of the object
+print(CreateSigningKeyDto.to_json())
+
+# convert the object into a dict
+create_signing_key_dto_dict = create_signing_key_dto_instance.to_dict()
+# create an instance of CreateSigningKeyDto from a dict
+create_signing_key_dto_from_dict = CreateSigningKeyDto.from_dict(create_signing_key_dto_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/CreateValidationKeyDto.md

@@ -0,0 +1,30 @@
+# CreateValidationKeyDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**public_key_pem** | **str** | The PEM encoded public key of the validation key being added | 
+**days_till_expired** | **float** | The number of days from the date the validation key was added until it expires | 
+
+## Example
+
+```python
+from fireblocks.models.create_validation_key_dto import CreateValidationKeyDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateValidationKeyDto from a JSON string
+create_validation_key_dto_instance = CreateValidationKeyDto.from_json(json)
+# print the JSON string representation of the object
+print(CreateValidationKeyDto.to_json())
+
+# convert the object into a dict
+create_validation_key_dto_dict = create_validation_key_dto_instance.to_dict()
+# create an instance of CreateValidationKeyDto from a dict
+create_validation_key_dto_from_dict = CreateValidationKeyDto.from_dict(create_validation_key_dto_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/CreateValidationKeyResponseDto.md

@@ -0,0 +1,32 @@
+# CreateValidationKeyResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validation_key** | [**ValidationKeyDto**](ValidationKeyDto.md) | Created validation key | 
+**admins** | **List[str]** | Admins who have to approve the validation key addition | 
+**approval_threshold** | **float** | Minimal number of approvers required. 0 for all | 
+**request_id** | **float** | Approval request id. Can be cancelled | 
+
+## Example
+
+```python
+from fireblocks.models.create_validation_key_response_dto import CreateValidationKeyResponseDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CreateValidationKeyResponseDto from a JSON string
+create_validation_key_response_dto_instance = CreateValidationKeyResponseDto.from_json(json)
+# print the JSON string representation of the object
+print(CreateValidationKeyResponseDto.to_json())
+
+# convert the object into a dict
+create_validation_key_response_dto_dict = create_validation_key_response_dto_instance.to_dict()
+# create an instance of CreateValidationKeyResponseDto from a dict
+create_validation_key_response_dto_from_dict = CreateValidationKeyResponseDto.from_dict(create_validation_key_response_dto_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+