Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

Bump SDK to 2.2.0-rc.1 #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.0.54
3.0.62
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.0
- API version: 3.10.0
- Package version: 2.2.0-rc.1
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

## Requirements.
Expand Down Expand Up @@ -110,10 +110,11 @@ Class | Method | HTTP request | Description
*AccountApi* | [**addresses**](docs/AccountApi.md#addresses) | **GET** /api/v3/account/addresses | Get node's HOPR and native addresses.
*AccountApi* | [**balances**](docs/AccountApi.md#balances) | **GET** /api/v3/account/balances | Get node's and associated Safe'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 as a hashmap.
*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.
Expand All @@ -122,6 +123,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* | [**eligiblez**](docs/ChecksApi.md#eligiblez) | **GET** /eligiblez | Check whether the node is eligible in the network.
*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.
Expand All @@ -134,22 +136,28 @@ Class | Method | HTTP request | Description
*MessagesApi* | [**send_message**](docs/MessagesApi.md#send_message) | **POST** /api/v3/messages | Send a message to another peer using the given path.
*MessagesApi* | [**size**](docs/MessagesApi.md#size) | **GET** /api/v3/messages/size | Get size of filtered message inbox for a specific tag
*NetworkApi* | [**price**](docs/NetworkApi.md#price) | **GET** /api/v3/network/price | Obtains the current ticket price.
*NetworkApi* | [**probability**](docs/NetworkApi.md#probability) | **GET** /api/v3/network/probability | Gets the current minimum incoming ticket winning probability defined by the network.
*NodeApi* | [**channel_graph**](docs/NodeApi.md#channel_graph) | **GET** /api/v3/node/graph | Retrieve node's channel graph in DOT or JSON format.
*NodeApi* | [**entry_nodes**](docs/NodeApi.md#entry_nodes) | **GET** /api/v3/node/entryNodes | List all known entry nodes with multiaddrs and eligibility.
*NodeApi* | [**info**](docs/NodeApi.md#info) | **GET** /api/v3/node/info | Get information about this HOPR Node.
*NodeApi* | [**metrics**](docs/NodeApi.md#metrics) | **GET** /api/v3/node/metrics | Retrieve Prometheus metrics from the running node.
*NodeApi* | [**peers**](docs/NodeApi.md#peers) | **GET** /api/v3/node/peers | Lists information for `connected peers` and `announced peers`.
*NodeApi* | [**version**](docs/NodeApi.md#version) | **GET** /api/v3/node/version | Get release version of the running node.
*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.
*NodeApi* | [**version**](docs/NodeApi.md#version) | **GET** /api/v3/node/version | Get the release version of the running node.
*PeersApi* | [**ping_peer**](docs/PeersApi.md#ping_peer) | **POST** /api/v3/peers/{destination}/ping | Directly pings the given peer.
*PeersApi* | [**show_peer_info**](docs/PeersApi.md#show_peer_info) | **GET** /api/v3/peers/{destination} | Returns transport-related information about the given peer.
*SessionApi* | [**close_client**](docs/SessionApi.md#close_client) | **DELETE** /api/v3/session/{protocol}/{ip}/{port} | Closes an existing Session listener.
*SessionApi* | [**create_client**](docs/SessionApi.md#create_client) | **POST** /api/v3/session/{protocol} | Creates a new client session returning the given session listening host and port over TCP or UDP.
*SessionApi* | [**list_clients**](docs/SessionApi.md#list_clients) | **GET** /api/v3/session/{protocol} | Lists existing Session listeners for the given IP protocol.
*TicketsApi* | [**redeem_all_tickets**](docs/TicketsApi.md#redeem_all_tickets) | **POST** /api/v3/tickets/redeem | Starts redeeming of all tickets in all channels.
*TicketsApi* | [**reset_ticket_statistics**](docs/TicketsApi.md#reset_ticket_statistics) | **DELETE** /api/v3/tickets/statistics | Resets the ticket metrics.
*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

- [AccountAddressesResponse](docs/AccountAddressesResponse.md)
- [AccountBalancesResponse](docs/AccountBalancesResponse.md)
- [AliasPeerIdBodyRequest](docs/AliasPeerIdBodyRequest.md)
- [AliasDestinationBodyRequest](docs/AliasDestinationBodyRequest.md)
- [AnnouncedPeer](docs/AnnouncedPeer.md)
- [ApiError](docs/ApiError.md)
- [ChannelInfoResponse](docs/ChannelInfoResponse.md)
Expand All @@ -159,7 +167,9 @@ Class | Method | HTTP request | Description
- [EntryNode](docs/EntryNode.md)
- [FundBodyRequest](docs/FundBodyRequest.md)
- [GetMessageBodyRequest](docs/GetMessageBodyRequest.md)
- [GraphExportQuery](docs/GraphExportQuery.md)
- [HeartbeatInfo](docs/HeartbeatInfo.md)
- [IpProtocol](docs/IpProtocol.md)
- [MessagePopAllResponse](docs/MessagePopAllResponse.md)
- [MessagePopResponse](docs/MessagePopResponse.md)
- [NodeChannel](docs/NodeChannel.md)
Expand All @@ -175,12 +185,19 @@ Class | Method | HTTP request | Description
- [PeerIdResponse](docs/PeerIdResponse.md)
- [PeerInfo](docs/PeerInfo.md)
- [PingResponse](docs/PingResponse.md)
- [RoutingOptions](docs/RoutingOptions.md)
- [SendMessageBodyRequest](docs/SendMessageBodyRequest.md)
- [SendMessageResponse](docs/SendMessageResponse.md)
- [SessionCapability](docs/SessionCapability.md)
- [SessionClientRequest](docs/SessionClientRequest.md)
- [SessionClientResponse](docs/SessionClientResponse.md)
- [SessionTargetSpec](docs/SessionTargetSpec.md)
- [SizeResponse](docs/SizeResponse.md)
- [TagQueryRequest](docs/TagQueryRequest.md)
- [TicketPriceResponse](docs/TicketPriceResponse.md)
- [TicketProbabilityResponse](docs/TicketProbabilityResponse.md)
- [WithdrawBodyRequest](docs/WithdrawBodyRequest.md)
- [WithdrawResponse](docs/WithdrawResponse.md)

## Documentation For Authorization

Expand Down
10 changes: 5 additions & 5 deletions docs/AccountApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Method | HTTP request | Description

Get node's HOPR and native addresses.

Get node's HOPR and native addresses. HOPR address is represented by the P2P PeerId and can be used by other node owner to interact with this node.
HOPR address is represented by the P2P PeerId and can be used by other node owner to interact with this node.

### Example
```python
Expand Down Expand Up @@ -63,7 +63,7 @@ This endpoint does not need any parameter.

Get node's and associated Safe's HOPR and native balances as the allowance for HOPR

Get node's and associated Safe's HOPR and native balances as the allowance for HOPR tokens to be drawn by HoprChannels from Safe. HOPR tokens from the Safe balance are used to fund the payment channels between this node and other nodes on the network. NATIVE balance of the Node is used to pay for the gas fees for the blockchain.
tokens to be drawn by HoprChannels from Safe. HOPR tokens from the Safe balance are used to fund the payment channels between this node and other nodes on the network. NATIVE balance of the Node is used to pay for the gas fees for the blockchain.

### Example
```python
Expand Down Expand Up @@ -109,11 +109,11 @@ 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.

Withdraw funds from this node to the ethereum wallet address. Both NATIVE or HOPR can be withdrawn using this method.
Both Native or HOPR can be withdrawn using this method.

### Example
```python
Expand Down Expand Up @@ -149,7 +149,7 @@ Name | Type | Description | Notes

### Return type

[**AccountBalancesResponse**](AccountBalancesResponse.md)
[**WithdrawResponse**](WithdrawResponse.md)

### Authorization

Expand Down
84 changes: 62 additions & 22 deletions docs/AliasApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ 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 as a hashmap.
[**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.

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 as a hashmap.

### Example
```python
Expand All @@ -34,7 +33,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 as a hashmap.
api_response = api_instance.aliases()
pprint(api_response)
except ApiException as e:
Expand All @@ -59,12 +58,57 @@ 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.

### 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.

Delete an alias.
(deprecated, will be removed in v3.0) Delete an alias.

### Example
```python
Expand All @@ -85,7 +129,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)
Expand Down Expand Up @@ -115,9 +159,7 @@ void (empty response body)
# **get_alias**
> PeerIdResponse get_alias(alias)

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
Expand All @@ -138,7 +180,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:
Expand Down Expand Up @@ -169,9 +211,7 @@ Name | Type | Description | Notes
# **set_alias**
> PeerIdResponse set_alias(body)

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
Expand All @@ -189,10 +229,10 @@ configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = hoprd_sdk.AliasApi(hoprd_sdk.ApiClient(configuration))
body = hoprd_sdk.AliasPeerIdBodyRequest() # AliasPeerIdBodyRequest | Alias name along with the PeerId to be aliased
body = hoprd_sdk.AliasDestinationBodyRequest() # AliasDestinationBodyRequest | 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:
Expand All @@ -203,7 +243,7 @@ except ApiException as e:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**AliasPeerIdBodyRequest**](AliasPeerIdBodyRequest.md)| Alias name along with the PeerId to be aliased |
**body** | [**AliasDestinationBodyRequest**](AliasDestinationBodyRequest.md)| Alias name along with the PeerId to be aliased |

### Return type

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alias** | **str** | |
**destination** | **str** | | [optional]
**peer_id** | **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)

Loading
Loading