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

js7/client/action/agent/store_subagent_clusters_action.py

@@ -0,0 +1,83 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.store_agents import SubagentCluster
+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,
+    StoreSubagentClusters as StoreSubagentClusters_V_2_8_2,
+    SubagentCluster as SubagentCluster_V_2_8_2,
+    SubagentID as SubagentID_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_subagent_clusters_action(
+    *, 
+    context: Context, 
+    subagent_clusters: List[SubagentCluster],
+    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(
+            subagent_clusters=subagent_clusters,
+            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="agents/cluster/store", 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(
+    *, 
+    subagent_clusters: List[SubagentCluster],
+    audit_log: Optional[AuditLog]
+) -> StoreSubagentClusters_V_2_8_2:
+    
+    # Validate: subagent_clusters
+    if not subagent_clusters:
+        raise ValueError("At least one subagent cluster in 'subagent_clusters' 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 StoreSubagentClusters_V_2_8_2(
+        subagent_clusters=[
+            SubagentCluster_V_2_8_2(
+                agent_id=sc.id,
+                subagent_cluster_id=sc.subagent_cluster_id,
+                title=sc.title,
+                subagent_ids=[
+                    SubagentID_V_2_8_2(
+                        subagent_id=id,
+                        priority=priority
+                    )
+                    for id, priority in sc.subagent_ids
+                ] if sc.subagent_ids else None,
+            )
+            for sc in subagent_clusters
+        ],
+        audit_log=res_audit_log
+    )

js7/client/action/agent/store_subagents_action.py

@@ -0,0 +1,97 @@
+from typing import Optional, List
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.common.store_agents import StoreSubagent
+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,
+    StoreSubAgents as StoreSubAgents_V_2_8_2,
+    Subagent as Subagent_V_2_8_2,
+    SubagentDirectorType as SubagentDirectorType_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_subagents_action(
+    *, 
+    context: Context, 
+    controller_id: str,
+    agent_id: str,
+    subagents: List[StoreSubagent],
+    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,
+            agent_id=agent_id,
+            subagents=subagents,
+            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="agents/inventory/cluster/subagents/store", 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,
+    agent_id: str,
+    subagents: List[StoreSubagent],
+    audit_log: Optional[AuditLog]
+) -> StoreSubAgents_V_2_8_2:
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: agent_id
+    if not agent_id:
+        raise ValueError("'agent_id' is required.")
+    
+    # Validate: subagents
+    if not subagents:
+        raise ValueError("At least one subagent in 'subagents' 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 StoreSubAgents_V_2_8_2(
+        controller_id=controller_id,
+        agent_id=agent_id,
+        subagents=[
+            Subagent_V_2_8_2(
+                subagent_id=s.id,
+                url=s.url,
+                title=s.title,
+                # Raises ValueError() if invalid
+                is_director=SubagentDirectorType_V_2_8_2(s.director_type) if s.director_type else None,
+                with_generate_subagent_cluster=s.with_generate_subagent_cluster,
+                ordering=s.order
+            )
+            for s in subagents
+        ],
+        audit_log=res_audit_log
+    )

js7/client/action/agent/switchover_agent_action.py

@@ -0,0 +1,75 @@
+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,
+    AgentCommand as AgentCommand_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def switchover_agent_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    agent_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,
+            agent_id=agent_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="agent/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, 
+    agent_id: str,
+    audit_log: Optional[AuditLog]
+) -> AgentCommand_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validates agent_id
+    if not agent_id:
+        raise ValueError("'agent_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 AgentCommand_V_2_8_2(
+        controller_id=controller_id,
+        agent_id=agent_id,
+        audit_log=res_audit_log
+    )

js7/client/action/controller/appoint_nodes_controller_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 appoint_controller_cluster_roles_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/appoint_nodes", 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/cancel_and_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 cancel_and_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/abort_and_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/cancel_controller_action.py

@@ -0,0 +1,71 @@
+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 cancel_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/abort", 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,
+    )

js7/client/action/controller/confirm_cluster_node_loss_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 confirm_cluster_node_loss_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/confirm_node_loss", 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(
+        audit_log=res_audit_log,
+        controller_id=controller_id,
+        with_switchover=False
+    )

js7/client/action/controller/get_controller_components_action.py

@@ -0,0 +1,41 @@
+from typing import Any, Dict
+
+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,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def get_controller_components_action(*, context: Context, controller_id: str) -> 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)
+    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/components", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, Components_V_2_8_2):
+        return result.model_dump(mode="json")
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(controller_id: str) -> ControllerIdReq_V_2_8_2:
+    # Validates controller id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Result
+    return ControllerIdReq_V_2_8_2(controller_id=controller_id)

js7/client/action/controller/get_controller_status_action.py

@@ -0,0 +1,72 @@
+from typing import Any, Dict, 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,
+    URLParameter as URLParameter_V_2_8_2,
+    JobScheduler200 as JobScheduler200_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def get_controller_status_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    url: Optional[str], 
+    audit_log: Optional[AuditLog]
+) -> 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,
+            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", 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):
+        return result.model_dump(mode="json")
+    
+    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
+    )