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

js7/client/action/joc/run_service_action.py

@@ -0,0 +1,74 @@
+from typing import Literal, Optional
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    ClusterServices as ClusterServices_V_2_8_2,
+    ClusterResponse as ClusterResponse_V_2_8_2,
+    ClusterServiceRun as ClusterServiceRun_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def run_service_action(
+    *, 
+    context: Context,
+    service_type: Literal["cleanup", "cluster", "dailyplan", "history", "lognotification", "monitor"],
+    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(service_type=service_type, 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="joc/cluster/run", call=EndpointCall(
+        http_service=context.http_service,
+        payload=request_data,
+        access_token=context.auth_provider.login(),
+        options=None
+    ))
+    
+    if isinstance(result, ClusterResponse_V_2_8_2):
+        if not result.state:
+            return False
+        
+        if result.state.value in ["ERROR", "MISSING_CONFIGURATION", "MISSING_HANDLERS", "MISSING_LICENSE", "UNCOMPLETED"]:
+            raise Exception(f"Restart of service: {service_type} failed with state: {result.state.value}.")
+        
+        return True
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    service_type: Literal["cleanup", "cluster", "dailyplan", "history", "lognotification", "monitor"], 
+    audit_log: Optional[AuditLog]
+) -> ClusterServiceRun_V_2_8_2:
+    
+    # Validate: service_type
+    svc_types = ["cleanup", "cluster", "dailyplan", "history", "lognotification", "monitor"]
+    if not service_type:
+        raise ValueError("'service_type' is required")
+    if service_type not in svc_types:
+        raise ValueError(f"Unsupported 'service_type': {service_type}. Supported values are: {svc_types}")
+    
+    # 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 ClusterServiceRun_V_2_8_2(
+        type=ClusterServices_V_2_8_2(service_type), # Raises ValueError if invalid.
+        audit_log=res_audit_log
+    )

js7/client/action/joc/store_settings_action.py

@@ -0,0 +1,62 @@
+import json
+from typing import Any, Dict, Optional
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    StoreSettingsFilter as StoreSettingsFilter_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_settings_action(*, context: Context, payload: Dict[str, Any], 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(
+            payload=payload,
+            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="settings/store", call=EndpointCall(
+        http_service=context.http_service,
+        payload=request_data,
+        access_token=context.auth_provider.login(),
+        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(
+    *,
+    payload: Dict[str, Any],
+    audit_log: Optional[AuditLog]
+) -> StoreSettingsFilter_V_2_8_2:
+
+    # Validate: payload
+    if not payload:
+        raise ValueError("'payload' 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 StoreSettingsFilter_V_2_8_2(
+        configuration_item=json.dumps(payload),
+        audit_log=res_audit_log
+    )

js7/client/action/joc/switch_over_action.py

@@ -0,0 +1,89 @@
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    ControllerIdReq as ControllerIdReq_V_2_8_2,
+    Components as Components_V_2_8_2,
+    ClusterSwitchMember as ClusterSwitchMember_V_2_8_2,
+    ClusterResponse as ClusterResponse_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def switch_over_action(
+    *,
+    context: Context,
+    controller_id: str
+) -> bool:
+
+    if not check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        raise RuntimeError(
+            f"Version {context.version} is not compatible with switch over."
+        )
+
+    request_data = _build_v_2_8_2_request(controller_id=controller_id)
+
+    # (1) Get controller components
+    result = context.joc_api.dispatch(
+        endpoint_id="controller/components",
+        call=EndpointCall(
+            http_service=context.http_service,
+            payload=request_data,
+            access_token=context.auth_provider.login(),
+            options=None
+        )
+    )
+
+    if not isinstance(result, Components_V_2_8_2):
+        raise RuntimeError(f"Unexpected response type from controller/components: {type(result).__name__}")
+
+    if not result.jocs:
+        raise ValueError("No JOC Cockpit instances found.")
+
+    # (2) Find exactly one standby JOC (severity == 1)
+    standby_members = [
+        j.member_id
+        for j in result.jocs
+        if j.member_id
+        and j.cluster_node_state
+        and j.cluster_node_state.severity == 1
+    ]
+
+    if not standby_members:
+        raise ValueError("Switch over failed: no standby JOC Cockpit instance found.")
+
+    if len(standby_members) > 1:
+        raise ValueError(f"Switch over failed: multiple standby JOCs found: {standby_members}")
+
+    member_id = standby_members[0]
+
+    # (3) Switch to standby member
+    result = context.joc_api.dispatch(
+        endpoint_id="joc/cluster/switch_member",
+        call=EndpointCall(
+            http_service=context.http_service,
+            payload=ClusterSwitchMember_V_2_8_2(member_id=member_id),
+            access_token=context.auth_provider.login(),
+            options=None
+        )
+    )
+
+    if not isinstance(result, ClusterResponse_V_2_8_2):
+        raise RuntimeError(f"Unexpected response type from switch_member: {type(result).__name__}")
+
+    if not result.state:
+        raise RuntimeError("Switch over failed: missing state in response.")
+
+    if result.state.value != "SWITCH_MEMBER":
+        raise RuntimeError(f"Switch over failed with state: {result.state.value}")
+
+    return True
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(*, controller_id: str) -> ControllerIdReq_V_2_8_2:
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+
+    return ControllerIdReq_V_2_8_2(controller_id=controller_id)

js7/client/action/order/add_orders_action.py

@@ -0,0 +1,115 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.schedule_time import ScheduleTime
+from ....model.public.client.input.add_order import Order
+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 (
+    AddOrders as AddOrders_V_2_8_2,
+    AddOrder as AddOrder_V_2_8_2,
+    OrderIDS as OrderIDS_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    PlanID as PlanID_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+# Returns: OrderIDs
+def add_orders_action(
+    *, 
+    context: Context,
+    controller_id: str,
+    orders: List[Order], 
+    audit_log: Optional[AuditLog]
+) -> List[str]:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            timezone=context.client_config.timezone, 
+            controller_id=controller_id,
+            orders=orders,
+            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/add", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OrderIDS_V_2_8_2):
+        if not result.order_ids:
+            raise RuntimeError("No order id returned by server.")
+        return result.order_ids
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    timezone: str, 
+    controller_id: str,
+    orders: List[Order],
+    audit_log: Optional[AuditLog]
+) -> AddOrders_V_2_8_2:
+    
+    # Validate: timezone
+    if not timezone:
+        raise ValueError("'timezone' is required in client configuration.")
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: orders
+    if not orders:
+        raise ValueError("At least one order in 'orders' 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 AddOrders_V_2_8_2(
+        controller_id=controller_id,
+        audit_log=res_audit_log,
+        orders=[
+            AddOrder_V_2_8_2(
+                arguments=o.arguments,
+                block_position=o.block_position,
+                end_positions=o.end_positions,
+                force_job_admission=o.force_job_admission,
+                open_closed_plan=o.open_closed_plan,
+                order_name=o.order_name if o.order_name else "unnamed",
+                plan_id=(
+                    PlanID_V_2_8_2(
+                        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=(
+                    o.scheduled_for.value 
+                    if o.scheduled_for 
+                    else None
+                ) if isinstance(o.scheduled_for, ScheduleTime) else o.scheduled_for,
+                start_position=o.start_position,
+                tags=o.tags,
+                time_zone=timezone,
+                workflow_path=o.workflow_path,
+            )
+            for o in orders
+        ]
+    )

js7/client/action/order/cancel_orders_action.py

@@ -0,0 +1,93 @@
+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 (
+    CancelOrders as CancelOrders_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 cancel_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, 
+            timezone=context.client_config.timezone,
+            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/cancel", 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, 
+    timezone: str,
+    order_ids: Optional[List[str]], 
+    workflow_paths: Optional[List[str]], 
+    audit_log: Optional[AuditLog]
+) -> CancelOrders_V_2_8_2:
+    
+    # Validate: timezone
+    if not timezone:
+        raise ValueError("'timezone' is required in client configuration.")
+    
+    # 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: 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=path)
+        for path in workflow_paths
+    ] if workflow_paths else None
+    
+    # Result
+    return CancelOrders_V_2_8_2(
+        controller_id=controller_id,
+        workflow_ids=res_workflow_ids,
+        order_ids=order_ids,
+        audit_log=res_audit_log,
+        time_zone=timezone
+    )

js7/client/action/order/confirm_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 confirm_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/confirm", 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: One of order_ids or workflow_paths
+    if sum([bool(order_ids), bool(workflow_paths)]) != 1:
+        raise ValueError("Exactly 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/continue_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 continue_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/continue", 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/get_order_history_action.py

@@ -0,0 +1,84 @@
+from typing import Any, Dict
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.filter.order_history_filter import OrderHistoryFilter
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    OrdersFilter as OrdersFilter_V_2_8_2,
+    OrderHistory as OrderHistory_V_2_8_2,
+    Folder as Folder_V_2_8_2,
+    HistoryStateText as HistoryStateText_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def get_order_history_action(*, context: Context, controller_id: str, filter: OrderHistoryFilter) -> 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="orders/history", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OrderHistory_V_2_8_2):
+        return result.model_dump()
+    
+    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: OrderHistoryFilter
+) -> OrdersFilter_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: timezone
+    if not timezone:
+        raise ValueError("'timezone' is required in client configuration.")
+        
+    # Result
+    return OrdersFilter_V_2_8_2(
+        controller_id=controller_id,
+        date_from=filter.date_from,
+        date_to=filter.date_to,
+        completed_date_from=filter.completed_date_from,
+        completed_date_to=filter.completed_date_to,
+        time_zone=timezone,
+        order_id=filter.order_id,
+        workflow_name=filter.workflow_name,
+        limit=filter.limit,
+        
+        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=[
+            HistoryStateText_V_2_8_2(s)
+            for s in filter.history_states
+        ] if filter.history_states else None,
+        
+        compact=None,
+        exclude_workflows=None,
+        history_ids=None,
+        orders=None,
+        workflow_path=None
+    )