uiprotect 7.11.0__py3-none-any.whl → 7.13.0__py3-none-any.whl

uiprotect/api.py

@@ -28,6 +28,7 @@ from platformdirs import user_cache_dir, user_config_dir
 from yarl import URL
 
 from uiprotect.data.convert import list_from_unifi_list
+from uiprotect.data.nvr import MetaInfo
 from uiprotect.data.user import Keyring, Keyrings, UlpUser, UlpUsers
 
 from ._compat import cached_property
@@ -163,6 +164,7 @@ class BaseApiClient:
     _port: int
     _username: str
     _password: str
+    _api_key: str | None = None
     _verify_ssl: bool
     _ws_timeout: int
 
@@ -174,10 +176,11 @@ class BaseApiClient:
     _cookiename = "TOKEN"
 
     headers: dict[str, str] | None = None
-    _websocket: Websocket | None = None
+    _private_websocket: Websocket | None = None
 
-    api_path: str = "/proxy/protect/api/"
-    ws_path: str = "/proxy/protect/ws/updates"
+    private_api_path: str = "/proxy/protect/api/"
+    public_api_path: str = "/proxy/protect/integration"
+    private_ws_path: str = "/proxy/protect/ws/updates"
 
     cache_dir: Path
     config_dir: Path
@@ -189,6 +192,7 @@ class BaseApiClient:
         port: int,
         username: str,
         password: str,
+        api_key: str | None = None,
         verify_ssl: bool = True,
         session: aiohttp.ClientSession | None = None,
         ws_timeout: int = 30,
@@ -203,6 +207,7 @@ class BaseApiClient:
 
         self._username = username
         self._password = password
+        self._api_key = api_key
         self._verify_ssl = verify_ssl
         self._ws_timeout = ws_timeout
         self._ws_receive_timeout = ws_receive_timeout
@@ -226,10 +231,10 @@ class BaseApiClient:
         """Updates the url after changing _host or _port."""
         if self._port != 443:
             self._url = URL(f"https://{self._host}:{self._port}")
-            self._ws_url = URL(f"wss://{self._host}:{self._port}{self.ws_path}")
+            self._ws_url = URL(f"wss://{self._host}:{self._port}{self.private_ws_path}")
         else:
             self._url = URL(f"https://{self._host}")
-            self._ws_url = URL(f"wss://{self._host}{self.ws_path}")
+            self._ws_url = URL(f"wss://{self._host}{self.private_ws_path}")
 
         self.base_url = str(self._url)
 
@@ -273,8 +278,8 @@ class BaseApiClient:
 
     def _get_websocket(self) -> Websocket:
         """Gets or creates current Websocket."""
-        if self._websocket is None:
-            self._websocket = Websocket(
+        if self._private_websocket is None:
+            self._private_websocket = Websocket(
                 self._get_websocket_url,
                 self._auth_websocket,
                 self._update_bootstrap_soon,
@@ -285,7 +290,7 @@ class BaseApiClient:
                 timeout=self._ws_timeout,
                 receive_timeout=self._ws_receive_timeout,
             )
-        return self._websocket
+        return self._private_websocket
 
     def _update_bootstrap_soon(self) -> None:
         """Update bootstrap soon."""
@@ -325,16 +330,21 @@ class BaseApiClient:
         url: str,
         require_auth: bool = False,
         auto_close: bool = True,
+        public_api: bool = False,
         **kwargs: Any,
     ) -> aiohttp.ClientResponse:
         """Make a request to UniFi Protect"""
-        if require_auth:
+        if require_auth and not public_api:
             await self.ensure_authenticated()
 
         request_url = self._url.join(
             URL(SplitResult("", "", url, "", ""), encoded=True)
         )
-        headers = kwargs.get("headers") or self.headers
+        headers = kwargs.get("headers") or self.headers or {}
+        if require_auth and public_api:
+            if self._api_key is None:
+                raise NotAuthorized("API key is required for public API requests")
+            headers = {"X-API-KEY": self._api_key}
         _LOGGER.debug("Request url: %s", request_url)
         if not self._verify_ssl:
             kwargs["ssl"] = False
@@ -391,16 +401,22 @@ class BaseApiClient:
         require_auth: bool = True,
         raise_exception: bool = True,
         api_path: str | None = None,
+        public_api: bool = False,
         **kwargs: Any,
     ) -> bytes | None:
         """Make a API request"""
-        path = api_path if api_path is not None else self.api_path
+        path = self.private_api_path
+        if api_path is not None:
+            path = api_path
+        elif public_api:
+            path = self.public_api_path
 
         response = await self.request(
             method,
             f"{path}{url}",
             require_auth=require_auth,
             auto_close=False,
+            public_api=public_api,
             **kwargs,
         )
 
@@ -453,6 +469,7 @@ class BaseApiClient:
         require_auth: bool = True,
         raise_exception: bool = True,
         api_path: str | None = None,
+        public_api: bool = False,
         **kwargs: Any,
     ) -> list[Any] | dict[str, Any] | None:
         data = await self.api_request_raw(
@@ -461,6 +478,7 @@ class BaseApiClient:
             require_auth=require_auth,
             raise_exception=raise_exception,
             api_path=api_path,
+            public_api=public_api,
             **kwargs,
         )
 
@@ -480,6 +498,7 @@ class BaseApiClient:
         method: str = "get",
         require_auth: bool = True,
         raise_exception: bool = True,
+        public_api: bool = False,
         **kwargs: Any,
     ) -> dict[str, Any]:
         data = await self.api_request(
@@ -487,6 +506,7 @@ class BaseApiClient:
             method=method,
             require_auth=require_auth,
             raise_exception=raise_exception,
+            public_api=public_api,
             **kwargs,
         )
 
@@ -501,6 +521,7 @@ class BaseApiClient:
         method: str = "get",
         require_auth: bool = True,
         raise_exception: bool = True,
+        public_api: bool = False,
         **kwargs: Any,
     ) -> list[Any]:
         data = await self.api_request(
@@ -508,6 +529,7 @@ class BaseApiClient:
             method=method,
             require_auth=require_auth,
             raise_exception=raise_exception,
+            public_api=public_api,
             **kwargs,
         )
 
@@ -686,11 +708,11 @@ class BaseApiClient:
 
     async def async_disconnect_ws(self) -> None:
         """Disconnect from Websocket."""
-        if self._websocket:
+        if self._private_websocket:
             websocket = self._get_websocket()
             websocket.stop()
             await websocket.wait_closed()
-            self._websocket = None
+            self._private_websocket = None
 
     def _process_ws_message(self, msg: aiohttp.WSMessage) -> None:
         raise NotImplementedError
@@ -727,6 +749,7 @@ class ProtectApiClient(BaseApiClient):
         port: UFP HTTPS port
         username: UFP username
         password: UFP password
+        api_key: API key for UFP
         verify_ssl: Verify HTTPS certificate (default: `True`)
         session: Optional aiohttp session to use (default: generate one)
         override_connection_host: Use `host` as your `connection_host` for RTSP stream instead of using the one provided by UniFi Protect.
@@ -754,6 +777,7 @@ class ProtectApiClient(BaseApiClient):
         port: int,
         username: str,
         password: str,
+        api_key: str | None = None,
         verify_ssl: bool = True,
         session: aiohttp.ClientSession | None = None,
         ws_timeout: int = 30,
@@ -773,6 +797,7 @@ class ProtectApiClient(BaseApiClient):
             port=port,
             username=username,
             password=password,
+            api_key=api_key,
             verify_ssl=verify_ssl,
             session=session,
             ws_timeout=ws_timeout,
@@ -1584,10 +1609,12 @@ class ProtectApiClient(BaseApiClient):
                 raise_exception=False,
             )
 
-        _LOGGER.debug("Requesting camera video: %s%s %s", self.api_path, path, params)
+        _LOGGER.debug(
+            "Requesting camera video: %s%s %s", self.private_api_path, path, params
+        )
         r = await self.request(
             "get",
-            f"{self.api_path}{path}",
+            f"{self.private_api_path}{path}",
             auto_close=False,
             timeout=0,
             params=params,
@@ -2072,3 +2099,13 @@ class ProtectApiClient(BaseApiClient):
             raise BadRequest("Failed to create API key")
 
         return response["data"]["full_api_key"]
+
+    async def get_meta_info(self) -> MetaInfo:
+        """Get metadata about the NVR."""
+        data = await self.api_request(
+            url="/v1/meta/info",
+            public_api=True,
+        )
+        if not isinstance(data, dict):
+            raise NvrError("Failed to retrieve meta info from public API")
+        return MetaInfo(**data)

uiprotect/cli/__init__.py

@@ -11,7 +11,7 @@ import orjson
 import typer
 from rich.progress import track
 
-from uiprotect.api import ProtectApiClient
+from uiprotect.api import MetaInfo, ProtectApiClient
 
 from ..data import Version, WSPacket
 from ..test_util import SampleDataGenerator
@@ -60,6 +60,15 @@ OPTION_PASSWORD = typer.Option(
     hide_input=True,
     envvar="UFP_PASSWORD",
 )
+OPTION_API_KEY = typer.Option(
+    ...,
+    "--api-key",
+    "-k",
+    help="UniFi Protect API key",
+    prompt=True,
+    hide_input=True,
+    envvar="UFP_API_KEY",
+)
 OPTION_ADDRESS = typer.Option(
     ...,
     "--address",
@@ -140,6 +149,7 @@ def main(
     ctx: typer.Context,
     username: str = OPTION_USERNAME,
     password: str = OPTION_PASSWORD,
+    api_key: str = OPTION_API_KEY,
     address: str = OPTION_ADDRESS,
     port: int = OPTION_PORT,
     verify: bool = OPTION_VERIFY,
@@ -155,6 +165,7 @@ def main(
         port,
         username,
         password,
+        api_key,
         verify_ssl=verify,
         ignore_unadopted=not include_unadopted,
     )
@@ -338,3 +349,19 @@ def create_api_key(
     _setup_logger()
     result = run_async(callback())
     typer.echo(result)
+
+
+@app.command()
+def get_meta_info(ctx: typer.Context) -> None:
+    """Get metadata about the current UniFi Protect instance."""
+    protect = cast(ProtectApiClient, ctx.obj.protect)
+
+    async def callback() -> MetaInfo:
+        meta = await protect.get_meta_info()
+        await protect.close_session()
+        return meta
+
+    _setup_logger()
+
+    result = run_async(callback())
+    typer.echo(result.model_dump_json())

uiprotect/data/nvr.py

@@ -71,6 +71,10 @@ DELETE_KEYS_THUMB = {"color", "vehicleType"}
 DELETE_KEYS_EVENT = {"deletedAt", "category", "subCategory"}
 
 
+class MetaInfo(ProtectBaseObject):
+    applicationVersion: str
+
+
 class NVRLocation(UserLocation):
     is_geofencing_enabled: bool
     radius: int

{uiprotect-7.11.0.dist-info → uiprotect-7.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: uiprotect
-Version: 7.11.0
+Version: 7.13.0
 Summary: Python API for Unifi Protect (Unofficial)
 License: MIT
 Author: UI Protect Maintainers

{uiprotect-7.11.0.dist-info → uiprotect-7.13.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 uiprotect/__init__.py,sha256=Oz6i1tonIz4QWVnEPkbielJDJ3WQdwZVgYtjY4IwGAQ,636
 uiprotect/__main__.py,sha256=C_bHCOkv5qj6WMy-6ELoY3Y6HDhLxOa1a30CzmbZhsg,462
 uiprotect/_compat.py,sha256=HThmb1zQZCEssCxYYbQzFhJq8zYYlVaSnIEZabKc-6U,302
-uiprotect/api.py,sha256=hfTd_BYyF_B6Ehbe41U99_9CEEAd-eUwLJ0pOpvojV4,71642
-uiprotect/cli/__init__.py,sha256=B70Zdwq4cdw3wyu39uY0lMkjk5EoWLRIfVncuTOZ4AE,9423
+uiprotect/api.py,sha256=R8-R3AmIxKDETndph2xelWOA0IDyM0VHl8ZLdftfAoI,73044
+uiprotect/cli/__init__.py,sha256=4nvTO0tW5aVforlh--_NwmGvxTvpOfmAiso5-acY850,10075
 uiprotect/cli/aiports.py,sha256=wpEr2w_hY18CGpFiQM2Yc0FiVwG_1l2CzZhZLGNigvI,1576
 uiprotect/cli/backup.py,sha256=ZiS7RZnJGKI8TJKLW2cOUzkRM8nyTvE5Ov_jZZGtvSM,36708
 uiprotect/cli/base.py,sha256=5-z-IS8g9iQqhR_YbjxaJAFiMMAY_7cCtNAtvLdRCoM,7524
@@ -20,7 +20,7 @@ uiprotect/data/base.py,sha256=CXIxaJCJNpavadn6uF7vlhI4wxkfD8MNBGgR-smRA7k,35401
 uiprotect/data/bootstrap.py,sha256=ddNaKrTprN7Zq0ZE3O_F5whepUh6z9GqyrUWxLyZ0HE,23570
 uiprotect/data/convert.py,sha256=xEN878_hm0HZZCVYGwJSxcSp2as9zpkvsemVIibReOA,2628
 uiprotect/data/devices.py,sha256=akNyLQKCNI8SiA7oUW1cSvE-IZ9Oav8iv9PfESpjits,115839
-uiprotect/data/nvr.py,sha256=CPmqp3wQouTAGQxUDFghCHsYVWEFSrga1Hf2_HmHDgA,47707
+uiprotect/data/nvr.py,sha256=lRBCKwAw6GhV7NFluouZkZEWln_faAABfYJXMrTGDZI,47772
 uiprotect/data/types.py,sha256=Hfm-Y3MSZtFgZ5AvEvhGqJP_YXPgYSUNybheW91RhOc,19284
 uiprotect/data/user.py,sha256=Del5LUmt5uCfAQMI9-kl_GaKm085oTLjxmcCrlEKXxc,10526
 uiprotect/data/websocket.py,sha256=m4EV1Qfh08eKOihy70ycViYgEQpeNSGZQJWdtGIYJDA,6791
@@ -32,8 +32,8 @@ uiprotect/test_util/__init__.py,sha256=HlQBgIgdtrvT-gQ5OWP92LbgVr_YzsD5NFImLRonU
 uiprotect/test_util/anonymize.py,sha256=f-8ijU-_y9r-uAbhIPn0f0I6hzJpAkvJzc8UpWihObI,8478
 uiprotect/utils.py,sha256=5Z30chqnQhQdtD1vabRtZXjBpeiJagL5KDuALQlWxk8,20559
 uiprotect/websocket.py,sha256=tEyenqblNXHcjWYuf4oRP1E7buNwx6zoECMwpBr-jig,8191
-uiprotect-7.11.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
-uiprotect-7.11.0.dist-info/METADATA,sha256=DPwqWEaP1QzQerdlXwHJt_W2Ka4BnROs9HgteI6fJsA,11109
-uiprotect-7.11.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-uiprotect-7.11.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
-uiprotect-7.11.0.dist-info/RECORD,,
+uiprotect-7.13.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
+uiprotect-7.13.0.dist-info/METADATA,sha256=tfjdL8uSLRjqEI0NxX_AbRPV5NEP2KTS9EvFdg2b_8g,11109
+uiprotect-7.13.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+uiprotect-7.13.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
+uiprotect-7.13.0.dist-info/RECORD,,