wizata-dsapi 2.2.0.dev9__tar.gz → 2.2.0.dev10__tar.gz

{wizata_dsapi-2.2.0.dev9 → wizata_dsapi-2.2.0.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.2.0.dev9
+Version: 2.2.0.dev10
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

{wizata_dsapi-2.2.0.dev9 → wizata_dsapi-2.2.0.dev10}/wizata_dsapi/__init__.py

@@ -66,7 +66,7 @@ from .connection import Connection, ConnectionMapping, ConnectionDirection, Tran
 from .connection_types import ConnectionType, CONNECTION_TYPES, TRANSFORM_SCHEMAS, get_connection_type, \
     list_connection_types
 from .product import ProductKind, Product, ProductComponent, BUILTIN_PRODUCT_KINDS, is_valid_product_key
-from .inventory import (InventoryBalance, inventory_mode, INVENTORY_OPTION, INVENTORY_MODES,
+from .inventory import (InventoryBalance, InventoryStorage, InventoryStorageDatapoint, inventory_mode, INVENTORY_OPTION, INVENTORY_MODES,
                         INVENTORY_MOVEMENTS, INVENTORY_BALANCES, INVENTORY_STOCK,
                         PRODUCT_TAG, PRODUCT_MESSAGE_KEY)
 from .dashboard import Dashboard, DashboardType

{wizata_dsapi-2.2.0.dev9 → wizata_dsapi-2.2.0.dev10}/wizata_dsapi/inventory.py

@@ -155,3 +155,52 @@ class InventoryBalance:
     def __repr__(self) -> str:
         return (f"InventoryBalance(datapoint={self.datapoint!r}, product={self.product!r}, "
                 f"timestamp={self.timestamp!r}, quantity={self.quantity!r})")
+
+
+class InventoryStorageDatapoint:
+    """One inventoryMovement DataPoint of a storage: its category and unit (DEV-6086)."""
+
+    def __init__(self, hardware_id: str = None, name: str = None, category=None, unit=None,
+                 unit_symbol: str = None):
+        self.hardware_id: Optional[str] = hardware_id
+        self.name: Optional[str] = name
+        self.category: Optional[str] = _uuid_str(category)
+        self.unit: Optional[str] = _uuid_str(unit)
+        self.unit_symbol: Optional[str] = unit_symbol
+
+    def to_dict(self) -> dict:
+        return {"hardwareId": self.hardware_id, "name": self.name, "category": self.category,
+                "unit": self.unit, "unitSymbol": self.unit_symbol}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStorageDatapoint":
+        return cls(hardware_id=data.get("hardwareId") or data.get("hardware_id"), name=data.get("name"),
+                   category=data.get("category"), unit=data.get("unit"),
+                   unit_symbol=data.get("unitSymbol") or data.get("unit_symbol"))
+
+
+class InventoryStorage:
+    """
+    A storage place: a Twin holding at least one inventoryMovement DataPoint (DEV-6086).
+    Read only, from ``POST /dsapi/planner/inventory/storages/search``.
+    """
+
+    def __init__(self, twin_id=None, twin_hardware_id: str = None, twin_name: str = None,
+                 datapoints: list = None):
+        self.twin_id: Optional[str] = _uuid_str(twin_id)
+        self.twin_hardware_id: Optional[str] = twin_hardware_id
+        self.twin_name: Optional[str] = twin_name
+        self.datapoints: list = list(datapoints or [])
+
+    def to_dict(self) -> dict:
+        return {"twin": {"id": self.twin_id, "hardwareId": self.twin_hardware_id, "name": self.twin_name},
+                "datapoints": [d.to_dict() for d in self.datapoints]}
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "InventoryStorage":
+        twin = data.get("twin") or {}
+        return cls(twin_id=twin.get("id"), twin_hardware_id=twin.get("hardwareId"), twin_name=twin.get("name"),
+                   datapoints=[InventoryStorageDatapoint.from_dict(d) for d in data.get("datapoints") or []])
+
+    def __repr__(self) -> str:
+        return f"InventoryStorage({self.twin_hardware_id!r}, {[d.hardware_id for d in self.datapoints]})"

wizata_dsapi-2.2.0.dev10/wizata_dsapi/version.py

@@ -0,0 +1 @@
+__version__ = "2.2.0.dev10"

{wizata_dsapi-2.2.0.dev9 → wizata_dsapi-2.2.0.dev10}/wizata_dsapi/wizata_dsapi_client.py

@@ -55,7 +55,7 @@ from .version import __version__
 import ast
 from .deployment import Deployment, DeploymentStatus
 from .product import ProductKind, Product, ProductComponent
-from .inventory import InventoryBalance
+from .inventory import InventoryBalance, InventoryStorage
 from .api_config import _registry
 
 from .streamlit_utils import get_streamlit_token, get_streamlit_domain
@@ -2909,6 +2909,23 @@ class WizataDSAPIClient(ApiInterface, ApiDtoInterface):
                                          body=search_query.to_dict())
         return PagedQueryResult.from_dict(response.json(), dto_class=InventoryBalance)
 
+    def search_inventory_storages(self, search_query=None) -> PagedQueryResult:
+        """
+        The storage places: Twins holding an inventoryMovement DataPoint, each with those
+        datapoints' category, unit and unit symbol (DEV-6086).
+
+        :param search_query: SearchQuery or dict; filters ``twin`` (hardware id or id) and
+            ``category`` (eq / in), ``_search`` (``{"query": text}`` on names and hardware ids).
+        :return: PagedQueryResult with InventoryStorage results, sorted by twin name.
+        """
+        if search_query is None:
+            search_query = SearchQuery()
+        elif isinstance(search_query, dict):
+            search_query = SearchQuery.from_dict(search_query)
+        response = self._planner_request("POST", "planner/inventory/storages/search",
+                                         body=search_query.to_dict())
+        return PagedQueryResult.from_dict(response.json(), dto_class=InventoryStorage)
+
     @staticmethod
     def _balance_id(value) -> str:
         balance_id = value.id if isinstance(value, InventoryBalance) else value

{wizata_dsapi-2.2.0.dev9 → wizata_dsapi-2.2.0.dev10}/wizata_dsapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wizata_dsapi
-Version: 2.2.0.dev9
+Version: 2.2.0.dev10
 Summary: Wizata Data Science Toolkit
 Author: Wizata S.A.
 Author-email: info@wizata.com

wizata_dsapi-2.2.0.dev9/wizata_dsapi/version.py

@@ -1 +0,0 @@
-__version__ = "2.2.0.dev9"