js7-client-python 2.0.1__py3-none-any.whl

js7/client/feature/workflow/manage.py

@@ -0,0 +1,54 @@
+from typing import Dict
+
+from ....client.context import Context
+
+from ...action.workflow.get_workflow_versions_action import get_workflow_versions_action
+
+
+class Manage:
+    def __init__(self, context: Context):
+        self._ctx = context
+        
+    def get_workflow_versions(
+        self,
+        controller_id: str,
+        workflow_path: str,
+        exclude_current_version: bool = False
+    ) -> Dict[str, str]:
+        """
+        Returns all versions of a given workflow.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_path (str):
+                The full path of the workflow whose versions should be retrieved.
+
+            exclude_current_version (bool):
+                If set to `True`, the currently active (current) version
+                of the workflow will be excluded from the result.
+
+        Returns:
+            Dict ([str, str]):
+                A dictionary mapping version id to workflow path
+                in the format: `{version_id: workflow_path}`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id` or
+                `workflow_path` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+        
+        return get_workflow_versions_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_path=workflow_path,
+            exclude_current_version=exclude_current_version
+        )
+        
+    

js7/client/feature/workflow/operate.py

@@ -0,0 +1,336 @@
+from typing import List, Optional
+
+from ....client.context import Context
+from ....model.public.client.common.audit_log import AuditLog
+
+from ...action.workflow.set_workflow_version_as_current_action import set_workflow_version_as_current_action
+from ...action.workflow.resume_workflows_action import resume_workflows_action
+from ...action.workflow.skip_job_instructions_action import skip_job_instructions_action
+from ...action.workflow.stop_job_instructions_action import stop_job_instructions_action
+from ...action.workflow.suspend_workflows_action import suspend_workflows_action
+from ...action.workflow.unskip_job_instructions_action import unskip_job_instructions_action
+from ...action.workflow.unstop_job_instructions_action import unstop_job_instructions_action
+
+
+class Operate:
+    def __init__(self, context: Context):
+        self._ctx = context
+        
+    def set_workflow_version_as_current(
+        self,
+        controller_id: str,
+        workflow_path: str,
+        workflow_version_id: str,
+        audit_log: Optional[AuditLog] = None
+    ) -> bool:
+        """
+        Sets a specific workflow version as the current version for all orders.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_path (str):
+                The full path of the workflow whose version should be updated.
+
+            workflow_version_id (str):
+                The workflow `version_id` that should be set as the current version.
+
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+
+        Returns:
+            bool:
+                Returns `True` if the operation was successful, otherwise `False`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id`,
+                `workflow_path`, or `workflow_version_id` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+        
+        return set_workflow_version_as_current_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_path=workflow_path,
+            workflow_version_id=workflow_version_id,
+            audit_log=audit_log
+        )
+        
+    def resume_workflow(
+        self,
+        controller_id: str,
+        workflow_paths: List[str],
+        audit_log: Optional[AuditLog] = None
+    ) -> bool:
+        """
+        Resumes a suspended workflow.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_path (str):
+                The full path of the workflow that should be resumed.
+
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+
+        Returns:
+            bool:
+                Returns `True` if the operation was successful,
+                otherwise `False`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id`
+                or `workflow_path` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+
+        return resume_workflows_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_paths=workflow_paths,
+            audit_log=audit_log
+        )
+        
+    def skip_job_instructions(
+        self,
+        controller_id: str,
+        workflow_path: str,
+        labels: List[str],
+        audit_log: Optional[AuditLog] = None
+    ) -> bool:
+        """
+        Skips one or more job instructions in a workflow.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_path (str):
+                The full path of the workflow in which the specified job
+                instructions should be skipped.
+
+            labels (List[str]):
+                A list of job instruction labels that should be skipped.
+
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+
+        Returns:
+            bool:
+                Returns `True` if the operation was successful,
+                otherwise `False`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id`,
+                `workflow_path`, or `labels` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+        
+        return skip_job_instructions_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )
+        
+    def stop_job_instructions(
+        self,
+        controller_id: str,
+        workflow_path: str,
+        labels: List[str],
+        audit_log: Optional[AuditLog] = None
+    ) -> bool:
+        """
+        Stops one or more job instructions in a workflow.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_path (str):
+                The full path of the workflow in which the specified job
+                instructions should be stopped.
+
+            labels (List[str]):
+                A list of job instruction labels identifying the job
+                instructions that should be stopped.
+
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+
+        Returns:
+            bool:
+                Returns `True` if the operation was successful,
+                otherwise `False`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id`,
+                `workflow_path`, or `labels` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+        
+        return stop_job_instructions_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )
+        
+    def suspend_workflows(
+        self,
+        controller_id: str,
+        workflow_paths: List[str],
+        audit_log: Optional[AuditLog] = None
+    ) -> bool:
+        """
+        Suspends one or more workflows.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_paths (List[str]):
+                A list of workflow paths identifying the workflows
+                that should be suspended.
+
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+
+        Returns:
+            bool:
+                Returns `True` if the operation was successful,
+                otherwise `False`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id`
+                or `workflow_paths` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+        
+        return suspend_workflows_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_paths=workflow_paths,
+            audit_log=audit_log
+        )
+        
+    def unskip_job_instructions(
+        self,
+        controller_id: str,
+        workflow_path: str,
+        labels: List[str],
+        audit_log: Optional[AuditLog] = None
+    ) -> bool:
+        """
+        Unskips previously skipped job instructions in a workflow.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_path (str):
+                The full path of the workflow in which the specified job
+                instructions should be re-enabled.
+
+            labels (List[str]):
+                A list of job instruction labels identifying the job
+                instructions that should no longer be skipped.
+
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+
+        Returns:
+            bool:
+                Returns `True` if the operation was successful,
+                otherwise `False`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id`,
+                `workflow_path`, or `labels` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+
+        return unskip_job_instructions_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )
+        
+    def unstop_job_instructions(
+        self,
+        controller_id: str,
+        workflow_path: str,
+        labels: List[str],
+        audit_log: Optional[AuditLog] = None
+    ) -> bool:
+        """
+        Releases previously stopped job instructions in a workflow.
+
+        Args:
+            controller_id (str):
+                The ID of the controller on which the operation should be executed.
+
+            workflow_path (str):
+                The full path of the workflow in which the specified job
+                instructions should be released.
+
+            labels (List[str]):
+                A list of job instruction labels identifying the job
+                instructions that should no longer remain stopped.
+
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+
+        Returns:
+            bool:
+                Returns `True` if the operation was successful,
+                otherwise `False`.
+
+        Raises:
+            ValueError:
+                If required arguments such as `controller_id`,
+                `workflow_path`, or `labels` are missing or invalid.
+
+            RuntimeError:
+                If the server version is not compatible or if an
+                unexpected response is returned.
+        """
+
+        return unstop_job_instructions_action(
+            context=self._ctx,
+            controller_id=controller_id,
+            workflow_path=workflow_path,
+            labels=labels,
+            audit_log=audit_log
+        )

js7/client/feature/workflow/workflow.py

@@ -0,0 +1,19 @@
+from functools import cached_property
+
+from .manage import Manage
+from .operate import Operate
+
+from ....client.context import Context
+
+
+class Workflow:
+    def __init__(self, context: Context):
+        self._ctx = context
+        
+    @cached_property
+    def manage(self) -> Manage:
+        return Manage(context=self._ctx)
+    
+    @cached_property
+    def operate(self) -> Operate:
+        return Operate(context=self._ctx)

js7/model/__init__.py

@@ -0,0 +1,132 @@
+#---------------------#
+# `./configuration/*` #
+#---------------------#
+from .configuration.http_configuration import HTTPConfiguration
+__all__ = ["HTTPConfiguration"]
+
+from .configuration.client_configuration import ClientConfiguration
+__all__ += ["ClientConfiguration"]
+
+#----------------------#
+# `./authentication/*` #
+#----------------------#
+from .configuration.auth_configuration import AuthConfiguration, BasicAuth, CertAuth
+__all__ += ["AuthConfiguration", "BasicAuth", "CertAuth"]
+
+#-------------#
+# `./error/*` #
+#-------------#
+from .error.http.joc_exceptions import (
+    JocError, 
+    AuthenticationFailed,
+    PermissionDenied,
+    SessionExpired,
+    JocValidationFailed,
+    JocOperationFailed,
+    ApprovalRequired
+)
+
+__all__ += [
+    "JocError", 
+    "AuthenticationFailed",
+    "PermissionDenied",
+    "SessionExpired",
+    "JocValidationFailed",
+    "JocOperationFailed",
+    "ApprovalRequired"
+]
+
+#--------------#
+# `./public/*` #
+#--------------#
+from .public.client.common import (
+    AuditLog, 
+    Change, 
+    Configuration, 
+    DeployConfiguration, 
+    DraftConfiguration, 
+    ReleaseConfiguration, 
+    GitCredentials, 
+    ScheduleTime,
+    StoreAgent,
+    StoreClusterAgent,
+    StoreSubagent,
+    SubagentCluster,
+    Account,
+    IdentityService,
+    Cycle
+)
+
+__all__ += [
+    "AuditLog", 
+    "Change", 
+    "Configuration", 
+    "DeployConfiguration", 
+    "DraftConfiguration", 
+    "ReleaseConfiguration", 
+    "GitCredentials",
+    "ScheduleTime",
+    "StoreAgent",
+    "StoreClusterAgent",
+    "StoreSubagent",
+    "SubagentCluster",
+    "Account",
+    "IdentityService",
+    "Cycle"
+]
+
+from .public.client.enum import (
+    DeployObjectType, 
+    DescriptorObjectType, 
+    OperationType, 
+    OrderPriority, 
+    ReleaseObjectType, 
+    ObjectType
+)
+
+__all__ += [
+    "DeployObjectType", 
+    "DescriptorObjectType", 
+    "OperationType", 
+    "OrderPriority", 
+    "ReleaseObjectType", 
+    "ObjectType"
+]
+
+#---------------------#
+# `./public/filter/*` #
+#---------------------#
+from .public.client.filter import (
+    ExportFilter, 
+    Folder, 
+    ExportFoldersFilter, 
+    GetOrderFilter, 
+    OrderHistoryFilter, 
+    ResumeOrderFilter, 
+    SuspendOrderFilter, 
+    TasksFilter, 
+    WorkflowID, 
+    DailyPlanOrdersFilter, 
+    DailyPlanSubmitOrderFilter,
+    DailyPlanCancelOrdersFilter,
+    DailyPlanProjectionsFilter
+)
+
+__all__ += [
+    "DailyPlanOrdersFilter", 
+    "ExportFilter", 
+    "Folder", 
+    "ExportFoldersFilter",
+    "GetOrderFilter", 
+    "OrderHistoryFilter", 
+    "ResumeOrderFilter", 
+    "SuspendOrderFilter", 
+    "TasksFilter", 
+    "WorkflowID",
+    "DailyPlanSubmitOrderFilter",
+    "DailyPlanCancelOrdersFilter",
+    "DailyPlanProjectionsFilter"
+]
+
+from .public.client.input import Order, PlanID
+__all__ += ["Order", "PlanID"]

js7/model/configuration/auth_configuration.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+from typing import Optional, Union
+from pydantic import BaseModel, model_validator
+
+
+class BasicAuth(BaseModel):
+    username: str
+    password: str
+
+
+class CertAuth(BaseModel):
+    certfile_path: Union[Path, str]
+    keyfile_path: Union[Path, str]
+
+
+class AuthConfiguration(BaseModel):
+    basic_auth: Optional[BasicAuth] = None
+    cert_auth: Optional[CertAuth]  = None
+    
+    @model_validator(mode="after")
+    def validate_exactly_one_auth(self):
+        if (self.basic_auth is None) == (self.cert_auth is None):
+            raise ValueError("Exactly one of 'basic_auth' or 'cert_auth' must be provided.")
+        return self

js7/model/configuration/client_configuration.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class ClientConfiguration(BaseModel):
+    timezone: str = "Etc/UTC"
+    """see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"""

js7/model/configuration/http_configuration.py

@@ -0,0 +1,10 @@
+from pathlib import Path
+from typing import Optional, Union
+from pydantic import BaseModel
+
+
+class HTTPConfiguration(BaseModel):
+    host: str
+    port: int
+    ssl: bool = False
+    cafile_path: Optional[Union[Path, str]] = None