js7-client-python 2.0.10__tar.gz → 2.0.12__tar.gz

{js7_client_python-2.0.10/src/js7_client_python.egg-info → js7_client_python-2.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: js7-client-python
-Version: 2.0.10
+Version: 2.0.12
 Summary: Python Client for the JOC Cockpit REST API
 Author: Marcel Kerth
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -687,13 +687,14 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pydantic<3.0.0,>=2.10.6
 Requires-Dist: cryptography
+Dynamic: license-file
 
 # JS7 Python Client
 
 [![PyPI version](https://img.shields.io/pypi/v/js7-client-python.svg)](https://pypi.org/project/js7-client-python/)
 [![Python versions](https://img.shields.io/pypi/pyversions/js7-client-python)](https://pypi.org/project/js7-client-python/)
 
-The JS7 Python Client provides methods for accessing the JS7 JOC REST API.
+The JS7 Python Client provides methods for accessing the JS7 JOC Cockpit REST API.
 It offers functionality similar to the JS7 Unix CLI: [JS7 Unix CLI](https://github.com/sos-berlin/js7-cli-unix).
 
 ## Requirements
@@ -716,7 +717,7 @@ The following example shows how to create a client instance and perform an opera
 
 ### Client Initialization
 
-Client initialization begins with configuring the JOC API endpoint and the user’s credentials.
+Client initialization begins with configuring the JOC Cockpit API endpoint and the user’s credentials.
 
 ```python
 import js7
@@ -759,7 +760,7 @@ client = js7.Client(
 
 ### Import Inventory Configurations
 
-A common use case is importing inventory configurations into JS7 JOC.
+A common use case is importing inventory configurations into JS7 JOC Cockpit.
 We use the previously created client instance to import configurations.
 
 ```python
@@ -773,7 +774,7 @@ print(f"Operation successful: {ok}")
 
 ## Namespaces
 
-The Client class follows the domains of the JS7 JOC API, but groups its methods into three namespaces:
+The Client class follows the domains of the JS7 JOC Cockpit REST API, but groups its methods into three namespaces:
 
 - **Manage**: Used to manage configurations and resources, such as importing, updating, or removing them.
 - **Operate**: Used to control runtime behavior, such as resuming a workflow or canceling an order.
@@ -781,5 +782,5 @@ The Client class follows the domains of the JS7 JOC API, but groups its methods
 
 ## Resources
 
-- **Docs**: [JS7 Python Client](https://kb.sos-berlin.com/display/JS7/JS7+-+Python+Client)
-- **Issues**: [JOC-2175 - Python Client for JS7 REST API](https://change.sos-berlin.com/browse/JOC-2175)
+- **Docs**: [JS7 - Python Client](https://kb.sos-berlin.com/display/JS7/JS7+-+Python+Client)
+- **Issues**: [JS-2240 - Offer Python Client for JS7 REST API](https://change.sos-berlin.com/browse/JOC-2175)

{js7_client_python-2.0.10 → js7_client_python-2.0.12}/README.md

@@ -3,7 +3,7 @@
 [![PyPI version](https://img.shields.io/pypi/v/js7-client-python.svg)](https://pypi.org/project/js7-client-python/)
 [![Python versions](https://img.shields.io/pypi/pyversions/js7-client-python)](https://pypi.org/project/js7-client-python/)
 
-The JS7 Python Client provides methods for accessing the JS7 JOC REST API.
+The JS7 Python Client provides methods for accessing the JS7 JOC Cockpit REST API.
 It offers functionality similar to the JS7 Unix CLI: [JS7 Unix CLI](https://github.com/sos-berlin/js7-cli-unix).
 
 ## Requirements
@@ -26,7 +26,7 @@ The following example shows how to create a client instance and perform an opera
 
 ### Client Initialization
 
-Client initialization begins with configuring the JOC API endpoint and the user’s credentials.
+Client initialization begins with configuring the JOC Cockpit API endpoint and the user’s credentials.
 
 ```python
 import js7
@@ -69,7 +69,7 @@ client = js7.Client(
 
 ### Import Inventory Configurations
 
-A common use case is importing inventory configurations into JS7 JOC.
+A common use case is importing inventory configurations into JS7 JOC Cockpit.
 We use the previously created client instance to import configurations.
 
 ```python
@@ -83,7 +83,7 @@ print(f"Operation successful: {ok}")
 
 ## Namespaces
 
-The Client class follows the domains of the JS7 JOC API, but groups its methods into three namespaces:
+The Client class follows the domains of the JS7 JOC Cockpit REST API, but groups its methods into three namespaces:
 
 - **Manage**: Used to manage configurations and resources, such as importing, updating, or removing them.
 - **Operate**: Used to control runtime behavior, such as resuming a workflow or canceling an order.
@@ -91,5 +91,5 @@ The Client class follows the domains of the JS7 JOC API, but groups its methods
 
 ## Resources
 
-- **Docs**: [JS7 Python Client](https://kb.sos-berlin.com/display/JS7/JS7+-+Python+Client)
-- **Issues**: [JOC-2175 - Python Client for JS7 REST API](https://change.sos-berlin.com/browse/JOC-2175)
+- **Docs**: [JS7 - Python Client](https://kb.sos-berlin.com/display/JS7/JS7+-+Python+Client)
+- **Issues**: [JS-2240 - Offer Python Client for JS7 REST API](https://change.sos-berlin.com/browse/JOC-2175)

{js7_client_python-2.0.10 → js7_client_python-2.0.12}/pyproject.toml

@@ -9,7 +9,7 @@ authors = [
 ]
 description = "Python Client for the JOC Cockpit REST API"
 readme = "README.md"
-version = "2.0.10"
+version = "2.0.12"
 requires-python = ">=3.8"
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -18,7 +18,7 @@ classifiers = [
 license = { file = "LICENSE" }
 dependencies = [
     "pydantic>=2.10.6,<3.0.0",
-    "cryptography"
+    "cryptography",
 ]
 
 [project.urls]
@@ -34,4 +34,4 @@ where = ["src"]
 include = ["js7*"]
 
 [tool.setuptools.package-data]
-js7 = ["java/**/*"]
+js7 = ["java/**/*"]

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agent/cluster/confirm_node_loss.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .......service.http_service import HTTPService
+from .......model.private.http.joc.joc_v_2_6_5 import AgentCommand, OK
+
+
+@dataclass
+class EndpointCall:    
+    http_service: HTTPService
+    access_token: str
+    payload:      AgentCommand
+
+
+def confirm_node_loss(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agent/cluster/confirm_node_loss",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agent/cluster/switchover.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .......service.http_service import HTTPService
+from .......model.private.http.joc.joc_v_2_6_5 import AgentCommand, OK
+
+
+@dataclass
+class EndpointCall:    
+    http_service: HTTPService
+    access_token: str
+    payload:      AgentCommand
+    
+
+def switchover(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agent/cluster/switchover",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agent/delete.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from ......service.http_service import HTTPService
+from ......model.private.http.joc.joc_v_2_6_5 import AgentCommand, OK
+
+
+@dataclass
+class EndpointCall:    
+    http_service: HTTPService
+    access_token: str
+    payload:      AgentCommand
+
+
+def delete(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agent/delete",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/agents.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from ......service.http_service import HTTPService
+from ......model.private.http.joc.joc_v_2_6_5 import ReadAgentsV, AgentsV
+
+
+@dataclass
+class EndpointCall:    
+    http_service: HTTPService
+    access_token: str
+    payload:      ReadAgentsV
+
+
+def agents(call: EndpointCall) -> AgentsV:    
+    if not call.access_token:
+        raise ValueError("'access_token' ist required in function call")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return AgentsV.model_validate_json(resp)

{js7_client_python-2.0.10/src/js7/api/joc/http/v_2_8_2 → js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5}/agents/cluster/delete.py

@@ -1,5 +1,14 @@
-from .......model.private.api.endpoint import EndpointDefinition, EndpointCall
-from .......model.private.http.joc.joc_v_2_8_2 import DeploySubagentClusters, OK
+from dataclasses import dataclass
+
+from .......service.http_service import HTTPService
+from .......model.private.http.joc.joc_v_2_6_5 import DeploySubagentClusters, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      DeploySubagentClusters
 
 
 def delete(call: EndpointCall) -> OK:
@@ -9,9 +18,6 @@ def delete(call: EndpointCall) -> OK:
     if not call.payload:
         raise ValueError("'payload' is required in function call.")
     
-    if not isinstance(call.payload, DeploySubagentClusters):
-        raise ValueError("'payload' is not an instance of model.http.joc_v_2_8_2.DeploySubagentClusters.")
-    
     body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
     
     with call.http_service as http:
@@ -25,12 +31,3 @@ def delete(call: EndpointCall) -> OK:
         )
         
         return OK.model_validate_json(resp)
-    
-ENDPOINT_DEFINITION = EndpointDefinition(
-    id="agents/cluster/delete",
-    function=delete,
-    version=("2.6.5", "2.8.3"),
-    payload_model=DeploySubagentClusters,
-    response_model=OK,
-    options=None
-)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/cluster/deploy.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .......service.http_service import HTTPService
+from .......model.private.http.joc.joc_v_2_6_5 import DeploySubagentClusters, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      DeploySubagentClusters
+
+
+def deploy(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/cluster/deploy", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/cluster/revoke.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .......service.http_service import HTTPService
+from .......model.private.http.joc.joc_v_2_6_5 import DeploySubagentClusters, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      DeploySubagentClusters
+
+
+def revoke(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/cluster/revoke", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/cluster/store.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .......service.http_service import HTTPService
+from .......model.private.http.joc.joc_v_2_6_5 import StoreSubagentClusters, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      StoreSubagentClusters
+
+
+def store(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/cluster/store", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/export.py

@@ -0,0 +1,29 @@
+from dataclasses import dataclass
+
+from ......service.http_service import HTTPService
+from ......model.private.http.joc.joc_v_2_6_5 import AgentExportFilter
+
+
+@dataclass
+class EndpointCall:    
+    http_service: HTTPService
+    access_token: str
+    payload:      AgentExportFilter
+
+
+def export(call: EndpointCall) -> bytes:
+    if not call.access_token:
+        raise ValueError("'access_token' ist required in function call")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/export",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token
+            }
+        )
+        
+        return resp

js7_client_python-2.0.10/src/js7/api/joc/http/v_2_8_2/agents/import.py → js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/import_.py

@@ -1,9 +1,27 @@
-from typing import Dict, Optional
+from typing import Dict, Optional, TypedDict
+from dataclasses import dataclass
 
-from ......model.private.api.endpoint import EndpointCall, EndpointDefinition
-from ......model.private.http.joc.joc_v_2_8_2 import OK
+from ......service.http_service import HTTPService
+from ......model.private.http.joc.joc_v_2_6_5 import OK
 
 
+class Options(TypedDict):
+    format: str
+    overwrite: bool
+    controller_id: str
+    audit_log_ticket_link: Optional[str]
+    audit_log_comment: Optional[str]
+    audit_log_time_spent: Optional[str]
+
+
+@dataclass
+class EndpointCall:    
+    http_service: HTTPService
+    access_token: str
+    payload:      bytes
+    options:      Options
+    
+
 def import_(call: EndpointCall) -> OK:
     if not call.access_token:
         raise ValueError("'access_token' is required in function call.")
@@ -24,9 +42,6 @@ def import_(call: EndpointCall) -> OK:
     if not controller_id:
         raise ValueError("'controller_id' is required in options.")
     
-    if overwrite is None:
-        raise ValueError("'overwrite' is required in options.")
-    
     if not format:
         raise ValueError("'format' is required in options.")
     
@@ -56,19 +71,3 @@ def import_(call: EndpointCall) -> OK:
         )
         
         return OK.model_validate_json(resp)
-    
-ENDPOINT_DEFINITION = EndpointDefinition(
-    id="agents/import",
-    function=import_,
-    version=("2.6.5", "2.8.3"),
-    payload_model=bytes,
-    response_model=OK,
-    options={
-        "format": str,
-        "overwrite": bool,
-        "controller_id": str,
-        "audit_log_ticket_link": Optional[str],
-        "audit_log_comment": Optional[str],
-        "audit_log_time_spent": Optional[str]
-    }
-)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/inventory/cluster/deploy.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from ........service.http_service import HTTPService
+from ........model.private.http.joc.joc_v_2_6_5 import DeployClusterAgents, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      DeployClusterAgents
+    
+
+def deploy(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/inventory/cluster/deploy", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/inventory/cluster/revoke.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from ........service.http_service import HTTPService
+from ........model.private.http.joc.joc_v_2_6_5 import DeployClusterAgents, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      DeployClusterAgents
+    
+
+def revoke(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/inventory/cluster/revoke", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/inventory/cluster/store.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from ........service.http_service import HTTPService
+from ........model.private.http.joc.joc_v_2_6_5 import StoreClusterAgents, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      StoreClusterAgents
+    
+
+def store(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/inventory/cluster/store", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/inventory/cluster/subagents/delete.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .........service.http_service import HTTPService
+from .........model.private.http.joc.joc_v_2_6_5 import SubAgentsCommand, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      SubAgentsCommand
+    
+
+def delete(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/inventory/cluster/subagents/delete", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/inventory/cluster/subagents/disable.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .........service.http_service import HTTPService
+from .........model.private.http.joc.joc_v_2_6_5 import SubAgentsCommand, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      SubAgentsCommand
+    
+
+def disable(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/inventory/cluster/subagents/disable", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)

js7_client_python-2.0.12/src/js7/api/joc/http/v_2_6_5/agents/inventory/cluster/subagents/enable.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from .........service.http_service import HTTPService
+from .........model.private.http.joc.joc_v_2_6_5 import SubAgentsCommand, OK
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      SubAgentsCommand
+    
+    
+def enable(call: EndpointCall) -> OK:
+    if not call.access_token:
+        raise ValueError("'access_token' is required in function call.")
+    
+    body = call.payload.model_dump_json(by_alias=True, exclude_none=True)
+    
+    with call.http_service as http:
+        resp = http.post(
+            path="/joc/api/agents/inventory/cluster/subagents/enable", 
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return OK.model_validate_json(resp)