howler-client 3.1.0.dev390__tar.gz → 3.1.0.dev397__tar.gz

{howler_client-3.1.0.dev390 → howler_client-3.1.0.dev397}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-client
-Version: 3.1.0.dev390
+Version: 3.1.0.dev397
 Summary: The Howler client library facilitates issuing requests to Howler
 License: MIT
 License-File: LICENSE

{howler_client-3.1.0.dev390 → howler_client-3.1.0.dev397}/howler_client/client.py

@@ -2,6 +2,7 @@ import sys
 
 from howler_client.common.utils import walk_api_path
 from howler_client.connection import Connection
+from howler_client.module.action import Action
 from howler_client.module.help import Help
 from howler_client.module.hit import Hit
 from howler_client.module.search import Search
@@ -20,6 +21,7 @@ class Client(object):
     def __init__(self: Self, connection: Connection):
         self._connection: Connection = connection
 
+        self.action = Action(self._connection)
         self.help = Help(self._connection)
         self.search = Search(self._connection)
         self.hit = Hit(self._connection, self.search)

{howler_client-3.1.0.dev390 → howler_client-3.1.0.dev397}/howler_client/common/utils.py

@@ -5,7 +5,7 @@ from typing import cast
 from urllib.parse import quote
 
 INVALID_STREAM_SEARCH_PARAMS = ("deep_paging_id", "rows", "sort")
-SEARCHABLE = ["hit"]
+SEARCHABLE = ["hit", "action"]
 API = "v1"
 
 

howler_client-3.1.0.dev397/howler_client/module/action.py

@@ -0,0 +1,74 @@
+"""Client module for Howler automation actions."""
+
+import sys
+from typing import TYPE_CHECKING, Any, List, Literal
+
+from howler_client.common.utils import api_path
+
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+if TYPE_CHECKING:
+    from howler_client import Connection
+
+
+class Action(object):
+    """Operations for managing and executing Howler automation actions."""
+
+    def __init__(self: Self, connection: "Connection"):
+        self._connection = connection
+
+    def __call__(self: Self, action_id: str) -> dict[str, Any]:
+        """Return an action by ID.
+
+        Args:
+            action_id: Unique identifier of the action.
+
+        Returns:
+            The action data.
+        """
+        return self._connection.get(api_path("action", action_id))
+
+    def list(self: Self) -> list[dict[str, Any]]:
+        """Return up to 250 actions visible to the current user."""
+        return self._connection.get(api_path("action/"))
+
+    def create(
+        self: Self,
+        action_data: dict[str, Any],
+        refresh: bool | Literal["true", "false", "wait_for"] = False,
+    ) -> dict[str, Any]:
+        """Create an action.
+
+        Args:
+            action_data: Action definition, including ``name``, ``query``, and ``operations``.
+            refresh: Whether to refresh the index before returning.
+
+        Returns:
+            The created action data.
+        """
+        return self._connection.post(api_path("action/", refresh=refresh), json=action_data)
+
+    def execute(
+        self: Self,
+        action_id: str,
+        request_id: str,
+        query: str | None = None,
+    ) -> dict[str, List[dict[str, Any]]]:
+        """Execute an action, optionally overriding its configured query.
+
+        Args:
+            action_id: Unique identifier of the action to execute.
+            request_id: Identifier used to correlate websocket execution updates.
+            query: Optional query to run instead of the action's configured query.
+
+        Returns:
+            The execution reports grouped by operation ID.
+        """
+        payload: dict[str, str] = {"request_id": request_id}
+        if query is not None:
+            payload["query"] = query
+
+        return self._connection.post(api_path("action", action_id, "execute"), json=payload)

{howler_client-3.1.0.dev390 → howler_client-3.1.0.dev397}/howler_client/module/search/__init__.py

@@ -77,3 +77,42 @@ class Search(object):
             timeout=timeout,
             track_total_hits=track_total_hits,
         )
+
+    def action(
+        self,
+        query,
+        filters=None,
+        fl=None,
+        offset=0,
+        rows=25,
+        sort=None,
+        timeout=None,
+        track_total_hits=None,
+    ):
+        """Search actions with a lucene query.
+
+        Required:
+        query   : lucene query (string)
+
+        Optional:
+        filters           : Additional lucene queries used to filter the data (list of strings)
+        fl                : List of fields to return (comma separated string of fields)
+        offset            : Offset at which the query items should start (integer)
+        rows              : Number of records to return (integer)
+        sort              : Field used for sorting with direction (string: ex. 'name asc')
+        timeout           : Max amount of milliseconds the query will run (integer)
+        track_total_hits  : Number of actions to track (default: 10k)
+
+        Returns the matching actions and search metadata.
+        """
+        return self._do_search(
+            "action",
+            query,
+            filters=filters,
+            fl=fl,
+            offset=offset,
+            rows=rows,
+            sort=sort,
+            timeout=timeout,
+            track_total_hits=track_total_hits,
+        )

{howler_client-3.1.0.dev390 → howler_client-3.1.0.dev397}/pyproject.toml

@@ -108,7 +108,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-client"
-version = "3.1.0.dev390"
+version = "3.1.0.dev397"
 description = "The Howler client library facilitates issuing requests to Howler"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",