Skip to content

Commit

Permalink
Generated SDK #1430
Browse files Browse the repository at this point in the history
  • Loading branch information
fireblocks_dx_team committed Dec 5, 2024
1 parent 893ec17 commit 2dafb56
Show file tree
Hide file tree
Showing 66 changed files with 915 additions and 282 deletions.
15 changes: 9 additions & 6 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,6 @@ docs/ReadCallFunctionDto.md
docs/RedeemFundsToLinkedDDAResponse.md
docs/RegisterNewAssetRequest.md
docs/RelatedRequestDto.md
docs/RelatedRequestStatusType.md
docs/RelatedTransactionDto.md
docs/RemoveCollateralRequestBody.md
docs/RenameCosigner.md
Expand All @@ -332,10 +331,11 @@ docs/ScreeningOperationFailure.md
docs/ScreeningOperationType.md
docs/ScreeningPolicyResponse.md
docs/ScreeningProviderRulesConfigurationResponse.md
docs/ScreeningUpdateConfigurationsRequest.md
docs/ScreeningUpdateConfigurations.md
docs/ScreeningValidationFailure.md
docs/ScreeningVerdict.md
docs/ScreeningVerdictMatchedRule.md
docs/SearchNetworkIdsResponse.md
docs/SessionDTO.md
docs/SessionMetadata.md
docs/SetAdminQuorumThresholdRequest.md
Expand Down Expand Up @@ -367,6 +367,7 @@ docs/SmartTransferCoinStatistic.md
docs/SmartTransferCreateTicket.md
docs/SmartTransferCreateTicketTerm.md
docs/SmartTransferForbiddenResponse.md
docs/SmartTransferFundDvpTicket.md
docs/SmartTransferFundTerm.md
docs/SmartTransferManuallyFundTerm.md
docs/SmartTransferNotFoundResponse.md
Expand Down Expand Up @@ -837,7 +838,6 @@ fireblocks/models/read_call_function_dto.py
fireblocks/models/redeem_funds_to_linked_dda_response.py
fireblocks/models/register_new_asset_request.py
fireblocks/models/related_request_dto.py
fireblocks/models/related_request_status_type.py
fireblocks/models/related_transaction_dto.py
fireblocks/models/remove_collateral_request_body.py
fireblocks/models/rename_cosigner.py
Expand All @@ -856,10 +856,11 @@ fireblocks/models/screening_operation_failure.py
fireblocks/models/screening_operation_type.py
fireblocks/models/screening_policy_response.py
fireblocks/models/screening_provider_rules_configuration_response.py
fireblocks/models/screening_update_configurations_request.py
fireblocks/models/screening_update_configurations.py
fireblocks/models/screening_validation_failure.py
fireblocks/models/screening_verdict.py
fireblocks/models/screening_verdict_matched_rule.py
fireblocks/models/search_network_ids_response.py
fireblocks/models/session_dto.py
fireblocks/models/session_metadata.py
fireblocks/models/set_admin_quorum_threshold_request.py
Expand Down Expand Up @@ -890,6 +891,7 @@ fireblocks/models/smart_transfer_coin_statistic.py
fireblocks/models/smart_transfer_create_ticket.py
fireblocks/models/smart_transfer_create_ticket_term.py
fireblocks/models/smart_transfer_forbidden_response.py
fireblocks/models/smart_transfer_fund_dvp_ticket.py
fireblocks/models/smart_transfer_fund_term.py
fireblocks/models/smart_transfer_manually_fund_term.py
fireblocks/models/smart_transfer_not_found_response.py
Expand Down Expand Up @@ -1347,7 +1349,6 @@ test/test_read_call_function_dto.py
test/test_redeem_funds_to_linked_dda_response.py
test/test_register_new_asset_request.py
test/test_related_request_dto.py
test/test_related_request_status_type.py
test/test_related_transaction_dto.py
test/test_remove_collateral_request_body.py
test/test_rename_cosigner.py
Expand All @@ -1367,10 +1368,11 @@ test/test_screening_operation_failure.py
test/test_screening_operation_type.py
test/test_screening_policy_response.py
test/test_screening_provider_rules_configuration_response.py
test/test_screening_update_configurations_request.py
test/test_screening_update_configurations.py
test/test_screening_validation_failure.py
test/test_screening_verdict.py
test/test_screening_verdict_matched_rule.py
test/test_search_network_ids_response.py
test/test_session_dto.py
test/test_session_metadata.py
test/test_set_admin_quorum_threshold_request.py
Expand Down Expand Up @@ -1402,6 +1404,7 @@ test/test_smart_transfer_coin_statistic.py
test/test_smart_transfer_create_ticket.py
test/test_smart_transfer_create_ticket_term.py
test/test_smart_transfer_forbidden_response.py
test/test_smart_transfer_fund_dvp_ticket.py
test/test_smart_transfer_fund_term.py
test/test_smart_transfer_manually_fund_term.py
test/test_smart_transfer_not_found_response.py
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ Class | Method | HTTP request | Description
*NetworkConnectionsApi* | [**get_network_id**](docs/NetworkConnectionsApi.md#get_network_id) | **GET** /network_ids/{networkId} | Returns specific network ID.
*NetworkConnectionsApi* | [**get_network_ids**](docs/NetworkConnectionsApi.md#get_network_ids) | **GET** /network_ids | Returns all network IDs, both local IDs and discoverable remote IDs
*NetworkConnectionsApi* | [**get_routing_policy_asset_groups**](docs/NetworkConnectionsApi.md#get_routing_policy_asset_groups) | **GET** /network_ids/routing_policy_asset_groups | Returns all enabled routing policy asset groups
*NetworkConnectionsApi* | [**search_network_ids**](docs/NetworkConnectionsApi.md#search_network_ids) | **GET** /network_ids/search | Search network IDs, both local IDs and discoverable remote IDs
*NetworkConnectionsApi* | [**set_network_id_discoverability**](docs/NetworkConnectionsApi.md#set_network_id_discoverability) | **PATCH** /network_ids/{networkId}/set_discoverability | Update network ID's discoverability.
*NetworkConnectionsApi* | [**set_network_id_name**](docs/NetworkConnectionsApi.md#set_network_id_name) | **PATCH** /network_ids/{networkId}/set_name | Update network ID's name.
*NetworkConnectionsApi* | [**set_network_id_routing_policy**](docs/NetworkConnectionsApi.md#set_network_id_routing_policy) | **PATCH** /network_ids/{networkId}/set_routing_policy | Update network id routing policy.
Expand Down Expand Up @@ -751,7 +752,6 @@ Class | Method | HTTP request | Description
- [RedeemFundsToLinkedDDAResponse](docs/RedeemFundsToLinkedDDAResponse.md)
- [RegisterNewAssetRequest](docs/RegisterNewAssetRequest.md)
- [RelatedRequestDto](docs/RelatedRequestDto.md)
- [RelatedRequestStatusType](docs/RelatedRequestStatusType.md)
- [RelatedTransactionDto](docs/RelatedTransactionDto.md)
- [RemoveCollateralRequestBody](docs/RemoveCollateralRequestBody.md)
- [RenameCosigner](docs/RenameCosigner.md)
Expand All @@ -770,10 +770,11 @@ Class | Method | HTTP request | Description
- [ScreeningOperationType](docs/ScreeningOperationType.md)
- [ScreeningPolicyResponse](docs/ScreeningPolicyResponse.md)
- [ScreeningProviderRulesConfigurationResponse](docs/ScreeningProviderRulesConfigurationResponse.md)
- [ScreeningUpdateConfigurationsRequest](docs/ScreeningUpdateConfigurationsRequest.md)
- [ScreeningUpdateConfigurations](docs/ScreeningUpdateConfigurations.md)
- [ScreeningValidationFailure](docs/ScreeningValidationFailure.md)
- [ScreeningVerdict](docs/ScreeningVerdict.md)
- [ScreeningVerdictMatchedRule](docs/ScreeningVerdictMatchedRule.md)
- [SearchNetworkIdsResponse](docs/SearchNetworkIdsResponse.md)
- [SessionDTO](docs/SessionDTO.md)
- [SessionMetadata](docs/SessionMetadata.md)
- [SetAdminQuorumThresholdRequest](docs/SetAdminQuorumThresholdRequest.md)
Expand Down Expand Up @@ -804,6 +805,7 @@ Class | Method | HTTP request | Description
- [SmartTransferCreateTicket](docs/SmartTransferCreateTicket.md)
- [SmartTransferCreateTicketTerm](docs/SmartTransferCreateTicketTerm.md)
- [SmartTransferForbiddenResponse](docs/SmartTransferForbiddenResponse.md)
- [SmartTransferFundDvpTicket](docs/SmartTransferFundDvpTicket.md)
- [SmartTransferFundTerm](docs/SmartTransferFundTerm.md)
- [SmartTransferManuallyFundTerm](docs/SmartTransferManuallyFundTerm.md)
- [SmartTransferNotFoundResponse](docs/SmartTransferNotFoundResponse.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/AbiFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**name** | **str** | The name of the contract function as it appears in the ABI | [optional]
**state_mutability** | **str** | The state mutability of the contract function as it appears in the ABI | [optional]
**type** | **str** | The type of the function |
**inputs** | [**List[Parameter]**](Parameter.md) | The parameters that this function/constructor posses |
**inputs** | [**List[Parameter]**](Parameter.md) | The parameters that this function/constructor posses | [optional]
**outputs** | [**List[Parameter]**](Parameter.md) | The parameters that this 'read' function returns | [optional]
**description** | **str** | The documentation of this function (if has any) | [optional]

Expand Down
12 changes: 7 additions & 5 deletions docs/ComplianceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ 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)

# **update_screening_configuration**
> ScreeningUpdateConfigurationsRequest update_screening_configuration(idempotency_key=idempotency_key)
> ScreeningUpdateConfigurations update_screening_configuration(screening_update_configurations, idempotency_key=idempotency_key)
Tenant - Screening Configuration

Expand All @@ -373,7 +373,7 @@ Update tenant screening configuration.


```python
from fireblocks.models.screening_update_configurations_request import ScreeningUpdateConfigurationsRequest
from fireblocks.models.screening_update_configurations import ScreeningUpdateConfigurations
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
Expand All @@ -394,11 +394,12 @@ configuration = ClientConfiguration(

# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
screening_update_configurations = fireblocks.ScreeningUpdateConfigurations() # ScreeningUpdateConfigurations |
idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

try:
# Tenant - Screening Configuration
api_response = fireblocks.compliance.update_screening_configuration(idempotency_key=idempotency_key).result()
api_response = fireblocks.compliance.update_screening_configuration(screening_update_configurations, idempotency_key=idempotency_key).result()
print("The response of ComplianceApi->update_screening_configuration:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -412,19 +413,20 @@ with Fireblocks(configuration) as fireblocks:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**screening_update_configurations** | [**ScreeningUpdateConfigurations**](ScreeningUpdateConfigurations.md)| |
**idempotency_key** | **str**| A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. | [optional]

### Return type

[**ScreeningUpdateConfigurationsRequest**](ScreeningUpdateConfigurationsRequest.md)
[**ScreeningUpdateConfigurations**](ScreeningUpdateConfigurations.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details
Expand Down
3 changes: 3 additions & 0 deletions docs/ContractDeployRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Name | Type | Description | Notes
**asset_id** | **str** | The base asset identifier of the blockchain you want to deploy to |
**vault_account_id** | **str** | The vault account id you wish to deploy from |
**constructor_parameters** | [**List[ParameterWithValue]**](ParameterWithValue.md) | The constructor parameters of this contract | [optional]
**use_gasless** | **bool** | Indicates whether the token should be created in a gasless manner, utilizing the ERC-2771 standard. When set to true, the transaction will be relayed by a designated relayer. The workspace must be configured to use Fireblocks gasless relay. | [optional]
**fee** | **str** | Max fee amount for the write function transaction. interchangeable with the 'feeLevel' field | [optional]
**fee_level** | **str** | Fee level for the write function transaction. interchangeable with the 'fee' field | [optional]

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ContractDoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**events** | **str** | A description of the contract`s events | [optional]
**kind** | **str** | Is it devdoc or userdoc |
**methods** | [**Dict[str, FunctionDoc]**](FunctionDoc.md) | The description of the contract functions |
**version** | **str** | The version of the contract |
**version** | **float** | The version of the contract |

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/ContractTemplateDto.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**name** | **str** | The name of the contract template |
**description** | **str** | A short description of the contract template |
**long_description** | **str** | A full description of the contract template. May contain to break the lines | [optional]
**abi** | **List[List[AbiFunction]]** | |
**abi** | [**List[AbiFunction]**](AbiFunction.md) | The abi of the contract template. Necessary for displaying and for after deployment encoding |
**attributes** | [**ContractAttributes**](ContractAttributes.md) | The attributes related to this contract template. It will be displayed in the tokenization page | [optional]
**docs** | [**ContractDoc**](ContractDoc.md) | A `natspec` compliant documentation json. Can be retrieved from the output json after compilation | [optional]
**owner** | **str** | The workspace id of the owner of this contract template. If it's a private contract, only this workspace will be allowed to deploy it | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/ContractUploadRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
**sourcecode** | **str** | The source code of the contract. Optional. | [optional]
**type** | **str** | The type of the contract template | [optional]
**docs** | [**ContractDoc**](ContractDoc.md) | A `natspec` compliant documentation json. Can be retrieved from the output json after compilation | [optional]
**abi** | **List[List[AbiFunction]]** | |
**abi** | [**List[AbiFunction]**](AbiFunction.md) | The abi of the contract template. Necessary for displaying and for after deployment encoding |
**attributes** | [**ContractAttributes**](ContractAttributes.md) | The attributes related to this contract template. It will be displayed in the tokenization page | [optional]

## Example
Expand Down
3 changes: 3 additions & 0 deletions docs/CreateTokenRequestDto.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Name | Type | Description | Notes
**vault_account_id** | **str** | The id of the vault account that initiated the request to issue the token |
**create_params** | [**CreateTokenRequestDtoCreateParams**](CreateTokenRequestDtoCreateParams.md) | |
**display_name** | **str** | | [optional]
**use_gasless** | **bool** | Indicates whether the token should be created in a gasless manner, utilizing the ERC-2771 standard. When set to true, the transaction will be relayed by a designated relayer. The workspace must be configured to use Fireblocks gasless relay. | [optional]
**fee** | **str** | Max fee amount for the write function transaction. interchangeable with the 'feeLevel' field | [optional]
**fee_level** | **str** | Fee level for the write function transaction. interchangeable with the 'fee' field | [optional]

## Example

Expand Down
8 changes: 4 additions & 4 deletions docs/DeployedContractsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ 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_deployed_contracts**
> DeployedContractsPaginatedResponse get_deployed_contracts(page_cursor=page_cursor, page_size=page_size, contract_address=contract_address, base_asset_id=base_asset_id, template_id=template_id)
> DeployedContractsPaginatedResponse get_deployed_contracts(page_cursor=page_cursor, page_size=page_size, contract_address=contract_address, base_asset_id=base_asset_id, contract_template_id=contract_template_id)
List deployed contracts data

Expand Down Expand Up @@ -353,11 +353,11 @@ with Fireblocks(configuration) as fireblocks:
page_size = 10 # float | Number of items per page, requesting more then max will return max items (optional)
contract_address = '0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66' # str | The contract's onchain address (optional)
base_asset_id = 'base_asset_id_example' # str | (optional)
template_id = 'template_id_example' # str | (optional)
contract_template_id = 'contract_template_id_example' # str | (optional)

try:
# List deployed contracts data
api_response = fireblocks.deployed_contracts.get_deployed_contracts(page_cursor=page_cursor, page_size=page_size, contract_address=contract_address, base_asset_id=base_asset_id, template_id=template_id).result()
api_response = fireblocks.deployed_contracts.get_deployed_contracts(page_cursor=page_cursor, page_size=page_size, contract_address=contract_address, base_asset_id=base_asset_id, contract_template_id=contract_template_id).result()
print("The response of DeployedContractsApi->get_deployed_contracts:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -375,7 +375,7 @@ Name | Type | Description | Notes
**page_size** | **float**| Number of items per page, requesting more then max will return max items | [optional]
**contract_address** | **str**| The contract's onchain address | [optional]
**base_asset_id** | **str**| | [optional]
**template_id** | **str**| | [optional]
**contract_template_id** | **str**| | [optional]

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/ExecuteActionRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**fee** | **str** | Represents the fee for a transaction, which can be specified as a percentage value. Only one of fee/feeLevel is required. | [optional]
**fee_level** | **str** | Represents the fee level for a transaction, which can be set as slow, medium, or fast. Only one of fee/feeLevel is required. | [optional]
**id** | **str** | id of position to withdraw |
**amount** | **str** | The number of tokens to unstake. This optional field is applicable only for liquid staking and allows for a partial unstake of the position. If not provided, the entire position will be unstaked by default. | [optional]

## Example

Expand Down
Loading

0 comments on commit 2dafb56

Please sign in to comment.