Generated SDK #538

Author: fireblocks_dx_team

.openapi-generator/FILES

@@ -18,8 +18,11 @@ docs/AddCollateralRequestBody.md
 docs/AddContractAssetRequest.md
 docs/AddCosignerRequest.md
 docs/AddCosignerResponse.md
+docs/AddExchangeAccountRequest.md
+docs/AddExchangeAccountResponse.md
 docs/AdditionalInfo.md
 docs/AmlRegistrationResult.md
+docs/AmlRegistrationResultFullPayload.md
 docs/AmlScreeningResult.md
 docs/AmountAggregationTimePeriodMethod.md
 docs/AmountAndChainDescriptor.md
@@ -83,8 +86,10 @@ docs/CollectionTokenMetadataDto.md
 docs/CollectionType.md
 docs/ComplianceApi.md
 docs/ComplianceResult.md
+docs/ComplianceResultFullPayload.md
 docs/ComplianceScreeningConfigurationApi.md
 docs/ComplianceScreeningResult.md
+docs/ComplianceScreeningResultFullPayload.md
 docs/ConfigChangeRequestStatus.md
 docs/ConfigConversionOperationSnapshot.md
 docs/ConfigDisbursementOperationSnapshot.md
@@ -619,8 +624,11 @@ fireblocks/models/add_collateral_request_body.py
 fireblocks/models/add_contract_asset_request.py
 fireblocks/models/add_cosigner_request.py
 fireblocks/models/add_cosigner_response.py
+fireblocks/models/add_exchange_account_request.py
+fireblocks/models/add_exchange_account_response.py
 fireblocks/models/additional_info.py
 fireblocks/models/aml_registration_result.py
+fireblocks/models/aml_registration_result_full_payload.py
 fireblocks/models/aml_screening_result.py
 fireblocks/models/amount_aggregation_time_period_method.py
 fireblocks/models/amount_and_chain_descriptor.py
@@ -679,7 +687,9 @@ fireblocks/models/collection_token_metadata_attribute_dto.py
 fireblocks/models/collection_token_metadata_dto.py
 fireblocks/models/collection_type.py
 fireblocks/models/compliance_result.py
+fireblocks/models/compliance_result_full_payload.py
 fireblocks/models/compliance_screening_result.py
+fireblocks/models/compliance_screening_result_full_payload.py
 fireblocks/models/config_change_request_status.py
 fireblocks/models/config_conversion_operation_snapshot.py
 fireblocks/models/config_disbursement_operation_snapshot.py
@@ -1148,8 +1158,11 @@ test/test_add_collateral_request_body.py
 test/test_add_contract_asset_request.py
 test/test_add_cosigner_request.py
 test/test_add_cosigner_response.py
+test/test_add_exchange_account_request.py
+test/test_add_exchange_account_response.py
 test/test_additional_info.py
 test/test_aml_registration_result.py
+test/test_aml_registration_result_full_payload.py
 test/test_aml_screening_result.py
 test/test_amount_aggregation_time_period_method.py
 test/test_amount_and_chain_descriptor.py
@@ -1214,8 +1227,10 @@ test/test_collection_token_metadata_dto.py
 test/test_collection_type.py
 test/test_compliance_api.py
 test/test_compliance_result.py
+test/test_compliance_result_full_payload.py
 test/test_compliance_screening_configuration_api.py
 test/test_compliance_screening_result.py
+test/test_compliance_screening_result_full_payload.py
 test/test_config_change_request_status.py
 test/test_config_conversion_operation_snapshot.py
 test/test_config_disbursement_operation_snapshot.py

README.md

@@ -247,6 +247,7 @@ Class | Method | HTTP request | Description
 *ComplianceApi* | [**get_aml_post_screening_policy**](docs/ComplianceApi.md#get_aml_post_screening_policy) | **GET** /screening/aml/post_screening_policy | AML - View Post-Screening Policy
 *ComplianceApi* | [**get_aml_screening_policy**](docs/ComplianceApi.md#get_aml_screening_policy) | **GET** /screening/aml/screening_policy | AML - View Screening Policy
 *ComplianceApi* | [**get_post_screening_policy**](docs/ComplianceApi.md#get_post_screening_policy) | **GET** /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy
+*ComplianceApi* | [**get_screening_full_details**](docs/ComplianceApi.md#get_screening_full_details) | **GET** /screening/transaction/{txId} | Provides all the compliance details for the given screened transaction.
 *ComplianceApi* | [**get_screening_policy**](docs/ComplianceApi.md#get_screening_policy) | **GET** /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy
 *ComplianceApi* | [**retry_rejected_transaction_bypass_screening_checks**](docs/ComplianceApi.md#retry_rejected_transaction_bypass_screening_checks) | **POST** /screening/transaction/{txId}/bypass_screening_policy | Calling the \"Bypass Screening Policy\" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
 *ComplianceApi* | [**update_aml_screening_configuration**](docs/ComplianceApi.md#update_aml_screening_configuration) | **PUT** /screening/aml/policy_configuration | Update AML Configuration
@@ -291,9 +292,11 @@ Class | Method | HTTP request | Description
 *DeployedContractsApi* | [**get_deployed_contracts**](docs/DeployedContractsApi.md#get_deployed_contracts) | **GET** /tokenization/contracts | List deployed contracts data
 *EmbeddedWalletsApi* | [**get_public_key_info_for_address_ncw**](docs/EmbeddedWalletsApi.md#get_public_key_info_for_address_ncw) | **GET** /ncw/{walletId}/accounts/{accountId}/{assetId}/{change}/{addressIndex}/public_key_info | Get the public key of an asset
 *EmbeddedWalletsApi* | [**get_public_key_info_ncw**](docs/EmbeddedWalletsApi.md#get_public_key_info_ncw) | **GET** /ncw/{walletId}/public_key_info | Get the public key for a derivation path
+*ExchangeAccountsApi* | [**add_exchange_account**](docs/ExchangeAccountsApi.md#add_exchange_account) | **POST** /exchange_accounts | Add an exchange account
 *ExchangeAccountsApi* | [**convert_assets**](docs/ExchangeAccountsApi.md#convert_assets) | **POST** /exchange_accounts/{exchangeAccountId}/convert | Convert exchange account funds from the source asset to the destination asset.
 *ExchangeAccountsApi* | [**get_exchange_account**](docs/ExchangeAccountsApi.md#get_exchange_account) | **GET** /exchange_accounts/{exchangeAccountId} | Find a specific exchange account
 *ExchangeAccountsApi* | [**get_exchange_account_asset**](docs/ExchangeAccountsApi.md#get_exchange_account_asset) | **GET** /exchange_accounts/{exchangeAccountId}/{assetId} | Find an asset for an exchange account
+*ExchangeAccountsApi* | [**get_exchange_accounts_credentials_public_key**](docs/ExchangeAccountsApi.md#get_exchange_accounts_credentials_public_key) | **GET** /exchange_accounts/credentials_public_key | Get public key to encrypt exchange credentials
 *ExchangeAccountsApi* | [**get_paged_exchange_accounts**](docs/ExchangeAccountsApi.md#get_paged_exchange_accounts) | **GET** /exchange_accounts/paged | Pagination list exchange accounts
 *ExchangeAccountsApi* | [**internal_transfer**](docs/ExchangeAccountsApi.md#internal_transfer) | **POST** /exchange_accounts/{exchangeAccountId}/internal_transfer | Internal transfer for exchange accounts
 *ExternalWalletsApi* | [**add_asset_to_external_wallet**](docs/ExternalWalletsApi.md#add_asset_to_external_wallet) | **POST** /external_wallets/{walletId}/{assetId} | Add an asset to an external wallet.
@@ -509,8 +512,11 @@ Class | Method | HTTP request | Description
  - [AddContractAssetRequest](docs/AddContractAssetRequest.md)
  - [AddCosignerRequest](docs/AddCosignerRequest.md)
  - [AddCosignerResponse](docs/AddCosignerResponse.md)
+ - [AddExchangeAccountRequest](docs/AddExchangeAccountRequest.md)
+ - [AddExchangeAccountResponse](docs/AddExchangeAccountResponse.md)
  - [AdditionalInfo](docs/AdditionalInfo.md)
  - [AmlRegistrationResult](docs/AmlRegistrationResult.md)
+ - [AmlRegistrationResultFullPayload](docs/AmlRegistrationResultFullPayload.md)
  - [AmlScreeningResult](docs/AmlScreeningResult.md)
  - [AmountAggregationTimePeriodMethod](docs/AmountAggregationTimePeriodMethod.md)
  - [AmountAndChainDescriptor](docs/AmountAndChainDescriptor.md)
@@ -568,7 +574,9 @@ Class | Method | HTTP request | Description
  - [CollectionTokenMetadataDto](docs/CollectionTokenMetadataDto.md)
  - [CollectionType](docs/CollectionType.md)
  - [ComplianceResult](docs/ComplianceResult.md)
+ - [ComplianceResultFullPayload](docs/ComplianceResultFullPayload.md)
  - [ComplianceScreeningResult](docs/ComplianceScreeningResult.md)
+ - [ComplianceScreeningResultFullPayload](docs/ComplianceScreeningResultFullPayload.md)
  - [ConfigChangeRequestStatus](docs/ConfigChangeRequestStatus.md)
  - [ConfigConversionOperationSnapshot](docs/ConfigConversionOperationSnapshot.md)
  - [ConfigDisbursementOperationSnapshot](docs/ConfigDisbursementOperationSnapshot.md)

docs/AddExchangeAccountRequest.md

@@ -0,0 +1,33 @@
+# AddExchangeAccountRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exchange_type** | [**ExchangeType**](ExchangeType.md) |  | 
+**name** | **str** | Display name of the exchange account | 
+**creds** | **str** | Encrypted credentials | [optional] 
+**key** | **str** | Api key of the exchange | [optional] 
+**main_account_id** | **str** | Optional - main account id of the exchange | [optional] 
+
+## Example
+
+```python
+from fireblocks.models.add_exchange_account_request import AddExchangeAccountRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddExchangeAccountRequest from a JSON string
+add_exchange_account_request_instance = AddExchangeAccountRequest.from_json(json)
+# print the JSON string representation of the object
+print(AddExchangeAccountRequest.to_json())
+
+# convert the object into a dict
+add_exchange_account_request_dict = add_exchange_account_request_instance.to_dict()
+# create an instance of AddExchangeAccountRequest from a dict
+add_exchange_account_request_from_dict = AddExchangeAccountRequest.from_dict(add_exchange_account_request_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/AddExchangeAccountResponse.md

@@ -0,0 +1,31 @@
+# AddExchangeAccountResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | Exchange account's identifier | [optional] 
+**name** | **str** | Display name of the exchange account | [optional] 
+**exchange_type** | [**ExchangeType**](ExchangeType.md) |  | [optional] 
+
+## Example
+
+```python
+from fireblocks.models.add_exchange_account_response import AddExchangeAccountResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AddExchangeAccountResponse from a JSON string
+add_exchange_account_response_instance = AddExchangeAccountResponse.from_json(json)
+# print the JSON string representation of the object
+print(AddExchangeAccountResponse.to_json())
+
+# convert the object into a dict
+add_exchange_account_response_dict = add_exchange_account_response_instance.to_dict()
+# create an instance of AddExchangeAccountResponse from a dict
+add_exchange_account_response_from_dict = AddExchangeAccountResponse.from_dict(add_exchange_account_response_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/AmlRegistrationResultFullPayload.md

@@ -0,0 +1,31 @@
+# AmlRegistrationResultFullPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **str** |  | [optional] 
+**success** | **bool** |  | [optional] 
+**timestamp** | **float** |  | [optional] 
+
+## Example
+
+```python
+from fireblocks.models.aml_registration_result_full_payload import AmlRegistrationResultFullPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AmlRegistrationResultFullPayload from a JSON string
+aml_registration_result_full_payload_instance = AmlRegistrationResultFullPayload.from_json(json)
+# print the JSON string representation of the object
+print(AmlRegistrationResultFullPayload.to_json())
+
+# convert the object into a dict
+aml_registration_result_full_payload_dict = aml_registration_result_full_payload_instance.to_dict()
+# create an instance of AmlRegistrationResultFullPayload from a dict
+aml_registration_result_full_payload_from_dict = AmlRegistrationResultFullPayload.from_dict(aml_registration_result_full_payload_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/ComplianceApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**get_aml_post_screening_policy**](ComplianceApi.md#get_aml_post_screening_policy) | **GET** /screening/aml/post_screening_policy | AML - View Post-Screening Policy
 [**get_aml_screening_policy**](ComplianceApi.md#get_aml_screening_policy) | **GET** /screening/aml/screening_policy | AML - View Screening Policy
 [**get_post_screening_policy**](ComplianceApi.md#get_post_screening_policy) | **GET** /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy
+[**get_screening_full_details**](ComplianceApi.md#get_screening_full_details) | **GET** /screening/transaction/{txId} | Provides all the compliance details for the given screened transaction.
 [**get_screening_policy**](ComplianceApi.md#get_screening_policy) | **GET** /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy
 [**retry_rejected_transaction_bypass_screening_checks**](ComplianceApi.md#retry_rejected_transaction_bypass_screening_checks) | **POST** /screening/transaction/{txId}/bypass_screening_policy | Calling the \"Bypass Screening Policy\" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
 [**update_aml_screening_configuration**](ComplianceApi.md#update_aml_screening_configuration) | **PUT** /screening/aml/policy_configuration | Update AML Configuration
@@ -221,6 +222,80 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **get_screening_full_details**
+> ComplianceResultFullPayload get_screening_full_details(tx_id)
+
+Provides all the compliance details for the given screened transaction.
+
+Provides all the compliance details for the given screened transaction.
+
+### Example
+
+
+```python
+from fireblocks.models.compliance_result_full_payload import ComplianceResultFullPayload
+from fireblocks.client import Fireblocks
+from fireblocks.client_configuration import ClientConfiguration
+from fireblocks.exceptions import ApiException
+from fireblocks.base_path import BasePath
+from pprint import pprint
+
+# load the secret key content from a file
+with open('your_secret_key_file_path', 'r') as file:
+    secret_key_value = file.read()
+
+# build the configuration
+configuration = ClientConfiguration(
+        api_key="your_api_key",
+        secret_key=secret_key_value,
+        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
+)
+
+
+# Enter a context with an instance of the API client
+with Fireblocks(configuration) as fireblocks:
+    tx_id = '550e8400-e29b-41d4-a716-446655440000' # str | Fireblocks transaction ID of the screened transaction
+
+    try:
+        # Provides all the compliance details for the given screened transaction.
+        api_response = fireblocks.compliance.get_screening_full_details(tx_id).result()
+        print("The response of ComplianceApi->get_screening_full_details:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ComplianceApi->get_screening_full_details: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tx_id** | **str**| Fireblocks transaction ID of the screened transaction | 
+
+### Return type
+
+[**ComplianceResultFullPayload**](ComplianceResultFullPayload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | A compliance object |  * X-Request-ID -  <br>  |
+**0** | Error Response |  * X-Request-ID -  <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **get_screening_policy**
 > ScreeningProviderRulesConfigurationResponse get_screening_policy()
 

docs/ComplianceResultFullPayload.md

@@ -0,0 +1,34 @@
+# ComplianceResultFullPayload
+
+The result of the Compliance AML/Travel Rule screening.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aml** | [**List[ComplianceScreeningResultFullPayload]**](ComplianceScreeningResultFullPayload.md) | The end result of the AML screening. | [optional] 
+**tr** | [**List[ComplianceScreeningResultFullPayload]**](ComplianceScreeningResultFullPayload.md) | The result of the Travel Rule screening. | [optional] 
+**aml_list** | [**List[ComplianceScreeningResultFullPayload]**](ComplianceScreeningResultFullPayload.md) | The list of all results of the AML screening. | [optional] 
+**status** | **str** | Status of compliance result screening. | [optional] 
+**aml_registration** | [**List[AmlRegistrationResultFullPayload]**](AmlRegistrationResultFullPayload.md) | The results of the AML address registration. | [optional] 
+
+## Example
+
+```python
+from fireblocks.models.compliance_result_full_payload import ComplianceResultFullPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ComplianceResultFullPayload from a JSON string
+compliance_result_full_payload_instance = ComplianceResultFullPayload.from_json(json)
+# print the JSON string representation of the object
+print(ComplianceResultFullPayload.to_json())
+
+# convert the object into a dict
+compliance_result_full_payload_dict = compliance_result_full_payload_instance.to_dict()
+# create an instance of ComplianceResultFullPayload from a dict
+compliance_result_full_payload_from_dict = ComplianceResultFullPayload.from_dict(compliance_result_full_payload_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/ComplianceScreeningResultFullPayload.md

@@ -0,0 +1,33 @@
+# ComplianceScreeningResultFullPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **str** |  | [optional] 
+**payload** | **object** | The payload of the screening result. The payload is a JSON object that contains the screening result. The payload is different for each screening provider.  | [optional] 
+**bypass_reason** | **str** |  | [optional] 
+**screening_status** | **str** |  | [optional] 
+**timestamp** | **float** |  | [optional] 
+
+## Example
+
+```python
+from fireblocks.models.compliance_screening_result_full_payload import ComplianceScreeningResultFullPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ComplianceScreeningResultFullPayload from a JSON string
+compliance_screening_result_full_payload_instance = ComplianceScreeningResultFullPayload.from_json(json)
+# print the JSON string representation of the object
+print(ComplianceScreeningResultFullPayload.to_json())
+
+# convert the object into a dict
+compliance_screening_result_full_payload_dict = compliance_screening_result_full_payload_instance.to_dict()
+# create an instance of ComplianceScreeningResultFullPayload from a dict
+compliance_screening_result_full_payload_from_dict = ComplianceScreeningResultFullPayload.from_dict(compliance_screening_result_full_payload_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)
+
+