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

js7/client/action/controller/register_controller_action.py

@@ -0,0 +1,93 @@
+from typing import Literal, 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 (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    RegisterParameters as RegisterParameters_V_2_8_2,
+    RegisterParameter as RegisterParameter_V_2_8_2,
+    ControllerRole as ControllerRole_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def register_controller_action(
+    *, 
+    context: Context, 
+    controller_id: Optional[str],
+    url: str,
+    cluster_url: Optional[str],
+    role: Literal["STANDALONE", "PRIMARY", "BACKUP"],
+    title: Optional[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,
+            url=url,
+            cluster_url=cluster_url,
+            role=role,
+            title=title,
+            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="controller/register", 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: Optional[str],
+    url: str,
+    cluster_url: Optional[str],
+    role: Literal["STANDALONE", "PRIMARY", "BACKUP"],
+    title: Optional[str],
+    audit_log: Optional[AuditLog]
+) -> RegisterParameters_V_2_8_2:
+
+    # Validate: url
+    if not url:
+        raise ValueError("'url' is required.")
+    
+    # Validate: role
+    if role not in ["STANDALONE", "PRIMARY", "BACKUP"]:
+        raise ValueError(f"Invalid 'role': {role}.")
+    
+    # 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 RegisterParameters_V_2_8_2(
+        controller_id=controller_id,
+        controllers=[
+            RegisterParameter_V_2_8_2(
+                url=url,
+                cluster_url=cluster_url,
+                role=ControllerRole_V_2_8_2(role), # Raises ValueError() if invalid.
+                title=title,
+            )
+        ],
+        audit_log=res_audit_log
+    )

js7/client/action/controller/restart_controller_action.py

@@ -0,0 +1,72 @@
+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.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    URLParameter as URLParameter__V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def restart_controller_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    url: Optional[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,
+            url=url,
+            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="controller/restart", 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, 
+    url: Optional[str], 
+    audit_log: Optional[AuditLog]
+) -> URLParameter__V_2_8_2:
+
+    # Validates controller id
+    if not controller_id:
+        raise ValueError("'controller_id' 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 URLParameter__V_2_8_2(
+        controller_id=controller_id,
+        url=url,
+        audit_log=res_audit_log,
+        with_switchover=False
+    )

js7/client/action/controller/switchover_controller_cluster_action.py

@@ -0,0 +1,67 @@
+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.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    URLParameter as URLParameter__V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def switchover_controller_cluster_action(
+    *, 
+    context: Context, 
+    controller_id: 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,
+            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="controller/cluster/switchover", 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, 
+    audit_log: Optional[AuditLog]
+) -> URLParameter__V_2_8_2:
+    
+    # Validates controller id
+    if not controller_id:
+        raise ValueError("'controller_id' 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 URLParameter__V_2_8_2(
+        controller_id=controller_id,
+        audit_log=res_audit_log
+    )

js7/client/action/controller/terminate_controller_action.py

@@ -0,0 +1,72 @@
+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.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    URLParameter as URLParameter_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def terminate_controller_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    url: Optional[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,
+            url=url,
+            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="controller/terminate", 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, 
+    url: Optional[str], 
+    audit_log: Optional[AuditLog]
+) -> URLParameter_V_2_8_2:
+
+    # Validates controller id
+    if not controller_id:
+        raise ValueError("'controller_id' 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 URLParameter_V_2_8_2(
+        controller_id=controller_id,
+        url=url,
+        audit_log=res_audit_log,
+        with_switchover=False
+    )

js7/client/action/controller/test_controller_instance_action.py

@@ -0,0 +1,65 @@
+from typing import Optional
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    TestConnect as TestConnect_V_2_8_2,
+    JobScheduler200 as JobScheduler200_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def test_controller_instance_action(
+    *, 
+    context: Context, 
+    controller_id: Optional[str], 
+    url: str
+) -> 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,
+            url=url
+        )
+    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="controller/test", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+
+    if isinstance(result, JobScheduler200_V_2_8_2):
+        if not (
+            result.controller
+            and result.controller.connection_state 
+            and result.controller.connection_state.severity != 0
+        ):
+            return False
+        
+        return True
+                
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *, 
+    controller_id: Optional[str], 
+    url: str
+) -> TestConnect_V_2_8_2:
+
+    # Validates controller id
+    if not url:
+        raise ValueError("'url' is required.")
+
+    # Result
+    return TestConnect_V_2_8_2(
+        controller_id=controller_id,
+        url=url
+    )

js7/client/action/controller/unregister_controller_action.py

@@ -0,0 +1,68 @@
+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.private.http.joc.joc_v_2_8_2 import (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    URLParameter as URLParameter_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def unregister_controller_action(
+    *, 
+    context: Context, 
+    controller_id: 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,
+            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="controller/unregister", 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,
+    audit_log: Optional[AuditLog]
+) -> URLParameter_V_2_8_2:
+    
+    # Validates controller id
+    if not controller_id:
+        raise ValueError("'controller_id' 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 URLParameter_V_2_8_2(
+        controller_id=controller_id,
+        audit_log=res_audit_log,
+        with_switchover=False
+    )

js7/client/action/daily_plan/cancel_orders_action.py

@@ -0,0 +1,59 @@
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.filter.daily_plan_order_filters import DailyPlanCancelOrdersFilter
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    Folder as Folder_V_2_8_2,
+    DailyPlanCancelOrders as DailyPlanCancelOrders_V_2_8_2,
+    OK as OK_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def cancel_orders_action(
+    *,
+    context: Context,
+    filter: DailyPlanCancelOrdersFilter
+) -> bool:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(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="daily_plan/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(filter: DailyPlanCancelOrdersFilter) -> DailyPlanCancelOrders_V_2_8_2:    
+    # Result
+    return DailyPlanCancelOrders_V_2_8_2(
+        daily_plan_date_from=filter.date_from,
+        daily_plan_date_to=filter.date_to,
+        controller_ids=filter.controller_ids,
+        order_ids=filter.order_ids,
+        workflow_paths=filter.workflow_paths,
+        schedule_paths=filter.schedule_paths,
+        
+        schedule_folders=[
+            Folder_V_2_8_2(folder=f.folder_path, recursive=f.recursive)
+            for f in filter.schedule_folders
+        ] if filter.schedule_folders else None,
+        
+        workflow_folders=[
+            Folder_V_2_8_2(folder=f.folder_path, recursive=f.recursive)
+            for f in filter.workflow_folders
+        ] if filter.workflow_folders else None
+    )

js7/client/action/daily_plan/copy_orders_action.py

@@ -0,0 +1,108 @@
+from typing import List, Optional, Tuple
+
+from ...context import Context
+from ....model.public.client.common.cycle import Cycle
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.common.schedule_time import ScheduleTime
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    DailyPlanCopyOrder as DailyPlanCopyOrder_V_2_8_2,
+    Cycle as Cycle_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    OrderIDMap200 as OrderIDMap200_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def copy_orders_action(
+    *,
+    context: Context,
+    controller_id: str,
+    order_ids: List[str],
+    scheduled_for: Optional[ScheduleTime],
+    cycle: Optional[Cycle],
+    force_job_admission: bool,
+    sticky_daily_plan_date: bool,
+    audit_log: Optional[AuditLog]
+) -> List[Tuple[str, 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,
+            order_ids=order_ids,
+            scheduled_for=scheduled_for,
+            cycle=cycle,
+            force_job_admission=force_job_admission,
+            sticky_daily_plan_date=sticky_daily_plan_date,
+            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="daily_plan/orders/copy", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None
+    ))
+
+    if isinstance(result, OrderIDMap200_V_2_8_2):
+        return [
+            (old_id, new_id)
+            for old_id, new_id in result.order_ids
+        ] if result.order_ids else []
+
+    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,
+    order_ids: List[str],
+    scheduled_for: Optional[ScheduleTime],
+    cycle: Optional[Cycle],
+    force_job_admission: bool,
+    sticky_daily_plan_date: bool,
+    audit_log: Optional[AuditLog]
+) -> DailyPlanCopyOrder_V_2_8_2:    
+    
+    # Validate: timezone
+    if not timezone:
+        raise ValueError("'timezone' is required in client config.")
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: order_ids
+    if not order_ids:
+        raise ValueError("At least one order id in 'order_ids' 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 DailyPlanCopyOrder_V_2_8_2(
+        time_zone=timezone,
+        controller_id=controller_id,
+        order_ids=order_ids,
+        scheduled_for=scheduled_for.value if scheduled_for else None,
+        cycle=Cycle_V_2_8_2(
+            begin=str(cycle.begin),
+            end=str(cycle.end),
+            repeat=str(cycle.repeat)
+        ) if cycle else None,
+        force_job_admission=force_job_admission,
+        stick_daily_plan_date=sticky_daily_plan_date,
+        audit_log=res_audit_log
+    )

js7/client/action/daily_plan/create_projections_action.py

@@ -0,0 +1,24 @@
+from ...context import Context
+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
+)
+
+
+def create_projections_action(
+    *,
+    context: Context
+) -> bool:
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="daily_plan/projections/recreate", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=None,
+        options=None
+    ))
+
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")