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

js7/client/action/agent/deploy_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 deploy_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/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,
+    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/disable_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 disable_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/disable", 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 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 DeployAgents_V_2_8_2(
+        controller_id=controller_id,
+        agent_ids=agent_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/disable_subagents_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,
+    SubAgentsCommand as SubAgentsCommand_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def disable_subagents_action(
+    *, 
+    context: Context, 
+    controller_id: str,
+    subagent_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_ids=subagent_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/subagents/disable", 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_ids: List[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_ids
+    if not subagent_ids:
+        raise ValueError("At least one agent id in 'subagent_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 SubAgentsCommand_V_2_8_2(
+        controller_id=controller_id,
+        subagent_ids=subagent_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/enable_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 enable_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/enable", 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 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 DeployAgents_V_2_8_2(
+        controller_id=controller_id,
+        agent_ids=agent_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/enable_subagents_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,
+    SubAgentsCommand as SubAgentsCommand_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def enable_subagents_action(
+    *, 
+    context: Context, 
+    controller_id: str,
+    subagent_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_ids=subagent_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/subagents/enable", 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_ids: List[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_ids
+    if not subagent_ids:
+        raise ValueError("At least one agent id in 'subagent_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 SubAgentsCommand_V_2_8_2(
+        controller_id=controller_id,
+        subagent_ids=subagent_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/export_agents_action.py

@@ -0,0 +1,101 @@
+from pathlib import Path
+from typing import List, Literal, Optional, Union
+
+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,
+    AgentExportFilter as AgentExportFilter_V_2_8_2,
+    ExportFile as ExportFile_V_2_8_2,
+    ArchiveFormat as ArchiveFormat_V_2_8_2
+)
+
+from ....util.bytes_converter.bytes_to_file import bytes_to_file
+from ....util.check_matching_version import check_matching_version
+
+
+def export_agents_action(
+    *, 
+    context: Context, 
+    out_path: Union[Path, str],
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    agent_ids: List[str],
+    audit_log: Optional[AuditLog]
+) -> bool:
+    
+    # Normalize out_path
+    out_path = Path(out_path)
+
+    # Determine expected suffix from archive_format
+    expected_suffix = ".tar.gz" if archive_format == "TAR_GZ" else ".zip"
+
+    # Append suffix if missing or wrong
+    if not out_path.name.endswith((".zip", ".tar.gz")):
+        out_path = out_path.with_name(out_path.name + expected_suffix)
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            out_path=out_path,
+            archive_format=archive_format,
+            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/export", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, bytes):
+        return bytes_to_file(data=result, out_path=Path(out_path))
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    out_path: Union[Path, str],
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    agent_ids: List[str],
+    audit_log: Optional[AuditLog]
+) -> AgentExportFilter_V_2_8_2:
+    
+    # Validate: out_path
+    if not out_path:
+        raise ValueError("'out_path' is required.")
+    
+    # Validate: archive_format
+    if not archive_format:
+        raise ValueError("'archive_format' is required.")
+    
+    # Validate: agent_ids
+    if not agent_ids:
+        raise ValueError("At least one agent id in 'agent_ids' is required.")
+    
+    # Build: export_file
+    res_export_file = ExportFile_V_2_8_2(
+        filename=Path(out_path).name,
+        format=(ArchiveFormat_V_2_8_2(archive_format)) # Raises ValueError() if invalid.
+    )
+    
+    # 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 AgentExportFilter_V_2_8_2(
+        agent_ids=agent_ids,
+        export_file=res_export_file,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/get_agents_status_action.py

@@ -0,0 +1,55 @@
+from typing import Any, Dict, List
+
+from ...context import Context
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    ReadAgentsV as ReadAgentsV_V_2_8_2,
+    AgentsV as AgentsV_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def get_agents_status_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    agent_ids: List[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=controller_id, agent_ids=agent_ids)
+    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", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, AgentsV_V_2_8_2):
+        return result.model_dump(mode="json").get("agents") 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, agent_ids: List[str]) -> ReadAgentsV_V_2_8_2:
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: agent_ids
+    if not agent_ids:
+        raise ValueError("At least one agent id in 'agent_ids' is required.")
+    
+    # Result
+    return ReadAgentsV_V_2_8_2(
+        controller_id=controller_id,
+        agent_ids=agent_ids,
+        compact=False,
+    )

js7/client/action/agent/import_agents_action.py

@@ -0,0 +1,139 @@
+from pathlib import Path
+from typing import Any, Dict, List, Literal, Optional, Tuple, Union
+
+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)
+
+from ....util.detect_archive_type import detect_archive_type
+from ....util.bytes_converter.files_to_bytes import files_to_bytes
+from ....util.bytes_converter.bytes_to_archive_bytes import bytes_to_archive_bytes
+from ....util.check_matching_version import check_matching_version
+from ....util.bytes_converter.read_bytes_archive_files_to_bytes import read_bytes_archive_files_to_bytes
+
+
+def import_agents_action(
+    *, 
+    context: Context,
+    controller_id: str,
+    file_path: Union[Path, str],
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    overwrite: bool,
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        options, data = _build_v_2_8_2_request(
+            controller_id=controller_id,
+            file_path=Path(file_path),
+            archive_format=archive_format,
+            overwrite=overwrite,
+            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/import", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=data,
+        options=options,
+    ))
+    
+    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                   #
+# Returns: [Formdata, List of archives] #
+#---------------------------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    file_path: Path,
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    overwrite: bool,
+    audit_log: Optional[AuditLog]
+) -> Tuple[Dict[str, Any], bytes]:
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: file_path
+    if not file_path.exists():
+        raise ValueError(f"File path does not exist: {file_path}")
+    
+    # Validate: archive_format
+    if archive_format not in ("ZIP", "TAR_GZ"):
+        raise ValueError("'archive_format' must be 'ZIP' or 'TAR_GZ'.")
+    
+    # Build: files_as_bytes
+    files_as_bytes = files_to_bytes(
+        file_path=file_path,
+        filter_suffixes=[".json", ".zip", ".tar.gz", ".tgz"]
+    )
+    
+    if not files_as_bytes:
+        raise ValueError(
+            "No matching files found for import. "
+            "Expected: '*.json', '*.zip', '*.tar.gz', '*.tgz'."
+        )
+    
+    # Build: res_files
+    files: List[Tuple[str, bytes]] = []
+    
+    for path, file in files_as_bytes:
+        # Skips invalid filenames
+        if path.rsplit("/", 1)[-1].startswith((".", "_", "-")):
+            continue
+                
+        archive_type = detect_archive_type(file)
+        
+        if not archive_type and path.endswith(".json"):
+            files.append((path, file))
+        else:
+            arch_files = read_bytes_archive_files_to_bytes(
+                file=file, 
+                filter_suffixes=[".json"]
+            )
+            
+            if not arch_files:
+                continue
+            
+            for arch_path, arch_file in arch_files:
+                # Skips invalid filenames
+                if arch_path.rsplit("/", 1)[-1].startswith((".", "_", "-")):
+                    continue
+                
+                # Removes archive suffix
+                path = path.split(".")[0]
+                
+                new_path = path + "/" + arch_path
+                files.append((new_path, arch_file))
+    
+    # Build: res_archive
+    res_archive = bytes_to_archive_bytes(archive_format=archive_format, files=files)
+    
+    # Build: options
+    res_options: Dict[str, Any] = {
+        "format": archive_format,
+        "overwrite": overwrite,
+        "controller_id": controller_id    
+    }
+    
+    # Build: audit_log
+    if audit_log:
+        if audit_log.ticket_link:
+            res_options["audit_log_ticket_link"] = audit_log.ticket_link
+        if audit_log.comment:
+            res_options["audit_log_comment"] = audit_log.comment
+        if audit_log.time_spent:
+            res_options["audit_log_time_spent"] = audit_log.time_spent
+    
+    # Result
+    return res_options, res_archive