Skip to content

Commit

Permalink
generate from spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@myrho
myrho committed Apr 5, 2024
1 parent cc840f6 commit cb7670a
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 4 deletions.
13 changes: 11 additions & 2 deletions docs/AddressesApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ Get outgoing transactions between two addresses
import time
import graphsense
from graphsense.api import addresses_api
from graphsense.model.height import Height
from graphsense.model.links import Links
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
Expand All @@ -218,6 +219,9 @@ with graphsense.ApiClient(configuration) as api_client:
currency = "btc" # str | The cryptocurrency code (e.g., btc)
address = "addressA" # str | The cryptocurrency address
neighbor = "addressE" # str | Neighbor address
min_height = Height(1) # Height | Return transactions starting from given height (optional)
max_height = Height(2) # Height | Return transactions up to (including) given height (optional)
order = "desc" # str | Sorting order (optional) if omitted the server will use the default value of "desc"
page = "page_example" # str | Resumption token for retrieving the next page (optional)
pagesize = 10 # int | Number of items returned in a single page (optional)

Expand All @@ -233,7 +237,7 @@ with graphsense.ApiClient(configuration) as api_client:
# and optional values
try:
# Get outgoing transactions between two addresses
api_response = api_instance.list_address_links(currency, address, neighbor, page=page, pagesize=pagesize)
api_response = api_instance.list_address_links(currency, address, neighbor, min_height=min_height, max_height=max_height, order=order, page=page, pagesize=pagesize)
pprint(api_response)
except graphsense.ApiException as e:
print("Exception when calling AddressesApi->list_address_links: %s\n" % e)
Expand All @@ -247,6 +251,9 @@ Name | Type | Description | Notes
**currency** | **str**| The cryptocurrency code (e.g., btc) |
**address** | **str**| The cryptocurrency address |
**neighbor** | **str**| Neighbor address |
**min_height** | **Height**| Return transactions starting from given height | [optional]
**max_height** | **Height**| Return transactions up to (including) given height | [optional]
**order** | **str**| Sorting order | [optional] if omitted the server will use the default value of "desc"
**page** | **str**| Resumption token for retrieving the next page | [optional]
**pagesize** | **int**| Number of items returned in a single page | [optional]
**_preload_content** | **bool** | If False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. | [optional] default is True.
Expand Down Expand Up @@ -425,6 +432,7 @@ with graphsense.ApiClient(configuration) as api_client:
direction = "out" # str | Incoming or outgoing transactions (optional)
min_height = Height(1) # Height | Return transactions starting from given height (optional)
max_height = Height(2) # Height | Return transactions up to (including) given height (optional)
order = "desc" # str | Sorting order (optional) if omitted the server will use the default value of "desc"
token_currency = "WETH" # str | Return transactions of given token currency (optional)
page = "page_example" # str | Resumption token for retrieving the next page (optional)
pagesize = 10 # int | Number of items returned in a single page (optional)
Expand All @@ -441,7 +449,7 @@ with graphsense.ApiClient(configuration) as api_client:
# and optional values
try:
# Get all transactions an address has been involved in
api_response = api_instance.list_address_txs(currency, address, direction=direction, min_height=min_height, max_height=max_height, token_currency=token_currency, page=page, pagesize=pagesize)
api_response = api_instance.list_address_txs(currency, address, direction=direction, min_height=min_height, max_height=max_height, order=order, token_currency=token_currency, page=page, pagesize=pagesize)
pprint(api_response)
except graphsense.ApiException as e:
print("Exception when calling AddressesApi->list_address_txs: %s\n" % e)
Expand All @@ -457,6 +465,7 @@ Name | Type | Description | Notes
**direction** | **str**| Incoming or outgoing transactions | [optional]
**min_height** | **Height**| Return transactions starting from given height | [optional]
**max_height** | **Height**| Return transactions up to (including) given height | [optional]
**order** | **str**| Sorting order | [optional] if omitted the server will use the default value of "desc"
**token_currency** | **str**| Return transactions of given token currency | [optional]
**page** | **str**| Resumption token for retrieving the next page | [optional]
**pagesize** | **int**| Number of items returned in a single page | [optional]
Expand Down
13 changes: 11 additions & 2 deletions docs/EntitiesApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,7 @@ Get transactions between two entities
import time
import graphsense
from graphsense.api import entities_api
from graphsense.model.height import Height
from graphsense.model.links import Links
from pprint import pprint
# Defining the host is optional and defaults to https://api.ikna.io
Expand All @@ -342,6 +343,9 @@ with graphsense.ApiClient(configuration) as api_client:
currency = "btc" # str | The cryptocurrency code (e.g., btc)
entity = 67065 # int | The entity ID
neighbor = 123456 # int | Neighbor entity
min_height = Height(1) # Height | Return transactions starting from given height (optional)
max_height = Height(2) # Height | Return transactions up to (including) given height (optional)
order = "desc" # str | Sorting order (optional) if omitted the server will use the default value of "desc"
page = "page_example" # str | Resumption token for retrieving the next page (optional)
pagesize = 10 # int | Number of items returned in a single page (optional)

Expand All @@ -357,7 +361,7 @@ with graphsense.ApiClient(configuration) as api_client:
# and optional values
try:
# Get transactions between two entities
api_response = api_instance.list_entity_links(currency, entity, neighbor, page=page, pagesize=pagesize)
api_response = api_instance.list_entity_links(currency, entity, neighbor, min_height=min_height, max_height=max_height, order=order, page=page, pagesize=pagesize)
pprint(api_response)
except graphsense.ApiException as e:
print("Exception when calling EntitiesApi->list_entity_links: %s\n" % e)
Expand All @@ -371,6 +375,9 @@ Name | Type | Description | Notes
**currency** | **str**| The cryptocurrency code (e.g., btc) |
**entity** | **int**| The entity ID |
**neighbor** | **int**| Neighbor entity |
**min_height** | **Height**| Return transactions starting from given height | [optional]
**max_height** | **Height**| Return transactions up to (including) given height | [optional]
**order** | **str**| Sorting order | [optional] if omitted the server will use the default value of "desc"
**page** | **str**| Resumption token for retrieving the next page | [optional]
**pagesize** | **int**| Number of items returned in a single page | [optional]
**_preload_content** | **bool** | If False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. | [optional] default is True.
Expand Down Expand Up @@ -553,6 +560,7 @@ with graphsense.ApiClient(configuration) as api_client:
direction = "out" # str | Incoming or outgoing transactions (optional)
min_height = Height(1) # Height | Return transactions starting from given height (optional)
max_height = Height(2) # Height | Return transactions up to (including) given height (optional)
order = "desc" # str | Sorting order (optional) if omitted the server will use the default value of "desc"
token_currency = "WETH" # str | Return transactions of given token currency (optional)
page = "page_example" # str | Resumption token for retrieving the next page (optional)
pagesize = 10 # int | Number of items returned in a single page (optional)
Expand All @@ -569,7 +577,7 @@ with graphsense.ApiClient(configuration) as api_client:
# and optional values
try:
# Get all transactions an entity has been involved in
api_response = api_instance.list_entity_txs(currency, entity, direction=direction, min_height=min_height, max_height=max_height, token_currency=token_currency, page=page, pagesize=pagesize)
api_response = api_instance.list_entity_txs(currency, entity, direction=direction, min_height=min_height, max_height=max_height, order=order, token_currency=token_currency, page=page, pagesize=pagesize)
pprint(api_response)
except graphsense.ApiException as e:
print("Exception when calling EntitiesApi->list_entity_txs: %s\n" % e)
Expand All @@ -585,6 +593,7 @@ Name | Type | Description | Notes
**direction** | **str**| Incoming or outgoing transactions | [optional]
**min_height** | **Height**| Return transactions starting from given height | [optional]
**max_height** | **Height**| Return transactions up to (including) given height | [optional]
**order** | **str**| Sorting order | [optional] if omitted the server will use the default value of "desc"
**token_currency** | **str**| Return transactions of given token currency | [optional]
**page** | **str**| Resumption token for retrieving the next page | [optional]
**pagesize** | **int**| Number of items returned in a single page | [optional]
Expand Down
36 changes: 36 additions & 0 deletions graphsense/api/addresses_api.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,9 @@ def __list_address_links(
neighbor (str): Neighbor address
Keyword Args:
min_height (Height): Return transactions starting from given height. [optional]
max_height (Height): Return transactions up to (including) given height. [optional]
order (str): Sorting order. [optional] if omitted the server will use the default value of "desc"
page (str): Resumption token for retrieving the next page. [optional]
pagesize (int): Number of items returned in a single page. [optional]
_return_http_data_only (bool): response data without head status
Expand Down Expand Up @@ -390,6 +393,9 @@ def __list_address_links(
'currency',
'address',
'neighbor',
'min_height',
'max_height',
'order',
'page',
'pagesize',
],
Expand All @@ -401,6 +407,7 @@ def __list_address_links(
'nullable': [
],
'enum': [
'order',
],
'validation': [
'pagesize',
Expand All @@ -414,6 +421,11 @@ def __list_address_links(
},
},
'allowed_values': {
('order',): {

"ASC": "asc",
"DESC": "desc"
},
},
'openapi_types': {
'currency':
Expand All @@ -422,6 +434,12 @@ def __list_address_links(
(str,),
'neighbor':
(str,),
'min_height':
(Height,),
'max_height':
(Height,),
'order':
(str,),
'page':
(str,),
'pagesize':
Expand All @@ -431,13 +449,19 @@ def __list_address_links(
'currency': 'currency',
'address': 'address',
'neighbor': 'neighbor',
'min_height': 'min_height',
'max_height': 'max_height',
'order': 'order',
'page': 'page',
'pagesize': 'pagesize',
},
'location_map': {
'currency': 'path',
'address': 'path',
'neighbor': 'query',
'min_height': 'query',
'max_height': 'query',
'order': 'query',
'page': 'query',
'pagesize': 'query',
},
Expand Down Expand Up @@ -650,6 +674,7 @@ def __list_address_txs(
direction (str): Incoming or outgoing transactions. [optional]
min_height (Height): Return transactions starting from given height. [optional]
max_height (Height): Return transactions up to (including) given height. [optional]
order (str): Sorting order. [optional] if omitted the server will use the default value of "desc"
token_currency (str): Return transactions of given token currency. [optional]
page (str): Resumption token for retrieving the next page. [optional]
pagesize (int): Number of items returned in a single page. [optional]
Expand Down Expand Up @@ -721,6 +746,7 @@ def __list_address_txs(
'direction',
'min_height',
'max_height',
'order',
'token_currency',
'page',
'pagesize',
Expand All @@ -733,6 +759,7 @@ def __list_address_txs(
],
'enum': [
'direction',
'order',
],
'validation': [
'pagesize',
Expand All @@ -751,6 +778,11 @@ def __list_address_txs(
"IN": "in",
"OUT": "out"
},
('order',): {

"ASC": "asc",
"DESC": "desc"
},
},
'openapi_types': {
'currency':
Expand All @@ -763,6 +795,8 @@ def __list_address_txs(
(Height,),
'max_height':
(Height,),
'order':
(str,),
'token_currency':
(str,),
'page':
Expand All @@ -776,6 +810,7 @@ def __list_address_txs(
'direction': 'direction',
'min_height': 'min_height',
'max_height': 'max_height',
'order': 'order',
'token_currency': 'token_currency',
'page': 'page',
'pagesize': 'pagesize',
Expand All @@ -786,6 +821,7 @@ def __list_address_txs(
'direction': 'query',
'min_height': 'query',
'max_height': 'query',
'order': 'query',
'token_currency': 'query',
'page': 'query',
'pagesize': 'query',
Expand Down
36 changes: 36 additions & 0 deletions graphsense/api/entities_api.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,9 @@ def __list_entity_links(
neighbor (int): Neighbor entity
Keyword Args:
min_height (Height): Return transactions starting from given height. [optional]
max_height (Height): Return transactions up to (including) given height. [optional]
order (str): Sorting order. [optional] if omitted the server will use the default value of "desc"
page (str): Resumption token for retrieving the next page. [optional]
pagesize (int): Number of items returned in a single page. [optional]
_return_http_data_only (bool): response data without head status
Expand Down Expand Up @@ -565,6 +568,9 @@ def __list_entity_links(
'currency',
'entity',
'neighbor',
'min_height',
'max_height',
'order',
'page',
'pagesize',
],
Expand All @@ -576,6 +582,7 @@ def __list_entity_links(
'nullable': [
],
'enum': [
'order',
],
'validation': [
'pagesize',
Expand All @@ -589,6 +596,11 @@ def __list_entity_links(
},
},
'allowed_values': {
('order',): {

"ASC": "asc",
"DESC": "desc"
},
},
'openapi_types': {
'currency':
Expand All @@ -597,6 +609,12 @@ def __list_entity_links(
(int,),
'neighbor':
(int,),
'min_height':
(Height,),
'max_height':
(Height,),
'order':
(str,),
'page':
(str,),
'pagesize':
Expand All @@ -606,13 +624,19 @@ def __list_entity_links(
'currency': 'currency',
'entity': 'entity',
'neighbor': 'neighbor',
'min_height': 'min_height',
'max_height': 'max_height',
'order': 'order',
'page': 'page',
'pagesize': 'pagesize',
},
'location_map': {
'currency': 'path',
'entity': 'path',
'neighbor': 'query',
'min_height': 'query',
'max_height': 'query',
'order': 'query',
'page': 'query',
'pagesize': 'query',
},
Expand Down Expand Up @@ -837,6 +861,7 @@ def __list_entity_txs(
direction (str): Incoming or outgoing transactions. [optional]
min_height (Height): Return transactions starting from given height. [optional]
max_height (Height): Return transactions up to (including) given height. [optional]
order (str): Sorting order. [optional] if omitted the server will use the default value of "desc"
token_currency (str): Return transactions of given token currency. [optional]
page (str): Resumption token for retrieving the next page. [optional]
pagesize (int): Number of items returned in a single page. [optional]
Expand Down Expand Up @@ -908,6 +933,7 @@ def __list_entity_txs(
'direction',
'min_height',
'max_height',
'order',
'token_currency',
'page',
'pagesize',
Expand All @@ -920,6 +946,7 @@ def __list_entity_txs(
],
'enum': [
'direction',
'order',
],
'validation': [
'pagesize',
Expand All @@ -938,6 +965,11 @@ def __list_entity_txs(
"IN": "in",
"OUT": "out"
},
('order',): {

"ASC": "asc",
"DESC": "desc"
},
},
'openapi_types': {
'currency':
Expand All @@ -950,6 +982,8 @@ def __list_entity_txs(
(Height,),
'max_height':
(Height,),
'order':
(str,),
'token_currency':
(str,),
'page':
Expand All @@ -963,6 +997,7 @@ def __list_entity_txs(
'direction': 'direction',
'min_height': 'min_height',
'max_height': 'max_height',
'order': 'order',
'token_currency': 'token_currency',
'page': 'page',
'pagesize': 'pagesize',
Expand All @@ -973,6 +1008,7 @@ def __list_entity_txs(
'direction': 'query',
'min_height': 'query',
'max_height': 'query',
'order': 'query',
'token_currency': 'query',
'page': 'query',
'pagesize': 'query',
Expand Down

0 comments on commit cb7670a

Please sign in to comment.