Update SDK Python to version 2.1.5

hoprnet · Nov 12, 2024 · 12043c7 · 12043c7
1 parent ca354f5
commit 12043c7
Show file tree

Hide file tree

Showing 102 changed files with 457 additions and 150 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,8 @@ This Rest API enables developers to interact with a hoprd node programatically t
 
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 3.1.0
-- Package version: 2.1.4
+- API version: 3.1.1
+- Package version: 2.1.5
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -110,10 +110,11 @@ Class | Method | HTTP request | Description
 *AccountApi* | [**addresses**](docs/AccountApi.md#addresses) | **GET** /api/v3/account/addresses | Get node&#x27;s HOPR and native addresses.
 *AccountApi* | [**balances**](docs/AccountApi.md#balances) | **GET** /api/v3/account/balances | Get node&#x27;s and associated Safe&#x27;s HOPR and native balances as the allowance for HOPR
 *AccountApi* | [**withdraw**](docs/AccountApi.md#withdraw) | **POST** /api/v3/account/withdraw | Withdraw funds from this node to the ethereum wallet address.
-*AliasApi* | [**aliases**](docs/AliasApi.md#aliases) | **GET** /api/v3/aliases | Get each previously set alias and its corresponding PeerId.
-*AliasApi* | [**delete_alias**](docs/AliasApi.md#delete_alias) | **DELETE** /api/v3/aliases/{alias} | Delete an alias.
-*AliasApi* | [**get_alias**](docs/AliasApi.md#get_alias) | **GET** /api/v3/aliases/{alias} | Get alias for the PeerId (Hopr address) that have this alias assigned to it.
-*AliasApi* | [**set_alias**](docs/AliasApi.md#set_alias) | **POST** /api/v3/aliases | Set alias for a peer with a specific PeerId.
+*AliasApi* | [**aliases**](docs/AliasApi.md#aliases) | **GET** /api/v3/aliases | (deprecated, will be removed in v3.0) Get each previously set alias and its corresponding PeerId.
+*AliasApi* | [**clear_aliases**](docs/AliasApi.md#clear_aliases) | **DELETE** /api/v3/aliases | (deprecated, will be removed in v3.0) Clear all aliases.
+*AliasApi* | [**delete_alias**](docs/AliasApi.md#delete_alias) | **DELETE** /api/v3/aliases/{alias} | (deprecated, will be removed in v3.0) Delete an alias.
+*AliasApi* | [**get_alias**](docs/AliasApi.md#get_alias) | **GET** /api/v3/aliases/{alias} | (deprecated, will be removed in v3.0) Get alias for the PeerId (Hopr address) that have this alias assigned to it.
+*AliasApi* | [**set_alias**](docs/AliasApi.md#set_alias) | **POST** /api/v3/aliases | (deprecated, will be removed in v3.0) Set alias for a peer with a specific PeerId.
 *ChannelsApi* | [**aggregate_tickets_in_channel**](docs/ChannelsApi.md#aggregate_tickets_in_channel) | **POST** /api/v3/channels/{channelId}/tickets/aggregate | Starts aggregation of tickets in the given channel.
 *ChannelsApi* | [**close_channel**](docs/ChannelsApi.md#close_channel) | **DELETE** /api/v3/channels/{channelId} | Closes the given channel.
 *ChannelsApi* | [**fund_channel**](docs/ChannelsApi.md#fund_channel) | **POST** /api/v3/channels/{channelId}/fund | Funds the given channel with the given amount of HOPR tokens.
@@ -181,6 +182,7 @@ Class | Method | HTTP request | Description
  - [TagQueryRequest](docs/TagQueryRequest.md)
  - [TicketPriceResponse](docs/TicketPriceResponse.md)
  - [WithdrawBodyRequest](docs/WithdrawBodyRequest.md)
+ - [WithdrawResponse](docs/WithdrawResponse.md)
 
 ## Documentation For Authorization
 

diff --git a/docs/AccountApi.md b/docs/AccountApi.md
@@ -109,7 +109,7 @@ This endpoint does not need any parameter.
 [[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**
-> AccountBalancesResponse withdraw(body)
+> WithdrawResponse withdraw(body)
 
 Withdraw funds from this node to the ethereum wallet address.
 
@@ -149,7 +149,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**AccountBalancesResponse**](AccountBalancesResponse.md)
+[**WithdrawResponse**](WithdrawResponse.md)
 
 ### Authorization
 

diff --git a/docs/AliasApi.md b/docs/AliasApi.md
@@ -4,17 +4,18 @@ All URIs are relative to */*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**aliases**](AliasApi.md#aliases) | **GET** /api/v3/aliases | Get each previously set alias and its corresponding PeerId.
-[**delete_alias**](AliasApi.md#delete_alias) | **DELETE** /api/v3/aliases/{alias} | Delete an alias.
-[**get_alias**](AliasApi.md#get_alias) | **GET** /api/v3/aliases/{alias} | Get alias for the PeerId (Hopr address) that have this alias assigned to it.
-[**set_alias**](AliasApi.md#set_alias) | **POST** /api/v3/aliases | Set alias for a peer with a specific PeerId.
+[**aliases**](AliasApi.md#aliases) | **GET** /api/v3/aliases | (deprecated, will be removed in v3.0) Get each previously set alias and its corresponding PeerId.
+[**clear_aliases**](AliasApi.md#clear_aliases) | **DELETE** /api/v3/aliases | (deprecated, will be removed in v3.0) Clear all aliases.
+[**delete_alias**](AliasApi.md#delete_alias) | **DELETE** /api/v3/aliases/{alias} | (deprecated, will be removed in v3.0) Delete an alias.
+[**get_alias**](AliasApi.md#get_alias) | **GET** /api/v3/aliases/{alias} | (deprecated, will be removed in v3.0) Get alias for the PeerId (Hopr address) that have this alias assigned to it.
+[**set_alias**](AliasApi.md#set_alias) | **POST** /api/v3/aliases | (deprecated, will be removed in v3.0) Set alias for a peer with a specific PeerId.
 
 # **aliases**
 > dict(str, str) aliases()
 
-Get each previously set alias and its corresponding PeerId.
+(deprecated, will be removed in v3.0) Get each previously set alias and its corresponding PeerId.
 
-Get each previously set alias and its corresponding PeerId.
+(deprecated, will be removed in v3.0) Get each previously set alias and its corresponding PeerId.
 
 ### Example
 ```python
@@ -34,7 +35,7 @@ configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
 api_instance = hoprd_sdk.AliasApi(hoprd_sdk.ApiClient(configuration))
 
 try:
-    # Get each previously set alias and its corresponding PeerId.
+    # (deprecated, will be removed in v3.0) Get each previously set alias and its corresponding PeerId.
     api_response = api_instance.aliases()
     pprint(api_response)
 except ApiException as e:
@@ -59,12 +60,61 @@ This endpoint does not need any parameter.
 
 [[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)
 
+# **clear_aliases**
+> clear_aliases()
+
+(deprecated, will be removed in v3.0) Clear all aliases.
+
+(deprecated, will be removed in v3.0) Clear all aliases.
+
+### Example
+```python
+from __future__ import print_function
+import time
+import hoprd_sdk
+from hoprd_sdk.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: api_token
+configuration = hoprd_sdk.Configuration()
+configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = hoprd_sdk.AliasApi(hoprd_sdk.ApiClient(configuration))
+
+try:
+    # (deprecated, will be removed in v3.0) Clear all aliases.
+    api_instance.clear_aliases()
+except ApiException as e:
+    print("Exception when calling AliasApi->clear_aliases: %s\n" % e)
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[api_token](../README.md#api_token), [bearer_token](../README.md#bearer_token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[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)
+
 # **delete_alias**
 > delete_alias(alias)
 
-Delete an alias.
+(deprecated, will be removed in v3.0) Delete an alias.
 
-Delete an alias.
+(deprecated, will be removed in v3.0) Delete an alias.
 
 ### Example
 ```python
@@ -85,7 +135,7 @@ api_instance = hoprd_sdk.AliasApi(hoprd_sdk.ApiClient(configuration))
 alias = 'alias_example' # str | Alias to be shown
 
 try:
-    # Delete an alias.
+    # (deprecated, will be removed in v3.0) Delete an alias.
     api_instance.delete_alias(alias)
 except ApiException as e:
     print("Exception when calling AliasApi->delete_alias: %s\n" % e)
@@ -115,9 +165,9 @@ void (empty response body)
 # **get_alias**
 > PeerIdResponse get_alias(alias)
 
-Get alias for the PeerId (Hopr address) that have this alias assigned to it.
+(deprecated, will be removed in v3.0) Get alias for the PeerId (Hopr address) that have this alias assigned to it.
 
-Get alias for the PeerId (Hopr address) that have this alias assigned to it.
+(deprecated, will be removed in v3.0) Get alias for the PeerId (Hopr address) that have this alias assigned to it.
 
 ### Example
 ```python
@@ -138,7 +188,7 @@ api_instance = hoprd_sdk.AliasApi(hoprd_sdk.ApiClient(configuration))
 alias = 'alias_example' # str | Alias to be shown
 
 try:
-    # Get alias for the PeerId (Hopr address) that have this alias assigned to it.
+    # (deprecated, will be removed in v3.0) Get alias for the PeerId (Hopr address) that have this alias assigned to it.
     api_response = api_instance.get_alias(alias)
     pprint(api_response)
 except ApiException as e:
@@ -169,9 +219,9 @@ Name | Type | Description  | Notes
 # **set_alias**
 > PeerIdResponse set_alias(body)
 
-Set alias for a peer with a specific PeerId.
+(deprecated, will be removed in v3.0) Set alias for a peer with a specific PeerId.
 
-Set alias for a peer with a specific PeerId.
+(deprecated, will be removed in v3.0) Set alias for a peer with a specific PeerId.
 
 ### Example
 ```python
@@ -192,7 +242,7 @@ api_instance = hoprd_sdk.AliasApi(hoprd_sdk.ApiClient(configuration))
 body = hoprd_sdk.AliasPeerIdBodyRequest() # AliasPeerIdBodyRequest | Alias name along with the PeerId to be aliased
 
 try:
-    # Set alias for a peer with a specific PeerId.
+    # (deprecated, will be removed in v3.0) Set alias for a peer with a specific PeerId.
     api_response = api_instance.set_alias(body)
     pprint(api_response)
 except ApiException as e:

diff --git a/docs/SendMessageBodyRequest.md b/docs/SendMessageBodyRequest.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **hops** | **int** |  | [optional] 
 **path** | **list[str]** |  | [optional] 
 **peer_id** | **str** | The recipient HOPR PeerId | 
-**tag** | **int** | The message tag used to filter messages based on application | 
+**tag** | **int** | The message tag used to filter messages based on application, must be from range &lt;1024,65535&gt; | 
 
 [[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/docs/WithdrawResponse.md b/docs/WithdrawResponse.md
@@ -0,0 +1,9 @@
+# WithdrawResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**receipt** | **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/hoprd_sdk/__init__.py b/hoprd_sdk/__init__.py
@@ -7,7 +7,7 @@
 
     This Rest API enables developers to interact with a hoprd node programatically through HTTP.  # noqa: E501
 
-    OpenAPI spec version: 3.1.0
+    OpenAPI spec version: 3.1.1
     Contact: [email protected]
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -63,3 +63,4 @@
 from hoprd_sdk.models.tag_query_request import TagQueryRequest
 from hoprd_sdk.models.ticket_price_response import TicketPriceResponse
 from hoprd_sdk.models.withdraw_body_request import WithdrawBodyRequest
+from hoprd_sdk.models.withdraw_response import WithdrawResponse
diff --git a/hoprd_sdk/api/account_api.py b/hoprd_sdk/api/account_api.py
@@ -5,7 +5,7 @@
 
     This Rest API enables developers to interact with a hoprd node programatically through HTTP.  # noqa: E501
 
-    OpenAPI spec version: 3.1.0
+    OpenAPI spec version: 3.1.1
     Contact: [email protected]
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -217,7 +217,7 @@ def withdraw(self, body, **kwargs):  # noqa: E501
 
         :param async_req bool
         :param WithdrawBodyRequest body: (required)
-        :return: AccountBalancesResponse
+        :return: WithdrawResponse
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -239,7 +239,7 @@ def withdraw_with_http_info(self, body, **kwargs):  # noqa: E501
 
         :param async_req bool
         :param WithdrawBodyRequest body: (required)
-        :return: AccountBalancesResponse
+        :return: WithdrawResponse
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -297,7 +297,7 @@ def withdraw_with_http_info(self, body, **kwargs):  # noqa: E501
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='AccountBalancesResponse',  # noqa: E501
+            response_type='WithdrawResponse',  # noqa: E501
             auth_settings=auth_settings,
             async_req=params.get('async_req'),
             _return_http_data_only=params.get('_return_http_data_only'),