neops_workflow_engine_client 0.30.0__tar.gz → 0.32.0__tar.gz

{neops_workflow_engine_client-0.30.0 → neops_workflow_engine_client-0.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neops_workflow_engine_client
-Version: 0.30.0
+Version: 0.32.0
 Summary: Neops Workflow Engine
 Home-page: https://github.com/GIT_USER_ID/GIT_REPO_ID
 License: NoLicense
@@ -29,7 +29,7 @@ Neops workflow engine API documentation
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 0.30.0
+- Package version: 0.32.0
 - Generator version: 7.9.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -112,11 +112,20 @@ Class | Method | HTTP request | Description
 *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks | 
 *FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} | 
 *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | 
+*JobApi* | [**job_controller_poll_job**](docs/JobApi.md#job_controller_poll_job) | **GET** /job | 
+*JobApi* | [**job_controller_push_job_result**](docs/JobApi.md#job_controller_push_job_result) | **POST** /job | 
+*WorkflowsApi* | [**workflow_controller_create**](docs/WorkflowsApi.md#workflow_controller_create) | **POST** /workflow | 
+*WorkflowsApi* | [**workflow_controller_find_all**](docs/WorkflowsApi.md#workflow_controller_find_all) | **GET** /workflow | 
+*WorkflowsApi* | [**workflow_controller_find_one**](docs/WorkflowsApi.md#workflow_controller_find_one) | **GET** /workflow/{id} | 
+*WorkflowsApi* | [**workflow_controller_remove**](docs/WorkflowsApi.md#workflow_controller_remove) | **DELETE** /workflow/{id} | 
+*WorkflowsApi* | [**workflow_controller_update**](docs/WorkflowsApi.md#workflow_controller_update) | **PATCH** /workflow/{id} | 
 
 
 ## Documentation For Models
 
  - [HealthResponse](docs/HealthResponse.md)
+ - [JobDefinitionDto](docs/JobDefinitionDto.md)
+ - [JobResultDto](docs/JobResultDto.md)
  - [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)
 
 

{neops_workflow_engine_client-0.30.0 → neops_workflow_engine_client-0.32.0}/README.md

@@ -4,7 +4,7 @@ Neops workflow engine API documentation
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 0.30.0
+- Package version: 0.32.0
 - Generator version: 7.9.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -87,11 +87,20 @@ Class | Method | HTTP request | Description
 *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks | 
 *FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} | 
 *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | 
+*JobApi* | [**job_controller_poll_job**](docs/JobApi.md#job_controller_poll_job) | **GET** /job | 
+*JobApi* | [**job_controller_push_job_result**](docs/JobApi.md#job_controller_push_job_result) | **POST** /job | 
+*WorkflowsApi* | [**workflow_controller_create**](docs/WorkflowsApi.md#workflow_controller_create) | **POST** /workflow | 
+*WorkflowsApi* | [**workflow_controller_find_all**](docs/WorkflowsApi.md#workflow_controller_find_all) | **GET** /workflow | 
+*WorkflowsApi* | [**workflow_controller_find_one**](docs/WorkflowsApi.md#workflow_controller_find_one) | **GET** /workflow/{id} | 
+*WorkflowsApi* | [**workflow_controller_remove**](docs/WorkflowsApi.md#workflow_controller_remove) | **DELETE** /workflow/{id} | 
+*WorkflowsApi* | [**workflow_controller_update**](docs/WorkflowsApi.md#workflow_controller_update) | **PATCH** /workflow/{id} | 
 
 
 ## Documentation For Models
 
  - [HealthResponse](docs/HealthResponse.md)
+ - [JobDefinitionDto](docs/JobDefinitionDto.md)
+ - [JobResultDto](docs/JobResultDto.md)
  - [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)
 
 

{neops_workflow_engine_client-0.30.0 → neops_workflow_engine_client-0.32.0}/neops_workflow_engine_client/__init__.py

@@ -14,12 +14,14 @@
 """  # noqa: E501
 
 
-__version__ = "0.30.0"
+__version__ = "0.32.0"
 
 # import apis into sdk package
 from neops_workflow_engine_client.api.default_api import DefaultApi
 from neops_workflow_engine_client.api.function_block_api import FunctionBlockApi
 from neops_workflow_engine_client.api.health_api import HealthApi
+from neops_workflow_engine_client.api.job_api import JobApi
+from neops_workflow_engine_client.api.workflows_api import WorkflowsApi
 
 # import ApiClient
 from neops_workflow_engine_client.api_response import ApiResponse
@@ -34,4 +36,6 @@ from neops_workflow_engine_client.exceptions import ApiException
 
 # import models into sdk package
 from neops_workflow_engine_client.models.health_response import HealthResponse
+from neops_workflow_engine_client.models.job_definition_dto import JobDefinitionDto
+from neops_workflow_engine_client.models.job_result_dto import JobResultDto
 from neops_workflow_engine_client.models.register_function_block_dto import RegisterFunctionBlockDto

{neops_workflow_engine_client-0.30.0 → neops_workflow_engine_client-0.32.0}/neops_workflow_engine_client/api/__init__.py

@@ -4,4 +4,6 @@
 from neops_workflow_engine_client.api.default_api import DefaultApi
 from neops_workflow_engine_client.api.function_block_api import FunctionBlockApi
 from neops_workflow_engine_client.api.health_api import HealthApi
+from neops_workflow_engine_client.api.job_api import JobApi
+from neops_workflow_engine_client.api.workflows_api import WorkflowsApi
 

neops_workflow_engine_client-0.32.0/neops_workflow_engine_client/api/job_api.py

@@ -0,0 +1,542 @@
+# coding: utf-8
+
+"""
+    Neops Workflow Engine
+
+    Neops workflow engine API documentation
+
+    The version of the OpenAPI document: 1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from neops_workflow_engine_client.models.job_definition_dto import JobDefinitionDto
+from neops_workflow_engine_client.models.job_result_dto import JobResultDto
+
+from neops_workflow_engine_client.api_client import ApiClient, RequestSerialized
+from neops_workflow_engine_client.api_response import ApiResponse
+from neops_workflow_engine_client.rest import RESTResponseType
+
+
+class JobApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def job_controller_poll_job(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> JobDefinitionDto:
+        """job_controller_poll_job
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._job_controller_poll_job_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "JobDefinitionDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def job_controller_poll_job_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[JobDefinitionDto]:
+        """job_controller_poll_job
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._job_controller_poll_job_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "JobDefinitionDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def job_controller_poll_job_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """job_controller_poll_job
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._job_controller_poll_job_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "JobDefinitionDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _job_controller_poll_job_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/job',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def job_controller_push_job_result(
+        self,
+        job_result_dto: JobResultDto,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> None:
+        """job_controller_push_job_result
+
+
+        :param job_result_dto: (required)
+        :type job_result_dto: JobResultDto
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._job_controller_push_job_result_serialize(
+            job_result_dto=job_result_dto,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def job_controller_push_job_result_with_http_info(
+        self,
+        job_result_dto: JobResultDto,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[None]:
+        """job_controller_push_job_result
+
+
+        :param job_result_dto: (required)
+        :type job_result_dto: JobResultDto
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._job_controller_push_job_result_serialize(
+            job_result_dto=job_result_dto,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def job_controller_push_job_result_without_preload_content(
+        self,
+        job_result_dto: JobResultDto,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """job_controller_push_job_result
+
+
+        :param job_result_dto: (required)
+        :type job_result_dto: JobResultDto
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._job_controller_push_job_result_serialize(
+            job_result_dto=job_result_dto,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _job_controller_push_job_result_serialize(
+        self,
+        job_result_dto,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if job_result_dto is not None:
+            _body_params = job_result_dto
+
+
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/job',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+