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

js7/client/action/order/get_orders_action.py

@@ -0,0 +1,83 @@
+from typing import List
+
+from ...context import Context
+from ....model.public.client.common.schedule_time import ScheduleTime
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.filter.get_order_filter import GetOrderFilter
+from ....model.public.client.input.add_order import Order, PlanID
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OrdersFilterV as OrdersFilterV_V_2_8_2,
+    OrderStateText as OrderStateText_V_2_8_2,
+    OrdersV as OrdersV_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+from ....util.str_converter.order_id_to_order_name import order_id_to_order_name
+
+
+def get_orders_action(*, context: Context, controller_id: str, filter: GetOrderFilter) -> List[Order]:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(controller_id=controller_id, filter=filter)
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="orders", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OrdersV_V_2_8_2):
+        return [
+            Order(
+                arguments=o.arguments,
+                block_position=o.position,
+                end_positions=o.end_positions,
+                force_job_admission=False,
+                open_closed_plan=False,
+                order_name = order_id_to_order_name(o.order_id),
+                plan_id=PlanID(
+                    notice_space_key=o.plan_id.notice_space_key,
+                    plan_schema_id=o.plan_id.plan_schema_id
+                ) if o.plan_id else None,
+                priority=o.priority,
+                scheduled_for=ScheduleTime.normalize(o.scheduled_for),
+                start_position=None,
+                tags=o.tags,
+                workflow_path=o.workflow_id.path or "" if o.workflow_id else ""
+            )
+            for o in result.orders
+        ] if result.orders else []
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(*, controller_id: str, filter: GetOrderFilter) -> OrdersFilterV_V_2_8_2:
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Build: States
+    res_states = [
+        OrderStateText_V_2_8_2(state) # Raises ValueError() if invalid.
+        for state in filter.states
+    ] if filter.states else None
+    
+    # Result
+    return OrdersFilterV_V_2_8_2(
+        controller_id=controller_id,
+        compact=filter.compact,
+        limit=filter.limit,
+        order_ids=filter.order_ids,
+        order_tags=filter.order_tags,
+        regex=filter.regex,
+        state_date_from=filter.state_date_from,
+        state_date_to=filter.state_date_to,
+        states=res_states,
+        without_workflow_tags=filter.without_workflow_tags,
+        workflow_tags=filter.workflow_tags
+    )

js7/client/action/order/remove_terminated_orders_action.py

@@ -0,0 +1,86 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    ModifyOrdersBase as ModifyOrdersBase_V_2_8_2,
+    OK as OK_V_2_8_2,
+    WorkflowID as WorkflowID_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def remove_terminated_orders_action(
+    *,
+    context: Context, 
+    controller_id: str, 
+    order_ids: Optional[List[str]],
+    workflow_paths: Optional[List[str]],
+    audit_log: Optional[AuditLog]
+) -> bool:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id,
+            order_ids=order_ids,
+            workflow_paths=workflow_paths,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="orders/remove_when_terminated", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    order_ids: Optional[List[str]],
+    workflow_paths: Optional[List[str]],
+    audit_log: Optional[AuditLog]
+) -> ModifyOrdersBase_V_2_8_2:
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: Any of order_ids or workflow_paths
+    if not (order_ids or workflow_paths):
+        raise ValueError("At least one of 'order_ids' or 'workflow_paths' must be provided.")
+    
+    # Build: audit_log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Build: res_workflow_ids
+    res_workflow_ids = [
+        WorkflowID_V_2_8_2(path=path)
+        for path in workflow_paths
+    ] if workflow_paths else None
+    
+    # Result
+    return ModifyOrdersBase_V_2_8_2(
+        controller_id=controller_id,
+        order_ids=order_ids,
+        workflow_ids=res_workflow_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/order/resume_orders_action.py

@@ -0,0 +1,102 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.filter.resume_order_filter import ResumeOrderFilter
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    WorkflowID as WorkflowID_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ResumeOrders as ResumeOrders_V_2_8_2,
+    Folder as Folder_V_2_8_2,
+    OrderStateText as OrderStateText_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def resume_orders_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    filter: ResumeOrderFilter, 
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            filter=filter, 
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="orders/resume", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    controller_id: str, 
+    filter: ResumeOrderFilter, 
+    audit_log: Optional[AuditLog]
+) -> ResumeOrders_V_2_8_2:
+    
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Build: res_workflow_ids
+    res_workflow_ids = [
+        WorkflowID_V_2_8_2(
+            path=id.workflow_path, 
+            version_id=id.version_id
+        )
+        for id in filter.workflow_ids
+    ] if filter.workflow_ids else None
+    
+    # Build: folders
+    res_folders = [
+        Folder_V_2_8_2(
+            folder=folder.folder_path,
+            recursive=folder.recursive
+        )
+        for folder in filter.folders
+    ] if filter.folders else None
+    
+    # Build: States
+    res_states = [
+        OrderStateText_V_2_8_2(state) # Raises ValueError() if invalid.
+        for state in filter.states
+    ] if filter.states else None
+    
+    # Result
+    return ResumeOrders_V_2_8_2(
+        controller_id=controller_id,
+        order_ids=filter.order_ids,
+        workflow_ids=res_workflow_ids,
+        folders=res_folders,
+        states=res_states,
+        force=filter.force,
+        from_current_block=filter.from_current_block,
+        position=filter.position,
+        variables=filter.variables,
+        cycle_end_time=filter.cycle_end_time,
+        audit_log=res_audit_log
+    )

js7/client/action/order/suspend_orders_action.py

@@ -0,0 +1,97 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.filter.suspend_order_filter import SuspendOrderFilter
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    WorkflowID as WorkflowID_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    SuspendOrders as SuspendOrders_V_2_8_2,
+    Folder as Folder_V_2_8_2,
+    OrderStateText as OrderStateText_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def suspend_orders_action(*, context: Context, controller_id: str, filter: SuspendOrderFilter, audit_log: Optional[AuditLog]) -> bool:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            filter=filter, 
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="orders/suspend", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    controller_id: str, 
+    filter: SuspendOrderFilter, 
+    audit_log: Optional[AuditLog]
+) -> SuspendOrders_V_2_8_2:
+    
+    # Build: res_audit_log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Build: res_workflow_ids
+    res_workflow_ids = [
+        WorkflowID_V_2_8_2(
+            path=id.workflow_path, 
+            version_id=id.version_id
+        )
+        for id in filter.workflow_ids
+    ] if filter.workflow_ids else None
+    
+    # Build: folders
+    res_folders = [
+        Folder_V_2_8_2(
+            folder=folder.folder_path,
+            recursive=folder.recursive
+        )
+        for folder in filter.folders
+    ] if filter.folders else None
+    
+    # Build: States
+    res_states = [
+        OrderStateText_V_2_8_2(state) # Raises ValueError() if invalid.
+        for state in filter.states
+    ] if filter.states else None
+    
+    # Result
+    return SuspendOrders_V_2_8_2(
+        controller_id=controller_id,
+        order_ids=filter.order_ids,
+        workflow_ids=res_workflow_ids,
+        folders=res_folders,
+        states=res_states,
+        date_from=filter.date_from,
+        date_to=filter.date_to,
+        time_zone=filter.timezone,
+        reset=filter.reset,
+        kill=filter.kill,
+        deep=filter.deep,
+        audit_log=res_audit_log
+    )

js7/client/action/task/get_task_history_info_action.py

@@ -0,0 +1,88 @@
+from typing import Any, Dict
+
+from ...context import Context
+from ....model.public.client.filter.tasks_filter import TasksFilter
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    JobsFilter as JobsFilter_V_2_8_2,
+    TaskHistory as TaskHistory_V_2_8_2,
+    Folder as Folder_V_2_8_2,
+    HistoryState as HistoryState_V_2_8_2,
+    HistoryStateText as HistoryStateText_V_2_8_2,
+    JobCriticality as JobCriticality_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def get_task_history_info_action(*, context: Context, controller_id: str, filter: TasksFilter) -> Dict[str, Any]:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id,
+            timezone=context.client_config.timezone,
+            filter=filter
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="tasks/history", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, TaskHistory_V_2_8_2):
+        return result.model_dump(mode="json").get("history") or {}
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    controller_id: str,
+    timezone: str,
+    filter: TasksFilter
+) -> JobsFilter_V_2_8_2:
+    
+    # Validate: controller_id: str
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    return JobsFilter_V_2_8_2(
+        controller_id=controller_id,
+        time_zone=timezone,
+        
+        date_from=filter.date_from.isoformat() if filter.date_from else None,
+        date_to=filter.date_to.isoformat() if filter.date_to else None,
+        completed_date_from=filter.completed_date_from.isoformat() if filter.completed_date_from else None,
+        completed_date_to=filter.completed_date_to.isoformat() if filter.completed_date_to else None,
+        
+        job_name=filter.job_name,
+        workflow_name=filter.workflow_name,
+        workflow_path=filter.workflow_paths,
+        
+        folders=[
+            Folder_V_2_8_2(folder=f.folder_path, recursive=f.recursive)
+            for f in filter.folders
+        ] if filter.folders else None,
+        
+        history_states=[
+            HistoryState_V_2_8_2(text=HistoryStateText_V_2_8_2(h)) # Raises ValueError() if invalid.
+            for h in filter.history_states
+        ] if filter.history_states else None,
+        
+        criticalities=[
+            JobCriticality_V_2_8_2(c) # Raises ValueError() if invalid.
+            for c in filter.criticalities
+        ] if filter.criticalities else None,
+        
+        exclude_jobs=None,
+        history_ids=None,
+        jobs=None,
+        task_ids=None,
+        limit=None,
+    )

js7/client/action/workflow/get_workflow_versions_action.py

@@ -0,0 +1,131 @@
+from typing import Dict
+from pathlib import PurePosixPath
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    WorkflowID as WorkflowID_V_2_8_2,
+    WorkflowFilter as WorkflowFilter_V_2_8_2,
+    Workflow as Workflow_V_2_8_2,
+    WorkflowsFilter as WorkflowsFilter_V_2_8_2,
+    Workflows as Workflows_V_2_8_2,
+    Folder as Folder_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+# Returns: { Version ID: Path }
+def get_workflow_versions_action(
+    *, 
+    context: Context,
+    controller_id: str,
+    workflow_path: str,
+    exclude_current_version: bool,
+) -> Dict[str, str]:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        result = _build_v_2_8_2_request(
+            ctx=context, 
+            controller_id=controller_id, 
+            workflow_path=workflow_path
+        )
+        
+        return _build_v_2_8_2_response(
+            response=result, 
+            exclude_current_version=exclude_current_version,
+            filter_workflow_path=workflow_path
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    ctx: Context,
+    controller_id: str,
+    workflow_path: str,
+) -> Workflows_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: workflow_path
+    if not workflow_path:
+        raise ValueError("'workflow_path' is required.")
+    
+    # Request: /workflow
+    res_workflow = ctx.joc_api.dispatch(endpoint_id="workflow", call=EndpointCall(
+        http_service=ctx.http_service,
+        access_token=ctx.auth_provider.login(),
+        payload=WorkflowFilter_V_2_8_2(
+            controller_id=controller_id,
+            workflow_id=WorkflowID_V_2_8_2(
+                path=workflow_path,
+                version_id=None
+            ),
+            compact=False
+        ),
+        options=None,
+    ))
+    
+    if not isinstance(res_workflow, Workflow_V_2_8_2):
+        raise RuntimeError(f"Unexpected response type: {type(res_workflow).__name__}")
+    
+    # Request: /workflows
+    if not (res_workflow.workflow and res_workflow.workflow.path):
+        raise ValueError("'workflow.path' missing in response.")
+    
+    res_workflows = ctx.joc_api.dispatch(endpoint_id="workflows", call=EndpointCall(
+        http_service=ctx.http_service,
+        access_token=ctx.auth_provider.login(),
+        payload=WorkflowsFilter_V_2_8_2(
+            controller_id=controller_id,
+            folders=[Folder_V_2_8_2(
+                folder=str(PurePosixPath(res_workflow.workflow.path).parent),
+                recursive=False
+            )],
+            compact=False,
+            
+        ),
+        options=None,
+    ))
+    
+    if not isinstance(res_workflows, Workflows_V_2_8_2):
+        raise RuntimeError(f"Unexpected response type: {type(res_workflow).__name__}")
+    
+    return res_workflows
+
+#----------------------#
+# Build 2.8.2 response #
+#----------------------#
+def _build_v_2_8_2_response(
+    *,
+    response: Workflows_V_2_8_2,
+    exclude_current_version: bool,
+    filter_workflow_path: str
+) -> Dict[str, str]:
+    res: Dict[str, str] = {}
+    
+    # Returns empty dictionary if no workflows found
+    if not response.workflows:
+        return res
+    
+    for w in response.workflows:
+        # Remove: Not matching workflows paths
+        if w.path != filter_workflow_path:
+            continue
+        
+        # Filter: exclude_current_version
+        if exclude_current_version and w.is_current_version:
+            continue
+    
+        if not (w.version_id and w.path):
+            continue
+        
+        res[w.version_id] = w.path
+
+    return res

js7/client/action/workflow/resume_workflows_action.py

@@ -0,0 +1,76 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    ModifyWorkflows as ModifyWorkflows_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def resume_workflows_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    workflow_paths: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id, 
+            workflow_paths=workflow_paths, 
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="workflows/resume", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    workflow_paths: List[str],
+    audit_log: Optional[AuditLog]
+) -> ModifyWorkflows_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: workflow_path
+    if not workflow_paths:
+        raise ValueError("At least one workflow path in 'workflow_paths' is required.")
+    
+    # Build: audit_log 
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ModifyWorkflows_V_2_8_2(
+        controller_id=controller_id,
+        workflow_paths=workflow_paths,
+        all=False,
+        audit_log=res_audit_log
+    )