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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: js7-client-python
-Version: 2.0.12
+Version: 2.0.13
 Summary: Python Client for the JOC Cockpit REST API
 Author: Marcel Kerth
 License:                     GNU GENERAL PUBLIC LICENSE

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

@@ -9,7 +9,7 @@ authors = [
 ]
 description = "Python Client for the JOC Cockpit REST API"
 readme = "README.md"
-version = "2.0.12"
+version = "2.0.13"
 requires-python = ">=3.8"
 classifiers = [
     "Programming Language :: Python :: 3",

js7_client_python-2.0.13/src/js7/api/joc/http/v_2_6_5/note/note.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 NoteIdentifier, NoteResponse
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      NoteIdentifier
+    
+
+def note(call: EndpointCall) -> NoteResponse:
+    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/note",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token,
+                "Accept": "application/json"
+            }
+        )
+        
+        return NoteResponse.model_validate_json(resp)

js7_client_python-2.0.13/src/js7/api/joc/http/v_2_6_5/note/post/add.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 AddPost, NoteResponse
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      AddPost
+    
+
+def add(call: EndpointCall) -> NoteResponse:
+    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/note/post/add",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token,
+                "Accept": "application/json"
+            }
+        )
+        
+        return NoteResponse.model_validate_json(resp)

js7_client_python-2.0.13/src/js7/api/joc/http/v_2_6_5/order/log.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 OrderHistoryFilter, OrderLog
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      OrderHistoryFilter
+
+
+def log(call: EndpointCall) -> OrderLog:
+    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/order/log",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token,
+                "Accept": "application/json"
+            }
+        )
+        
+        return OrderLog.model_validate_json(resp)

js7_client_python-2.0.13/src/js7/api/joc/http/v_2_6_5/orders/overview/summary.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 OrdersFilter, OrdersOverView
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      OrdersFilter
+    
+
+def summary(call: EndpointCall) -> OrdersOverView:
+    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/orders/overview/summary",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token,
+                "Accept": "application/json"
+            }
+        )
+        
+        return OrdersOverView.model_validate_json(resp)

js7_client_python-2.0.13/src/js7/api/joc/http/v_2_6_5/workflows/search.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 WorkflowSearchFilter, ResponseSearch
+
+
+@dataclass
+class EndpointCall:
+    http_service: HTTPService
+    access_token: str
+    payload:      WorkflowSearchFilter
+
+
+def search(call: EndpointCall) -> ResponseSearch:
+    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/workflows/search",
+            body=body,
+            headers={
+                "X-Access-Token": call.access_token, 
+                "Accept": "application/json"
+            }
+        )
+        
+        return ResponseSearch.model_validate_json(resp)

js7_client_python-2.0.13/src/js7/client/action/note/get_note_action.py

@@ -0,0 +1,50 @@
+from typing import Any, Dict
+
+from ...context import Context
+from ....api.joc.http.v_2_6_5.note.note import note, EndpointCall
+from ....util.version_to_tuple import version_to_tuple
+from ....model.public.client.enum.object_types import ObjectType
+from ....model.private.http.joc.joc_v_2_6_5 import (
+    NoteIdentifier as NoteIdentifier_V_2_6_5,
+    CommonConfigurationType as CommonConfigurationType_V_2_6_5
+)
+
+
+def get_note_action(
+    *,
+    context: Context,
+    name: str,
+    object_type: ObjectType
+) -> Dict[str, Any]:
+    
+    if version_to_tuple(context.version) >= version_to_tuple("2.6.5"):
+        request_data = _build_v_2_6_5_request(
+            name=name,
+            object_type=object_type
+        )
+
+        result = note(EndpointCall(
+            http_service=context.http_service,
+            access_token=context.auth_provider.login(),
+            payload=request_data,
+        ))
+
+        return result.model_dump(mode="json").get("posts") or {}
+        
+    raise RuntimeError(f"JOC Cockpit version {context.version} is not supported. Minimum required version is 2.6.5.")
+
+def _build_v_2_6_5_request(
+    *,
+    name: str,
+    object_type: ObjectType
+) -> NoteIdentifier_V_2_6_5:
+
+    # Validate: controller_id
+    if not name:
+        raise ValueError("'name' is required.")
+    
+    # Result
+    return NoteIdentifier_V_2_6_5(
+        name=name,
+        object_type=CommonConfigurationType_V_2_6_5(object_type.value) # Raises ValueError() if invalid.
+    )

js7_client_python-2.0.13/src/js7/client/action/note/post_to_note_action.py

@@ -0,0 +1,80 @@
+from typing import Any, Dict, Literal, Optional
+
+from ...context import Context
+from ....api.joc.http.v_2_6_5.note.post.add import add, EndpointCall
+from ....util.version_to_tuple import version_to_tuple
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.enum.object_types import ObjectType
+from ....model.private.http.joc.joc_v_2_6_5 import (
+    CommonConfigurationType as CommonConfigurationType_V_2_6_5,
+    AddPost as AddPost_V_2_6_5,
+    AuditParams as AuditParams_V_2_6_5,
+    Severity as Severity_V_2_6_5
+)
+
+
+def post_to_note_action(
+    *,
+    context: Context,
+    name: str,
+    object_type: ObjectType,
+    content: str,
+    severity: Literal["INFO", "LOW", "NORMAL", "HIGH", "CRITICAL"],
+    audit_log: Optional[AuditLog]
+) -> Dict[str, Any]:
+    
+    if version_to_tuple(context.version) >= version_to_tuple("2.6.5"):
+        request_data = _build_v_2_6_5_request(
+            name=name,
+            object_type=object_type,
+            content=content,
+            severity=severity,
+            audit_log=audit_log
+        )
+
+        result = add(EndpointCall(
+            http_service=context.http_service,
+            access_token=context.auth_provider.login(),
+            payload=request_data,
+        ))
+
+        return result.model_dump(mode="json").get("posts") or {}
+        
+    raise RuntimeError(f"JOC Cockpit version {context.version} is not supported. Minimum required version is 2.6.5.")
+
+def _build_v_2_6_5_request(
+    *,
+    name: str,
+    object_type: ObjectType,
+    content: str,
+    severity: Literal["INFO", "LOW", "NORMAL", "HIGH", "CRITICAL"],
+    audit_log: Optional[AuditLog]
+) -> AddPost_V_2_6_5:
+
+    # Validate: name
+    if not name:
+        raise ValueError("'name' is required.")
+    
+    # Validate: content
+    if not content:
+        raise ValueError("'content' is required.")
+    
+    # Validate: severity
+    if severity not in ("INFO", "LOW", "NORMAL", "HIGH", "CRITICAL"):
+        raise ValueError("'severity' must be 'INFO', 'LOW', 'NORMAL', 'HIGH' or 'CRITICAL'.")
+    
+    # Build: audit_log
+    res_audit_log = AuditParams_V_2_6_5(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return AddPost_V_2_6_5(
+        name=name,
+        object_type=CommonConfigurationType_V_2_6_5(object_type.value), # Raises ValueError() if invalid.
+        content=content,
+        severity=Severity_V_2_6_5(severity), # Raises ValueError() if invalid.
+        audit_log=res_audit_log
+    )

js7_client_python-2.0.13/src/js7/client/action/order/get_order_log_action.py

@@ -0,0 +1,48 @@
+from typing import Any, Dict
+
+from ...context import Context
+from ....api.joc.http.v_2_6_5.order.log import log, EndpointCall
+from ....util.version_to_tuple import version_to_tuple
+from ....model.private.http.joc.joc_v_2_6_5 import (
+    OrderHistoryFilter as OrderHistoryFilter_V_2_6_5
+)
+
+
+def get_order_log_action(
+    *,
+    context: Context,
+    controller_id: str,
+    history_id: int
+) -> Dict[str, Any]:
+    
+    if version_to_tuple(context.version) >= version_to_tuple("2.6.5"):
+        request_data = _build_v_2_6_5_request(
+            controller_id=controller_id,
+            history_id=history_id
+        )
+
+        result = log(EndpointCall(
+            http_service=context.http_service,
+            access_token=context.auth_provider.login(),
+            payload=request_data,
+        ))
+
+        return result.model_dump(mode="json").get("log_events") or {}
+        
+    raise RuntimeError(f"JOC Cockpit version {context.version} is not supported. Minimum required version is 2.6.5.")
+
+def _build_v_2_6_5_request(
+    *, 
+    controller_id: str,
+    history_id: int
+) -> OrderHistoryFilter_V_2_6_5:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Result
+    return OrderHistoryFilter_V_2_6_5(
+        controller_id=controller_id,
+        history_id=history_id
+    )

js7_client_python-2.0.13/src/js7/client/action/order/get_orders_overview_action.py

@@ -0,0 +1,54 @@
+from typing import Optional, Tuple
+
+from ...context import Context
+from ....api.joc.http.v_2_6_5.orders.overview.summary import summary, EndpointCall
+from ....util.version_to_tuple import version_to_tuple
+from ....model.private.http.joc.joc_v_2_6_5 import (
+    OrdersFilter as OrdersFilter_V_2_6_5
+)
+
+
+def get_orders_overview_action(
+    *,
+    context: Context, 
+    controller_id: Optional[str],
+    date_from: Optional[str],
+    date_to: Optional[str]
+) -> Tuple[int, int]:
+    
+    if version_to_tuple(context.version) >= version_to_tuple("2.6.5"):
+        request_data = _build_v_2_6_5_request(
+            controller_id=controller_id,
+            date_from=date_from,
+            date_to=date_to,
+            timezone=context.client_config.timezone
+        )
+
+        result = summary(EndpointCall(
+            http_service=context.http_service,
+            access_token=context.auth_provider.login(),
+            payload=request_data,
+        ))
+        
+        successful = result.orders.successful or 0 if result.orders else 0
+        failed = result.orders.failed or 0 if result.orders else 0
+        
+        return (successful, failed)
+    
+    raise RuntimeError(f"JOC Cockpit version {context.version} is not supported. Minimum required version is 2.6.5.")
+
+def _build_v_2_6_5_request(
+    *, 
+    controller_id: Optional[str],
+    date_from: Optional[str],
+    date_to: Optional[str],
+    timezone: Optional[str]
+) -> OrdersFilter_V_2_6_5:
+
+    # Result
+    return OrdersFilter_V_2_6_5(
+        controller_id=controller_id,
+        date_from=date_from,
+        date_to=date_to,
+        time_zone=timezone
+    )

js7_client_python-2.0.13/src/js7/client/action/workflow/search_workflows_action.py

@@ -0,0 +1,50 @@
+from typing import List
+
+from ...context import Context
+from ....api.joc.http.v_2_6_5.workflows.search import search as api_search, EndpointCall
+from ....util.version_to_tuple import version_to_tuple
+from ....model.private.http.joc.joc_v_2_6_5 import (
+    WorkflowSearchFilter as WorkflowSearchFilter_V_2_6_5,
+)
+
+
+# Returns: [Workflow Paths]
+def search_workflows_action(*, context: Context, controller_id: str, search: str) -> List[str]:
+    
+    if version_to_tuple(context.version) >= version_to_tuple("2.6.5"):
+        request_data = _build_v_2_6_5_request(
+            controller_id=controller_id, 
+            search=search
+        )
+
+        result = api_search(EndpointCall(
+            http_service=context.http_service,
+            access_token=context.auth_provider.login(),
+            payload=request_data,
+        ))
+        
+        wf_paths: List[str] = []
+        
+        if result.results:
+            for r in result.results:
+                if r.path:
+                    wf_paths.append(r.path)
+        
+        return wf_paths
+    
+    raise RuntimeError(f"JOC Cockpit version {context.version} is not supported. Minimum required version is 2.6.5.")
+
+
+def _build_v_2_6_5_request(*, controller_id: str, search: str) -> WorkflowSearchFilter_V_2_6_5:
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: search
+    if not search:
+        raise ValueError("'search' is required.")
+    
+    return WorkflowSearchFilter_V_2_6_5(
+        controller_id=controller_id,
+        search=search
+    )

{js7_client_python-2.0.12 → js7_client_python-2.0.13}/src/js7/client/client.py

@@ -16,6 +16,7 @@ from .feature.workflow.workflow import Workflow
 from .feature.controller.controller import Controller
 from .feature.iam.iam import IAM
 from .feature.daily_plan.daily_plan import DailyPlan
+from .feature.note.note import Note
 
 from .action.helper.encrypt_action import encrypt_action
 from .action.helper.decrypt_action import decrypt_action
@@ -90,6 +91,10 @@ class Client:
     @cached_property
     def daily_plan(self) -> DailyPlan:
         return DailyPlan(context=self._ctx)
+    
+    @cached_property
+    def note(self) -> Note:
+        return Note(context=self._ctx)
         
     def login(self, auth_config: Optional[AuthConfiguration] = None, force_server_login: bool = False) -> str:
         """

js7_client_python-2.0.13/src/js7/client/feature/note/manage.py

@@ -0,0 +1,92 @@
+from typing import Any, Dict, Literal, Optional
+
+from js7.model.public.client.common.audit_log import AuditLog
+
+from ....model.public.client.enum.object_types import ObjectType
+
+from ...context import Context
+
+from ...action.note.get_note_action import get_note_action
+from ...action.note.post_to_note_action import post_to_note_action
+
+
+class Manage:
+    def __init__(self, context: Context):
+        self._ctx = context
+        
+    def get_note(
+        self,
+        name: str,
+        object_type: ObjectType
+    ) -> Dict[str, Any]:
+        """
+        Gets a note.
+        
+        Args:
+            name (str):
+                Object name of the configuration item.
+                
+            object_type (ObjectType):
+                Object type of the configuration item.
+                
+        Returns:
+            Dict[str, Any]:
+                A list of posts.
+                
+        Raises:
+            ValueError:
+                If required arguments are missing or invalid.
+
+            RuntimeError:
+                If the operation fails or the server version is incompatible.
+        """
+        
+        return get_note_action(context=self._ctx, name=name, object_type=object_type)
+        
+    def post_to_note(
+        self,
+        name: str,
+        object_type: ObjectType,
+        content: str,
+        severity: Literal["INFO", "LOW", "NORMAL", "HIGH", "CRITICAL"] = "NORMAL",
+        audit_log: Optional[AuditLog] = None
+    ) -> Dict[str, Any]:
+        """
+        Adds a post to a note and returns the updated note.
+        
+        Args:
+            name (str):
+                Object name of the configuration item.
+                
+            object_type (ObjectType):
+                Object type of the configuration item.
+        
+            content (str):
+                Content of a post in markdown format.
+                
+            severity (Literal["INFO", "LOW", "NORMAL", "HIGH", "CRITICAL"]):
+                Severity of a post.
+                
+            audit_log (Optional[AuditLog]):
+                Creates an audit log entry for this operation.
+                
+        Returns:
+            Dict[str, Any]:
+                A list of posts.
+                
+        Raises:
+            ValueError:
+                If required arguments are missing or invalid.
+
+            RuntimeError:
+                If the operation fails or the server version is incompatible.
+        """
+        
+        return post_to_note_action(
+            context=self._ctx,
+            name=name,
+            object_type=object_type,
+            content=content,
+            severity=severity,
+            audit_log=audit_log
+        )

js7_client_python-2.0.13/src/js7/client/feature/note/note.py

@@ -0,0 +1,13 @@
+from functools import cached_property
+
+from ...context import Context
+from .manage import Manage
+    
+    
+class Note:
+    def __init__(self, context: Context):
+        self._ctx = context
+    
+    @cached_property
+    def manage(self) -> Manage:
+        return Manage(context=self._ctx)