diff --git a/setup.py b/setup.py index d6c33cf..98aa560 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ setup( name="zarban", - version="0.5.2", + version="0.5.3", author="Zarban", author_email="info@zarban.io", description="Python SDK for Zarban", diff --git a/src/zarban/service/docs/Account.md b/src/zarban/service/docs/Account.md deleted file mode 100644 index 4760c64..0000000 --- a/src/zarban/service/docs/Account.md +++ /dev/null @@ -1,18 +0,0 @@ -# Account - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**points** | **int** | The number of points the account has. | -**address** | **str** | Ethereum address of the account | -**wallet_balance** | [**WalletBalance**](WalletBalance.md) | | -**net_worth** | **dict(str, str)** | | -**total_debt** | **dict(str, str)** | | -**total_deposits** | **dict(str, str)** | | -**lendingpool_summary** | [**AccountLendingpoolSummary**](AccountLendingpoolSummary.md) | | -**stabelcoin_system_summary** | [**AccountStablecoinSystemSummary**](AccountStablecoinSystemSummary.md) | | -**staking_summary** | [**AccountStakingSummary**](AccountStakingSummary.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/AccountLendingpoolSummary.md b/src/zarban/service/docs/AccountLendingpoolSummary.md deleted file mode 100644 index e851a98..0000000 --- a/src/zarban/service/docs/AccountLendingpoolSummary.md +++ /dev/null @@ -1,20 +0,0 @@ -# AccountLendingpoolSummary - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_debt** | **dict(str, str)** | | -**total_deposits** | **dict(str, str)** | | -**total_collateral** | **dict(str, str)** | | -**health_factor** | **str** | Health factor in lending pool | -**net_apy** | **str** | Net annual percentage yield in lending pool | -**total_supply_apy** | **str** | Total supply rate in lending pool for account | -**total_borrow_apy** | **str** | Total borrow rate in lending pool for account | -**available_to_borrow** | **dict(str, str)** | | -**borrow_power_used** | **str** | Borrow power used in lending pool | -**current_liquidation_threshold** | **str** | Current liquidation threshold in lending pool | -**loan_to_value** | **str** | Loan to value in lending pool | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/AccountStablecoinSystemSummary.md b/src/zarban/service/docs/AccountStablecoinSystemSummary.md deleted file mode 100644 index 07f1847..0000000 --- a/src/zarban/service/docs/AccountStablecoinSystemSummary.md +++ /dev/null @@ -1,12 +0,0 @@ -# AccountStablecoinSystemSummary - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_debt** | **dict(str, str)** | | -**total_deposits** | **dict(str, str)** | | -**net_apy** | **str** | Net annual percentage yield in stablecoin system | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/AccountStakingSummary.md b/src/zarban/service/docs/AccountStakingSummary.md deleted file mode 100644 index 15945cf..0000000 --- a/src/zarban/service/docs/AccountStakingSummary.md +++ /dev/null @@ -1,12 +0,0 @@ -# AccountStakingSummary - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_stake** | **dict(str, str)** | | -**unclaimed_reward** | **dict(str, str)** | | -**net_apy** | **str** | Net annual percentage yield in staking contract | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/AccountsApi.md b/src/zarban/service/docs/AccountsApi.md deleted file mode 100644 index 131c67c..0000000 --- a/src/zarban/service/docs/AccountsApi.md +++ /dev/null @@ -1,74 +0,0 @@ -# zarban.service.openapi_client.AccountsApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_account_by_address**](AccountsApi.md#get_account_by_address) | **GET** /v2/accounts/{address} | Get account by address - - -# **get_account_by_address** -> Account get_account_by_address(address) - -Get account by address - -Get account by address - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.AccountsApi(api_client) - address = '0x1234567890123456789012345678901234567890' # str | Ethereum address of the account - - try: - # Get account by address - api_response = api_instance.get_account_by_address(address) - pprint(api_response) - except ApiException as e: - print("Exception when calling AccountsApi->get_account_by_address: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **address** | **str**| Ethereum address of the account | - -### Return type - -[**Account**](Account.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Account details | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/Address.md b/src/zarban/service/docs/Address.md deleted file mode 100644 index 12510a6..0000000 --- a/src/zarban/service/docs/Address.md +++ /dev/null @@ -1,11 +0,0 @@ -# Address - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**label** | **str** | The label of the address. | -**address** | **str** | The Ethereum address. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/AddressResponse.md b/src/zarban/service/docs/AddressResponse.md deleted file mode 100644 index 89640a8..0000000 --- a/src/zarban/service/docs/AddressResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# AddressResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[Address]**](Address.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/AddressesApi.md b/src/zarban/service/docs/AddressesApi.md deleted file mode 100644 index 38e5c48..0000000 --- a/src/zarban/service/docs/AddressesApi.md +++ /dev/null @@ -1,71 +0,0 @@ -# zarban.service.openapi_client.AddressesApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_all_addresses**](AddressesApi.md#get_all_addresses) | **GET** /v2/addresses | Get all addresses - - -# **get_all_addresses** -> AddressResponse get_all_addresses(format=format) - -Get all addresses - -All addresses knows to Zarban. - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.AddressesApi(api_client) - format = 'format_example' # str | The type of addresses to return (optional) - - try: - # Get all addresses - api_response = api_instance.get_all_addresses(format=format) - pprint(api_response) - except ApiException as e: - print("Exception when calling AddressesApi->get_all_addresses: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **format** | **str**| The type of addresses to return | [optional] - -### Return type - -[**AddressResponse**](AddressResponse.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 JSON object with addresses | - | - -[[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) - diff --git a/src/zarban/service/docs/Balance.md b/src/zarban/service/docs/Balance.md deleted file mode 100644 index 4044ca4..0000000 --- a/src/zarban/service/docs/Balance.md +++ /dev/null @@ -1,11 +0,0 @@ -# Balance - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token** | [**Token**](Token.md) | | -**balance** | **dict(str, str)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/BasicEvent.md b/src/zarban/service/docs/BasicEvent.md deleted file mode 100644 index 95169a5..0000000 --- a/src/zarban/service/docs/BasicEvent.md +++ /dev/null @@ -1,14 +0,0 @@ -# BasicEvent - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | Identifier for the event. | -**name** | [**EventName**](EventName.md) | | -**type** | [**EventType**](EventType.md) | | -**domain** | [**EventDomain**](EventDomain.md) | | -**raw** | [**Log**](Log.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/BorrowsApi.md b/src/zarban/service/docs/BorrowsApi.md deleted file mode 100644 index 58b94f1..0000000 --- a/src/zarban/service/docs/BorrowsApi.md +++ /dev/null @@ -1,79 +0,0 @@ -# zarban.service.openapi_client.BorrowsApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_user_borrows**](BorrowsApi.md#get_user_borrows) | **GET** /v2/lendingpool/borrows | Get user borrows of lendingpool - - -# **get_user_borrows** -> UserBorrowsResponse get_user_borrows(user=user, reserve=reserve, cursor=cursor, limit=limit) - -Get user borrows of lendingpool - -Get user borrows of lendingpool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.BorrowsApi(api_client) - user = 'user_example' # str | Ethereum address of the user (optional) -reserve = 'reserve_example' # str | Ethereum address of the reserve (optional) -cursor = 56 # int | Cursor for pagination (optional) -limit = 50 # int | Limit the number of deposits returned (default is 50) (optional) (default to 50) - - try: - # Get user borrows of lendingpool - api_response = api_instance.get_user_borrows(user=user, reserve=reserve, cursor=cursor, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling BorrowsApi->get_user_borrows: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | **str**| Ethereum address of the user | [optional] - **reserve** | **str**| Ethereum address of the reserve | [optional] - **cursor** | **int**| Cursor for pagination | [optional] - **limit** | **int**| Limit the number of deposits returned (default is 50) | [optional] [default to 50] - -### Return type - -[**UserBorrowsResponse**](UserBorrowsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of user borrows | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/ChainActivity.md b/src/zarban/service/docs/ChainActivity.md deleted file mode 100644 index d42add3..0000000 --- a/src/zarban/service/docs/ChainActivity.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChainActivity - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**step_number** | **int** | | -**number_of_steps** | **int** | | -**steps** | [**list[ChainActivityStep]**](ChainActivityStep.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/ChainActivityStep.md b/src/zarban/service/docs/ChainActivityStep.md deleted file mode 100644 index b25eeff..0000000 --- a/src/zarban/service/docs/ChainActivityStep.md +++ /dev/null @@ -1,11 +0,0 @@ -# ChainActivityStep - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**data** | [**ChainActivityStepData**](ChainActivityStepData.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/ChainActivityStepData.md b/src/zarban/service/docs/ChainActivityStepData.md deleted file mode 100644 index 57e5326..0000000 --- a/src/zarban/service/docs/ChainActivityStepData.md +++ /dev/null @@ -1,18 +0,0 @@ -# ChainActivityStepData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**label** | **dict(str, str)** | | -**gas_use_estimate** | **int** | | -**gas_fee_estimate** | **dict(str, str)** | | -**method_parameters** | [**MethodParameters**](MethodParameters.md) | | -**name** | **str** | The name of the EIP712 signature | -**typed_data** | [**TypedData**](TypedData.md) | | -**hash** | **str** | The hash of the EIP712 signature that needs to be signed | -**message** | **str** | The message that needs to be signed | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/CollectorApi.md b/src/zarban/service/docs/CollectorApi.md deleted file mode 100644 index ec86247..0000000 --- a/src/zarban/service/docs/CollectorApi.md +++ /dev/null @@ -1,67 +0,0 @@ -# zarban.service.openapi_client.CollectorApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_collector_data**](CollectorApi.md#get_collector_data) | **GET** /v2/stats | Get collector data - - -# **get_collector_data** -> Stats get_collector_data() - -Get collector data - -Get collector data - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.CollectorApi(api_client) - - try: - # Get collector data - api_response = api_instance.get_collector_data() - pprint(api_response) - except ApiException as e: - print("Exception when calling CollectorApi->get_collector_data: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**Stats**](Stats.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 JSON object with collector data | - | - -[[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) - diff --git a/src/zarban/service/docs/DepositsApi.md b/src/zarban/service/docs/DepositsApi.md deleted file mode 100644 index e15b33b..0000000 --- a/src/zarban/service/docs/DepositsApi.md +++ /dev/null @@ -1,79 +0,0 @@ -# zarban.service.openapi_client.DepositsApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_user_deposits**](DepositsApi.md#get_user_deposits) | **GET** /v2/lendingpool/deposits | Get user deposits of Lendingpool - - -# **get_user_deposits** -> UserDepositsResponse get_user_deposits(user=user, reserve=reserve, cursor=cursor, limit=limit) - -Get user deposits of Lendingpool - -Get user deposits of Lendingpool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.DepositsApi(api_client) - user = 'user_example' # str | Ethereum address of the user (optional) -reserve = 'reserve_example' # str | Ethereum address of the reserve (optional) -cursor = 56 # int | Cursor for pagination (optional) -limit = 50 # int | Limit the number of deposits returned (default is 50) (optional) (default to 50) - - try: - # Get user deposits of Lendingpool - api_response = api_instance.get_user_deposits(user=user, reserve=reserve, cursor=cursor, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling DepositsApi->get_user_deposits: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | **str**| Ethereum address of the user | [optional] - **reserve** | **str**| Ethereum address of the reserve | [optional] - **cursor** | **int**| Cursor for pagination | [optional] - **limit** | **int**| Limit the number of deposits returned (default is 50) | [optional] [default to 50] - -### Return type - -[**UserDepositsResponse**](UserDepositsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of user deposits | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/DutchAmount.md b/src/zarban/service/docs/DutchAmount.md deleted file mode 100644 index a427989..0000000 --- a/src/zarban/service/docs/DutchAmount.md +++ /dev/null @@ -1,13 +0,0 @@ -# DutchAmount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token** | [**Token**](Token.md) | | -**start_amount** | **dict(str, str)** | | -**end_amount** | **dict(str, str)** | | -**recipient** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/EIP712SignRequest.md b/src/zarban/service/docs/EIP712SignRequest.md deleted file mode 100644 index fe97227..0000000 --- a/src/zarban/service/docs/EIP712SignRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# EIP712SignRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the EIP712 signature | -**typed_data** | [**TypedData**](TypedData.md) | | -**hash** | **str** | The hash of the EIP712 signature that needs to be signed | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Error.md b/src/zarban/service/docs/Error.md deleted file mode 100644 index 01ae5b6..0000000 --- a/src/zarban/service/docs/Error.md +++ /dev/null @@ -1,11 +0,0 @@ -# Error - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**msg** | **str** | Error message | -**reasons** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/ErrorMessage.md b/src/zarban/service/docs/ErrorMessage.md deleted file mode 100644 index d6c5952..0000000 --- a/src/zarban/service/docs/ErrorMessage.md +++ /dev/null @@ -1,11 +0,0 @@ -# ErrorMessage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user_message** | **str** | User-friendly error message | -**solutions** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/EventDetailsResponse.md b/src/zarban/service/docs/EventDetailsResponse.md deleted file mode 100644 index 00abcba..0000000 --- a/src/zarban/service/docs/EventDetailsResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# EventDetailsResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[Log]**](Log.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/EventDomain.md b/src/zarban/service/docs/EventDomain.md deleted file mode 100644 index 8a1f68c..0000000 --- a/src/zarban/service/docs/EventDomain.md +++ /dev/null @@ -1,10 +0,0 @@ -# EventDomain - -The domain of the event. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/EventName.md b/src/zarban/service/docs/EventName.md deleted file mode 100644 index 2abfa3f..0000000 --- a/src/zarban/service/docs/EventName.md +++ /dev/null @@ -1,9 +0,0 @@ -# EventName - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/EventType.md b/src/zarban/service/docs/EventType.md deleted file mode 100644 index 00f76bb..0000000 --- a/src/zarban/service/docs/EventType.md +++ /dev/null @@ -1,10 +0,0 @@ -# EventType - -The type of the event. who has triggered the event. -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/ExtendedEvent.md b/src/zarban/service/docs/ExtendedEvent.md deleted file mode 100644 index b78420d..0000000 --- a/src/zarban/service/docs/ExtendedEvent.md +++ /dev/null @@ -1,15 +0,0 @@ -# ExtendedEvent - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**domain** | [**EventDomain**](EventDomain.md) | | -**id** | **int** | Identifier for the event. | -**name** | [**EventName**](EventName.md) | | -**raw** | [**Log**](Log.md) | | -**type** | [**EventType**](EventType.md) | | -**payload** | **dict(str, object)** | The payload of the event. The payload is a JSON-marshalled | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/FormattedReserveData.md b/src/zarban/service/docs/FormattedReserveData.md deleted file mode 100644 index b64d63d..0000000 --- a/src/zarban/service/docs/FormattedReserveData.md +++ /dev/null @@ -1,30 +0,0 @@ -# FormattedReserveData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Identifier for the reserve data. | -**underlying_asset** | [**Token**](Token.md) | | -**z_token_address** | **str** | Address of the associated zToken contract in hexadecimal format. | -**variable_debt_token_address** | **str** | Address of the associated variable debt token contract in hexadecimal format. | -**borrowing_enabled** | **bool** | | -**is_active** | **bool** | | -**is_frozen** | **bool** | | -**usage_as_collateral_enabled** | **bool** | | -**reserve_factor** | **str** | | -**base_lt_vas_collateral** | **str** | | -**reserve_liquidation_threshold** | **str** | | -**reserve_liquidation_bonus** | **str** | | -**utilization_rate** | **str** | | -**total_debt** | **dict(str, str)** | | -**total_liquidity** | **dict(str, str)** | | -**available_liquidity** | **dict(str, str)** | | -**supply_apy** | **str** | | -**supply_apr** | **str** | | -**variable_borrow_apy** | **str** | | -**variable_borrow_apr** | **str** | | -**price** | **dict(str, str)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Ilk.md b/src/zarban/service/docs/Ilk.md deleted file mode 100644 index 41ece6d..0000000 --- a/src/zarban/service/docs/Ilk.md +++ /dev/null @@ -1,28 +0,0 @@ -# Ilk - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Name of the ILK | -**symbol** | [**Symbol**](Symbol.md) | | -**minimum_collateralization_ratio** | **str** | Minimum Collateralization Ratio | -**maximum_loan_to_value** | **str** | Maximum Loan To Value | -**liquidation_penalty** | **str** | Liquidation Penalty | -**debt_ceiling** | **dict(str, str)** | | -**debt** | **dict(str, str)** | | -**annual_stability_fee** | **str** | Annual Stability Fee | -**dust_limit** | **dict(str, str)** | | -**price** | **dict(str, str)** | | -**next_price** | **dict(str, str)** | | -**join** | **str** | Join Address | -**median** | **str** | Median Address | -**gem** | **str** | Gem Address | -**clipper** | **str** | Clipper Address | -**pip** | **str** | Pip Address | -**hole** | **dict(str, str)** | | -**dirt** | **dict(str, str)** | | -**available_to_borrow** | **dict(str, str)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/IlksApi.md b/src/zarban/service/docs/IlksApi.md deleted file mode 100644 index 7673f10..0000000 --- a/src/zarban/service/docs/IlksApi.md +++ /dev/null @@ -1,132 +0,0 @@ -# zarban.service.openapi_client.IlksApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_all_ilks**](IlksApi.md#get_all_ilks) | **GET** /v2/ilks | Get all Ilks -[**get_ilk_by_name**](IlksApi.md#get_ilk_by_name) | **GET** /v2/ilks/{name} | Get Ilk by name - - -# **get_all_ilks** -> IlksResponse get_all_ilks() - -Get all Ilks - -Retrieve a list of all available ilks. - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.IlksApi(api_client) - - try: - # Get all Ilks - api_response = api_instance.get_all_ilks() - pprint(api_response) - except ApiException as e: - print("Exception when calling IlksApi->get_all_ilks: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**IlksResponse**](IlksResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved list of ilks | - | -**500** | Internal server error | - | - -[[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_ilk_by_name** -> Ilk get_ilk_by_name(name) - -Get Ilk by name - -Retrieve an Ilk by providing its name. - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.IlksApi(api_client) - name = 'name_example' # str | Name of the ILK - - try: - # Get Ilk by name - api_response = api_instance.get_ilk_by_name(name) - pprint(api_response) - except ApiException as e: - print("Exception when calling IlksApi->get_ilk_by_name: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Name of the ILK | - -### Return type - -[**Ilk**](Ilk.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved ILK | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/IlksResponse.md b/src/zarban/service/docs/IlksResponse.md deleted file mode 100644 index 4872284..0000000 --- a/src/zarban/service/docs/IlksResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# IlksResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[Ilk]**](Ilk.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingPoolApi.md b/src/zarban/service/docs/LendingPoolApi.md deleted file mode 100644 index 2d48814..0000000 --- a/src/zarban/service/docs/LendingPoolApi.md +++ /dev/null @@ -1,540 +0,0 @@ -# zarban.service.openapi_client.LendingPoolApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_lending_pool_borrow**](LendingPoolApi.md#create_lending_pool_borrow) | **POST** /v2/lendingpool/tx/borrow | Borrow from lending pool -[**create_lending_pool_deposit**](LendingPoolApi.md#create_lending_pool_deposit) | **POST** /v2/lendingpool/tx/deposit | Deposit to lending pool -[**create_lending_pool_repay**](LendingPoolApi.md#create_lending_pool_repay) | **POST** /v2/lendingpool/tx/repay | Repay to lending pool -[**create_lending_pool_withdraw**](LendingPoolApi.md#create_lending_pool_withdraw) | **POST** /v2/lendingpool/tx/withdraw | Withdraw from lending pool -[**fetch_reserve_data_by_asset**](LendingPoolApi.md#fetch_reserve_data_by_asset) | **GET** /v2/lendingpool/reserves | Fetch Reserve Data By Asset -[**get_user_borrows**](LendingPoolApi.md#get_user_borrows) | **GET** /v2/lendingpool/borrows | Get user borrows of lendingpool -[**get_user_deposits**](LendingPoolApi.md#get_user_deposits) | **GET** /v2/lendingpool/deposits | Get user deposits of Lendingpool -[**set_lending_pool_asset_collateral**](LendingPoolApi.md#set_lending_pool_asset_collateral) | **POST** /v2/lendingpool/tx/useassetascollateral | Enable/Disable asset as collateral - - -# **create_lending_pool_borrow** -> LendingpoolBorrowTxResponse create_lending_pool_borrow(lendingpool_borrow_tx_request) - -Borrow from lending pool - -Borrow from lending pool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - lendingpool_borrow_tx_request = zarban.service.openapi_client.LendingpoolBorrowTxRequest() # LendingpoolBorrowTxRequest | Borrow transaction request, if amount is not provided, it will be calculated based on the token balance - - try: - # Borrow from lending pool - api_response = api_instance.create_lending_pool_borrow(lendingpool_borrow_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->create_lending_pool_borrow: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lendingpool_borrow_tx_request** | [**LendingpoolBorrowTxRequest**](LendingpoolBorrowTxRequest.md)| Borrow transaction request, if amount is not provided, it will be calculated based on the token balance | - -### Return type - -[**LendingpoolBorrowTxResponse**](LendingpoolBorrowTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **create_lending_pool_deposit** -> LendingpoolDepositTxResponse create_lending_pool_deposit(lendingpool_deposit_tx_request) - -Deposit to lending pool - -Deposit to lending pool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - lendingpool_deposit_tx_request = zarban.service.openapi_client.LendingpoolDepositTxRequest() # LendingpoolDepositTxRequest | Deposit transaction request, if amount is not provided, it will be calculated based on the token balance - - try: - # Deposit to lending pool - api_response = api_instance.create_lending_pool_deposit(lendingpool_deposit_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->create_lending_pool_deposit: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lendingpool_deposit_tx_request** | [**LendingpoolDepositTxRequest**](LendingpoolDepositTxRequest.md)| Deposit transaction request, if amount is not provided, it will be calculated based on the token balance | - -### Return type - -[**LendingpoolDepositTxResponse**](LendingpoolDepositTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **create_lending_pool_repay** -> LendingpoolRepayTxResponse create_lending_pool_repay(lendingpool_repay_tx_request) - -Repay to lending pool - -Repay to lending pool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - lendingpool_repay_tx_request = zarban.service.openapi_client.LendingpoolRepayTxRequest() # LendingpoolRepayTxRequest | Repay transaction request, if amount is not provided, it will repay the maximum possible amount - - try: - # Repay to lending pool - api_response = api_instance.create_lending_pool_repay(lendingpool_repay_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->create_lending_pool_repay: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lendingpool_repay_tx_request** | [**LendingpoolRepayTxRequest**](LendingpoolRepayTxRequest.md)| Repay transaction request, if amount is not provided, it will repay the maximum possible amount | - -### Return type - -[**LendingpoolRepayTxResponse**](LendingpoolRepayTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **create_lending_pool_withdraw** -> LendingpoolWithdrawTxResponse create_lending_pool_withdraw(lendingpool_withdraw_tx_request) - -Withdraw from lending pool - -Withdraw from lending pool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - lendingpool_withdraw_tx_request = zarban.service.openapi_client.LendingpoolWithdrawTxRequest() # LendingpoolWithdrawTxRequest | Withdraw transaction request, if amount is not provided, it will be calculated based on the user account status - - try: - # Withdraw from lending pool - api_response = api_instance.create_lending_pool_withdraw(lendingpool_withdraw_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->create_lending_pool_withdraw: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lendingpool_withdraw_tx_request** | [**LendingpoolWithdrawTxRequest**](LendingpoolWithdrawTxRequest.md)| Withdraw transaction request, if amount is not provided, it will be calculated based on the user account status | - -### Return type - -[**LendingpoolWithdrawTxResponse**](LendingpoolWithdrawTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **fetch_reserve_data_by_asset** -> FormattedReserveData fetch_reserve_data_by_asset(asset=asset) - -Fetch Reserve Data By Asset - -Retrieve data of reserves - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - asset = 'asset_example' # str | The asset address in hexadecimal format. (optional) - - try: - # Fetch Reserve Data By Asset - api_response = api_instance.fetch_reserve_data_by_asset(asset=asset) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->fetch_reserve_data_by_asset: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **asset** | **str**| The asset address in hexadecimal format. | [optional] - -### Return type - -[**FormattedReserveData**](FormattedReserveData.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response. | - | -**400** | Bad request (e.g. invalid asset address). | - | -**500** | Internal Server Error. | - | - -[[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_user_borrows** -> UserBorrowsResponse get_user_borrows(user=user, reserve=reserve, cursor=cursor, limit=limit) - -Get user borrows of lendingpool - -Get user borrows of lendingpool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - user = 'user_example' # str | Ethereum address of the user (optional) -reserve = 'reserve_example' # str | Ethereum address of the reserve (optional) -cursor = 56 # int | Cursor for pagination (optional) -limit = 50 # int | Limit the number of deposits returned (default is 50) (optional) (default to 50) - - try: - # Get user borrows of lendingpool - api_response = api_instance.get_user_borrows(user=user, reserve=reserve, cursor=cursor, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->get_user_borrows: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | **str**| Ethereum address of the user | [optional] - **reserve** | **str**| Ethereum address of the reserve | [optional] - **cursor** | **int**| Cursor for pagination | [optional] - **limit** | **int**| Limit the number of deposits returned (default is 50) | [optional] [default to 50] - -### Return type - -[**UserBorrowsResponse**](UserBorrowsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of user borrows | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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_user_deposits** -> UserDepositsResponse get_user_deposits(user=user, reserve=reserve, cursor=cursor, limit=limit) - -Get user deposits of Lendingpool - -Get user deposits of Lendingpool - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - user = 'user_example' # str | Ethereum address of the user (optional) -reserve = 'reserve_example' # str | Ethereum address of the reserve (optional) -cursor = 56 # int | Cursor for pagination (optional) -limit = 50 # int | Limit the number of deposits returned (default is 50) (optional) (default to 50) - - try: - # Get user deposits of Lendingpool - api_response = api_instance.get_user_deposits(user=user, reserve=reserve, cursor=cursor, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->get_user_deposits: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | **str**| Ethereum address of the user | [optional] - **reserve** | **str**| Ethereum address of the reserve | [optional] - **cursor** | **int**| Cursor for pagination | [optional] - **limit** | **int**| Limit the number of deposits returned (default is 50) | [optional] [default to 50] - -### Return type - -[**UserDepositsResponse**](UserDepositsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of user deposits | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **set_lending_pool_asset_collateral** -> LendingpoolUseAssetAsCollateralTxResponse set_lending_pool_asset_collateral(lendingpool_use_asset_as_collateral_tx_request) - -Enable/Disable asset as collateral - -Allows to enable/disable a specific asset as collateral - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LendingPoolApi(api_client) - lendingpool_use_asset_as_collateral_tx_request = zarban.service.openapi_client.LendingpoolUseAssetAsCollateralTxRequest() # LendingpoolUseAssetAsCollateralTxRequest | UseAssetAsCollateral transaction request - - try: - # Enable/Disable asset as collateral - api_response = api_instance.set_lending_pool_asset_collateral(lendingpool_use_asset_as_collateral_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling LendingPoolApi->set_lending_pool_asset_collateral: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lendingpool_use_asset_as_collateral_tx_request** | [**LendingpoolUseAssetAsCollateralTxRequest**](LendingpoolUseAssetAsCollateralTxRequest.md)| UseAssetAsCollateral transaction request | - -### Return type - -[**LendingpoolUseAssetAsCollateralTxResponse**](LendingpoolUseAssetAsCollateralTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/LendingpoolBorrow.md b/src/zarban/service/docs/LendingpoolBorrow.md deleted file mode 100644 index 6456f2d..0000000 --- a/src/zarban/service/docs/LendingpoolBorrow.md +++ /dev/null @@ -1,14 +0,0 @@ -# LendingpoolBorrow - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | The Ethereum address of the user. | -**underlying_asset** | [**Token**](Token.md) | | -**amount** | **dict(str, str)** | | -**borrow_rate** | **str** | The borrow rate. | -**max_borrow_amount** | **dict(str, str)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolBorrowTxRequest.md b/src/zarban/service/docs/LendingpoolBorrowTxRequest.md deleted file mode 100644 index 8962e67..0000000 --- a/src/zarban/service/docs/LendingpoolBorrowTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# LendingpoolBorrowTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**symbol** | **str** | | -**amount** | **str** | The amount to borrow in native token units | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolBorrowTxResponse.md b/src/zarban/service/docs/LendingpoolBorrowTxResponse.md deleted file mode 100644 index fdf4686..0000000 --- a/src/zarban/service/docs/LendingpoolBorrowTxResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# LendingpoolBorrowTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] -**response** | [**LendingpoolTxResponse**](LendingpoolTxResponse.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolDeposit.md b/src/zarban/service/docs/LendingpoolDeposit.md deleted file mode 100644 index d936b95..0000000 --- a/src/zarban/service/docs/LendingpoolDeposit.md +++ /dev/null @@ -1,14 +0,0 @@ -# LendingpoolDeposit - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | The Ethereum address of the user. | -**underlying_asset** | [**Token**](Token.md) | | -**amount** | **dict(str, str)** | | -**usage_as_collateral_enabled_on_user** | **bool** | Whether the user has enabled the asset as collateral. | -**supply_apy** | **str** | The supply APY. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolDepositTxRequest.md b/src/zarban/service/docs/LendingpoolDepositTxRequest.md deleted file mode 100644 index 49ae065..0000000 --- a/src/zarban/service/docs/LendingpoolDepositTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# LendingpoolDepositTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**symbol** | **str** | | -**amount** | **str** | The amount to deposit in native token units, if not provided, it will be calculated based on the token balance | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolDepositTxResponse.md b/src/zarban/service/docs/LendingpoolDepositTxResponse.md deleted file mode 100644 index 6d736fb..0000000 --- a/src/zarban/service/docs/LendingpoolDepositTxResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# LendingpoolDepositTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] -**response** | [**LendingpoolTxResponse**](LendingpoolTxResponse.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolRepayTxRequest.md b/src/zarban/service/docs/LendingpoolRepayTxRequest.md deleted file mode 100644 index 4810f4d..0000000 --- a/src/zarban/service/docs/LendingpoolRepayTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# LendingpoolRepayTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**symbol** | **str** | | -**amount** | **str** | The amount to repay in native token units, if not provided, it will be calculated based on the borrow balance | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolRepayTxResponse.md b/src/zarban/service/docs/LendingpoolRepayTxResponse.md deleted file mode 100644 index 35c0ad7..0000000 --- a/src/zarban/service/docs/LendingpoolRepayTxResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# LendingpoolRepayTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] -**response** | [**LendingpoolTxResponse**](LendingpoolTxResponse.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolStats.md b/src/zarban/service/docs/LendingpoolStats.md deleted file mode 100644 index d812d6e..0000000 --- a/src/zarban/service/docs/LendingpoolStats.md +++ /dev/null @@ -1,12 +0,0 @@ -# LendingpoolStats - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**total_available** | **dict** | | -**total_borrows** | **dict** | | -**total_market_size** | **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) - - diff --git a/src/zarban/service/docs/LendingpoolTxResponse.md b/src/zarban/service/docs/LendingpoolTxResponse.md deleted file mode 100644 index 9e5f956..0000000 --- a/src/zarban/service/docs/LendingpoolTxResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# LendingpoolTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_health_factor** | **str** | The health factor after the deposit | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolUseAssetAsCollateralTxRequest.md b/src/zarban/service/docs/LendingpoolUseAssetAsCollateralTxRequest.md deleted file mode 100644 index ea597c4..0000000 --- a/src/zarban/service/docs/LendingpoolUseAssetAsCollateralTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# LendingpoolUseAssetAsCollateralTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**symbol** | **str** | Symbol of asset | -**enabled** | **bool** | Enable or disable the asset as collateral | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolUseAssetAsCollateralTxResponse.md b/src/zarban/service/docs/LendingpoolUseAssetAsCollateralTxResponse.md deleted file mode 100644 index 13c65cd..0000000 --- a/src/zarban/service/docs/LendingpoolUseAssetAsCollateralTxResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# LendingpoolUseAssetAsCollateralTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] -**response** | [**LendingpoolTxResponse**](LendingpoolTxResponse.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolWithdrawTxRequest.md b/src/zarban/service/docs/LendingpoolWithdrawTxRequest.md deleted file mode 100644 index 2fe8532..0000000 --- a/src/zarban/service/docs/LendingpoolWithdrawTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# LendingpoolWithdrawTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**symbol** | **str** | | -**amount** | **str** | The amount to withdraw in native token units, if not provided, it will be calculated based on the deposit balance | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LendingpoolWithdrawTxResponse.md b/src/zarban/service/docs/LendingpoolWithdrawTxResponse.md deleted file mode 100644 index 84ab457..0000000 --- a/src/zarban/service/docs/LendingpoolWithdrawTxResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# LendingpoolWithdrawTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] -**response** | [**LendingpoolTxResponse**](LendingpoolTxResponse.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Log.md b/src/zarban/service/docs/Log.md deleted file mode 100644 index feae298..0000000 --- a/src/zarban/service/docs/Log.md +++ /dev/null @@ -1,20 +0,0 @@ -# Log - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the log | -**contract** | **str** | The contract address | -**timestamp** | [**Timestamp**](Timestamp.md) | | -**address** | **str** | The Ethereum address | -**block_number** | **int** | The block number | -**tx_hash** | **str** | The transaction hash | -**block_hash** | **str** | The block hash | -**index** | **int** | The index | -**topics** | **list[str]** | | -**data** | **str** | The data of the log | -**decoded** | **dict(str, str)** | The decoded log, if available | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/LogsApi.md b/src/zarban/service/docs/LogsApi.md deleted file mode 100644 index 5951020..0000000 --- a/src/zarban/service/docs/LogsApi.md +++ /dev/null @@ -1,74 +0,0 @@ -# zarban.service.openapi_client.LogsApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_logs_by_transaction_hash**](LogsApi.md#get_logs_by_transaction_hash) | **GET** /v2/logs/{txHash} | Get raw and decoded logs by transaction hash - - -# **get_logs_by_transaction_hash** -> EventDetailsResponse get_logs_by_transaction_hash(tx_hash) - -Get raw and decoded logs by transaction hash - -Get raw and decoded logs by transaction hash - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.LogsApi(api_client) - tx_hash = 'tx_hash_example' # str | Transaction hash - - try: - # Get raw and decoded logs by transaction hash - api_response = api_instance.get_logs_by_transaction_hash(tx_hash) - pprint(api_response) - except ApiException as e: - print("Exception when calling LogsApi->get_logs_by_transaction_hash: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tx_hash** | **str**| Transaction hash | - -### Return type - -[**EventDetailsResponse**](EventDetailsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Event details | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/MethodParameters.md b/src/zarban/service/docs/MethodParameters.md deleted file mode 100644 index 7a2657f..0000000 --- a/src/zarban/service/docs/MethodParameters.md +++ /dev/null @@ -1,12 +0,0 @@ -# MethodParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**to** | **str** | | [optional] -**calldata** | **str** | | [optional] -**value** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Order.md b/src/zarban/service/docs/Order.md deleted file mode 100644 index 39a854b..0000000 --- a/src/zarban/service/docs/Order.md +++ /dev/null @@ -1,18 +0,0 @@ -# Order - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**quote_id** | **str** | | [optional] -**outputs** | [**list[RawDutchAmount]**](RawDutchAmount.md) | | -**encoded_order** | **str** | | -**signature** | **str** | | -**input** | [**RawDutchAmount**](RawDutchAmount.md) | | -**order_status** | **str** | | -**chain_id** | **int** | | -**order_hash** | **str** | | -**order_type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/OrderInfo.md b/src/zarban/service/docs/OrderInfo.md deleted file mode 100644 index 2425768..0000000 --- a/src/zarban/service/docs/OrderInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -# OrderInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_id** | **int** | | -**permit2_address** | **str** | | -**reactor** | **str** | | -**swapper** | **str** | | -**nonce** | **str** | | -**deadline** | [**Timestamp**](Timestamp.md) | | -**additional_validation_contract** | **str** | | -**additional_validation_data** | **str** | | -**decay_start_time** | [**Timestamp**](Timestamp.md) | | -**decay_end_time** | [**Timestamp**](Timestamp.md) | | -**exclusive_filler** | **str** | | -**exclusivity_override_bps** | **int** | | -**input** | [**DutchAmount**](DutchAmount.md) | | -**outputs** | [**list[DutchAmount]**](DutchAmount.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/OrderResponse.md b/src/zarban/service/docs/OrderResponse.md deleted file mode 100644 index 41d8b10..0000000 --- a/src/zarban/service/docs/OrderResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# OrderResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[Order]**](Order.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/OrderType.md b/src/zarban/service/docs/OrderType.md deleted file mode 100644 index fcc835a..0000000 --- a/src/zarban/service/docs/OrderType.md +++ /dev/null @@ -1,9 +0,0 @@ -# OrderType - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/OrdersApi.md b/src/zarban/service/docs/OrdersApi.md deleted file mode 100644 index 4124f7d..0000000 --- a/src/zarban/service/docs/OrdersApi.md +++ /dev/null @@ -1,156 +0,0 @@ -# zarban.service.openapi_client.OrdersApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_unfilled_orders**](OrdersApi.md#get_unfilled_orders) | **GET** /v2/orders | Fetch Unfilled Orders -[**sync_order**](OrdersApi.md#sync_order) | **POST** /v2/orders/sync | Updates Order Entity - - -# **get_unfilled_orders** -> OrderResponse get_unfilled_orders(type=type, hash=hash, status=status, offerer=offerer, filler=filler, decay_start_time=decay_start_time, decay_end_time=decay_end_time, deadline=deadline, cursor=cursor, limit=limit) - -Fetch Unfilled Orders - -Get a list of unfilled orders filtered by different parameters. - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.OrdersApi(api_client) - type = 'type_example' # str | Type of the order (optional) -hash = 'hash_example' # str | order hash (optional) -status = 'status_example' # str | Status of the order (optional) -offerer = 'offerer_example' # str | Ethereum address of the offerer (optional) -filler = 'filler_example' # str | Ethereum address of the filler (optional) -decay_start_time = zarban.service.openapi_client.TimeRange() # TimeRange | Decay start time (optional) -decay_end_time = zarban.service.openapi_client.TimeRange() # TimeRange | Decay end time (optional) -deadline = zarban.service.openapi_client.TimeRange() # TimeRange | Order deadline (optional) -cursor = 56 # int | Cursor for pagination (optional) -limit = 10 # int | Limit the number of orders returned (default is 10) (optional) (default to 10) - - try: - # Fetch Unfilled Orders - api_response = api_instance.get_unfilled_orders(type=type, hash=hash, status=status, offerer=offerer, filler=filler, decay_start_time=decay_start_time, decay_end_time=decay_end_time, deadline=deadline, cursor=cursor, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling OrdersApi->get_unfilled_orders: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **type** | **str**| Type of the order | [optional] - **hash** | **str**| order hash | [optional] - **status** | **str**| Status of the order | [optional] - **offerer** | **str**| Ethereum address of the offerer | [optional] - **filler** | **str**| Ethereum address of the filler | [optional] - **decay_start_time** | [**TimeRange**](.md)| Decay start time | [optional] - **decay_end_time** | [**TimeRange**](.md)| Decay end time | [optional] - **deadline** | [**TimeRange**](.md)| Order deadline | [optional] - **cursor** | **int**| Cursor for pagination | [optional] - **limit** | **int**| Limit the number of orders returned (default is 10) | [optional] [default to 10] - -### Return type - -[**OrderResponse**](OrderResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response. | - | -**400** | Bad request (e.g. invalid filter parameters). | - | -**500** | Internal Server Error. | - | - -[[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) - -# **sync_order** -> Error sync_order(update_order_request) - -Updates Order Entity - -updates an order entity in database - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.OrdersApi(api_client) - update_order_request = zarban.service.openapi_client.UpdateOrderRequest() # UpdateOrderRequest | - - try: - # Updates Order Entity - api_response = api_instance.sync_order(update_order_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling OrdersApi->sync_order: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **update_order_request** | [**UpdateOrderRequest**](UpdateOrderRequest.md)| | - -### Return type - -[**Error**](Error.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/PermitApi.md b/src/zarban/service/docs/PermitApi.md deleted file mode 100644 index 6d80963..0000000 --- a/src/zarban/service/docs/PermitApi.md +++ /dev/null @@ -1,75 +0,0 @@ -# zarban.service.openapi_client.PermitApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_single_token_permit**](PermitApi.md#get_single_token_permit) | **GET** /v2/permit/single | Get permit for single token - - -# **get_single_token_permit** -> PermitSingle get_single_token_permit(token, user) - -Get permit for single token - -Get permit for single token - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.PermitApi(api_client) - token = 'token_example' # str | Ethereum address of the token -user = 'user_example' # str | Ethereum address of the user - - try: - # Get permit for single token - api_response = api_instance.get_single_token_permit(token, user) - pprint(api_response) - except ApiException as e: - print("Exception when calling PermitApi->get_single_token_permit: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token** | **str**| Ethereum address of the token | - **user** | **str**| Ethereum address of the user | - -### Return type - -[**PermitSingle**](PermitSingle.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/PermitSingle.md b/src/zarban/service/docs/PermitSingle.md deleted file mode 100644 index 7762538..0000000 --- a/src/zarban/service/docs/PermitSingle.md +++ /dev/null @@ -1,11 +0,0 @@ -# PermitSingle - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**typed_data** | [**TypedData**](TypedData.md) | | -**hash** | **str** | The hash of the permit that needs to be signed | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/PersonalSignRequest.md b/src/zarban/service/docs/PersonalSignRequest.md deleted file mode 100644 index a2af93b..0000000 --- a/src/zarban/service/docs/PersonalSignRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# PersonalSignRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | The message that needs to be signed | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/PointsApi.md b/src/zarban/service/docs/PointsApi.md deleted file mode 100644 index 2b1d577..0000000 --- a/src/zarban/service/docs/PointsApi.md +++ /dev/null @@ -1,68 +0,0 @@ -# zarban.service.openapi_client.PointsApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_scoreboard**](PointsApi.md#get_scoreboard) | **GET** /v2/points/scoreboard | Get scoreboard - - -# **get_scoreboard** -> Scoreboard get_scoreboard() - -Get scoreboard - -Get scoreboard - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.PointsApi(api_client) - - try: - # Get scoreboard - api_response = api_instance.get_scoreboard() - pprint(api_response) - except ApiException as e: - print("Exception when calling PointsApi->get_scoreboard: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**Scoreboard**](Scoreboard.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 JSON object with scoreboard data | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/PreparedTx.md b/src/zarban/service/docs/PreparedTx.md deleted file mode 100644 index 1584c5f..0000000 --- a/src/zarban/service/docs/PreparedTx.md +++ /dev/null @@ -1,14 +0,0 @@ -# PreparedTx - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**label** | **dict(str, str)** | | -**gas_use_estimate** | **int** | | -**gas_fee_estimate** | **dict(str, str)** | | -**method_parameters** | [**MethodParameters**](MethodParameters.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Price.md b/src/zarban/service/docs/Price.md deleted file mode 100644 index 4b96a74..0000000 --- a/src/zarban/service/docs/Price.md +++ /dev/null @@ -1,12 +0,0 @@ -# Price - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**symbol** | [**Symbol**](Symbol.md) | | -**value** | **dict(str, str)** | | -**timestamp** | [**Timestamp**](Timestamp.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/PriceListResponse.md b/src/zarban/service/docs/PriceListResponse.md deleted file mode 100644 index b7378b5..0000000 --- a/src/zarban/service/docs/PriceListResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# PriceListResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[Price]**](Price.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/PricesApi.md b/src/zarban/service/docs/PricesApi.md deleted file mode 100644 index 6429c4d..0000000 --- a/src/zarban/service/docs/PricesApi.md +++ /dev/null @@ -1,73 +0,0 @@ -# zarban.service.openapi_client.PricesApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**list_prices**](PricesApi.md#list_prices) | **GET** /v2/prices | List prices based on query parameters - - -# **list_prices** -> PriceListResponse list_prices(symbol=symbol) - -List prices based on query parameters - -Retrieve a list of price details based on specified query parameters - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.PricesApi(api_client) - symbol = 'symbol_example' # str | Symbol of the price (optional) - - try: - # List prices based on query parameters - api_response = api_instance.list_prices(symbol=symbol) - pprint(api_response) - except ApiException as e: - print("Exception when calling PricesApi->list_prices: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **symbol** | **str**| Symbol of the price | [optional] - -### Return type - -[**PriceListResponse**](PriceListResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad Request | - | -**500** | Internal Server Error | - | - -[[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) - diff --git a/src/zarban/service/docs/QuoteRequest.md b/src/zarban/service/docs/QuoteRequest.md deleted file mode 100644 index 9d94043..0000000 --- a/src/zarban/service/docs/QuoteRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -# QuoteRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**request_id** | **str** | | [optional] -**type** | [**OrderType**](OrderType.md) | | [optional] -**trade_type** | [**TradeType**](TradeType.md) | | -**input_token** | **str** | | -**output_token** | **str** | | -**amount** | **str** | | -**recipient** | **str** | | -**options** | [**QuoteRequestOptions**](QuoteRequestOptions.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/QuoteRequestOptions.md b/src/zarban/service/docs/QuoteRequestOptions.md deleted file mode 100644 index 69b97cc..0000000 --- a/src/zarban/service/docs/QuoteRequestOptions.md +++ /dev/null @@ -1,19 +0,0 @@ -# QuoteRequestOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dry_run** | **bool** | | [optional] [default to False] -**slippage_tolerance** | **str** | | [optional] [default to '0.005'] -**use_synthetic_quotes** | **bool** | | [optional] [default to False] -**permit_signature** | **str** | | [optional] -**permit_nonce** | **str** | | [optional] -**permit_expiration** | **int** | | [optional] -**permit_amount** | **str** | | [optional] -**permit_sig_deadline** | **int** | | [optional] -**quote_id** | **str** | | [optional] -**encoded_order** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/QuoteResponse.md b/src/zarban/service/docs/QuoteResponse.md deleted file mode 100644 index ceb5f57..0000000 --- a/src/zarban/service/docs/QuoteResponse.md +++ /dev/null @@ -1,25 +0,0 @@ -# QuoteResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**OrderType**](OrderType.md) | | -**trade_type** | [**TradeType**](TradeType.md) | | -**time** | [**Timestamp**](Timestamp.md) | | -**amount** | **dict(str, str)** | | -**quote** | **dict(str, str)** | | -**quote_id** | **str** | | -**gas_price** | **dict(str, str)** | | -**gas_use_estimate** | **int** | | -**gas_fee_estimate** | **dict(str, str)** | | -**route_string** | **str** | | -**method_parameters** | [**MethodParameters**](MethodParameters.md) | | [optional] -**route** | [**list[RouteItem]**](RouteItem.md) | | -**order_info** | [**OrderInfo**](OrderInfo.md) | | [optional] -**encoded_order** | **str** | | [optional] -**order_hash** | **str** | | [optional] -**permit_data** | [**TypedData**](TypedData.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/RawDutchAmount.md b/src/zarban/service/docs/RawDutchAmount.md deleted file mode 100644 index df55a60..0000000 --- a/src/zarban/service/docs/RawDutchAmount.md +++ /dev/null @@ -1,13 +0,0 @@ -# RawDutchAmount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token** | **str** | | -**start_amount** | **str** | | -**end_amount** | **str** | | -**recipient** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/RouteItem.md b/src/zarban/service/docs/RouteItem.md deleted file mode 100644 index a155b33..0000000 --- a/src/zarban/service/docs/RouteItem.md +++ /dev/null @@ -1,9 +0,0 @@ -# RouteItem - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Scoreboard.md b/src/zarban/service/docs/Scoreboard.md deleted file mode 100644 index cd841b9..0000000 --- a/src/zarban/service/docs/Scoreboard.md +++ /dev/null @@ -1,10 +0,0 @@ -# Scoreboard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**items** | [**list[ScoreboardItem]**](ScoreboardItem.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/ScoreboardItem.md b/src/zarban/service/docs/ScoreboardItem.md deleted file mode 100644 index 9a245a9..0000000 --- a/src/zarban/service/docs/ScoreboardItem.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScoreboardItem - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address** | **str** | | -**points** | **int** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StableCoinSystemApi.md b/src/zarban/service/docs/StableCoinSystemApi.md deleted file mode 100644 index fd15e4a..0000000 --- a/src/zarban/service/docs/StableCoinSystemApi.md +++ /dev/null @@ -1,1100 +0,0 @@ -# zarban.service.openapi_client.StableCoinSystemApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**approve_and_join_zar_transaction**](StableCoinSystemApi.md#approve_and_join_zar_transaction) | **POST** /v2/stablecoinsystem/auctions/tx/zarjoin | approve and join ZAR token into Vat contract -[**create_stable_coin_vault**](StableCoinSystemApi.md#create_stable_coin_vault) | **POST** /v2/stablecoinsystem/tx/createvault | Create vault -[**deposit_stable_coin_collateral**](StableCoinSystemApi.md#deposit_stable_coin_collateral) | **POST** /v2/stablecoinsystem/tx/depositcollateral | Deposit collateral -[**exit_gem_transaction**](StableCoinSystemApi.md#exit_gem_transaction) | **POST** /v2/stablecoinsystem/auctions/tx/gemexit | exit Gem token (which can be used as collateral) from Vat contract -[**exit_zar_transaction**](StableCoinSystemApi.md#exit_zar_transaction) | **POST** /v2/stablecoinsystem/auctions/tx/zarexit | exit ZAR token from Vat contract -[**get_all_ilks**](StableCoinSystemApi.md#get_all_ilks) | **GET** /v2/ilks | Get all Ilks -[**get_collector_data**](StableCoinSystemApi.md#get_collector_data) | **GET** /v2/stats | Get collector data -[**get_ilk_by_name**](StableCoinSystemApi.md#get_ilk_by_name) | **GET** /v2/ilks/{name} | Get Ilk by name -[**get_vault_by_id**](StableCoinSystemApi.md#get_vault_by_id) | **GET** /v2/vaults/{id} | Get a vault by ID -[**get_vault_events_by_id**](StableCoinSystemApi.md#get_vault_events_by_id) | **GET** /v2/vaults/{id}/events | Get vault events by ID -[**get_vaults_by_owner**](StableCoinSystemApi.md#get_vaults_by_owner) | **GET** /v2/vaults | Get vaults by owner query -[**liquidate_vault_transaction**](StableCoinSystemApi.md#liquidate_vault_transaction) | **POST** /v2/stablecoinsystem/tx/bark | liquidate a vault -[**mint_zar_transaction**](StableCoinSystemApi.md#mint_zar_transaction) | **POST** /v2/stablecoinsystem/tx/mintzar | Mint ZAR -[**repay_zar_transaction**](StableCoinSystemApi.md#repay_zar_transaction) | **POST** /v2/stablecoinsystem/tx/repayzar | Repay ZAR -[**reset_auction_transaction**](StableCoinSystemApi.md#reset_auction_transaction) | **POST** /v2/stablecoinsystem/auctions/tx/redo | reset a auction -[**take_auction_transaction**](StableCoinSystemApi.md#take_auction_transaction) | **POST** /v2/stablecoinsystem/auctions/tx/take | take a auction -[**withdraw_collateral_transaction**](StableCoinSystemApi.md#withdraw_collateral_transaction) | **POST** /v2/stablecoinsystem/tx/withdrawcollateral | Withdraw collateral - - -# **approve_and_join_zar_transaction** -> ChainActivity approve_and_join_zar_transaction(stablecoin_system_zarjoin_tx_request) - -approve and join ZAR token into Vat contract - -approve and join ZAR token into Vat contract - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_zarjoin_tx_request = zarban.service.openapi_client.StablecoinSystemZarjoinTxRequest() # StablecoinSystemZarjoinTxRequest | Approve and join Zar token into Vat contract transaction request - - try: - # approve and join ZAR token into Vat contract - api_response = api_instance.approve_and_join_zar_transaction(stablecoin_system_zarjoin_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->approve_and_join_zar_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_zarjoin_tx_request** | [**StablecoinSystemZarjoinTxRequest**](StablecoinSystemZarjoinTxRequest.md)| Approve and join Zar token into Vat contract transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **create_stable_coin_vault** -> ChainActivity create_stable_coin_vault(stablecoin_system_create_vault_tx_request) - -Create vault - -Create vault - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_create_vault_tx_request = zarban.service.openapi_client.StablecoinSystemCreateVaultTxRequest() # StablecoinSystemCreateVaultTxRequest | Create vault transaction request - - try: - # Create vault - api_response = api_instance.create_stable_coin_vault(stablecoin_system_create_vault_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->create_stable_coin_vault: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_create_vault_tx_request** | [**StablecoinSystemCreateVaultTxRequest**](StablecoinSystemCreateVaultTxRequest.md)| Create vault transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **deposit_stable_coin_collateral** -> ChainActivity deposit_stable_coin_collateral(stablecoin_system_deposit_collateral_tx_request) - -Deposit collateral - -Deposit collateral - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_deposit_collateral_tx_request = zarban.service.openapi_client.StablecoinSystemDepositCollateralTxRequest() # StablecoinSystemDepositCollateralTxRequest | Deposit collateral transaction request - - try: - # Deposit collateral - api_response = api_instance.deposit_stable_coin_collateral(stablecoin_system_deposit_collateral_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->deposit_stable_coin_collateral: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_deposit_collateral_tx_request** | [**StablecoinSystemDepositCollateralTxRequest**](StablecoinSystemDepositCollateralTxRequest.md)| Deposit collateral transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **exit_gem_transaction** -> ChainActivity exit_gem_transaction(stablecoin_system_gemexit_tx_request) - -exit Gem token (which can be used as collateral) from Vat contract - -exit Gem token (which can be used as collateral) from Vat contract - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_gemexit_tx_request = zarban.service.openapi_client.StablecoinSystemGemexitTxRequest() # StablecoinSystemGemexitTxRequest | exit Zar token from Vat contract transaction request - - try: - # exit Gem token (which can be used as collateral) from Vat contract - api_response = api_instance.exit_gem_transaction(stablecoin_system_gemexit_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->exit_gem_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_gemexit_tx_request** | [**StablecoinSystemGemexitTxRequest**](StablecoinSystemGemexitTxRequest.md)| exit Zar token from Vat contract transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **exit_zar_transaction** -> ChainActivity exit_zar_transaction(stablecoin_system_zarexit_tx_request) - -exit ZAR token from Vat contract - -exit ZAR token from Vat contract - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_zarexit_tx_request = zarban.service.openapi_client.StablecoinSystemZarexitTxRequest() # StablecoinSystemZarexitTxRequest | exit Zar token from Vat contract transaction request - - try: - # exit ZAR token from Vat contract - api_response = api_instance.exit_zar_transaction(stablecoin_system_zarexit_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->exit_zar_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_zarexit_tx_request** | [**StablecoinSystemZarexitTxRequest**](StablecoinSystemZarexitTxRequest.md)| exit Zar token from Vat contract transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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_all_ilks** -> IlksResponse get_all_ilks() - -Get all Ilks - -Retrieve a list of all available ilks. - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - - try: - # Get all Ilks - api_response = api_instance.get_all_ilks() - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->get_all_ilks: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**IlksResponse**](IlksResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved list of ilks | - | -**500** | Internal server error | - | - -[[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_collector_data** -> Stats get_collector_data() - -Get collector data - -Get collector data - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - - try: - # Get collector data - api_response = api_instance.get_collector_data() - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->get_collector_data: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**Stats**](Stats.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 JSON object with collector data | - | - -[[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_ilk_by_name** -> Ilk get_ilk_by_name(name) - -Get Ilk by name - -Retrieve an Ilk by providing its name. - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - name = 'name_example' # str | Name of the ILK - - try: - # Get Ilk by name - api_response = api_instance.get_ilk_by_name(name) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->get_ilk_by_name: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| Name of the ILK | - -### Return type - -[**Ilk**](Ilk.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved ILK | - | -**500** | Internal server error | - | - -[[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_vault_by_id** -> Vault get_vault_by_id(id) - -Get a vault by ID - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - id = 56 # int | Vault ID - - try: - # Get a vault by ID - api_response = api_instance.get_vault_by_id(id) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->get_vault_by_id: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **int**| Vault ID | - -### Return type - -[**Vault**](Vault.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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_vault_events_by_id** -> VaultEventsResponse get_vault_events_by_id(id, type=type) - -Get vault events by ID - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - id = 56 # int | Vault ID -type = 'type_example' # str | Event type (optional) - - try: - # Get vault events by ID - api_response = api_instance.get_vault_events_by_id(id, type=type) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->get_vault_events_by_id: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **int**| Vault ID | - **type** | **str**| Event type | [optional] - -### Return type - -[**VaultEventsResponse**](VaultEventsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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_vaults_by_owner** -> VaultsResponse get_vaults_by_owner(owner=owner) - -Get vaults by owner query - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - owner = 'owner_example' # str | Ethereum address of the owner (optional) - - try: - # Get vaults by owner query - api_response = api_instance.get_vaults_by_owner(owner=owner) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->get_vaults_by_owner: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **owner** | **str**| Ethereum address of the owner | [optional] - -### Return type - -[**VaultsResponse**](VaultsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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) - -# **liquidate_vault_transaction** -> ChainActivity liquidate_vault_transaction(stablecoin_system_bark_tx_request) - -liquidate a vault - -liquidate a vault - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_bark_tx_request = zarban.service.openapi_client.StablecoinSystemBarkTxRequest() # StablecoinSystemBarkTxRequest | Liquidate a Vault transaction request - - try: - # liquidate a vault - api_response = api_instance.liquidate_vault_transaction(stablecoin_system_bark_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->liquidate_vault_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_bark_tx_request** | [**StablecoinSystemBarkTxRequest**](StablecoinSystemBarkTxRequest.md)| Liquidate a Vault transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **mint_zar_transaction** -> ChainActivity mint_zar_transaction(stablecoin_system_mint_zar_tx_request) - -Mint ZAR - -Mint ZAR - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_mint_zar_tx_request = zarban.service.openapi_client.StablecoinSystemMintZarTxRequest() # StablecoinSystemMintZarTxRequest | Mint ZAR transaction request - - try: - # Mint ZAR - api_response = api_instance.mint_zar_transaction(stablecoin_system_mint_zar_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->mint_zar_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_mint_zar_tx_request** | [**StablecoinSystemMintZarTxRequest**](StablecoinSystemMintZarTxRequest.md)| Mint ZAR transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **repay_zar_transaction** -> ChainActivity repay_zar_transaction(stablecoin_system_repay_zar_tx_request) - -Repay ZAR - -Repay ZAR - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_repay_zar_tx_request = zarban.service.openapi_client.StablecoinSystemRepayZarTxRequest() # StablecoinSystemRepayZarTxRequest | Repay ZAR transaction request - - try: - # Repay ZAR - api_response = api_instance.repay_zar_transaction(stablecoin_system_repay_zar_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->repay_zar_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_repay_zar_tx_request** | [**StablecoinSystemRepayZarTxRequest**](StablecoinSystemRepayZarTxRequest.md)| Repay ZAR transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **reset_auction_transaction** -> ChainActivity reset_auction_transaction(stablecoin_system_redo_tx_request) - -reset a auction - -reset a auction - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_redo_tx_request = zarban.service.openapi_client.StablecoinSystemRedoTxRequest() # StablecoinSystemRedoTxRequest | Reset a Auction transaction request - - try: - # reset a auction - api_response = api_instance.reset_auction_transaction(stablecoin_system_redo_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->reset_auction_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_redo_tx_request** | [**StablecoinSystemRedoTxRequest**](StablecoinSystemRedoTxRequest.md)| Reset a Auction transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **take_auction_transaction** -> ChainActivity take_auction_transaction(stablecoin_system_take_tx_request) - -take a auction - -take a auction - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_take_tx_request = zarban.service.openapi_client.StablecoinSystemTakeTxRequest() # StablecoinSystemTakeTxRequest | Take a Auction transaction request - - try: - # take a auction - api_response = api_instance.take_auction_transaction(stablecoin_system_take_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->take_auction_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_take_tx_request** | [**StablecoinSystemTakeTxRequest**](StablecoinSystemTakeTxRequest.md)| Take a Auction transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **withdraw_collateral_transaction** -> ChainActivity withdraw_collateral_transaction(stablecoin_system_withdraw_collateral_tx_request) - -Withdraw collateral - -Withdraw collateral - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StableCoinSystemApi(api_client) - stablecoin_system_withdraw_collateral_tx_request = zarban.service.openapi_client.StablecoinSystemWithdrawCollateralTxRequest() # StablecoinSystemWithdrawCollateralTxRequest | Withdraw collateral transaction request - - try: - # Withdraw collateral - api_response = api_instance.withdraw_collateral_transaction(stablecoin_system_withdraw_collateral_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StableCoinSystemApi->withdraw_collateral_transaction: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stablecoin_system_withdraw_collateral_tx_request** | [**StablecoinSystemWithdrawCollateralTxRequest**](StablecoinSystemWithdrawCollateralTxRequest.md)| Withdraw collateral transaction request | - -### Return type - -[**ChainActivity**](ChainActivity.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/StablecoinSystemBarkTxRequest.md b/src/zarban/service/docs/StablecoinSystemBarkTxRequest.md deleted file mode 100644 index f345207..0000000 --- a/src/zarban/service/docs/StablecoinSystemBarkTxRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# StablecoinSystemBarkTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user who is liquidating the vault and receiving incentives. | -**vault_id** | **int** | The ID of the vault | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemCreateVaultTxRequest.md b/src/zarban/service/docs/StablecoinSystemCreateVaultTxRequest.md deleted file mode 100644 index 5b555b0..0000000 --- a/src/zarban/service/docs/StablecoinSystemCreateVaultTxRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# StablecoinSystemCreateVaultTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ilk_name** | **str** | The name of the ilk | -**user** | **str** | Ethereum address of the user | -**collateral_amount** | **str** | The amount of collateral to deposit in native token units | [optional] -**mint_amount** | **str** | The amount of stablecoin to mint in native token units | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemDepositCollateralTxRequest.md b/src/zarban/service/docs/StablecoinSystemDepositCollateralTxRequest.md deleted file mode 100644 index dea4076..0000000 --- a/src/zarban/service/docs/StablecoinSystemDepositCollateralTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StablecoinSystemDepositCollateralTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**vault_id** | **int** | The ID of the vault | -**amount** | **str** | The amount of collateral to deposit in native token units, if not provided, it will be calculated based on the wallet balance | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemGemexitTxRequest.md b/src/zarban/service/docs/StablecoinSystemGemexitTxRequest.md deleted file mode 100644 index 55ae80c..0000000 --- a/src/zarban/service/docs/StablecoinSystemGemexitTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StablecoinSystemGemexitTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user intends to exit gem tokens from the Vat contract and receive them.. | -**amount** | **str** | The amount of Gem token to exit from Vat contract | -**ilk** | **str** | Name of the ILK | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemMintZarTxRequest.md b/src/zarban/service/docs/StablecoinSystemMintZarTxRequest.md deleted file mode 100644 index ad38fa3..0000000 --- a/src/zarban/service/docs/StablecoinSystemMintZarTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StablecoinSystemMintZarTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**vault_id** | **int** | The ID of the vault | -**amount** | **str** | The amount of stablecoin to mint in native token units, if not provided, it will be calculated based on the available to mint amount | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemRedoTxRequest.md b/src/zarban/service/docs/StablecoinSystemRedoTxRequest.md deleted file mode 100644 index c1455b1..0000000 --- a/src/zarban/service/docs/StablecoinSystemRedoTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StablecoinSystemRedoTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user resetting the auction and receiving incentives. | -**auction_id** | **int** | The ID of the auction | -**ilk** | **str** | Name of the ILK | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemRepayZarTxRequest.md b/src/zarban/service/docs/StablecoinSystemRepayZarTxRequest.md deleted file mode 100644 index c5e5137..0000000 --- a/src/zarban/service/docs/StablecoinSystemRepayZarTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StablecoinSystemRepayZarTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**vault_id** | **int** | The ID of the vault | -**amount** | **str** | The amount of stablecoin to repay in native token units, if not provided, it will be calculated based on the borrow balance | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemStats.md b/src/zarban/service/docs/StablecoinSystemStats.md deleted file mode 100644 index f442032..0000000 --- a/src/zarban/service/docs/StablecoinSystemStats.md +++ /dev/null @@ -1,15 +0,0 @@ -# StablecoinSystemStats - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**system_surplus** | [**SystemSurplus**](SystemSurplus.md) | | -**system_debt** | [**SystemDebt**](SystemDebt.md) | | -**system_debt_ceiling** | [**SystemDebtCeiling**](SystemDebtCeiling.md) | | -**system_surplus_buffer** | [**SystemSurplusBuffer**](SystemSurplusBuffer.md) | | -**system_bad_debt** | [**SystemBadDebt**](SystemBadDebt.md) | | -**system_surplus_lot_size** | [**SystemSurplusLotSize**](SystemSurplusLotSize.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemTakeTxRequest.md b/src/zarban/service/docs/StablecoinSystemTakeTxRequest.md deleted file mode 100644 index 568a58c..0000000 --- a/src/zarban/service/docs/StablecoinSystemTakeTxRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# StablecoinSystemTakeTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user taking the auction. | -**auction_id** | **int** | The ID of the auction | -**ilk** | **str** | Name of the ILK | -**collateral_amount_upper_limit** | **str** | upper limit on the amount of collateral to buy [wad] | -**max_acceptable_price** | **str** | Maximum acceptable price (ZAR / collateral) [ray] | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemWithdrawCollateralTxRequest.md b/src/zarban/service/docs/StablecoinSystemWithdrawCollateralTxRequest.md deleted file mode 100644 index d525d57..0000000 --- a/src/zarban/service/docs/StablecoinSystemWithdrawCollateralTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StablecoinSystemWithdrawCollateralTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**vault_id** | **int** | The ID of the vault | -**amount** | **str** | The amount of collateral to withdraw in native token units, if not provided, it will be calculated based on the withdrawable balance | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemZarexitTxRequest.md b/src/zarban/service/docs/StablecoinSystemZarexitTxRequest.md deleted file mode 100644 index 260e05f..0000000 --- a/src/zarban/service/docs/StablecoinSystemZarexitTxRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# StablecoinSystemZarexitTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user intends to exit zar tokens from the Vat contract and receive them.. | -**amount** | **str** | The amount of Zar token to exit from Vat contract | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StablecoinSystemZarjoinTxRequest.md b/src/zarban/service/docs/StablecoinSystemZarjoinTxRequest.md deleted file mode 100644 index b6bbc30..0000000 --- a/src/zarban/service/docs/StablecoinSystemZarjoinTxRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# StablecoinSystemZarjoinTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user intends to join zar tokens into the Vat contract. | -**amount** | **str** | The amount of ZAR to approve and join into Vat contract | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakeBalance.md b/src/zarban/service/docs/StakeBalance.md deleted file mode 100644 index 0e8f1a0..0000000 --- a/src/zarban/service/docs/StakeBalance.md +++ /dev/null @@ -1,10 +0,0 @@ -# StakeBalance - -The amount of asset staked in native token units -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakePlan.md b/src/zarban/service/docs/StakePlan.md deleted file mode 100644 index dbbcd36..0000000 --- a/src/zarban/service/docs/StakePlan.md +++ /dev/null @@ -1,15 +0,0 @@ -# StakePlan - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**plan_name** | **str** | Name of staking plan | -**contract_address** | **str** | Ethereum address of the staking contract | -**apy** | **str** | Annual percentage yield of the staking plan | -**stake_token** | [**Token**](Token.md) | | -**reward_token** | [**Token**](Token.md) | | -**finish_at** | [**Timestamp**](Timestamp.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakePlansResponse.md b/src/zarban/service/docs/StakePlansResponse.md deleted file mode 100644 index 8aa756c..0000000 --- a/src/zarban/service/docs/StakePlansResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# StakePlansResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[StakePlan]**](StakePlan.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakingApi.md b/src/zarban/service/docs/StakingApi.md deleted file mode 100644 index dc1cb27..0000000 --- a/src/zarban/service/docs/StakingApi.md +++ /dev/null @@ -1,336 +0,0 @@ -# zarban.service.openapi_client.StakingApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**collect_staking_reward**](StakingApi.md#collect_staking_reward) | **POST** /v2/staking/tx/collectreward | Collect staking reward -[**get_staking_plans**](StakingApi.md#get_staking_plans) | **GET** /v2/staking/plans | Get staking plans -[**get_user_staking_stats**](StakingApi.md#get_user_staking_stats) | **GET** /v2/staking/stats | Get user staking stats -[**stake_to_staking_contract**](StakingApi.md#stake_to_staking_contract) | **POST** /v2/staking/tx/stake | Stake to staking contract -[**withdraw_staked_asset**](StakingApi.md#withdraw_staked_asset) | **POST** /v2/staking/tx/withdraw | Withdraw staked asset - - -# **collect_staking_reward** -> StakingCollectRewardTxResponse collect_staking_reward(staking_collect_reward_tx_request) - -Collect staking reward - -Collect staking reward - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StakingApi(api_client) - staking_collect_reward_tx_request = zarban.service.openapi_client.StakingCollectRewardTxRequest() # StakingCollectRewardTxRequest | Collect reward transaction request - - try: - # Collect staking reward - api_response = api_instance.collect_staking_reward(staking_collect_reward_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StakingApi->collect_staking_reward: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **staking_collect_reward_tx_request** | [**StakingCollectRewardTxRequest**](StakingCollectRewardTxRequest.md)| Collect reward transaction request | - -### Return type - -[**StakingCollectRewardTxResponse**](StakingCollectRewardTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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_staking_plans** -> StakePlansResponse get_staking_plans() - -Get staking plans - -Get staking plans - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StakingApi(api_client) - - try: - # Get staking plans - api_response = api_instance.get_staking_plans() - pprint(api_response) - except ApiException as e: - print("Exception when calling StakingApi->get_staking_plans: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**StakePlansResponse**](StakePlansResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of stakes | - | -**500** | Internal server error | - | - -[[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_user_staking_stats** -> UserStakesResponse get_user_staking_stats(user=user, address=address, active=active, cursor=cursor, limit=limit) - -Get user staking stats - -Get user staking stats - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StakingApi(api_client) - user = 'user_example' # str | Ethereum address of the user (optional) -address = 'address_example' # str | Ethereum address of the staking contract (optional) -active = True # bool | Filter by active stakes (optional) -cursor = 56 # int | Cursor for pagination (optional) -limit = 50 # int | Limit the number of stakes returned (default is 50) (optional) (default to 50) - - try: - # Get user staking stats - api_response = api_instance.get_user_staking_stats(user=user, address=address, active=active, cursor=cursor, limit=limit) - pprint(api_response) - except ApiException as e: - print("Exception when calling StakingApi->get_user_staking_stats: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | **str**| Ethereum address of the user | [optional] - **address** | **str**| Ethereum address of the staking contract | [optional] - **active** | **bool**| Filter by active stakes | [optional] - **cursor** | **int**| Cursor for pagination | [optional] - **limit** | **int**| Limit the number of stakes returned (default is 50) | [optional] [default to 50] - -### Return type - -[**UserStakesResponse**](UserStakesResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List of stakes | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **stake_to_staking_contract** -> StakingStakeTxResponse stake_to_staking_contract(staking_stake_tx_request) - -Stake to staking contract - -Stake to staking contract - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StakingApi(api_client) - staking_stake_tx_request = zarban.service.openapi_client.StakingStakeTxRequest() # StakingStakeTxRequest | Stake transaction request, if amount is not provided, then the whole wallet balance will be used - - try: - # Stake to staking contract - api_response = api_instance.stake_to_staking_contract(staking_stake_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StakingApi->stake_to_staking_contract: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **staking_stake_tx_request** | [**StakingStakeTxRequest**](StakingStakeTxRequest.md)| Stake transaction request, if amount is not provided, then the whole wallet balance will be used | - -### Return type - -[**StakingStakeTxResponse**](StakingStakeTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - -# **withdraw_staked_asset** -> StakingWithdrawTxResponse withdraw_staked_asset(staking_withdraw_tx_request) - -Withdraw staked asset - -Withdraw staked asset - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.StakingApi(api_client) - staking_withdraw_tx_request = zarban.service.openapi_client.StakingWithdrawTxRequest() # StakingWithdrawTxRequest | Withdraw transaction request, if amount is not provided, then the whole staked amount will be withdrawn - - try: - # Withdraw staked asset - api_response = api_instance.withdraw_staked_asset(staking_withdraw_tx_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling StakingApi->withdraw_staked_asset: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **staking_withdraw_tx_request** | [**StakingWithdrawTxRequest**](StakingWithdrawTxRequest.md)| Withdraw transaction request, if amount is not provided, then the whole staked amount will be withdrawn | - -### Return type - -[**StakingWithdrawTxResponse**](StakingWithdrawTxResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/StakingCollectRewardTxRequest.md b/src/zarban/service/docs/StakingCollectRewardTxRequest.md deleted file mode 100644 index 03c6d86..0000000 --- a/src/zarban/service/docs/StakingCollectRewardTxRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# StakingCollectRewardTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**contract_address** | **str** | Ethereum address of the staking contract | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakingCollectRewardTxResponse.md b/src/zarban/service/docs/StakingCollectRewardTxResponse.md deleted file mode 100644 index b52b18a..0000000 --- a/src/zarban/service/docs/StakingCollectRewardTxResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# StakingCollectRewardTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakingStakeTxRequest.md b/src/zarban/service/docs/StakingStakeTxRequest.md deleted file mode 100644 index 71d4e08..0000000 --- a/src/zarban/service/docs/StakingStakeTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StakingStakeTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**contract_address** | **str** | Ethereum address of the staking contract | -**amount** | **str** | The amount of asset to stake in native token units | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakingStakeTxResponse.md b/src/zarban/service/docs/StakingStakeTxResponse.md deleted file mode 100644 index a4689a7..0000000 --- a/src/zarban/service/docs/StakingStakeTxResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# StakingStakeTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakingWithdrawTxRequest.md b/src/zarban/service/docs/StakingWithdrawTxRequest.md deleted file mode 100644 index 2e4fd72..0000000 --- a/src/zarban/service/docs/StakingWithdrawTxRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# StakingWithdrawTxRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**contract_address** | **str** | Ethereum address of the staking contract | -**amount** | **str** | The amount of asset to withdraw in native token units | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/StakingWithdrawTxResponse.md b/src/zarban/service/docs/StakingWithdrawTxResponse.md deleted file mode 100644 index d56031f..0000000 --- a/src/zarban/service/docs/StakingWithdrawTxResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# StakingWithdrawTxResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chain_activity** | [**ChainActivity**](ChainActivity.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Stats.md b/src/zarban/service/docs/Stats.md deleted file mode 100644 index 25cd4bf..0000000 --- a/src/zarban/service/docs/Stats.md +++ /dev/null @@ -1,11 +0,0 @@ -# Stats - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**stablecoin_system** | [**StablecoinSystemStats**](StablecoinSystemStats.md) | | -**lendingpool** | [**LendingpoolStats**](LendingpoolStats.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/SwapApi.md b/src/zarban/service/docs/SwapApi.md deleted file mode 100644 index 14aa286..0000000 --- a/src/zarban/service/docs/SwapApi.md +++ /dev/null @@ -1,73 +0,0 @@ -# zarban.service.openapi_client.SwapApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_swap_quote**](SwapApi.md#get_swap_quote) | **POST** /v2/swap/quote | Get a quote for a swap - - -# **get_swap_quote** -> QuoteResponse get_swap_quote(quote_request) - -Get a quote for a swap - -Get a quote for a swap - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.SwapApi(api_client) - quote_request = zarban.service.openapi_client.QuoteRequest() # QuoteRequest | - - try: - # Get a quote for a swap - api_response = api_instance.get_swap_quote(quote_request) - pprint(api_response) - except ApiException as e: - print("Exception when calling SwapApi->get_swap_quote: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **quote_request** | [**QuoteRequest**](QuoteRequest.md)| | - -### Return type - -[**QuoteResponse**](QuoteResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/Symbol.md b/src/zarban/service/docs/Symbol.md deleted file mode 100644 index dbc16f4..0000000 --- a/src/zarban/service/docs/Symbol.md +++ /dev/null @@ -1,10 +0,0 @@ -# Symbol - -Symbol representation -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/SystemBadDebt.md b/src/zarban/service/docs/SystemBadDebt.md deleted file mode 100644 index 27db634..0000000 --- a/src/zarban/service/docs/SystemBadDebt.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemBadDebt - -System bad debt -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/SystemDebt.md b/src/zarban/service/docs/SystemDebt.md deleted file mode 100644 index c665360..0000000 --- a/src/zarban/service/docs/SystemDebt.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemDebt - -System debt -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/SystemDebtCeiling.md b/src/zarban/service/docs/SystemDebtCeiling.md deleted file mode 100644 index 465731b..0000000 --- a/src/zarban/service/docs/SystemDebtCeiling.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemDebtCeiling - -System debt ceiling -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/SystemSurplus.md b/src/zarban/service/docs/SystemSurplus.md deleted file mode 100644 index e9604b0..0000000 --- a/src/zarban/service/docs/SystemSurplus.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemSurplus - -System surplus -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/SystemSurplusBuffer.md b/src/zarban/service/docs/SystemSurplusBuffer.md deleted file mode 100644 index 0da1ee8..0000000 --- a/src/zarban/service/docs/SystemSurplusBuffer.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemSurplusBuffer - -System surplus buffer -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/SystemSurplusLotSize.md b/src/zarban/service/docs/SystemSurplusLotSize.md deleted file mode 100644 index bc058ad..0000000 --- a/src/zarban/service/docs/SystemSurplusLotSize.md +++ /dev/null @@ -1,10 +0,0 @@ -# SystemSurplusLotSize - -System surplus lot size -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/TimeRange.md b/src/zarban/service/docs/TimeRange.md deleted file mode 100644 index fb957f7..0000000 --- a/src/zarban/service/docs/TimeRange.md +++ /dev/null @@ -1,11 +0,0 @@ -# TimeRange - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_from** | **datetime** | | [optional] -**to** | **datetime** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Timestamp.md b/src/zarban/service/docs/Timestamp.md deleted file mode 100644 index 0f78bc6..0000000 --- a/src/zarban/service/docs/Timestamp.md +++ /dev/null @@ -1,11 +0,0 @@ -# Timestamp - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**jalaali** | **str** | Jalaali date | -**gregorian** | **str** | Gregorian date | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Token.md b/src/zarban/service/docs/Token.md deleted file mode 100644 index f366a22..0000000 --- a/src/zarban/service/docs/Token.md +++ /dev/null @@ -1,16 +0,0 @@ -# Token - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the token. | -**symbol** | [**Symbol**](Symbol.md) | | -**decimals** | **int** | The number of decimals for the token. | -**address** | **str** | The Ethereum address of the token. | -**logo_uri** | **str** | The URI of the token's logo. | -**chain_id** | **int** | The chain ID of the token. | -**persian_name** | **str** | The Persian name of the token. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/TradeType.md b/src/zarban/service/docs/TradeType.md deleted file mode 100644 index be00622..0000000 --- a/src/zarban/service/docs/TradeType.md +++ /dev/null @@ -1,9 +0,0 @@ -# TradeType - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Type.md b/src/zarban/service/docs/Type.md deleted file mode 100644 index 98c3c4c..0000000 --- a/src/zarban/service/docs/Type.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**type** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/TypedData.md b/src/zarban/service/docs/TypedData.md deleted file mode 100644 index 57b1366..0000000 --- a/src/zarban/service/docs/TypedData.md +++ /dev/null @@ -1,13 +0,0 @@ -# TypedData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**types** | **dict(str, list[Type])** | A map where each key is a string and each value is a list of Type | -**primary_type** | **str** | | -**domain** | [**TypedDataDomain**](TypedDataDomain.md) | | -**message** | **dict(str, object)** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/TypedDataDomain.md b/src/zarban/service/docs/TypedDataDomain.md deleted file mode 100644 index ff10f4e..0000000 --- a/src/zarban/service/docs/TypedDataDomain.md +++ /dev/null @@ -1,14 +0,0 @@ -# TypedDataDomain - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | **str** | | [optional] -**chain_id** | **str** | | -**verifying_contract** | **str** | | -**salt** | **str** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/UnclaimedReward.md b/src/zarban/service/docs/UnclaimedReward.md deleted file mode 100644 index d1e0017..0000000 --- a/src/zarban/service/docs/UnclaimedReward.md +++ /dev/null @@ -1,10 +0,0 @@ -# UnclaimedReward - -The amount of unclaimed reward in native token units -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/UpdateOrderRequest.md b/src/zarban/service/docs/UpdateOrderRequest.md deleted file mode 100644 index adb37c9..0000000 --- a/src/zarban/service/docs/UpdateOrderRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# UpdateOrderRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**order_hash** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/UserBorrowsResponse.md b/src/zarban/service/docs/UserBorrowsResponse.md deleted file mode 100644 index 76cc334..0000000 --- a/src/zarban/service/docs/UserBorrowsResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# UserBorrowsResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[LendingpoolBorrow]**](LendingpoolBorrow.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/UserDepositsResponse.md b/src/zarban/service/docs/UserDepositsResponse.md deleted file mode 100644 index 0688079..0000000 --- a/src/zarban/service/docs/UserDepositsResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# UserDepositsResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[LendingpoolDeposit]**](LendingpoolDeposit.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/UserError.md b/src/zarban/service/docs/UserError.md deleted file mode 100644 index d790f3d..0000000 --- a/src/zarban/service/docs/UserError.md +++ /dev/null @@ -1,11 +0,0 @@ -# UserError - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**messages** | [**dict(str, ErrorMessage)**](ErrorMessage.md) | Localized error messages | -**reasons** | **list[str]** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/UserStake.md b/src/zarban/service/docs/UserStake.md deleted file mode 100644 index a494d50..0000000 --- a/src/zarban/service/docs/UserStake.md +++ /dev/null @@ -1,14 +0,0 @@ -# UserStake - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**user** | **str** | Ethereum address of the user | -**balance** | [**StakeBalance**](StakeBalance.md) | | -**unclaimed_reward** | [**UnclaimedReward**](UnclaimedReward.md) | | -**contract_address** | **str** | Ethereum address of the staking contract | -**plan_name** | **str** | Name of staking plan | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/UserStakesResponse.md b/src/zarban/service/docs/UserStakesResponse.md deleted file mode 100644 index aa5501f..0000000 --- a/src/zarban/service/docs/UserStakesResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# UserStakesResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[UserStake]**](UserStake.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/V3PoolInRoute.md b/src/zarban/service/docs/V3PoolInRoute.md deleted file mode 100644 index 53829c2..0000000 --- a/src/zarban/service/docs/V3PoolInRoute.md +++ /dev/null @@ -1,13 +0,0 @@ -# V3PoolInRoute - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address** | **str** | | -**token_in** | [**Token**](Token.md) | | -**token_out** | [**Token**](Token.md) | | -**fee** | **str** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/Vault.md b/src/zarban/service/docs/Vault.md deleted file mode 100644 index 108743d..0000000 --- a/src/zarban/service/docs/Vault.md +++ /dev/null @@ -1,20 +0,0 @@ -# Vault - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | Identifier for the vault. | -**owner** | **str** | Ethereum address of the vault owner. | -**urn** | **str** | Ethereum address of the vault urn. | -**liquidation_price** | **dict(str, str)** | | -**collateral_locked** | **dict(str, str)** | | -**collateralization_ratio** | **str** | The collateralization ratio of the vault. | -**loan_to_value** | **str** | The loan to value of the vault. | -**debt** | **dict(str, str)** | | -**available_to_withdraw** | **dict(str, str)** | | -**available_to_mint** | **dict(str, str)** | | -**ilk** | [**Ilk**](Ilk.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/VaultEvent.md b/src/zarban/service/docs/VaultEvent.md deleted file mode 100644 index f79b3ef..0000000 --- a/src/zarban/service/docs/VaultEvent.md +++ /dev/null @@ -1,12 +0,0 @@ -# VaultEvent - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**delta_collateral** | **dict(str, str)** | | -**delta_debt** | **dict(str, str)** | | -**ilk** | [**Ilk**](Ilk.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/VaultEventExtension.md b/src/zarban/service/docs/VaultEventExtension.md deleted file mode 100644 index 9914e85..0000000 --- a/src/zarban/service/docs/VaultEventExtension.md +++ /dev/null @@ -1,10 +0,0 @@ -# VaultEventExtension - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payload** | [**VaultEvent**](VaultEvent.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/VaultEventItem.md b/src/zarban/service/docs/VaultEventItem.md deleted file mode 100644 index f692ff3..0000000 --- a/src/zarban/service/docs/VaultEventItem.md +++ /dev/null @@ -1,15 +0,0 @@ -# VaultEventItem - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | Identifier for the event. | -**name** | [**EventName**](EventName.md) | | -**type** | [**EventType**](EventType.md) | | -**domain** | [**EventDomain**](EventDomain.md) | | -**raw** | [**Log**](Log.md) | | -**payload** | [**VaultEvent**](VaultEvent.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/VaultEventsResponse.md b/src/zarban/service/docs/VaultEventsResponse.md deleted file mode 100644 index fa364b5..0000000 --- a/src/zarban/service/docs/VaultEventsResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# VaultEventsResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[ExtendedEvent]**](ExtendedEvent.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/VaultsApi.md b/src/zarban/service/docs/VaultsApi.md deleted file mode 100644 index d037d7e..0000000 --- a/src/zarban/service/docs/VaultsApi.md +++ /dev/null @@ -1,202 +0,0 @@ -# zarban.service.openapi_client.VaultsApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_vault_by_id**](VaultsApi.md#get_vault_by_id) | **GET** /v2/vaults/{id} | Get a vault by ID -[**get_vault_events_by_id**](VaultsApi.md#get_vault_events_by_id) | **GET** /v2/vaults/{id}/events | Get vault events by ID -[**get_vaults_by_owner**](VaultsApi.md#get_vaults_by_owner) | **GET** /v2/vaults | Get vaults by owner query - - -# **get_vault_by_id** -> Vault get_vault_by_id(id) - -Get a vault by ID - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.VaultsApi(api_client) - id = 56 # int | Vault ID - - try: - # Get a vault by ID - api_response = api_instance.get_vault_by_id(id) - pprint(api_response) - except ApiException as e: - print("Exception when calling VaultsApi->get_vault_by_id: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **int**| Vault ID | - -### Return type - -[**Vault**](Vault.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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_vault_events_by_id** -> VaultEventsResponse get_vault_events_by_id(id, type=type) - -Get vault events by ID - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.VaultsApi(api_client) - id = 56 # int | Vault ID -type = 'type_example' # str | Event type (optional) - - try: - # Get vault events by ID - api_response = api_instance.get_vault_events_by_id(id, type=type) - pprint(api_response) - except ApiException as e: - print("Exception when calling VaultsApi->get_vault_events_by_id: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **int**| Vault ID | - **type** | **str**| Event type | [optional] - -### Return type - -[**VaultEventsResponse**](VaultEventsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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_vaults_by_owner** -> VaultsResponse get_vaults_by_owner(owner=owner) - -Get vaults by owner query - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.VaultsApi(api_client) - owner = 'owner_example' # str | Ethereum address of the owner (optional) - - try: - # Get vaults by owner query - api_response = api_instance.get_vaults_by_owner(owner=owner) - pprint(api_response) - except ApiException as e: - print("Exception when calling VaultsApi->get_vaults_by_owner: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **owner** | **str**| Ethereum address of the owner | [optional] - -### Return type - -[**VaultsResponse**](VaultsResponse.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful response | - | -**400** | Bad request | - | -**404** | Not found | - | -**500** | Internal server error | - | - -[[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) - diff --git a/src/zarban/service/docs/VaultsResponse.md b/src/zarban/service/docs/VaultsResponse.md deleted file mode 100644 index fc5be05..0000000 --- a/src/zarban/service/docs/VaultsResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# VaultsResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**list[Vault]**](Vault.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/WalletBalance.md b/src/zarban/service/docs/WalletBalance.md deleted file mode 100644 index b2fba52..0000000 --- a/src/zarban/service/docs/WalletBalance.md +++ /dev/null @@ -1,10 +0,0 @@ -# WalletBalance - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**balances** | [**list[Balance]**](Balance.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/src/zarban/service/docs/WebsocketApi.md b/src/zarban/service/docs/WebsocketApi.md deleted file mode 100644 index 69ab298..0000000 --- a/src/zarban/service/docs/WebsocketApi.md +++ /dev/null @@ -1,66 +0,0 @@ -# zarban.service.openapi_client.WebsocketApi - -All URIs are relative to *https://api.zarban.io* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_unfilled_orders_websocket**](WebsocketApi.md#get_unfilled_orders_websocket) | **GET** /v2/ws | Websocket Upgrade - - -# **get_unfilled_orders_websocket** -> get_unfilled_orders_websocket() - -Websocket Upgrade - -Upgrade to websocket connection - -### Example - -```python -from __future__ import print_function -import time -import zarban.service.openapi_client -from zarban.service.openapi_client.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to https://api.zarban.io -# See configuration.py for a list of all supported configuration parameters. -configuration = zarban.service.openapi_client.Configuration( - host = "https://api.zarban.io" -) - - -# Enter a context with an instance of the API client -with zarban.service.openapi_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = zarban.service.openapi_client.WebsocketApi(api_client) - - try: - # Websocket Upgrade - api_instance.get_unfilled_orders_websocket() - except ApiException as e: - print("Exception when calling WebsocketApi->get_unfilled_orders_websocket: %s\n" % e) -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**101** | Switching Protocols | - | - -[[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) - diff --git a/src/zarban/service/openapi_client/models/method_parameters.py b/src/zarban/service/openapi_client/models/method_parameters.py index 40b9091..3aee56e 100644 --- a/src/zarban/service/openapi_client/models/method_parameters.py +++ b/src/zarban/service/openapi_client/models/method_parameters.py @@ -56,12 +56,9 @@ def __init__(self, to=None, calldata=None, value=None, local_vars_configuration= self._value = None self.discriminator = None - if to is not None: - self.to = to - if calldata is not None: - self.calldata = calldata - if value is not None: - self.value = value + self.to = to + self.calldata = calldata + self.value = value @property def to(self): @@ -81,9 +78,11 @@ def to(self, to): :param to: The to of this MethodParameters. # noqa: E501 :type: str """ + if self.local_vars_configuration.client_side_validation and to is None: # noqa: E501 + raise ValueError("Invalid value for `to`, must not be `None`") # noqa: E501 if (self.local_vars_configuration.client_side_validation and - to is not None and not re.search(r'^(0x)?[0-9a-fA-F]{40}$', to)): # noqa: E501 - raise ValueError(r"Invalid value for `to`, must be a follow pattern or equal to `/^(0x)?[0-9a-fA-F]{40}$/`") # noqa: E501 + to is not None and not re.search(r'^$|^(0x)?[0-9a-fA-F]{40}$', to)): # noqa: E501 + raise ValueError(r"Invalid value for `to`, must be a follow pattern or equal to `/^$|^(0x)?[0-9a-fA-F]{40}$/`") # noqa: E501 self._to = to @@ -105,6 +104,8 @@ def calldata(self, calldata): :param calldata: The calldata of this MethodParameters. # noqa: E501 :type: str """ + if self.local_vars_configuration.client_side_validation and calldata is None: # noqa: E501 + raise ValueError("Invalid value for `calldata`, must not be `None`") # noqa: E501 self._calldata = calldata @@ -126,6 +127,8 @@ def value(self, value): :param value: The value of this MethodParameters. # noqa: E501 :type: str """ + if self.local_vars_configuration.client_side_validation and value is None: # noqa: E501 + raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501 self._value = value diff --git a/src/zarban/service/test/test_method_parameters.py b/src/zarban/service/test/test_method_parameters.py index adbcd9a..5ba5c87 100644 --- a/src/zarban/service/test/test_method_parameters.py +++ b/src/zarban/service/test/test_method_parameters.py @@ -43,6 +43,9 @@ def make_instance(self, include_optional): ) else : return MethodParameters( + to = 'a', + calldata = '0', + value = '0', ) def testMethodParameters(self):