perceptic-core-client 0.5.12__py3-none-any.whl → 0.6.1__py3-none-any.whl

perceptic_core_client/perceptic_core_client/docs/FileSystemResourceApi.md

@@ -0,0 +1,276 @@
+# perceptic_core_client.FileSystemResourceApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**api_v1_file_systems_file_system_rid_get**](FileSystemResourceApi.md#api_v1_file_systems_file_system_rid_get) | **GET** /api/v1/file-systems/{fileSystemRid} | Get File System
+[**api_v1_file_systems_get**](FileSystemResourceApi.md#api_v1_file_systems_get) | **GET** /api/v1/file-systems | List All File Systems
+[**api_v1_file_systems_managed_post**](FileSystemResourceApi.md#api_v1_file_systems_managed_post) | **POST** /api/v1/file-systems/managed | Create Managed File System
+[**api_v1_file_systems_remote_post**](FileSystemResourceApi.md#api_v1_file_systems_remote_post) | **POST** /api/v1/file-systems/remote | Create Remote File System
+
+
+# **api_v1_file_systems_file_system_rid_get**
+> FileSystemApiDto api_v1_file_systems_file_system_rid_get(file_system_rid)
+
+Get File System
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.file_system_api_dto import FileSystemApiDto
+from perceptic_core_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.FileSystemResourceApi(api_client)
+    file_system_rid = 'file_system_rid_example' # str | 
+
+    try:
+        # Get File System
+        api_response = api_instance.api_v1_file_systems_file_system_rid_get(file_system_rid)
+        print("The response of FileSystemResourceApi->api_v1_file_systems_file_system_rid_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FileSystemResourceApi->api_v1_file_systems_file_system_rid_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_system_rid** | **str**|  | 
+
+### Return type
+
+[**FileSystemApiDto**](FileSystemApiDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **api_v1_file_systems_get**
+> ListAllFileSystemsResponse api_v1_file_systems_get()
+
+List All File Systems
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.list_all_file_systems_response import ListAllFileSystemsResponse
+from perceptic_core_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.FileSystemResourceApi(api_client)
+
+    try:
+        # List All File Systems
+        api_response = api_instance.api_v1_file_systems_get()
+        print("The response of FileSystemResourceApi->api_v1_file_systems_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FileSystemResourceApi->api_v1_file_systems_get: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListAllFileSystemsResponse**](ListAllFileSystemsResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **api_v1_file_systems_managed_post**
+> CreateFileSystemResponse api_v1_file_systems_managed_post(create_managed_file_system_request)
+
+Create Managed File System
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.create_file_system_response import CreateFileSystemResponse
+from perceptic_core_client.models.create_managed_file_system_request import CreateManagedFileSystemRequest
+from perceptic_core_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.FileSystemResourceApi(api_client)
+    create_managed_file_system_request = perceptic_core_client.CreateManagedFileSystemRequest() # CreateManagedFileSystemRequest | 
+
+    try:
+        # Create Managed File System
+        api_response = api_instance.api_v1_file_systems_managed_post(create_managed_file_system_request)
+        print("The response of FileSystemResourceApi->api_v1_file_systems_managed_post:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FileSystemResourceApi->api_v1_file_systems_managed_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_managed_file_system_request** | [**CreateManagedFileSystemRequest**](CreateManagedFileSystemRequest.md)|  | 
+
+### Return type
+
+[**CreateFileSystemResponse**](CreateFileSystemResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**400** | Bad Request |  -  |
+
+[[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)
+
+# **api_v1_file_systems_remote_post**
+> CreateFileSystemResponse api_v1_file_systems_remote_post(create_remote_file_system_request)
+
+Create Remote File System
+
+### Example
+
+
+```python
+import perceptic_core_client
+from perceptic_core_client.models.create_file_system_response import CreateFileSystemResponse
+from perceptic_core_client.models.create_remote_file_system_request import CreateRemoteFileSystemRequest
+from perceptic_core_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = perceptic_core_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with perceptic_core_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = perceptic_core_client.FileSystemResourceApi(api_client)
+    create_remote_file_system_request = perceptic_core_client.CreateRemoteFileSystemRequest() # CreateRemoteFileSystemRequest | 
+
+    try:
+        # Create Remote File System
+        api_response = api_instance.api_v1_file_systems_remote_post(create_remote_file_system_request)
+        print("The response of FileSystemResourceApi->api_v1_file_systems_remote_post:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling FileSystemResourceApi->api_v1_file_systems_remote_post: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_remote_file_system_request** | [**CreateRemoteFileSystemRequest**](CreateRemoteFileSystemRequest.md)|  | 
+
+### Return type
+
+[**CreateFileSystemResponse**](CreateFileSystemResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**400** | Bad Request |  -  |
+
+[[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)
+

perceptic_core_client/perceptic_core_client/docs/FileSystemRootMetadataApiDto.md

@@ -0,0 +1,31 @@
+# FileSystemRootMetadataApiDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **str** |  | [optional] 
+**container_name** | **str** |  | [optional] 
+**bucket_name** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.file_system_root_metadata_api_dto import FileSystemRootMetadataApiDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of FileSystemRootMetadataApiDto from a JSON string
+file_system_root_metadata_api_dto_instance = FileSystemRootMetadataApiDto.from_json(json)
+# print the JSON string representation of the object
+print(FileSystemRootMetadataApiDto.to_json())
+
+# convert the object into a dict
+file_system_root_metadata_api_dto_dict = file_system_root_metadata_api_dto_instance.to_dict()
+# create an instance of FileSystemRootMetadataApiDto from a dict
+file_system_root_metadata_api_dto_from_dict = FileSystemRootMetadataApiDto.from_dict(file_system_root_metadata_api_dto_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetConnectionResponse.md

@@ -0,0 +1,29 @@
+# GetConnectionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connection** | [**ConnectionApiDto**](ConnectionApiDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_connection_response import GetConnectionResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetConnectionResponse from a JSON string
+get_connection_response_instance = GetConnectionResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetConnectionResponse.to_json())
+
+# convert the object into a dict
+get_connection_response_dict = get_connection_response_instance.to_dict()
+# create an instance of GetConnectionResponse from a dict
+get_connection_response_from_dict = GetConnectionResponse.from_dict(get_connection_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetIndexerResponse.md

@@ -0,0 +1,29 @@
+# GetIndexerResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indexer** | [**IndexerDto**](IndexerDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_indexer_response import GetIndexerResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetIndexerResponse from a JSON string
+get_indexer_response_instance = GetIndexerResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetIndexerResponse.to_json())
+
+# convert the object into a dict
+get_indexer_response_dict = get_indexer_response_instance.to_dict()
+# create an instance of GetIndexerResponse from a dict
+get_indexer_response_from_dict = GetIndexerResponse.from_dict(get_indexer_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetIndexingTaskResponse.md

@@ -0,0 +1,29 @@
+# GetIndexingTaskResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | [**IndexingTaskDto**](IndexingTaskDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_indexing_task_response import GetIndexingTaskResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetIndexingTaskResponse from a JSON string
+get_indexing_task_response_instance = GetIndexingTaskResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetIndexingTaskResponse.to_json())
+
+# convert the object into a dict
+get_indexing_task_response_dict = get_indexing_task_response_instance.to_dict()
+# create an instance of GetIndexingTaskResponse from a dict
+get_indexing_task_response_from_dict = GetIndexingTaskResponse.from_dict(get_indexing_task_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetMetadataResponse.md

@@ -0,0 +1,29 @@
+# GetMetadataResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**ResourceMetadataDto**](ResourceMetadataDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_metadata_response import GetMetadataResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetMetadataResponse from a JSON string
+get_metadata_response_instance = GetMetadataResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetMetadataResponse.to_json())
+
+# convert the object into a dict
+get_metadata_response_dict = get_metadata_response_instance.to_dict()
+# create an instance of GetMetadataResponse from a dict
+get_metadata_response_from_dict = GetMetadataResponse.from_dict(get_metadata_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetParentResponse.md

@@ -0,0 +1,29 @@
+# GetParentResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent** | [**ResourceId**](ResourceId.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_parent_response import GetParentResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetParentResponse from a JSON string
+get_parent_response_instance = GetParentResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetParentResponse.to_json())
+
+# convert the object into a dict
+get_parent_response_dict = get_parent_response_instance.to_dict()
+# create an instance of GetParentResponse from a dict
+get_parent_response_from_dict = GetParentResponse.from_dict(get_parent_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetParentUriResponse.md

@@ -0,0 +1,29 @@
+# GetParentUriResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_parent_uri_response import GetParentUriResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetParentUriResponse from a JSON string
+get_parent_uri_response_instance = GetParentUriResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetParentUriResponse.to_json())
+
+# convert the object into a dict
+get_parent_uri_response_dict = get_parent_uri_response_instance.to_dict()
+# create an instance of GetParentUriResponse from a dict
+get_parent_uri_response_from_dict = GetParentUriResponse.from_dict(get_parent_uri_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetSignedUrlResponse.md

@@ -0,0 +1,29 @@
+# GetSignedUrlResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**maybe_url** | **str** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_signed_url_response import GetSignedUrlResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetSignedUrlResponse from a JSON string
+get_signed_url_response_instance = GetSignedUrlResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetSignedUrlResponse.to_json())
+
+# convert the object into a dict
+get_signed_url_response_dict = get_signed_url_response_instance.to_dict()
+# create an instance of GetSignedUrlResponse from a dict
+get_signed_url_response_from_dict = GetSignedUrlResponse.from_dict(get_signed_url_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetWorkerEventsResponse.md

@@ -0,0 +1,29 @@
+# GetWorkerEventsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**List[WorkerEvent]**](WorkerEvent.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_worker_events_response import GetWorkerEventsResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetWorkerEventsResponse from a JSON string
+get_worker_events_response_instance = GetWorkerEventsResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetWorkerEventsResponse.to_json())
+
+# convert the object into a dict
+get_worker_events_response_dict = get_worker_events_response_instance.to_dict()
+# create an instance of GetWorkerEventsResponse from a dict
+get_worker_events_response_from_dict = GetWorkerEventsResponse.from_dict(get_worker_events_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetWorkerMetadataResponse.md

@@ -0,0 +1,29 @@
+# GetWorkerMetadataResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**worker_metadata** | [**WorkerMetadataDto**](WorkerMetadataDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_worker_metadata_response import GetWorkerMetadataResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetWorkerMetadataResponse from a JSON string
+get_worker_metadata_response_instance = GetWorkerMetadataResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetWorkerMetadataResponse.to_json())
+
+# convert the object into a dict
+get_worker_metadata_response_dict = get_worker_metadata_response_instance.to_dict()
+# create an instance of GetWorkerMetadataResponse from a dict
+get_worker_metadata_response_from_dict = GetWorkerMetadataResponse.from_dict(get_worker_metadata_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetWorkerStatusResponse.md

@@ -0,0 +1,29 @@
+# GetWorkerStatusResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**run_status** | [**RunStatusDto**](RunStatusDto.md) |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_worker_status_response import GetWorkerStatusResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetWorkerStatusResponse from a JSON string
+get_worker_status_response_instance = GetWorkerStatusResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetWorkerStatusResponse.to_json())
+
+# convert the object into a dict
+get_worker_status_response_dict = get_worker_status_response_instance.to_dict()
+# create an instance of GetWorkerStatusResponse from a dict
+get_worker_status_response_from_dict = GetWorkerStatusResponse.from_dict(get_worker_status_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/GetWorkersResponse.md

@@ -0,0 +1,29 @@
+# GetWorkersResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**worker_identifiers** | **Dict[str, List[str]]** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.get_workers_response import GetWorkersResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetWorkersResponse from a JSON string
+get_workers_response_instance = GetWorkersResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetWorkersResponse.to_json())
+
+# convert the object into a dict
+get_workers_response_dict = get_workers_response_instance.to_dict()
+# create an instance of GetWorkersResponse from a dict
+get_workers_response_from_dict = GetWorkersResponse.from_dict(get_workers_response_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)
+
+

perceptic_core_client/perceptic_core_client/docs/IndexerDto.md

@@ -0,0 +1,32 @@
+# IndexerDto
+
+Indexer service details, including supported index version range and capabilities.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indexer_rid** | **str** |  | [optional] 
+**target_index_version** | **int** |  | [optional] 
+**minimum_supported_index_version** | **int** |  | [optional] 
+
+## Example
+
+```python
+from perceptic_core_client.models.indexer_dto import IndexerDto
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of IndexerDto from a JSON string
+indexer_dto_instance = IndexerDto.from_json(json)
+# print the JSON string representation of the object
+print(IndexerDto.to_json())
+
+# convert the object into a dict
+indexer_dto_dict = indexer_dto_instance.to_dict()
+# create an instance of IndexerDto from a dict
+indexer_dto_from_dict = IndexerDto.from_dict(indexer_dto_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)
+
+