WIP

Author: tmunzer-AIDE

pyproject.toml

@@ -35,6 +35,12 @@ dependencies = [
 "Bug Tracker" = "https://github.com/tmunzer/mistapi_python/issues"
 
 # UV-specific configuration
+[tool.uv.scripts]
+test   = "pytest"
+lint   = "ruff check src/"
+fmt    = "ruff format src/"
+build  = "python -m build"
+
 [tool.uv]
 dev-dependencies = [
   # Testing dependencies

src/mistapi/api/v1/sites/devices.py

@@ -1734,7 +1734,7 @@ def clearSiteDevicePendingVersion(
 
 
 def clearSiteDevicePolicyHitCount(
-    mist_session: _APISession, site_id: str, device_id: str
+    mist_session: _APISession, site_id: str, device_id: str, body: dict
 ) -> _APIResponse:
     """
     API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/common/clear-site-device-policy-hit-count
@@ -1756,7 +1756,7 @@ def clearSiteDevicePolicyHitCount(
     """
 
     uri = f"/api/v1/sites/{site_id}/devices/{device_id}/clear_policy_hit_count"
-    resp = mist_session.mist_post(uri=uri)
+    resp = mist_session.mist_post(uri=uri, body=body)
     return resp
 
 
@@ -2375,7 +2375,7 @@ def getSiteDeviceZtpPassword(
 
 
 def testSiteSsrDnsResolution(
-    mist_session: _APISession, site_id: str, device_id: str
+    mist_session: _APISession, site_id: str, device_id: str, body: dict
 ) -> _APIResponse:
     """
     API doc: https://www.juniper.net/documentation/us/en/software/mist/api/http/api/utilities/wan/test-site-ssr-dns-resolution
@@ -2397,7 +2397,7 @@ def testSiteSsrDnsResolution(
     """
 
     uri = f"/api/v1/sites/{site_id}/devices/{device_id}/resolve_dns"
-    resp = mist_session.mist_post(uri=uri)
+    resp = mist_session.mist_post(uri=uri, body=body)
     return resp
 
 

src/mistapi/websockets/__init__.py

@@ -21,4 +21,4 @@
     ws.connect()
 """
 
-from mistapi.websockets import location, orgs, sites
+from mistapi.websockets import location, orgs, session, sites, utils

src/mistapi/websockets/__ws_client.py

@@ -39,12 +39,12 @@ class _MistWebsocket:
     def __init__(
         self,
         mist_session: "APISession",
-        channel: str,
+        channels: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
     ) -> None:
         self._mist_session = mist_session
-        self._channel = channel
+        self._channels = channels
         self._ping_interval = ping_interval
         self._ping_timeout = ping_timeout
         self._ws: websocket.WebSocketApp | None = None
@@ -97,7 +97,8 @@ def on_close(self, callback: Callable[[int, str], None]) -> None:
     # Internal WebSocketApp handlers
 
     def _handle_open(self, ws: websocket.WebSocketApp) -> None:
-        ws.send(json.dumps({"subscribe": self._channel}))
+        for channel in self._channels:
+            ws.send(json.dumps({"subscribe": channel}))
         if self._on_open_cb:
             self._on_open_cb()
 

src/mistapi/websockets/location.py

@@ -15,7 +15,7 @@
 from mistapi.websockets.__ws_client import _MistWebsocket
 
 
-class LocationBleAssetsEvents(_MistWebsocket):
+class BleAssetsEvents(_MistWebsocket):
     """WebSocket stream for location BLE assets events.
 
     Subscribes to the ``/sites/{site_id}/stats/maps/{map_id}/assets`` channel and delivers
@@ -27,8 +27,8 @@ class LocationBleAssetsEvents(_MistWebsocket):
         Authenticated API session.
     site_id : str
         UUID of the site to stream events from.
-    map_id : str
-        UUID of the map to stream events from.
+    map_id : list[str]
+        UUIDs of the maps to stream events from.
     ping_interval : int, default 30
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
@@ -63,19 +63,20 @@ def __init__(
         self,
         mist_session: APISession,
         site_id: str,
-        map_id: str,
+        map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
     ) -> None:
+        channels = [f"/sites/{site_id}/stats/maps/{mid}/assets" for mid in map_id]
         super().__init__(
             mist_session,
-            channel=f"/sites/{site_id}/stats/maps/{map_id}/assets",
+            channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )
 
 
-class LocationConnectedClientsEvents(_MistWebsocket):
+class ConnectedClientsEvents(_MistWebsocket):
     """WebSocket stream for location connected clients events.
 
     Subscribes to the ``/sites/{site_id}/stats/maps/{map_id}/clients`` channel and delivers
@@ -87,8 +88,8 @@ class LocationConnectedClientsEvents(_MistWebsocket):
         Authenticated API session.
     site_id : str
         UUID of the site to stream events from.
-    map_id : str
-        UUID of the map to stream events from.
+    map_id : list[str]
+        UUIDs of the maps to stream events from.
     ping_interval : int, default 30
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
@@ -122,19 +123,20 @@ def __init__(
         self,
         mist_session: APISession,
         site_id: str,
-        map_id: str,
+        map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
     ) -> None:
+        channels = [f"/sites/{site_id}/stats/maps/{mid}/clients" for mid in map_id]
         super().__init__(
             mist_session,
-            channel=f"/sites/{site_id}/stats/maps/{map_id}/clients",
+            channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )
 
 
-class LocationSdkClientsEvents(_MistWebsocket):
+class SdkClientsEvents(_MistWebsocket):
     """WebSocket stream for location SDK clients events.
 
     Subscribes to the ``/sites/{site_id}/stats/maps/{map_id}/sdkclients`` channel and delivers
@@ -146,8 +148,8 @@ class LocationSdkClientsEvents(_MistWebsocket):
         Authenticated API session.
     site_id : str
         UUID of the site to stream events from.
-    map_id : str
-        UUID of the map to stream events from.
+    map_id : list[str]
+        UUIDs of the maps to stream events from.
     ping_interval : int, default 30
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
@@ -181,19 +183,20 @@ def __init__(
         self,
         mist_session: APISession,
         site_id: str,
-        map_id: str,
+        map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
     ) -> None:
+        channels = [f"/sites/{site_id}/stats/maps/{mid}/sdkclients" for mid in map_id]
         super().__init__(
             mist_session,
-            channel=f"/sites/{site_id}/stats/maps/{map_id}/sdkclients",
+            channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )
 
 
-class LocationUnconnectedClientsEvents(_MistWebsocket):
+class UnconnectedClientsEvents(_MistWebsocket):
     """WebSocket stream for location unconnected clients events.
 
     Subscribes to the ``/sites/{site_id}/stats/maps/{map_id}/unconnected_clients`` channel and delivers
@@ -205,8 +208,8 @@ class LocationUnconnectedClientsEvents(_MistWebsocket):
         Authenticated API session.
     site_id : str
         UUID of the site to stream events from.
-    map_id : str
-        UUID of the map to stream events from.
+    map_id : list[str]
+        UUIDs of the maps to stream events from.
     ping_interval : int, default 30
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
@@ -240,19 +243,22 @@ def __init__(
         self,
         mist_session: APISession,
         site_id: str,
-        map_id: str,
+        map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
     ) -> None:
+        channels = [
+            f"/sites/{site_id}/stats/maps/{mid}/unconnected_clients" for mid in map_id
+        ]
         super().__init__(
             mist_session,
-            channel=f"/sites/{site_id}/stats/maps/{map_id}/unconnected_clients",
+            channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )
 
 
-class LocationDiscoveredBleAssetsEvents(_MistWebsocket):
+class DiscoveredBleAssetsEvents(_MistWebsocket):
     """WebSocket stream for location discovered BLE assets events.
 
     Subscribes to the ``/sites/{site_id}/stats/maps/{map_id}/discovered_assets`` channel and delivers
@@ -264,8 +270,8 @@ class LocationDiscoveredBleAssetsEvents(_MistWebsocket):
         Authenticated API session.
     site_id : str
         UUID of the site to stream events from.
-    map_id : str
-        UUID of the map to stream events from.
+    map_id : list[str]
+        UUIDs of the maps to stream events from.
     ping_interval : int, default 30
         Interval in seconds to send WebSocket ping frames (keep-alive).
     ping_timeout : int, default 10
@@ -299,13 +305,16 @@ def __init__(
         self,
         mist_session: APISession,
         site_id: str,
-        map_id: str,
+        map_id: list[str],
         ping_interval: int = 30,
         ping_timeout: int = 10,
     ) -> None:
+        channels = [
+            f"/sites/{site_id}/stats/maps/{mid}/discovered_assets" for mid in map_id
+        ]
         super().__init__(
             mist_session,
-            channel=f"/sites/{site_id}/stats/maps/{map_id}/discovered_assets",
+            channels=channels,
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )

src/mistapi/websockets/orgs.py

@@ -15,7 +15,7 @@
 from mistapi.websockets.__ws_client import _MistWebsocket
 
 
-class OrgInsightsEvents(_MistWebsocket):
+class InsightsEvents(_MistWebsocket):
     """WebSocket stream for organization insights events.
 
     Subscribes to the ``orgs/{org_id}/insights/summary`` channel and delivers
@@ -65,13 +65,13 @@ def __init__(
     ) -> None:
         super().__init__(
             mist_session,
-            channel=f"/orgs/{org_id}/insights/summary",
+            channels=[f"/orgs/{org_id}/insights/summary"],
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )
 
 
-class OrgMxEdgesStatsEvents(_MistWebsocket):
+class MxEdgesStatsEvents(_MistWebsocket):
     """WebSocket stream for organization MX edges stats events.
 
     Subscribes to the ``orgs/{org_id}/stats/mxedges`` channel and delivers
@@ -121,13 +121,13 @@ def __init__(
     ) -> None:
         super().__init__(
             mist_session,
-            channel=f"/orgs/{org_id}/stats/mxedges",
+            channels=[f"/orgs/{org_id}/stats/mxedges"],
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )
 
 
-class OrgMxEdgesUpgradesEvents(_MistWebsocket):
+class MxEdgesUpgradesEvents(_MistWebsocket):
     """WebSocket stream for org MX edges upgrades events.
 
     Subscribes to the ``orgs/{org_id}/mxedges`` channel and delivers
@@ -177,7 +177,7 @@ def __init__(
     ) -> None:
         super().__init__(
             mist_session,
-            channel=f"/orgs/{org_id}/mxedges",
+            channels=[f"/orgs/{org_id}/mxedges"],
             ping_interval=ping_interval,
             ping_timeout=ping_timeout,
         )

src/mistapi/websockets/session.py

@@ -0,0 +1,72 @@
+"""
+--------------------------------------------------------------------------------
+------------------------- Mist API Python CLI Session --------------------------
+
+    Written by: Thomas Munzer (tmunzer@juniper.net)
+    Github    : https://github.com/tmunzer/mistapi_python
+
+    This package is licensed under the MIT License.
+
+--------------------------------------------------------------------------------
+WebSocket channel for Remote Commands events.
+"""
+
+from mistapi import APISession
+from mistapi.websockets.__ws_client import _MistWebsocket
+
+
+class SessionWithUrl(_MistWebsocket):
+    """WebSocket stream for remote commands events.
+
+    Open a WebSocket connection to a custom channel URL for remote command events.
+    This is a base class that can be used to implement specific remote command event streams by providing the
+    appropriate channel URL.
+
+    PARAMS
+    -----------
+    mist_session : mistapi.APISession
+        Authenticated API session.
+    url : str
+        URL of the WebSocket channel to connect to.
+    ping_interval : int, default 30
+        Interval in seconds to send WebSocket ping frames (keep-alive).
+    ping_timeout : int, default 10
+        Time in seconds to wait for a ping response before considering the connection dead.
+
+    EXAMPLE
+    -----------
+    Callback style (background thread)::
+
+        ws = sessionWithUrl(session, url="wss://example.com/channel")
+        ws.on_message(lambda data: print(data))
+        ws.connect()
+        input("Press Enter to stop")
+        ws.disconnect()
+
+    Generator style::
+
+        ws = sessionWithUrl(session, url="wss://example.com/channel")
+        ws.connect(run_in_background=True)
+        for msg in ws.receive():
+            process(msg)
+
+    Context manager::
+
+        with sessionWithUrl(session, url="wss://example.com/channel") as ws:
+            ws.on_message(my_handler)
+            time.sleep(60)
+    """
+
+    def __init__(
+        self,
+        mist_session: APISession,
+        url: str,
+        ping_interval: int = 30,
+        ping_timeout: int = 10,
+    ) -> None:
+        super().__init__(
+            mist_session,
+            channels=[url],
+            ping_interval=ping_interval,
+            ping_timeout=ping_timeout,
+        )