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

js7/client/action/agent/remove_agent_action.py

@@ -0,0 +1,79 @@
+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 remove_agent_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    agent_id: str,
+    force: bool,
+    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,
+            force=force,
+            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/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,
+    agent_id: str,
+    force: bool,
+    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,
+        force=force,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/reset_agents_action.py

@@ -0,0 +1,79 @@
+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,
+    ResetAgents as ResetAgents_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def reset_agents_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    agent_ids: List[str],
+    force: bool,
+    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,
+            force=force,
+            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/reset", 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],
+    force: bool,
+    audit_log: Optional[AuditLog]
+) -> ResetAgents_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validates agent_id
+    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 ResetAgents_V_2_8_2(
+        controller_id=controller_id,
+        agent_ids=agent_ids,
+        force=force,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/reset_subagent_action.py

@@ -0,0 +1,79 @@
+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,
+    SubAgentCommand as SubAgentCommand_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def reset_subagent_action(
+    *, 
+    context: Context, 
+    controller_id: str,
+    subagent_id: str,
+    force: bool,
+    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,
+            force=force,
+            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/subagent/reset", 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,
+    force: bool,
+    audit_log: Optional[AuditLog]
+) -> SubAgentCommand_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("At least one agent id in '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 SubAgentCommand_V_2_8_2(
+        controller_id=controller_id,
+        subagent_id=subagent_id,
+        force=force,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/revoke_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 revoke_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/revoke", 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_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 DeployClusterAgents_V_2_8_2(
+        controller_id=controller_id,
+        cluster_agent_ids=agent_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/revoke_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 revoke_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/revoke", 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_id
+    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/revoke_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 revoke_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/revoke", 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_ids
+    if not subagent_cluster_ids:
+        raise ValueError("At least one agent id in 'subagent_cluster_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 DeploySubagentClusters_V_2_8_2(
+        controller_id=controller_id,
+        subagent_cluster_ids=subagent_cluster_ids,
+        audit_log=res_audit_log
+    )

js7/client/action/agent/store_cluster_agents_action.py

@@ -0,0 +1,99 @@
+from typing import List, Optional
+
+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 StoreClusterAgent
+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,
+    StoreClusterAgents as StoreClusterAgents_V_2_8_2,
+    ClusterAgent as ClusterAgent_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_cluster_agents_action(
+    *,
+    context: Context, 
+    controller_id: str, 
+    agents: List[StoreClusterAgent],
+    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,
+            agents=agents,
+            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/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, 
+    agents: List[StoreClusterAgent],
+    audit_log: Optional[AuditLog]
+) -> StoreClusterAgents_V_2_8_2:
+    
+    # Validates controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validates agents
+    if not agents:
+        raise ValueError("At least one agent in 'agents' is required.")
+    
+    # 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
+
+    # Result
+    return StoreClusterAgents_V_2_8_2(
+        controller_id=controller_id,
+        cluster_agents=[
+            ClusterAgent_V_2_8_2(
+                agent_id=a.id,
+                agent_name=a.name,
+                agent_name_aliases=a.aliases,
+                title=a.title,
+                process_limit=a.process_limit,
+                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, 
+                        ordering=s.order,
+                        with_generate_subagent_cluster=s.with_generate_subagent_cluster
+                    )
+                    for s in a.subagents
+                ]
+            )
+            for a in agents
+        ],
+        audit_log=res_audit_log
+    )

js7/client/action/agent/store_standalone_agents_action.py

@@ -0,0 +1,87 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.common.store_agents import StoreAgent
+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,
+    StoreAgents as StoreAgents_V_2_8_2,
+    Agent as Agent_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def store_standalone_agents_action(
+    *, 
+    context: Context, 
+    controller_id: str, 
+    agents: List[StoreAgent],
+    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,
+            agents=agents,
+            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/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, 
+    agents: List[StoreAgent],
+    audit_log: Optional[AuditLog]
+) -> StoreAgents_V_2_8_2:
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: agents
+    if not agents:
+        raise ValueError("At least one agent in 'agents' 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 StoreAgents_V_2_8_2(
+        controller_id=controller_id,
+        agents=[
+            Agent_V_2_8_2(
+                agent_id=a.id,
+                agent_name=a.name,
+                agent_name_aliases=a.aliases,
+                url=a.url,
+                process_limit=a.process_limit,
+                hidden=a.hidden
+            )
+            for a in agents
+        ],
+        audit_log=res_audit_log
+    )