Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ docs/PaginatedAddressResponse.md
docs/PaginatedAddressResponsePaging.md
docs/PaginatedAssetWalletResponse.md
docs/PaginatedAssetWalletResponsePaging.md
docs/PaginatedAssetsResponse.md
docs/Paging.md
docs/PairApiKeyRequest.md
docs/PairApiKeyResponse.md
Expand Down Expand Up @@ -898,6 +899,7 @@ fireblocks/models/paginated_address_response.py
fireblocks/models/paginated_address_response_paging.py
fireblocks/models/paginated_asset_wallet_response.py
fireblocks/models/paginated_asset_wallet_response_paging.py
fireblocks/models/paginated_assets_response.py
fireblocks/models/paging.py
fireblocks/models/pair_api_key_request.py
fireblocks/models/pair_api_key_response.py
Expand Down Expand Up @@ -1478,6 +1480,7 @@ test/test_paginated_address_response.py
test/test_paginated_address_response_paging.py
test/test_paginated_asset_wallet_response.py
test/test_paginated_asset_wallet_response_paging.py
test/test_paginated_assets_response.py
test/test_paging.py
test/test_pair_api_key_request.py
test/test_pair_api_key_response.py
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,9 +318,10 @@ Class | Method | HTTP request | Description
*InternalWalletsApi* | [**create_internal_wallet**](docs/InternalWalletsApi.md#create_internal_wallet) | **POST** /internal_wallets | Create an internal wallet
*InternalWalletsApi* | [**create_internal_wallet_asset**](docs/InternalWalletsApi.md#create_internal_wallet_asset) | **POST** /internal_wallets/{walletId}/{assetId} | Add an asset to an internal wallet
*InternalWalletsApi* | [**delete_internal_wallet**](docs/InternalWalletsApi.md#delete_internal_wallet) | **DELETE** /internal_wallets/{walletId} | Delete an internal wallet
*InternalWalletsApi* | [**delete_internal_wallet_asset**](docs/InternalWalletsApi.md#delete_internal_wallet_asset) | **DELETE** /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address from an internal wallet
*InternalWalletsApi* | [**get_internal_wallet**](docs/InternalWalletsApi.md#get_internal_wallet) | **GET** /internal_wallets/{walletId} | Get assets for internal wallet
*InternalWalletsApi* | [**delete_internal_wallet_asset**](docs/InternalWalletsApi.md#delete_internal_wallet_asset) | **DELETE** /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address
*InternalWalletsApi* | [**get_internal_wallet**](docs/InternalWalletsApi.md#get_internal_wallet) | **GET** /internal_wallets/{walletId} | Get an asset from an internal wallet
*InternalWalletsApi* | [**get_internal_wallet_asset**](docs/InternalWalletsApi.md#get_internal_wallet_asset) | **GET** /internal_wallets/{walletId}/{assetId} | Get an asset from an internal wallet
*InternalWalletsApi* | [**get_internal_wallet_assets_paginated**](docs/InternalWalletsApi.md#get_internal_wallet_assets_paginated) | **GET** /internal_wallets/{walletId}/assets | List assets in an internal wallet (Paginated)
*InternalWalletsApi* | [**get_internal_wallets**](docs/InternalWalletsApi.md#get_internal_wallets) | **GET** /internal_wallets | List internal wallets
*InternalWalletsApi* | [**set_customer_ref_id_for_internal_wallet**](docs/InternalWalletsApi.md#set_customer_ref_id_for_internal_wallet) | **POST** /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for an internal wallet
*JobManagementApi* | [**cancel_job**](docs/JobManagementApi.md#cancel_job) | **POST** /batch/{jobId}/cancel | Cancel a running job
Expand Down Expand Up @@ -765,6 +766,7 @@ Class | Method | HTTP request | Description
- [PaginatedAddressResponsePaging](docs/PaginatedAddressResponsePaging.md)
- [PaginatedAssetWalletResponse](docs/PaginatedAssetWalletResponse.md)
- [PaginatedAssetWalletResponsePaging](docs/PaginatedAssetWalletResponsePaging.md)
- [PaginatedAssetsResponse](docs/PaginatedAssetsResponse.md)
- [Paging](docs/Paging.md)
- [PairApiKeyRequest](docs/PairApiKeyRequest.md)
- [PairApiKeyResponse](docs/PairApiKeyResponse.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/ContractUploadRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**long_description** | **str** | A full description of the contract template. May contain to break the lines | [optional]
**bytecode** | **str** | The compiled artifact of this smart contract. Used for deployment of this contract template |
**sourcecode** | **str** | The source code of the contract. Optional. | [optional]
**type** | **str** | The type of the contract template | [optional]
**type** | **str** | The type of the contract template |
**docs** | [**ContractDoc**](ContractDoc.md) | A `natspec` compliant documentation json. Can be retrieved from the output json after compilation | [optional]
**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]
Expand Down
175 changes: 167 additions & 8 deletions docs/InternalWalletsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Method | HTTP request | Description
[**create_internal_wallet**](InternalWalletsApi.md#create_internal_wallet) | **POST** /internal_wallets | Create an internal wallet
[**create_internal_wallet_asset**](InternalWalletsApi.md#create_internal_wallet_asset) | **POST** /internal_wallets/{walletId}/{assetId} | Add an asset to an internal wallet
[**delete_internal_wallet**](InternalWalletsApi.md#delete_internal_wallet) | **DELETE** /internal_wallets/{walletId} | Delete an internal wallet
[**delete_internal_wallet_asset**](InternalWalletsApi.md#delete_internal_wallet_asset) | **DELETE** /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address from an internal wallet
[**get_internal_wallet**](InternalWalletsApi.md#get_internal_wallet) | **GET** /internal_wallets/{walletId} | Get assets for internal wallet
[**delete_internal_wallet_asset**](InternalWalletsApi.md#delete_internal_wallet_asset) | **DELETE** /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address
[**get_internal_wallet**](InternalWalletsApi.md#get_internal_wallet) | **GET** /internal_wallets/{walletId} | Get an asset from an internal wallet
[**get_internal_wallet_asset**](InternalWalletsApi.md#get_internal_wallet_asset) | **GET** /internal_wallets/{walletId}/{assetId} | Get an asset from an internal wallet
[**get_internal_wallet_assets_paginated**](InternalWalletsApi.md#get_internal_wallet_assets_paginated) | **GET** /internal_wallets/{walletId}/assets | List assets in an internal wallet (Paginated)
[**get_internal_wallets**](InternalWalletsApi.md#get_internal_wallets) | **GET** /internal_wallets | List internal wallets
[**set_customer_ref_id_for_internal_wallet**](InternalWalletsApi.md#set_customer_ref_id_for_internal_wallet) | **POST** /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for an internal wallet

Expand All @@ -21,6 +22,10 @@ Create an internal wallet

Creates a new internal wallet with the requested name.

Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Example


Expand Down Expand Up @@ -98,6 +103,16 @@ Add an asset to an internal wallet

Adds an asset to an existing internal wallet.

Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Learn more about Whitelisted Internal Addresses
[here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Example


Expand Down Expand Up @@ -178,6 +193,12 @@ No authorization required
Delete an internal wallet

Deletes an internal wallet by ID.
Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Example

Expand Down Expand Up @@ -245,10 +266,19 @@ No authorization required
# **delete_internal_wallet_asset**
> delete_internal_wallet_asset(wallet_id, asset_id)

Delete a whitelisted address from an internal wallet
Delete a whitelisted address

Deletes a whitelisted address (for an asset) from an internal wallet.

Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Example


Expand Down Expand Up @@ -276,7 +306,7 @@ with Fireblocks(configuration) as fireblocks:
asset_id = 'asset_id_example' # str | The ID of the asset to delete

try:
# Delete a whitelisted address from an internal wallet
# Delete a whitelisted address
fireblocks.internal_wallets.delete_internal_wallet_asset(wallet_id, asset_id).result()
except Exception as e:
print("Exception when calling InternalWalletsApi->delete_internal_wallet_asset: %s\n" % e)
Expand Down Expand Up @@ -317,9 +347,18 @@ No authorization required
# **get_internal_wallet**
> UnmanagedWallet get_internal_wallet(wallet_id)

Get assets for internal wallet
Get an asset from an internal wallet

Returns information for an asset in an internal wallet.

This endpoint will be deprecated after 6 months. </br>As part of the depreciation process this endpoint will no longer return balances, only addresses. </br>Until it is deprecated, this endpoint will behave the same way.

Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Returns all assets in an internal wallet by ID.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

### Example

Expand Down Expand Up @@ -349,7 +388,7 @@ with Fireblocks(configuration) as fireblocks:
wallet_id = 'wallet_id_example' # str | The ID of the wallet to return

try:
# Get assets for internal wallet
# Get an asset from an internal wallet
api_response = fireblocks.internal_wallets.get_internal_wallet(wallet_id).result()
print("The response of InternalWalletsApi->get_internal_wallet:\n")
pprint(api_response)
Expand Down Expand Up @@ -395,6 +434,15 @@ Get an asset from an internal wallet

Returns information for an asset in an internal wallet.

Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

### Example


Expand Down Expand Up @@ -464,15 +512,117 @@ 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_internal_wallet_assets_paginated**
> PaginatedAssetsResponse get_internal_wallet_assets_paginated(wallet_id, page_size=page_size, page_cursor=page_cursor)

List assets in an internal wallet (Paginated)

Returns a paginated response of assets in an internal wallet.

This is a new paginated endpoint that gets all the assets from the wallet container with balances. </br>This endpoint returns a limited amount of results with a quick response time.

Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

### Example


```python
from fireblocks.models.paginated_assets_response import PaginatedAssetsResponse
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:
wallet_id = 'wallet_id_example' # str | The ID of the internal wallet to return assets for
page_size = 50 # float | (optional) (default to 50)
page_cursor = 'page_cursor_example' # str | (optional)

try:
# List assets in an internal wallet (Paginated)
api_response = fireblocks.internal_wallets.get_internal_wallet_assets_paginated(wallet_id, page_size=page_size, page_cursor=page_cursor).result()
print("The response of InternalWalletsApi->get_internal_wallet_assets_paginated:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling InternalWalletsApi->get_internal_wallet_assets_paginated: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**wallet_id** | **str**| The ID of the internal wallet to return assets for |
**page_size** | **float**| | [optional] [default to 50]
**page_cursor** | **str**| | [optional]

### Return type

[**PaginatedAssetsResponse**](PaginatedAssetsResponse.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 paginated response of assets for the internal wallet | * 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_internal_wallets**
> List[UnmanagedWallet] get_internal_wallets()

List internal wallets

Gets a list of internal wallets.

**Note**: BTC-based assets belonging to whitelisted addresses cannot be retrieved between 00:00 UTC and 00:01 UTC daily due to third-party provider, Blockchair, being unavailable for this 60 second period. Please wait until the next minute to retrieve BTC-based assets.
**Note**:
- BTC-based assets belonging to whitelisted addresses cannot be
retrieved between 00:00 UTC and 00:01 UTC daily due to third-party
provider, Blockchain, being unavailable for this 60 second period.
</br>Please wait until the next minute to retrieve BTC-based assets.
- The list of assets returned will NOT include the balances anymore.

Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

### Example

Expand Down Expand Up @@ -544,6 +694,15 @@ Set an AML/KYT customer reference ID for an internal wallet

Sets an AML/KYT customer reference ID for the specific internal wallet.

Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.

- You can see the balance of the Internal Wallet via Fireblocks
- You cannot initiate transactions from Internal Wallets through Fireblocks

Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Example


Expand Down
31 changes: 31 additions & 0 deletions docs/PaginatedAssetsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# PaginatedAssetsResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total** | **float** | Total number of assets in the internal wallet | [optional]
**data** | [**UnmanagedWallet**](UnmanagedWallet.md) | |
**next** | **str** | Cursor for the next page of results | [optional]

## Example

```python
from fireblocks.models.paginated_assets_response import PaginatedAssetsResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedAssetsResponse from a JSON string
paginated_assets_response_instance = PaginatedAssetsResponse.from_json(json)
# print the JSON string representation of the object
print(PaginatedAssetsResponse.to_json())

# convert the object into a dict
paginated_assets_response_dict = paginated_assets_response_instance.to_dict()
# create an instance of PaginatedAssetsResponse from a dict
paginated_assets_response_from_dict = PaginatedAssetsResponse.from_dict(paginated_assets_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)


Loading