howler-client 2.4.0.dev302__tar.gz → 3.0.0.dev305__tar.gz

{howler_client-2.4.0.dev302 → howler_client-3.0.0.dev305}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: howler-client
-Version: 2.4.0.dev302
+Version: 3.0.0.dev305
 Summary: The Howler client library facilitates issuing requests to Howler
 License: MIT
 License-File: LICENSE

{howler_client-2.4.0.dev302 → howler_client-3.0.0.dev305}/howler_client/module/hit.py

@@ -2,7 +2,7 @@ import json
 import sys
 import warnings
 from hashlib import sha256
-from typing import TYPE_CHECKING, Any, Literal
+from typing import TYPE_CHECKING, Any, Literal, TypedDict
 
 from howler_client.common.dict_utils import flatten
 from howler_client.common.utils import ClientError, api_path
@@ -44,6 +44,14 @@ UPDATE_OPERATIONS = [
 ]
 
 
+class CreateHitsResponse(TypedDict):
+    """Response returned after successfully creating one or more hits."""
+
+    valid: list[dict[str, Any]]
+    invalid: list[dict[str, Any]]
+    warnings: list[str]
+
+
 class Hit(object):
     "Operations pertaining to ingesting and interacting with Howler hits."
 
@@ -147,7 +155,7 @@ class Hit(object):
         self: Self,
         data: dict[str, Any] | list[dict[str, Any]],
         ignore_extra_values: bool = False,
-    ):
+    ) -> CreateHitsResponse | None:
         """Create one or many hits using the howler schema.
 
         Args:
@@ -156,7 +164,8 @@ class Hit(object):
                 Defaults to False.
 
         Returns:
-            dict[str, list[dict[str, Any]]]: A list of valid and invalid hits
+            CreateHitsResponse | None: Created and invalid hits with warnings, or ``None`` when no
+                new hits are submitted (e.g., input is empty or all submitted hits already exist).
         """
         if not isinstance(data, list):
             data = [data]

{howler_client-2.4.0.dev302 → howler_client-3.0.0.dev305}/pyproject.toml

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