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

js7/model/public/client/common/__init__.py

@@ -0,0 +1,27 @@
+from .audit_log import AuditLog
+from .changes import Change
+from .configurations import Configuration, DeployConfiguration, DraftConfiguration, ReleaseConfiguration
+from .git_credentials import GitCredentials
+from .schedule_time import ScheduleTime
+from .store_agents import StoreClusterAgent, StoreSubagent, SubagentCluster, StoreAgent
+from .accounts import Account
+from .identity_service import IdentityService
+from .cycle import Cycle
+
+__all__ = [
+    "Configuration", 
+    "DeployConfiguration", 
+    "DraftConfiguration", 
+    "ReleaseConfiguration", 
+    "AuditLog", 
+    "Change",
+    "GitCredentials",
+    "ScheduleTime",
+    "StoreClusterAgent", 
+    "StoreSubagent",
+    "SubagentCluster", 
+    "StoreAgent",
+    "Account",
+    "IdentityService",
+    "Cycle"
+]

js7/model/public/client/common/accounts.py

@@ -0,0 +1,21 @@
+from datetime import datetime
+from typing import List, Optional
+from pydantic import BaseModel
+
+from .....model.public.client.common.audit_log import AuditLog
+
+
+class Account(BaseModel):
+    account_name: str
+    password: Optional[str] = None
+    disabled: Optional[bool] = None
+    force_password_change: Optional[bool] = None
+    roles: Optional[List[str]] = None
+    identity_service_name: str
+
+
+class BlockedAccount(BaseModel):
+    account_name: str
+    comment: Optional[str] = None
+    blocked_since: Optional[datetime] = None
+    audit_log: Optional[AuditLog] = None

js7/model/public/client/common/audit_log.py

@@ -0,0 +1,8 @@
+from typing import Optional
+from pydantic import BaseModel
+
+
+class AuditLog(BaseModel):
+    ticket_link: Optional[str] = None
+    comment:     Optional[str] = None
+    time_spent:  Optional[int] = None

js7/model/public/client/common/changes.py

@@ -0,0 +1,18 @@
+from typing import List, Literal, Optional, Set
+from pydantic import BaseModel
+
+from ..enum.object_types import ObjectType
+
+
+ChangeStatus = Literal["DEPLOYED", "VALID", "RELEASED"]
+
+
+class Change(BaseModel):
+    path: Optional[str]
+    name: Optional[str] = None
+    object_type: ObjectType
+    status: Optional[Set[ChangeStatus]] = None
+
+
+class ChangeDependencies(Change):
+    dependencies: List[Change]

js7/model/public/client/common/configurations.py

@@ -0,0 +1,53 @@
+from typing import Optional
+from pydantic import BaseModel, model_validator
+
+from ..enum.object_types import DeployObjectType, ReleaseObjectType, ObjectType
+
+
+class _BaseConfiguration(BaseModel):
+    path: str
+    """Path to an inventory object or folder."""
+
+
+class DeployConfiguration(_BaseConfiguration):
+    commit_id: Optional[str] = None
+    """Optional commit identifier used to deploy a specific inventory state."""
+    
+    object_type: DeployObjectType
+    """Type of the deployable inventory object."""
+    
+    recursive: bool = False
+    """If set to True and `path` refers to a folder, all contained objects are processed recursively."""
+
+
+class DraftConfiguration(_BaseConfiguration):
+    object_type: DeployObjectType
+    """Type of the draft inventory object."""
+    
+    recursive: bool = False
+    """If set to True and `path` refers to a folder, all contained objects are processed recursively."""
+    
+    @model_validator(mode="after")
+    def validate_recursive(self):
+        if self.recursive and self.object_type != "FOLDER":
+            raise ValueError("'recursive' can only be used when object_type is 'FOLDER'.")
+        return self
+    
+    
+class ReleaseConfiguration(_BaseConfiguration):
+    object_type: ReleaseObjectType
+    """Type of the releasable inventory object."""
+    
+    recursive: bool = False
+    """If set to True and `path` refers to a folder, all contained objects are processed recursively."""
+
+    @model_validator(mode="after")
+    def validate_recursive(self):
+        if self.recursive and self.object_type != "FOLDER":
+            raise ValueError("'recursive' can only be used when object_type is 'FOLDER'.")
+        return self
+
+
+class Configuration(_BaseConfiguration):
+    object_type: ObjectType
+    """Type of the inventory object."""

js7/model/public/client/common/cycle.py

@@ -0,0 +1,12 @@
+from datetime import time
+from pydantic import BaseModel, field_serializer
+
+
+class Cycle(BaseModel):
+    begin: time
+    end: time
+    repeat: time
+
+    @field_serializer("begin", "end", "repeat")
+    def serialize_time(self, value: time) -> str:
+        return value.strftime("%H:%M:%S")

js7/model/public/client/common/git_credentials.py

@@ -0,0 +1,12 @@
+from typing import Optional
+from pydantic import BaseModel
+
+
+class GitCredentials(BaseModel):
+    email: str
+    git_account: str
+    git_server: str
+    keyfile_path: Optional[str] = None
+    password: Optional[str] = None
+    personal_access_token: Optional[str] = None
+    username: str

js7/model/public/client/common/identity_service.py

@@ -0,0 +1,14 @@
+from typing import Literal, Optional
+
+from pydantic import BaseModel
+
+
+class IdentityService(BaseModel):
+    identity_service_name: str
+    identity_service_type: Literal["UNKNOWN", "KEYCLOAK", "KEYCLOAK-JOC", "LDAP", "LDAP-JOC", "OIDC", "OIDC-JOC", "FIDO", "JOC", "CERTIFICATE"]
+    service_authentication_scheme: Literal["SINGLE-FACTOR", "TWO-FACTOR"]
+    second_factor: bool = False
+    second_factor_identity_service_name: Optional[str] = None
+    disabled: bool = False
+    required: bool = False
+    ordering: int = 1

js7/model/public/client/common/schedule_time.py

@@ -0,0 +1,50 @@
+from datetime import datetime, timezone
+from typing import Optional, Union
+from pydantic import BaseModel
+
+
+class ScheduleTime(BaseModel):
+    value: str
+
+    @classmethod
+    def normalize(cls, value: Optional[Union[str, float, int]]) -> Optional["ScheduleTime"]:
+        if value is None:
+            return None
+
+        # numeric epoch millis
+        if isinstance(value, (int, float)):
+            ts = value / 1000.0
+            dt = datetime.fromtimestamp(ts, tz=timezone.utc)
+            return ScheduleTime.at(dt)
+
+        # numeric string → epoch millis
+        if value.replace(".", "", 1).isdigit():
+            ts = float(value) / 1000.0
+            dt = datetime.fromtimestamp(ts, tz=timezone.utc)
+            return ScheduleTime.at(dt)
+
+        # plain JS7 string
+        return ScheduleTime(value=value)
+    
+    @classmethod
+    def now(cls) -> "ScheduleTime":
+        return cls(value="now")
+
+    @classmethod
+    def never(cls) -> "ScheduleTime":
+        return cls(value="never")
+
+    @classmethod
+    def now_plus_seconds(cls, seconds: int) -> "ScheduleTime":
+        return cls(value=f"now + {seconds}")
+
+    @classmethod
+    def now_plus_hms(cls, hours: int = 0, minutes: int = 0, seconds: int = 0) -> "ScheduleTime":
+        return cls(value=f"now + {hours:02d}:{minutes:02d}:{seconds:02d}")
+
+    @classmethod
+    def at(cls, dt: datetime) -> "ScheduleTime":
+        return cls(value=dt.strftime("%Y-%m-%d %H:%M:%S"))
+
+    def __str__(self) -> str:
+        return self.value

js7/model/public/client/common/store_agents.py

@@ -0,0 +1,96 @@
+from typing import List, Literal, Optional, Tuple
+from pydantic import BaseModel
+
+
+class StoreSubagent(BaseModel):
+    id: str
+    """
+    The `id` is the name that is used in the Controller to identify a Subagent.
+    This value is set once and cannot be overwritten.
+    """
+    
+    url: str
+    """URL of the subagent."""
+    
+    title: Optional[str] = None
+    """The title of the agent."""
+    
+    director_type: Optional[Literal["NO_DIRECTOR", "PRIMARY_DIRECTOR", "SECONDARY_DIRECTOR"]] = None
+    
+    order: Optional[int] = None
+    
+    with_generate_subagent_cluster: bool = False
+    """
+    if true then a subagent cluster with only the subagent as member is created.
+    The subagent cluster ID is equal the subagend ID.
+    """
+
+
+class StoreClusterAgent(BaseModel):
+    id: str
+    """
+    The `id` is the (technical) name that is used in the Controller to identify an Agent.
+    This value is set once and cannot be overwritten.
+    """
+    
+    name: str
+    """The `name` is the (logical) name that is used for the configuration of a Job to identify an Agent."""
+    
+    aliases: Optional[List[str]] = None
+    """Aliases of the `name`."""
+    
+    title: Optional[str] = None
+    """The title of the agent."""
+    
+    process_limit: Optional[int] = None
+    """Limits the number max. processes that are started by the Agent."""
+    
+    subagents: List[StoreSubagent]
+
+
+class StoreAgent(BaseModel):
+    id: str
+    """
+    The `id` is the (technical) name that is used in the Controller to identify an Agent.
+    This value is set once and cannot be overwritten.
+    """
+    
+    name: str
+    """The `name` is the (logical) name that is used for the configuration of a Job to identify an Agent."""
+    
+    aliases: Optional[List[str]] = None
+    """Aliases of the `name`."""
+    
+    url: str
+    """URL of the agent."""
+    
+    process_limit: Optional[int] = None
+    """Limits the number max. processes that are started by the Agent."""
+    
+    hidden: bool = False
+    """A hidden Agent will not be offered in JOC Cockpit during the Job configuration."""
+    
+    
+class SubagentCluster(BaseModel):
+    id: str
+    """
+    The `id` is the (technical) name that is used in the Controller to identify an Agent.
+    This value is set once and cannot be overwritten.
+    """
+    
+    subagent_cluster_id: str
+    """The ID of the Subagent Cluster."""
+    
+    title: Optional[str] = None
+    """A title of the Subagent Cluster."""
+    
+    subagent_ids: Optional[List[Tuple[str, int]]] = None
+    """
+    Collection of Subagents.
+    
+    Arguments:
+        str: The subagent id.
+        int: The subagent priority.
+    """
+    
+    

js7/model/public/client/enum/__init__.py

@@ -0,0 +1,19 @@
+from .object_types import (
+    DeployObjectType, 
+    DescriptorObjectType, 
+    ReleaseObjectType, 
+    ObjectType
+)
+
+__all__ = [
+    "DeployObjectType", 
+    "DescriptorObjectType", 
+    "ReleaseObjectType", 
+    "ObjectType"
+]
+
+from .operation_type import OperationType
+__all__ += ["OperationType"]
+
+from .order_priority import OrderPriority
+__all__ += ["OrderPriority"]

js7/model/public/client/enum/object_types.py

@@ -0,0 +1,48 @@
+from enum import Enum
+
+
+class ObjectType(str, Enum):
+    """All inventory object types."""
+    
+    FOLDER = "FOLDER"
+    WORKFLOW = "WORKFLOW"
+    LOCK = "LOCK"
+    NOTICEBOARD = "NOTICEBOARD"
+    JOBRESOURCE = "JOBRESOURCE"
+    FILEORDERSOURCE = "FILEORDERSOURCE"
+    SCHEDULE = "SCHEDULE"
+    WORKINGDAYSCALENDAR = "WORKINGDAYSCALENDAR"
+    NONWORKINGDAYSCALENDAR = "NONWORKINGDAYSCALENDAR"
+    JOBTEMPLATE = "JOBTEMPLATE"
+    INCLUDESCRIPT = "INCLUDESCRIPT"
+    REPORT = "REPORT"
+    DEPLOYMENTDESCRIPTOR = "DEPLOYMENTDESCRIPTOR"
+    DESCRIPTORFOLDER = "DESCRIPTORFOLDER"
+
+
+class DeployObjectType(str, Enum):
+    """Only deployable inventory object types."""
+    
+    FOLDER = "FOLDER"
+    WORKFLOW = "WORKFLOW"
+    LOCK = "LOCK"
+    NOTICEBOARD = "NOTICEBOARD"
+    JOBRESOURCE = "JOBRESOURCE"
+    FILEORDERSOURCE = "FILEORDERSOURCE"
+
+
+class ReleaseObjectType(str, Enum):
+    """Only releasable inventory object types."""
+    
+    FOLDER = "FOLDER"
+    SCHEDULE = "SCHEDULE"
+    WORKINGDAYSCALENDAR = "WORKINGDAYSCALENDAR"
+    NONWORKINGDAYSCALENDAR = "NONWORKINGDAYSCALENDAR"
+    JOBTEMPLATE = "JOBTEMPLATE"
+    INCLUDESCRIPT = "INCLUDESCRIPT"
+    REPORT = "REPORT"
+
+
+class DescriptorObjectType(str, Enum):
+    DEPLOYMENTDESCRIPTOR = "DEPLOYMENTDESCRIPTOR"
+    DESCRIPTORFOLDER = "DESCRIPTORFOLDER"

js7/model/public/client/enum/operation_type.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+class OperationType(str, Enum):
+    DEPLOY  = "DEPLOY"
+    EXPORT  = "EXPORT"
+    GIT     = "GIT"
+    RECALL  = "RECALL"
+    RELEASE = "RELEASE"
+    REMOVE  = "REMOVE"
+    REVOKE  = "REVOKE"

js7/model/public/client/enum/order_priority.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class OrderPriority(int, Enum):
+    LOW          = -20000
+    BELOW_NORMAL = -10000
+    NORMAL       = 0
+    ABOVE_NORMAL = 10000
+    HIGH         = 20000

js7/model/public/client/filter/__init__.py

@@ -0,0 +1,35 @@
+#----------#
+# Elements #
+#----------#
+from .element import WorkflowID, Folder
+__all__ = ["WorkflowID", "Folder"]
+
+#---------#
+# Filters #
+#---------#
+from .daily_plan_order_filters import (
+    DailyPlanOrdersFilter, 
+    DailyPlanCancelOrdersFilter, 
+    DailyPlanSubmitOrderFilter, 
+    DailyPlanProjectionsFilter
+)
+from .export_filter import ExportFilter
+from .get_order_filter import GetOrderFilter
+from .order_history_filter import OrderHistoryFilter
+from .resume_order_filter import ResumeOrderFilter
+from .suspend_order_filter import SuspendOrderFilter
+from .tasks_filter import TasksFilter
+from .export_folders_filter import ExportFoldersFilter
+__all__ += [
+    "DailyPlanOrdersFilter", 
+    "ExportFilter", 
+    "ExportFoldersFilter",
+    "GetOrderFilter", 
+    "OrderHistoryFilter", 
+    "ResumeOrderFilter",
+    "SuspendOrderFilter",
+    "TasksFilter",
+    "DailyPlanCancelOrdersFilter",
+    "DailyPlanSubmitOrderFilter",
+    "DailyPlanProjectionsFilter"
+]