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

js7/api/joc/http/v_2_8_2/workflows/suspend.py

@@ -0,0 +1,36 @@
+from ......model.private.api.endpoint import EndpointDefinition, EndpointCall
+from ......model.private.http.joc.joc_v_2_8_2 import ModifyWorkflows, OK
+
+
+def suspend(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    if not call.payload:
+        raise ValueError("'payload' is required in function call.")
+    
+    if not isinstance(call.payload, ModifyWorkflows):
+        raise ValueError("'payload' is not an instance of model.http.joc_v_2_8_2.ModifyWorkflows.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/workflows/suspend", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)
+    
+ENDPOINT_DEFINITION = EndpointDefinition(
+    id="workflows/suspend",
+    function=suspend,
+    version=("2.6.5", "2.8.3"),
+    payload_model=ModifyWorkflows,
+    response_model=OK,
+    options=None
+)

js7/api/joc/http/v_2_8_2/workflows/unskip.py

@@ -0,0 +1,36 @@
+from ......model.private.api.endpoint import EndpointDefinition, EndpointCall
+from ......model.private.http.joc.joc_v_2_8_2 import ModifyWorkflowLabels, OK
+
+
+def unskip(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    if not call.payload:
+        raise ValueError("'payload' is required in function call.")
+    
+    if not isinstance(call.payload, ModifyWorkflowLabels):
+        raise ValueError("'payload' is not an instance of model.http.joc_v_2_8_2.ModifyWorkflowLabels.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/workflow/unskip", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)
+    
+ENDPOINT_DEFINITION = EndpointDefinition(
+    id="workflow/unskip",
+    function=unskip,
+    version=("2.6.5", "2.8.3"),
+    payload_model=ModifyWorkflowLabels,
+    response_model=OK,
+    options=None
+)

js7/api/joc/http/v_2_8_2/workflows/unstop.py

@@ -0,0 +1,36 @@
+from ......model.private.api.endpoint import EndpointDefinition, EndpointCall
+from ......model.private.http.joc.joc_v_2_8_2 import ModifyWorkflowPositions, OK
+
+
+def unstop(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    if not call.payload:
+        raise ValueError("'payload' is required in function call.")
+    
+    if not isinstance(call.payload, ModifyWorkflowPositions):
+        raise ValueError("'payload' is not an instance of model.http.joc_v_2_8_2.ModifyWorkflowPositions.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/workflow/unstop", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)
+    
+ENDPOINT_DEFINITION = EndpointDefinition(
+    id="workflow/unstop",
+    function=unstop,
+    version=("2.6.5", "2.8.3"),
+    payload_model=ModifyWorkflowPositions,
+    response_model=OK,
+    options=None
+)

js7/api/joc/http/v_2_8_2/workflows/workflows.py

@@ -0,0 +1,36 @@
+from ......model.private.api.endpoint import EndpointDefinition, EndpointCall
+from ......model.private.http.joc.joc_v_2_8_2 import WorkflowsFilter, Workflows
+
+
+def workflows(call: EndpointCall) -> Workflows:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    if not call.payload:
+        raise ValueError("'payload' is required in function call.")
+    
+    if not isinstance(call.payload, WorkflowsFilter):
+        raise ValueError("'payload' is not an instance of model.http.joc_v_2_8_2.WorkflowsFilter.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/workflows", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token,
+                "Accept": "application/json"
+            }
+        )
+        
+        return Workflows.model_validate_json(resp)
+
+ENDPOINT_DEFINITION = EndpointDefinition(
+    id="workflows",
+    function=workflows,
+    version=("2.6.5", "2.8.3"),
+    payload_model=WorkflowsFilter,
+    response_model=Workflows,
+    options=None
+)

js7/api/joc/interface/dispatcher.py

@@ -0,0 +1,76 @@
+from typing import Optional, Union, get_args, get_origin
+from pydantic import BaseModel
+
+from .resolver import Resolver
+from ....model.private.api.endpoint import EndpointCall, EndpointDefinition
+
+
+class Dispatcher(Resolver):
+    def __init__(self, version: Optional[str]):
+        super().__init__()
+        self._version = version
+
+    def set_version(self, version: str):
+        self._version = version
+    
+    def dispatch(self, *, endpoint_id: str, call: EndpointCall) -> Union[BaseModel, bytes, bytearray]:
+        # Auto discovery if no version is set.
+        if not self._version:
+            for ep in self._endpoint_cache:
+                if endpoint_id == ep.id:
+                    try:
+                        return self._execute(ep, call)
+                    except RuntimeError:
+                        continue
+            
+            raise RuntimeError("Auto discovery for endpoint failed.")
+        
+        ep = self.resolve(version=self._version, endpoint_id=endpoint_id)
+        
+        return self._execute(ep, call)
+
+    def _execute(self, endpoint_definition: EndpointDefinition, call: EndpointCall):
+        # Validates payload
+        if endpoint_definition.payload_model:
+            if not call.payload:
+                raise ValueError("Payload is required for this endpoint")
+            if not isinstance(call.payload, endpoint_definition.payload_model):
+                raise TypeError(
+                    f"Payload must be {endpoint_definition.payload_model.__name__}"
+                )
+
+        # Validates options
+        if endpoint_definition.options:
+            call_options = call.options or {}
+
+            for name, typ in endpoint_definition.options.items():
+                value = call_options.get(name)
+
+                # Optional[T]
+                if get_origin(typ) is Union and type(None) in get_args(typ):
+                    inner = next(t for t in get_args(typ) if t is not type(None))
+                    if value is not None and not isinstance(value, inner):
+                        raise TypeError(
+                            f"Option '{name}' must be {inner.__name__} or None"
+                        )
+                    continue
+
+                # Required option
+                if value is None:
+                    raise ValueError(f"Missing option '{name}'")
+
+                if not isinstance(value, typ):
+                    raise TypeError(
+                        f"Option '{name}' must be {typ.__name__}"
+                    )
+
+        # Calls the endpoint function from 'EndpointDefinition'
+        result = endpoint_definition.function(call)
+
+        # Validate response type        
+        if not isinstance(result, endpoint_definition.response_model):
+            raise TypeError(
+                f"Invalid response type: expected {endpoint_definition.response_model.__name__}"
+            )
+
+        return result

js7/api/joc/interface/interface.py

@@ -0,0 +1,8 @@
+from typing import Optional
+from .dispatcher import Dispatcher
+
+
+class Interface(Dispatcher):
+    def __init__(self, version: Optional[str]):
+        super().__init__(version=version)
+        

js7/api/joc/interface/resolver.py

@@ -0,0 +1,75 @@
+import importlib
+import os
+from pathlib import Path
+from typing import List
+
+from ....model.private.api.endpoint import EndpointDefinition
+
+from ....util.check_matching_version import check_matching_version
+
+
+class Resolver:
+    def __init__(self):
+        self._endpoint_cache: List[EndpointDefinition] = []
+        self._load_endpoints(
+            base_package="js7.api.joc.http",
+            base_path = Path(__file__).parents[1] / "http"
+        )
+
+    def _load_endpoints(self, *, base_package: str, base_path: Path) -> None:
+        """
+        Walks through js7/api/joc/http and imports all modules
+        that expose ENDPOINT_DEFINITION.
+        """
+
+        for root, _, files in os.walk(base_path):
+            for file in files:
+                if not file.endswith(".py"):
+                    continue
+                if file.startswith("__"):
+                    continue
+
+                file_path = Path(root) / file
+
+                # relative path without .py
+                rel_path = file_path.relative_to(base_path).with_suffix("")
+
+                # module import path
+                module_path = ".".join(
+                    [base_package] + list(rel_path.parts)
+                )
+
+                module = importlib.import_module(module_path)
+
+                if hasattr(module, "ENDPOINT_DEFINITION"):
+                    endpoint_def = getattr(module, "ENDPOINT_DEFINITION")
+
+                    if not isinstance(endpoint_def, EndpointDefinition):
+                        raise TypeError(
+                            f"{module_path}.ENDPOINT_DEFINITION is not EndpointDefinition"
+                        )
+
+                    self._endpoint_cache.append(endpoint_def)
+        
+    def resolve(self, *, version: str, endpoint_id: str) -> EndpointDefinition:
+        """
+        Resolves the endpoint definition for a given JOC version.
+        """
+        
+        if not self._endpoint_cache:
+            raise RuntimeError("Endpoint cache is empty.")
+        
+        for ep in self._endpoint_cache:
+            ep_min_version, ep_max_version = ep.version
+            
+            version_is_ok = check_matching_version(
+                min=ep_min_version, 
+                max=ep_max_version, 
+                check=version
+            )
+            
+            if endpoint_id == ep.id and version_is_ok:
+                return ep
+        
+        raise ValueError(f"Endpoint with id: {endpoint_id} and version {version} is not available.")    
+

js7/client/action/agent/confirm_node_loss_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 confirm_node_loss_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/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,
+    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/agent/delete_subagent_action.py

@@ -0,0 +1,77 @@
+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,
+    SubAgentsCommand as SubAgentsCommand_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def delete_subagent_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    subagent_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,
+            subagent_id=subagent_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="agents/inventory/cluster/subagents/delete", 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,
+    subagent_id: str,
+    audit_log: Optional[AuditLog]
+) -> SubAgentsCommand_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validates subagent_id
+    if not subagent_id:
+        raise ValueError("'subagent_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 SubAgentsCommand_V_2_8_2(
+        controller_id=controller_id,
+        subagent_ids=[
+            subagent_id
+        ],
+        audit_log=res_audit_log
+    )

js7/client/action/agent/delete_subagent_clusters_action.py

@@ -0,0 +1,75 @@
+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 (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    DeploySubagentClusters as DeploySubagentClusters_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def delete_subagent_clusters_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    subagent_cluster_ids: 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,
+            subagent_cluster_ids=subagent_cluster_ids,
+            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/delete", 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,
+    subagent_cluster_ids: List[str],
+    audit_log: Optional[AuditLog]
+) -> DeploySubagentClusters_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validates subagent_cluster_id
+    if not subagent_cluster_ids:
+        raise ValueError("At least one id in 'subagent_cluster_ids' are 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 DeploySubagentClusters_V_2_8_2(
+        controller_id=controller_id,
+        subagent_cluster_ids=subagent_cluster_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/deploy_cluster_agents_action.py

@@ -0,0 +1,75 @@
+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 (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    DeployClusterAgents as DeployClusterAgents_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def deploy_cluster_agents_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    agent_ids: 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,
+            agent_ids=agent_ids,
+            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/deploy", 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_ids: List[str],
+    audit_log: Optional[AuditLog]
+) -> DeployClusterAgents_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validates agent_ids
+    if not agent_ids:
+        raise ValueError("At least one agent id in 'agent_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 DeployClusterAgents_V_2_8_2(
+        controller_id=controller_id,
+        cluster_agent_ids=agent_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/deploy_standalone_agents_action.py

@@ -0,0 +1,75 @@
+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 (
+    AuditParams as AuditParams_V_2_8_2,
+    OK as OK_V_2_8_2,
+    DeployAgents as DeployAgents_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def deploy_standalone_agents_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    agent_ids: 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,
+            agent_ids=agent_ids,
+            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/deploy", 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_ids: List[str],
+    audit_log: Optional[AuditLog]
+) -> DeployAgents_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validates agent_ids
+    if not agent_ids:
+        raise ValueError("At least one id in 'agent_ids' are 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 DeployAgents_V_2_8_2(
+        controller_id=controller_id,
+        agent_ids=agent_ids,
+        audit_log=res_audit_log
+    )