# xcherryapi
This APIs between xCherry service and SDKs
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.0.3
- Package version: 0.0.3
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/xcherryio/apis.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/xcherryio/apis.git`)
Then import the package:
```python
import xcherryapi
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import xcherryapi
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import xcherryapi
from xcherryapi.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 = xcherryapi.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with xcherryapi.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = xcherryapi.DefaultApi(api_client)
process_execution_describe_request = xcherryapi.ProcessExecutionDescribeRequest() # ProcessExecutionDescribeRequest | (optional)
try:
# describe a process execution
api_response = api_instance.api_v1_xcherry_service_process_execution_describe_post(process_execution_describe_request=process_execution_describe_request)
print("The response of DefaultApi->api_v1_xcherry_service_process_execution_describe_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->api_v1_xcherry_service_process_execution_describe_post: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**api_v1_xcherry_service_process_execution_describe_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_describe_post) | **POST** /api/v1/xcherry/service/process-execution/describe | describe a process execution
*DefaultApi* | [**api_v1_xcherry_service_process_execution_publish_to_local_queue_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_publish_to_local_queue_post) | **POST** /api/v1/xcherry/service/process-execution/publish-to-local-queue | send message(s) to be consumed within a single process execution
*DefaultApi* | [**api_v1_xcherry_service_process_execution_rpc_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_rpc_post) | **POST** /api/v1/xcherry/service/process-execution/rpc | execute a RPC method of a process execution
*DefaultApi* | [**api_v1_xcherry_service_process_execution_start_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_start_post) | **POST** /api/v1/xcherry/service/process-execution/start | start a process execution
*DefaultApi* | [**api_v1_xcherry_service_process_execution_stop_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_stop_post) | **POST** /api/v1/xcherry/service/process-execution/stop | stop a process execution
*DefaultApi* | [**api_v1_xcherry_worker_async_state_execute_post**](docs/DefaultApi.md#api_v1_xcherry_worker_async_state_execute_post) | **POST** /api/v1/xcherry/worker/async-state/execute | invoking AsyncState.execute API
*DefaultApi* | [**api_v1_xcherry_worker_async_state_wait_until_post**](docs/DefaultApi.md#api_v1_xcherry_worker_async_state_wait_until_post) | **POST** /api/v1/xcherry/worker/async-state/wait-until | invoking AsyncState.waitUntil API
*DefaultApi* | [**api_v1_xcherry_worker_process_rpc_post**](docs/DefaultApi.md#api_v1_xcherry_worker_process_rpc_post) | **POST** /api/v1/xcherry/worker/process/rpc | execute a RPC method of a process execution in the worker
*DefaultApi* | [**internal_api_v1_xcherry_notify_immediate_tasks_post**](docs/DefaultApi.md#internal_api_v1_xcherry_notify_immediate_tasks_post) | **POST** /internal/api/v1/xcherry/notify-immediate-tasks | for api service to tell async service that there are new immediate tasks added to the queue
*DefaultApi* | [**internal_api_v1_xcherry_notify_timer_tasks_post**](docs/DefaultApi.md#internal_api_v1_xcherry_notify_timer_tasks_post) | **POST** /internal/api/v1/xcherry/notify-timer-tasks | for api service to tell async service that there are new timer tasks added to the queue
## Documentation For Models
- [ApiErrorResponse](docs/ApiErrorResponse.md)
- [AppDatabaseColumnValue](docs/AppDatabaseColumnValue.md)
- [AppDatabaseConfig](docs/AppDatabaseConfig.md)
- [AppDatabaseError](docs/AppDatabaseError.md)
- [AppDatabaseErrorHandling](docs/AppDatabaseErrorHandling.md)
- [AppDatabaseReadRequest](docs/AppDatabaseReadRequest.md)
- [AppDatabaseReadResponse](docs/AppDatabaseReadResponse.md)
- [AppDatabaseRowReadResponse](docs/AppDatabaseRowReadResponse.md)
- [AppDatabaseRowWrite](docs/AppDatabaseRowWrite.md)
- [AppDatabaseTableConfig](docs/AppDatabaseTableConfig.md)
- [AppDatabaseTableReadRequest](docs/AppDatabaseTableReadRequest.md)
- [AppDatabaseTableReadResponse](docs/AppDatabaseTableReadResponse.md)
- [AppDatabaseTableRowSelector](docs/AppDatabaseTableRowSelector.md)
- [AppDatabaseTableWrite](docs/AppDatabaseTableWrite.md)
- [AppDatabaseWrite](docs/AppDatabaseWrite.md)
- [AsyncStateConfig](docs/AsyncStateConfig.md)
- [AsyncStateExecuteRequest](docs/AsyncStateExecuteRequest.md)
- [AsyncStateExecuteResponse](docs/AsyncStateExecuteResponse.md)
- [AsyncStateWaitUntilRequest](docs/AsyncStateWaitUntilRequest.md)
- [AsyncStateWaitUntilResponse](docs/AsyncStateWaitUntilResponse.md)
- [CommandRequest](docs/CommandRequest.md)
- [CommandResults](docs/CommandResults.md)
- [CommandStatus](docs/CommandStatus.md)
- [CommandWaitingType](docs/CommandWaitingType.md)
- [Context](docs/Context.md)
- [DatabaseLockingType](docs/DatabaseLockingType.md)
- [EncodedObject](docs/EncodedObject.md)
- [ErrorSubType](docs/ErrorSubType.md)
- [KeyValue](docs/KeyValue.md)
- [LoadLocalAttributesRequest](docs/LoadLocalAttributesRequest.md)
- [LoadLocalAttributesResponse](docs/LoadLocalAttributesResponse.md)
- [LocalAttributeConfig](docs/LocalAttributeConfig.md)
- [LocalQueueCommand](docs/LocalQueueCommand.md)
- [LocalQueueMessage](docs/LocalQueueMessage.md)
- [LocalQueueMessageResult](docs/LocalQueueMessageResult.md)
- [LocalQueueResult](docs/LocalQueueResult.md)
- [NotifyImmediateTasksRequest](docs/NotifyImmediateTasksRequest.md)
- [NotifyTimerTasksRequest](docs/NotifyTimerTasksRequest.md)
- [ProcessExecutionDescribeRequest](docs/ProcessExecutionDescribeRequest.md)
- [ProcessExecutionDescribeResponse](docs/ProcessExecutionDescribeResponse.md)
- [ProcessExecutionRpcRequest](docs/ProcessExecutionRpcRequest.md)
- [ProcessExecutionRpcResponse](docs/ProcessExecutionRpcResponse.md)
- [ProcessExecutionStartRequest](docs/ProcessExecutionStartRequest.md)
- [ProcessExecutionStartResponse](docs/ProcessExecutionStartResponse.md)
- [ProcessExecutionStopRequest](docs/ProcessExecutionStopRequest.md)
- [ProcessExecutionStopType](docs/ProcessExecutionStopType.md)
- [ProcessIdReusePolicy](docs/ProcessIdReusePolicy.md)
- [ProcessRpcWorkerRequest](docs/ProcessRpcWorkerRequest.md)
- [ProcessRpcWorkerResponse](docs/ProcessRpcWorkerResponse.md)
- [ProcessStartConfig](docs/ProcessStartConfig.md)
- [ProcessStatus](docs/ProcessStatus.md)
- [PublishToLocalQueueRequest](docs/PublishToLocalQueueRequest.md)
- [RetryPolicy](docs/RetryPolicy.md)
- [StateDecision](docs/StateDecision.md)
- [StateFailureRecoveryOptions](docs/StateFailureRecoveryOptions.md)
- [StateFailureRecoveryPolicy](docs/StateFailureRecoveryPolicy.md)
- [StateMovement](docs/StateMovement.md)
- [ThreadCloseDecision](docs/ThreadCloseDecision.md)
- [ThreadCloseType](docs/ThreadCloseType.md)
- [TimerCommand](docs/TimerCommand.md)
- [TimerResult](docs/TimerResult.md)
- [WorkerApiType](docs/WorkerApiType.md)
- [WorkerErrorResponse](docs/WorkerErrorResponse.md)
- [WriteConflictMode](docs/WriteConflictMode.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/xcherryio/apis",
"name": "xcherryapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,xCherry APIs",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/ea/cf/da59f7331755de5da6f6c352ce40da9b82dc0697d16fc35ec91ecb813a75/xcherryapi-0.0.3.tar.gz",
"platform": null,
"description": "# xcherryapi\nThis APIs between xCherry service and SDKs\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.0.3\n- Package version: 0.0.3\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/xcherryio/apis.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/xcherryio/apis.git`)\n\nThen import the package:\n```python\nimport xcherryapi\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport xcherryapi\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport xcherryapi\nfrom xcherryapi.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = xcherryapi.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith xcherryapi.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = xcherryapi.DefaultApi(api_client)\n process_execution_describe_request = xcherryapi.ProcessExecutionDescribeRequest() # ProcessExecutionDescribeRequest | (optional)\n\n try:\n # describe a process execution\n api_response = api_instance.api_v1_xcherry_service_process_execution_describe_post(process_execution_describe_request=process_execution_describe_request)\n print(\"The response of DefaultApi->api_v1_xcherry_service_process_execution_describe_post:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->api_v1_xcherry_service_process_execution_describe_post: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**api_v1_xcherry_service_process_execution_describe_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_describe_post) | **POST** /api/v1/xcherry/service/process-execution/describe | describe a process execution\n*DefaultApi* | [**api_v1_xcherry_service_process_execution_publish_to_local_queue_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_publish_to_local_queue_post) | **POST** /api/v1/xcherry/service/process-execution/publish-to-local-queue | send message(s) to be consumed within a single process execution\n*DefaultApi* | [**api_v1_xcherry_service_process_execution_rpc_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_rpc_post) | **POST** /api/v1/xcherry/service/process-execution/rpc | execute a RPC method of a process execution\n*DefaultApi* | [**api_v1_xcherry_service_process_execution_start_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_start_post) | **POST** /api/v1/xcherry/service/process-execution/start | start a process execution\n*DefaultApi* | [**api_v1_xcherry_service_process_execution_stop_post**](docs/DefaultApi.md#api_v1_xcherry_service_process_execution_stop_post) | **POST** /api/v1/xcherry/service/process-execution/stop | stop a process execution\n*DefaultApi* | [**api_v1_xcherry_worker_async_state_execute_post**](docs/DefaultApi.md#api_v1_xcherry_worker_async_state_execute_post) | **POST** /api/v1/xcherry/worker/async-state/execute | invoking AsyncState.execute API\n*DefaultApi* | [**api_v1_xcherry_worker_async_state_wait_until_post**](docs/DefaultApi.md#api_v1_xcherry_worker_async_state_wait_until_post) | **POST** /api/v1/xcherry/worker/async-state/wait-until | invoking AsyncState.waitUntil API\n*DefaultApi* | [**api_v1_xcherry_worker_process_rpc_post**](docs/DefaultApi.md#api_v1_xcherry_worker_process_rpc_post) | **POST** /api/v1/xcherry/worker/process/rpc | execute a RPC method of a process execution in the worker\n*DefaultApi* | [**internal_api_v1_xcherry_notify_immediate_tasks_post**](docs/DefaultApi.md#internal_api_v1_xcherry_notify_immediate_tasks_post) | **POST** /internal/api/v1/xcherry/notify-immediate-tasks | for api service to tell async service that there are new immediate tasks added to the queue\n*DefaultApi* | [**internal_api_v1_xcherry_notify_timer_tasks_post**](docs/DefaultApi.md#internal_api_v1_xcherry_notify_timer_tasks_post) | **POST** /internal/api/v1/xcherry/notify-timer-tasks | for api service to tell async service that there are new timer tasks added to the queue\n\n\n## Documentation For Models\n\n - [ApiErrorResponse](docs/ApiErrorResponse.md)\n - [AppDatabaseColumnValue](docs/AppDatabaseColumnValue.md)\n - [AppDatabaseConfig](docs/AppDatabaseConfig.md)\n - [AppDatabaseError](docs/AppDatabaseError.md)\n - [AppDatabaseErrorHandling](docs/AppDatabaseErrorHandling.md)\n - [AppDatabaseReadRequest](docs/AppDatabaseReadRequest.md)\n - [AppDatabaseReadResponse](docs/AppDatabaseReadResponse.md)\n - [AppDatabaseRowReadResponse](docs/AppDatabaseRowReadResponse.md)\n - [AppDatabaseRowWrite](docs/AppDatabaseRowWrite.md)\n - [AppDatabaseTableConfig](docs/AppDatabaseTableConfig.md)\n - [AppDatabaseTableReadRequest](docs/AppDatabaseTableReadRequest.md)\n - [AppDatabaseTableReadResponse](docs/AppDatabaseTableReadResponse.md)\n - [AppDatabaseTableRowSelector](docs/AppDatabaseTableRowSelector.md)\n - [AppDatabaseTableWrite](docs/AppDatabaseTableWrite.md)\n - [AppDatabaseWrite](docs/AppDatabaseWrite.md)\n - [AsyncStateConfig](docs/AsyncStateConfig.md)\n - [AsyncStateExecuteRequest](docs/AsyncStateExecuteRequest.md)\n - [AsyncStateExecuteResponse](docs/AsyncStateExecuteResponse.md)\n - [AsyncStateWaitUntilRequest](docs/AsyncStateWaitUntilRequest.md)\n - [AsyncStateWaitUntilResponse](docs/AsyncStateWaitUntilResponse.md)\n - [CommandRequest](docs/CommandRequest.md)\n - [CommandResults](docs/CommandResults.md)\n - [CommandStatus](docs/CommandStatus.md)\n - [CommandWaitingType](docs/CommandWaitingType.md)\n - [Context](docs/Context.md)\n - [DatabaseLockingType](docs/DatabaseLockingType.md)\n - [EncodedObject](docs/EncodedObject.md)\n - [ErrorSubType](docs/ErrorSubType.md)\n - [KeyValue](docs/KeyValue.md)\n - [LoadLocalAttributesRequest](docs/LoadLocalAttributesRequest.md)\n - [LoadLocalAttributesResponse](docs/LoadLocalAttributesResponse.md)\n - [LocalAttributeConfig](docs/LocalAttributeConfig.md)\n - [LocalQueueCommand](docs/LocalQueueCommand.md)\n - [LocalQueueMessage](docs/LocalQueueMessage.md)\n - [LocalQueueMessageResult](docs/LocalQueueMessageResult.md)\n - [LocalQueueResult](docs/LocalQueueResult.md)\n - [NotifyImmediateTasksRequest](docs/NotifyImmediateTasksRequest.md)\n - [NotifyTimerTasksRequest](docs/NotifyTimerTasksRequest.md)\n - [ProcessExecutionDescribeRequest](docs/ProcessExecutionDescribeRequest.md)\n - [ProcessExecutionDescribeResponse](docs/ProcessExecutionDescribeResponse.md)\n - [ProcessExecutionRpcRequest](docs/ProcessExecutionRpcRequest.md)\n - [ProcessExecutionRpcResponse](docs/ProcessExecutionRpcResponse.md)\n - [ProcessExecutionStartRequest](docs/ProcessExecutionStartRequest.md)\n - [ProcessExecutionStartResponse](docs/ProcessExecutionStartResponse.md)\n - [ProcessExecutionStopRequest](docs/ProcessExecutionStopRequest.md)\n - [ProcessExecutionStopType](docs/ProcessExecutionStopType.md)\n - [ProcessIdReusePolicy](docs/ProcessIdReusePolicy.md)\n - [ProcessRpcWorkerRequest](docs/ProcessRpcWorkerRequest.md)\n - [ProcessRpcWorkerResponse](docs/ProcessRpcWorkerResponse.md)\n - [ProcessStartConfig](docs/ProcessStartConfig.md)\n - [ProcessStatus](docs/ProcessStatus.md)\n - [PublishToLocalQueueRequest](docs/PublishToLocalQueueRequest.md)\n - [RetryPolicy](docs/RetryPolicy.md)\n - [StateDecision](docs/StateDecision.md)\n - [StateFailureRecoveryOptions](docs/StateFailureRecoveryOptions.md)\n - [StateFailureRecoveryPolicy](docs/StateFailureRecoveryPolicy.md)\n - [StateMovement](docs/StateMovement.md)\n - [ThreadCloseDecision](docs/ThreadCloseDecision.md)\n - [ThreadCloseType](docs/ThreadCloseType.md)\n - [TimerCommand](docs/TimerCommand.md)\n - [TimerResult](docs/TimerResult.md)\n - [WorkerApiType](docs/WorkerApiType.md)\n - [WorkerErrorResponse](docs/WorkerErrorResponse.md)\n - [WriteConflictMode](docs/WriteConflictMode.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "xCherry APIs",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/xcherryio/apis",
"Repository": "https://github.com/xcherryio/apis"
},
"split_keywords": [
"openapi",
"openapi-generator",
"xcherry apis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9dfed53d6dc6f1fa07ccbba72c13fb83eec9b77560548c3c67039d14f1c02b9c",
"md5": "abfc08e90f0064dec413522de831ce20",
"sha256": "38fbcb59bfcf7e07c200c273cbe147fbb2b2564029be2e0c68cdc5ed6b03e256"
},
"downloads": -1,
"filename": "xcherryapi-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "abfc08e90f0064dec413522de831ce20",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 105613,
"upload_time": "2023-11-28T19:31:32",
"upload_time_iso_8601": "2023-11-28T19:31:32.839950Z",
"url": "https://files.pythonhosted.org/packages/9d/fe/d53d6dc6f1fa07ccbba72c13fb83eec9b77560548c3c67039d14f1c02b9c/xcherryapi-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eacfda59f7331755de5da6f6c352ce40da9b82dc0697d16fc35ec91ecb813a75",
"md5": "760f947116f46735637c528a7cfabb96",
"sha256": "df48891c927bca340ce983c73ca264de421584f41a80c6f53a69062f72ebef59"
},
"downloads": -1,
"filename": "xcherryapi-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "760f947116f46735637c528a7cfabb96",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 36028,
"upload_time": "2023-11-28T19:31:34",
"upload_time_iso_8601": "2023-11-28T19:31:34.082563Z",
"url": "https://files.pythonhosted.org/packages/ea/cf/da59f7331755de5da6f6c352ce40da9b82dc0697d16fc35ec91ecb813a75/xcherryapi-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-28 19:31:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xcherryio",
"github_project": "apis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xcherryapi"
}
JSON
