neops_workflow_engine_client 0.41.7__tar.gz → 0.41.10__tar.gz

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: neops_workflow_engine_client
-Version: 0.41.7
+Version: 0.41.10
 Summary: Neops Workflow Engine
 License: NoLicense
 Keywords: OpenAPI,OpenAPI-Generator,Neops Workflow Engine
@@ -28,7 +28,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.41.7
+- Package version: 0.41.10
 - Generator version: 7.9.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -132,7 +132,10 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [Acquires](docs/Acquires.md)
  - [CreateWorkflowDefinitionDto](docs/CreateWorkflowDefinitionDto.md)
+ - [CronConfiguration](docs/CronConfiguration.md)
+ - [CrontabConfiguration](docs/CrontabConfiguration.md)
  - [DeviceDto](docs/DeviceDto.md)
  - [DevicesResponseDto](docs/DevicesResponseDto.md)
  - [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/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.41.7
+- Package version: 0.41.10
 - Generator version: 7.9.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -108,7 +108,10 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [Acquires](docs/Acquires.md)
  - [CreateWorkflowDefinitionDto](docs/CreateWorkflowDefinitionDto.md)
+ - [CronConfiguration](docs/CronConfiguration.md)
+ - [CrontabConfiguration](docs/CrontabConfiguration.md)
  - [DeviceDto](docs/DeviceDto.md)
  - [DevicesResponseDto](docs/DevicesResponseDto.md)
  - [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/neops_workflow_engine_client/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "0.41.7"
+__version__ = "0.41.10"
 
 # import apis into sdk package
 from neops_workflow_engine_client.api.blackboard_api import BlackboardApi
@@ -36,7 +36,10 @@ from neops_workflow_engine_client.exceptions import ApiAttributeError
 from neops_workflow_engine_client.exceptions import ApiException
 
 # import models into sdk package
+from neops_workflow_engine_client.models.acquires import Acquires
 from neops_workflow_engine_client.models.create_workflow_definition_dto import CreateWorkflowDefinitionDto
+from neops_workflow_engine_client.models.cron_configuration import CronConfiguration
+from neops_workflow_engine_client.models.crontab_configuration import CrontabConfiguration
 from neops_workflow_engine_client.models.device_dto import DeviceDto
 from neops_workflow_engine_client.models.devices_response_dto import DevicesResponseDto
 from neops_workflow_engine_client.models.execute_workflow_dto import ExecuteWorkflowDto

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/neops_workflow_engine_client/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.41.7/python'
+        self.user_agent = 'OpenAPI-Generator/0.41.10/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/neops_workflow_engine_client/configuration.py

@@ -393,7 +393,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0\n"\
-               "SDK Package Version: 0.41.7".\
+               "SDK Package Version: 0.41.10".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/neops_workflow_engine_client/models/__init__.py

@@ -14,7 +14,10 @@
 
 
 # import models into model package
+from neops_workflow_engine_client.models.acquires import Acquires
 from neops_workflow_engine_client.models.create_workflow_definition_dto import CreateWorkflowDefinitionDto
+from neops_workflow_engine_client.models.cron_configuration import CronConfiguration
+from neops_workflow_engine_client.models.crontab_configuration import CrontabConfiguration
 from neops_workflow_engine_client.models.device_dto import DeviceDto
 from neops_workflow_engine_client.models.devices_response_dto import DevicesResponseDto
 from neops_workflow_engine_client.models.execute_workflow_dto import ExecuteWorkflowDto

neops_workflow_engine_client-0.41.7/neops_workflow_engine_client/models/workflow_config.py → neops_workflow_engine_client-0.41.10/neops_workflow_engine_client/models/acquires.py

@@ -22,15 +22,13 @@ from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
 
-class WorkflowConfig(BaseModel):
+class Acquires(BaseModel):
     """
-    WorkflowConfig
+    Acquires
     """ # noqa: E501
-    execution_strategy: Dict[str, Any] = Field(alias="executionStrategy")
-    parameters: Dict[str, Any]
-    run_on: Dict[str, Any] = Field(alias="runOn")
-    acquire: List[StrictStr]
-    __properties: ClassVar[List[str]] = ["executionStrategy", "parameters", "runOn", "acquire"]
+    entity_type: StrictStr = Field(alias="entityType")
+    query: StrictStr
+    __properties: ClassVar[List[str]] = ["entityType", "query"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -50,7 +48,7 @@ class WorkflowConfig(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of WorkflowConfig from a JSON string"""
+        """Create an instance of Acquires from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -75,7 +73,7 @@ class WorkflowConfig(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of WorkflowConfig from a dict"""
+        """Create an instance of Acquires from a dict"""
         if obj is None:
             return None
 
@@ -83,10 +81,8 @@ class WorkflowConfig(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "executionStrategy": obj.get("executionStrategy"),
-            "parameters": obj.get("parameters"),
-            "runOn": obj.get("runOn"),
-            "acquire": obj.get("acquire")
+            "entityType": obj.get("entityType"),
+            "query": obj.get("query")
         })
         return _obj
 

neops_workflow_engine_client-0.41.10/neops_workflow_engine_client/models/cron_configuration.py

@@ -0,0 +1,103 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List
+from neops_workflow_engine_client.models.crontab_configuration import CrontabConfiguration
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CronConfiguration(BaseModel):
+    """
+    CronConfiguration
+    """ # noqa: E501
+    description: StrictStr
+    query: StrictStr
+    parameters: Dict[str, Any]
+    crontab: CrontabConfiguration
+    concurrency: StrictBool
+    enabled: StrictBool
+    condition: StrictStr
+    __properties: ClassVar[List[str]] = ["description", "query", "parameters", "crontab", "concurrency", "enabled", "condition"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CronConfiguration from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of crontab
+        if self.crontab:
+            _dict['crontab'] = self.crontab.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CronConfiguration from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "description": obj.get("description"),
+            "query": obj.get("query"),
+            "parameters": obj.get("parameters"),
+            "crontab": CrontabConfiguration.from_dict(obj["crontab"]) if obj.get("crontab") is not None else None,
+            "concurrency": obj.get("concurrency"),
+            "enabled": obj.get("enabled"),
+            "condition": obj.get("condition")
+        })
+        return _obj
+
+

neops_workflow_engine_client-0.41.10/neops_workflow_engine_client/models/crontab_configuration.py

@@ -0,0 +1,99 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CrontabConfiguration(BaseModel):
+    """
+    CrontabConfiguration
+    """ # noqa: E501
+    second: StrictStr
+    minute: StrictStr
+    hour: StrictStr
+    day_of_month: StrictStr = Field(alias="dayOfMonth")
+    month: StrictStr
+    day_of_week: StrictStr = Field(alias="dayOfWeek")
+    timezone: StrictStr
+    __properties: ClassVar[List[str]] = ["second", "minute", "hour", "dayOfMonth", "month", "dayOfWeek", "timezone"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CrontabConfiguration from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CrontabConfiguration from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "second": obj.get("second"),
+            "minute": obj.get("minute"),
+            "hour": obj.get("hour"),
+            "dayOfMonth": obj.get("dayOfMonth"),
+            "month": obj.get("month"),
+            "dayOfWeek": obj.get("dayOfWeek"),
+            "timezone": obj.get("timezone")
+        })
+        return _obj
+
+

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/neops_workflow_engine_client/models/root_workflow.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from neops_workflow_engine_client.models.cron_configuration import CronConfiguration
 from neops_workflow_engine_client.models.retry_configuration import RetryConfiguration
 from neops_workflow_engine_client.models.workflow_config import WorkflowConfig
 from neops_workflow_engine_client.models.workflow_steps_inner import WorkflowStepsInner
@@ -39,9 +40,9 @@ class RootWorkflow(BaseModel):
     config: WorkflowConfig
     steps: List[WorkflowStepsInner]
     version: StrictStr
-    description: StrictStr
-    cron: List[StrictStr]
-    hide_for_execution: StrictBool = Field(alias="hideForExecution")
+    description: Optional[StrictStr] = None
+    cron: Optional[List[CronConfiguration]] = None
+    hide_for_execution: Optional[StrictBool] = Field(default=None, alias="hideForExecution")
     __properties: ClassVar[List[str]] = ["id", "name", "retryConfig", "condition", "continueOnError", "delay", "type", "config", "steps", "version", "description", "cron", "hideForExecution"]
 
     model_config = ConfigDict(
@@ -96,6 +97,13 @@ class RootWorkflow(BaseModel):
                 if _item_steps:
                     _items.append(_item_steps.to_dict())
             _dict['steps'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in cron (list)
+        _items = []
+        if self.cron:
+            for _item_cron in self.cron:
+                if _item_cron:
+                    _items.append(_item_cron.to_dict())
+            _dict['cron'] = _items
         return _dict
 
     @classmethod
@@ -119,7 +127,7 @@ class RootWorkflow(BaseModel):
             "steps": [WorkflowStepsInner.from_dict(_item) for _item in obj["steps"]] if obj.get("steps") is not None else None,
             "version": obj.get("version"),
             "description": obj.get("description"),
-            "cron": obj.get("cron"),
+            "cron": [CronConfiguration.from_dict(_item) for _item in obj["cron"]] if obj.get("cron") is not None else None,
             "hideForExecution": obj.get("hideForExecution")
         })
         return _obj

neops_workflow_engine_client-0.41.10/neops_workflow_engine_client/models/workflow_config.py

@@ -0,0 +1,111 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from neops_workflow_engine_client.models.acquires import Acquires
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkflowConfig(BaseModel):
+    """
+    WorkflowConfig
+    """ # noqa: E501
+    execution_strategy: Dict[str, Any] = Field(alias="executionStrategy")
+    parameters: Dict[str, Any]
+    run_on: Optional[StrictStr] = Field(default=None, alias="runOn")
+    acquire: Optional[List[Acquires]] = None
+    __properties: ClassVar[List[str]] = ["executionStrategy", "parameters", "runOn", "acquire"]
+
+    @field_validator('run_on')
+    def run_on_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['global', 'device', 'client', 'interface', 'group']):
+            raise ValueError("must be one of enum values ('global', 'device', 'client', 'interface', 'group')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WorkflowConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in acquire (list)
+        _items = []
+        if self.acquire:
+            for _item_acquire in self.acquire:
+                if _item_acquire:
+                    _items.append(_item_acquire.to_dict())
+            _dict['acquire'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WorkflowConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "executionStrategy": obj.get("executionStrategy"),
+            "parameters": obj.get("parameters"),
+            "runOn": obj.get("runOn"),
+            "acquire": [Acquires.from_dict(_item) for _item in obj["acquire"]] if obj.get("acquire") is not None else None
+        })
+        return _obj
+
+

{neops_workflow_engine_client-0.41.7 → neops_workflow_engine_client-0.41.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "neops_workflow_engine_client"
-version = "0.41.7"
+version = "0.41.10"
 description = "Neops Workflow Engine"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"