Update SDK Python to version 2.1.0-rc.4 (#40)

Co-authored-by: hopr-bot <[email protected]>
hoprnet · May 8, 2024 · f7495a3 · f7495a3
1 parent ee1cef7
commit f7495a3
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ API server using the hopr-lib created HOPR node and exposing it using a HTTP RES
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 0.2.1
-- Package version: 2.1.0-rc.3
+- Package version: 2.1.0-rc.4
 - Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
 
 ## Requirements.
@@ -110,7 +110,7 @@ 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* | [**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.
@@ -122,7 +122,7 @@ Class | Method | HTTP request | Description
 *ChannelsApi* | [**redeem_tickets_in_channel**](docs/ChannelsApi.md#redeem_tickets_in_channel) | **POST** /api/v3/channels/{channelId}/tickets/redeem | Starts redeeming all tickets in the given channel.
 *ChannelsApi* | [**show_channel**](docs/ChannelsApi.md#show_channel) | **GET** /api/v3/channels/{channelId} | Returns information about the given channel.
 *ChannelsApi* | [**show_channel_tickets**](docs/ChannelsApi.md#show_channel_tickets) | **GET** /api/v3/channels/{channelId}/tickets | Lists all tickets for the given channel  ID.
-*ChecksApi* | [**healthyz**](docs/ChecksApi.md#healthyz) | **GET** /healthyz | Check whether the node is healthy
+*ChecksApi* | [**healthyz**](docs/ChecksApi.md#healthyz) | **GET** /healthyz | Check whether the node is healthy.
 *ChecksApi* | [**readyz**](docs/ChecksApi.md#readyz) | **GET** /readyz | Check whether the node is ready to accept connections.
 *ChecksApi* | [**startedz**](docs/ChecksApi.md#startedz) | **GET** /startedz | Check whether the node is started.
 *ConfigurationApi* | [**configuration**](docs/ConfigurationApi.md#configuration) | **GET** /api/v3/node/configuration | Get the configuration of the running node.
@@ -142,7 +142,7 @@ Class | Method | HTTP request | Description
 *PeersApi* | [**ping_peer**](docs/PeersApi.md#ping_peer) | **POST** /api/v3/peers/{peerId}/ping | Directly pings the given peer.
 *PeersApi* | [**show_peer_info**](docs/PeersApi.md#show_peer_info) | **GET** /api/v3/peers/{peerId} | Returns transport-related information about the given peer.
 *TicketsApi* | [**redeem_all_tickets**](docs/TicketsApi.md#redeem_all_tickets) | **POST** /api/v3/tickets/redeem | Starts redeeming of all tickets in all channels.
-*TicketsApi* | [**show_all_tickets**](docs/TicketsApi.md#show_all_tickets) | **GET** /api/v3/tickets | Returns all the tickets in all the channels.
+*TicketsApi* | [**show_all_tickets**](docs/TicketsApi.md#show_all_tickets) | **GET** /api/v3/tickets | Endpoint is deprecated and will be removed in the future. Returns an empty array.
 *TicketsApi* | [**show_ticket_statistics**](docs/TicketsApi.md#show_ticket_statistics) | **GET** /api/v3/tickets/statistics | Returns current complete statistics on tickets.
 
 ## Documentation For Models

diff --git a/docs/AliasApi.md b/docs/AliasApi.md
@@ -4,17 +4,17 @@ 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
+[**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**
 > dict(str, str) aliases()
 
-Get each previously set alias and its corresponding PeerId
+Get each previously set alias and its corresponding PeerId.
 
-Get each previously set alias and its corresponding PeerId
+Get each previously set alias and its corresponding PeerId.
 
 ### Example
 ```python
@@ -34,7 +34,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
+    # Get each previously set alias and its corresponding PeerId.
     api_response = api_instance.aliases()
     pprint(api_response)
 except ApiException as e:

diff --git a/docs/ChecksApi.md b/docs/ChecksApi.md
@@ -4,16 +4,16 @@ All URIs are relative to */*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**healthyz**](ChecksApi.md#healthyz) | **GET** /healthyz | Check whether the node is healthy
+[**healthyz**](ChecksApi.md#healthyz) | **GET** /healthyz | Check whether the node is healthy.
 [**readyz**](ChecksApi.md#readyz) | **GET** /readyz | Check whether the node is ready to accept connections.
 [**startedz**](ChecksApi.md#startedz) | **GET** /startedz | Check whether the node is started.
 
 # **healthyz**
 > healthyz()
 
-Check whether the node is healthy
+Check whether the node is healthy.
 
-Check whether the node is healthy
+Check whether the node is healthy.
 
 ### Example
 ```python
@@ -27,7 +27,7 @@ from pprint import pprint
 api_instance = hoprd_sdk.ChecksApi()
 
 try:
-    # Check whether the node is healthy
+    # Check whether the node is healthy.
     api_instance.healthyz()
 except ApiException as e:
     print("Exception when calling ChecksApi->healthyz: %s\n" % e)

diff --git a/docs/TicketsApi.md b/docs/TicketsApi.md
@@ -5,7 +5,7 @@ All URIs are relative to */*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**redeem_all_tickets**](TicketsApi.md#redeem_all_tickets) | **POST** /api/v3/tickets/redeem | Starts redeeming of all tickets in all channels.
-[**show_all_tickets**](TicketsApi.md#show_all_tickets) | **GET** /api/v3/tickets | Returns all the tickets in all the channels.
+[**show_all_tickets**](TicketsApi.md#show_all_tickets) | **GET** /api/v3/tickets | Endpoint is deprecated and will be removed in the future. Returns an empty array.
 [**show_ticket_statistics**](TicketsApi.md#show_ticket_statistics) | **GET** /api/v3/tickets/statistics | Returns current complete statistics on tickets.
 
 # **redeem_all_tickets**
@@ -60,9 +60,9 @@ void (empty response body)
 # **show_all_tickets**
 > list[ChannelTicket] show_all_tickets()
 
-Returns all the tickets in all the channels.
+Endpoint is deprecated and will be removed in the future. Returns an empty array.
 
-Returns all the tickets in all the channels.
+Endpoint is deprecated and will be removed in the future. Returns an empty array.
 
 ### Example
 ```python
@@ -82,7 +82,7 @@ configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
 api_instance = hoprd_sdk.TicketsApi(hoprd_sdk.ApiClient(configuration))
 
 try:
-    # Returns all the tickets in all the channels.
+    # Endpoint is deprecated and will be removed in the future. Returns an empty array.
     api_response = api_instance.show_all_tickets()
     pprint(api_response)
 except ApiException as e:

diff --git a/hoprd_sdk/api/alias_api.py b/hoprd_sdk/api/alias_api.py
@@ -33,9 +33,9 @@ def __init__(self, api_client=None):
         self.api_client = api_client
 
     def aliases(self, **kwargs):  # noqa: E501
-        """Get each previously set alias and its corresponding PeerId  # noqa: E501
+        """Get each previously set alias and its corresponding PeerId.  # noqa: E501
 
-        Get each previously set alias and its corresponding PeerId  # noqa: E501
+        Get each previously set alias and its corresponding PeerId.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.aliases(async_req=True)
@@ -54,9 +54,9 @@ def aliases(self, **kwargs):  # noqa: E501
             return data
 
     def aliases_with_http_info(self, **kwargs):  # noqa: E501
-        """Get each previously set alias and its corresponding PeerId  # noqa: E501
+        """Get each previously set alias and its corresponding PeerId.  # noqa: E501
 
-        Get each previously set alias and its corresponding PeerId  # noqa: E501
+        Get each previously set alias and its corresponding PeerId.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.aliases_with_http_info(async_req=True)

diff --git a/hoprd_sdk/api/checks_api.py b/hoprd_sdk/api/checks_api.py
@@ -33,9 +33,9 @@ def __init__(self, api_client=None):
         self.api_client = api_client
 
     def healthyz(self, **kwargs):  # noqa: E501
-        """Check whether the node is healthy  # noqa: E501
+        """Check whether the node is healthy.  # noqa: E501
 
-        Check whether the node is healthy  # noqa: E501
+        Check whether the node is healthy.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.healthyz(async_req=True)
@@ -54,9 +54,9 @@ def healthyz(self, **kwargs):  # noqa: E501
             return data
 
     def healthyz_with_http_info(self, **kwargs):  # noqa: E501
-        """Check whether the node is healthy  # noqa: E501
+        """Check whether the node is healthy.  # noqa: E501
 
-        Check whether the node is healthy  # noqa: E501
+        Check whether the node is healthy.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.healthyz_with_http_info(async_req=True)

diff --git a/hoprd_sdk/api/tickets_api.py b/hoprd_sdk/api/tickets_api.py
@@ -120,9 +120,9 @@ def redeem_all_tickets_with_http_info(self, **kwargs):  # noqa: E501
             collection_formats=collection_formats)
 
     def show_all_tickets(self, **kwargs):  # noqa: E501
-        """Returns all the tickets in all the channels.  # noqa: E501
+        """Endpoint is deprecated and will be removed in the future. Returns an empty array.  # noqa: E501
 
-        Returns all the tickets in all the channels.  # noqa: E501
+        Endpoint is deprecated and will be removed in the future. Returns an empty array.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.show_all_tickets(async_req=True)
@@ -141,9 +141,9 @@ def show_all_tickets(self, **kwargs):  # noqa: E501
             return data
 
     def show_all_tickets_with_http_info(self, **kwargs):  # noqa: E501
-        """Returns all the tickets in all the channels.  # noqa: E501
+        """Endpoint is deprecated and will be removed in the future. Returns an empty array.  # noqa: E501
 
-        Returns all the tickets in all the channels.  # noqa: E501
+        Endpoint is deprecated and will be removed in the future. Returns an empty array.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
         >>> thread = api.show_all_tickets_with_http_info(async_req=True)

diff --git a/hoprd_sdk/api_client.py b/hoprd_sdk/api_client.py
@@ -73,7 +73,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/2.1.0-rc.3/python'
+        self.user_agent = 'Swagger-Codegen/2.1.0-rc.4/python'
 
     def __enter__(self):
         return self

diff --git a/hoprd_sdk/api_client.py.orig b/hoprd_sdk/api_client.py.orig
@@ -72,7 +72,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/2.1.0-rc.3/python'
+        self.user_agent = 'Swagger-Codegen/2.1.0-rc.4/python'
 
     def __del__(self):
         self.pool.close()

diff --git a/hoprd_sdk/configuration.py b/hoprd_sdk/configuration.py
@@ -250,5 +250,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.2.1\n"\
-               "SDK Package Version: 2.1.0-rc.3".\
+               "SDK Package Version: 2.1.0-rc.4".\
                format(env=sys.platform, pyversion=sys.version)
diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "hoprd-sdk"
-VERSION = "2.1.0-rc.3"
+VERSION = "2.1.0-rc.4"
 # To install the library, run the following
 #
 # python setup.py install

diff --git a/test/test_alias_api.py b/test/test_alias_api.py
@@ -31,7 +31,7 @@ def tearDown(self):
     def test_aliases(self):
         """Test case for aliases
 
-        Get each previously set alias and its corresponding PeerId  # noqa: E501
+        Get each previously set alias and its corresponding PeerId.  # noqa: E501
         """
         pass
 

diff --git a/test/test_checks_api.py b/test/test_checks_api.py
@@ -31,7 +31,7 @@ def tearDown(self):
     def test_healthyz(self):
         """Test case for healthyz
 
-        Check whether the node is healthy  # noqa: E501
+        Check whether the node is healthy.  # noqa: E501
         """
         pass
 

diff --git a/test/test_tickets_api.py b/test/test_tickets_api.py
@@ -38,7 +38,7 @@ def test_redeem_all_tickets(self):
     def test_show_all_tickets(self):
         """Test case for show_all_tickets
 
-        Returns all the tickets in all the channels.  # noqa: E501
+        Endpoint is deprecated and will be removed in the future. Returns an empty array.  # noqa: E501
         """
         pass