uiprotect 0.15.1__tar.gz → 1.0.0__tar.gz

{uiprotect-0.15.1 → uiprotect-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 0.15.1
+Version: 1.0.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 License: MIT

{uiprotect-0.15.1 → uiprotect-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiprotect"
-version = "0.15.1"
+version = "1.0.0"
 description = "Python API for Unifi Protect (Unofficial)"
 authors = ["UI Protect Maintainers <ui@koston.org>"]
 license = "MIT"

{uiprotect-0.15.1 → uiprotect-1.0.0}/src/uiprotect/api.py

@@ -746,10 +746,6 @@ class ProtectApiClient(BaseApiClient):
         if debug:
             set_debug()
 
-    @property
-    def is_ready(self) -> bool:
-        return self._bootstrap is not None
-
     @cached_property
     def bootstrap(self) -> Bootstrap:
         if self._bootstrap is None:
@@ -1154,7 +1150,7 @@ class ProtectApiClient(BaseApiClient):
         objs: list[ProtectModel] = []
 
         for obj_dict in await self.get_devices_raw(model_type):
-            obj = create_from_unifi_dict(obj_dict)
+            obj = create_from_unifi_dict(obj_dict, api=self)
 
             if expected_type is not None and not isinstance(obj, expected_type):
                 raise NvrError(f"Unexpected model returned: {obj.model}")

{uiprotect-0.15.1 → uiprotect-1.0.0}/src/uiprotect/data/base.py

@@ -84,7 +84,7 @@ class ProtectBaseObject(BaseModel):
     * Provides `.unifi_dict` to convert object back into UFP JSON
     """
 
-    _api: ProtectApiClient | None = PrivateAttr(None)
+    _api: ProtectApiClient = PrivateAttr(...)
 
     _protect_objs: ClassVar[dict[str, type[ProtectBaseObject]] | None] = None
     _protect_lists: ClassVar[dict[str, type[ProtectBaseObject]] | None] = None
@@ -103,7 +103,8 @@ class ProtectBaseObject(BaseModel):
         Use the static method `.from_unifi_dict()` to create objects from UFP JSON data from then the main class constructor.
         """
         super().__init__(**data)
-        self._api = api
+        if api is not None:
+            self._api = api
 
     @classmethod
     def from_unifi_dict(
@@ -125,7 +126,8 @@ class ProtectBaseObject(BaseModel):
         (cameras, users, etc.)
 
         """
-        data["api"] = api
+        if api is not None:
+            data["api"] = api
         data = cls.unifi_dict_to_dict(data)
 
         if is_debug():
@@ -161,7 +163,8 @@ class ProtectBaseObject(BaseModel):
                 }
 
         obj = super().construct(_fields_set=_fields_set, **values)
-        obj._api = api
+        if api is not None:
+            obj._api = api
 
         return obj
 
@@ -756,7 +759,9 @@ class ProtectModelWithId(ProtectModel):
         if self.model is None:
             raise BadRequest("Unknown model type")
 
-        if not self.api.bootstrap.auth_user.can(self.model, PermissionNode.WRITE, self):
+        if not self._api.bootstrap.auth_user.can(
+            self.model, PermissionNode.WRITE, self
+        ):
             if revert_on_fail:
                 self.revert_changes(data_before_changes)
             raise NotAuthorized(f"Do not have write permission for obj: {self.id}")
@@ -811,11 +816,11 @@ class ProtectModelWithId(ProtectModel):
         data_frame.header = header
         data_frame.data = updated
 
-        message = self.api.bootstrap.process_ws_packet(
+        message = self._api.bootstrap.process_ws_packet(
             WSPacket(action_frame.packed + data_frame.packed),
         )
         if message is not None:
-            self.api.emit_message(message)
+            self._api.emit_message(message)
 
 
 class ProtectDeviceModel(ProtectModelWithId):
@@ -977,7 +982,7 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
 
     async def _api_update(self, data: dict[str, Any]) -> None:
         if self.model is not None:
-            return await self.api.update_device(self.model, self.id, data)
+            return await self._api.update_device(self.model, self.id, data)
         return None
 
     def unifi_dict(
@@ -1026,12 +1031,12 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
         if self.bridge_id is None:
             return None
 
-        return self.api.bootstrap.bridges[self.bridge_id]
+        return self._api.bootstrap.bridges[self.bridge_id]
 
     @property
     def protect_url(self) -> str:
         """UFP Web app URL for this device"""
-        return f"{self.api.base_url}/protect/devices/{self.id}"
+        return f"{self._api.base_url}/protect/devices/{self.id}"
 
     @property
     def is_adopted_by_us(self) -> bool:
@@ -1053,13 +1058,13 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
     async def reboot(self) -> None:
         """Reboots an adopted device"""
         if self.model is not None:
-            if not self.api.bootstrap.auth_user.can(
+            if not self._api.bootstrap.auth_user.can(
                 self.model,
                 PermissionNode.WRITE,
                 self,
             ):
                 raise NotAuthorized("Do not have permission to reboot device")
-            await self.api.reboot_device(self.model, self.id)
+            await self._api.reboot_device(self.model, self.id)
 
     async def unadopt(self) -> None:
         """Unadopt/Unmanage adopted device"""
@@ -1067,13 +1072,13 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
             raise BadRequest("Device is not adopted")
 
         if self.model is not None:
-            if not self.api.bootstrap.auth_user.can(
+            if not self._api.bootstrap.auth_user.can(
                 self.model,
                 PermissionNode.DELETE,
                 self,
             ):
                 raise NotAuthorized("Do not have permission to unadopt devices")
-            await self.api.unadopt_device(self.model, self.id)
+            await self._api.unadopt_device(self.model, self.id)
 
     async def adopt(self, name: str | None = None) -> None:
         """Adopts a device"""
@@ -1081,10 +1086,10 @@ class ProtectAdoptableDeviceModel(ProtectDeviceModel):
             raise BadRequest("Device cannot be adopted")
 
         if self.model is not None:
-            if not self.api.bootstrap.auth_user.can(self.model, PermissionNode.CREATE):
+            if not self._api.bootstrap.auth_user.can(self.model, PermissionNode.CREATE):
                 raise NotAuthorized("Do not have permission to adopt devices")
 
-            await self.api.adopt_device(self.model, self.id)
+            await self._api.adopt_device(self.model, self.id)
             if name is not None:
                 await self.set_name(name)
 
@@ -1118,4 +1123,4 @@ class ProtectMotionDeviceModel(ProtectAdoptableDeviceModel):
         if self.last_motion_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_motion_event_id)
+        return self._api.bootstrap.events.get(self.last_motion_event_id)

{uiprotect-0.15.1 → uiprotect-1.0.0}/src/uiprotect/data/bootstrap.py

@@ -272,7 +272,7 @@ class Bootstrap(ProtectBaseObject):
 
     @property
     def auth_user(self) -> User:
-        user: User = self.api.bootstrap.users[self.auth_user_id]
+        user: User = self._api.bootstrap.users[self.auth_user_id]
         return user
 
     @property
@@ -388,7 +388,7 @@ class Bootstrap(ProtectBaseObject):
             and obj.model.value in ModelType.bootstrap_models_set()
         ):
             key = f"{obj.model.value}s"
-            if not self.api.ignore_unadopted or (
+            if not self._api.ignore_unadopted or (
                 obj.is_adopted and not obj.is_adopted_by_other
             ):
                 getattr(self, key)[obj.id] = obj
@@ -612,9 +612,9 @@ class Bootstrap(ProtectBaseObject):
         """Refresh a device in the bootstrap."""
         try:
             if model_type == ModelType.NVR:
-                device: ProtectModelWithId = await self.api.get_nvr()
+                device: ProtectModelWithId = await self._api.get_nvr()
             else:
-                device = await self.api.get_device(model_type, device_id)
+                device = await self._api.get_device(model_type, device_id)
         except (
             ValidationError,
             TimeoutError,

{uiprotect-0.15.1 → uiprotect-1.0.0}/src/uiprotect/data/devices.py

@@ -158,7 +158,7 @@ class Light(ProtectMotionDeviceModel):
         if self.camera_id is None:
             return None
 
-        return self.api.bootstrap.cameras[self.camera_id]
+        return self._api.bootstrap.cameras[self.camera_id]
 
     async def set_paired_camera(self, camera: Camera | None) -> None:
         """Sets the camera paired with the light"""
@@ -283,7 +283,7 @@ class CameraChannel(ProtectBaseObject):
 
         if self._rtsp_url is not None:
             return self._rtsp_url
-        self._rtsp_url = f"rtsp://{self.api.connection_host}:{self.api.bootstrap.nvr.ports.rtsp}/{self.rtsp_alias}"
+        self._rtsp_url = f"rtsp://{self._api.connection_host}:{self._api.bootstrap.nvr.ports.rtsp}/{self.rtsp_alias}"
         return self._rtsp_url
 
     @property
@@ -293,7 +293,7 @@ class CameraChannel(ProtectBaseObject):
 
         if self._rtsps_url is not None:
             return self._rtsps_url
-        self._rtsps_url = f"rtsps://{self.api.connection_host}:{self.api.bootstrap.nvr.ports.rtsps}/{self.rtsp_alias}?enableSrtp"
+        self._rtsps_url = f"rtsps://{self._api.connection_host}:{self._api.bootstrap.nvr.ports.rtsps}/{self.rtsp_alias}?enableSrtp"
         return self._rtsps_url
 
     @property
@@ -1124,7 +1124,7 @@ class Camera(ProtectMotionDeviceModel):
         if self.last_ring_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_ring_event_id)
+        return self._api.bootstrap.events.get(self.last_ring_event_id)
 
     @property
     def last_smart_detect_event(self) -> Event | None:
@@ -1132,7 +1132,7 @@ class Camera(ProtectMotionDeviceModel):
         if self.last_smart_detect_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_smart_detect_event_id)
+        return self._api.bootstrap.events.get(self.last_smart_detect_event_id)
 
     @property
     def hdr_mode_display(self) -> Literal["auto", "off", "always"]:
@@ -1160,7 +1160,7 @@ class Camera(ProtectMotionDeviceModel):
         if event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(event_id)
+        return self._api.bootstrap.events.get(event_id)
 
     @property
     def last_smart_audio_detect_event(self) -> Event | None:
@@ -1168,7 +1168,7 @@ class Camera(ProtectMotionDeviceModel):
         if self.last_smart_audio_detect_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_smart_audio_detect_event_id)
+        return self._api.bootstrap.events.get(self.last_smart_audio_detect_event_id)
 
     def get_last_smart_audio_detect_event(
         self,
@@ -1179,11 +1179,11 @@ class Camera(ProtectMotionDeviceModel):
         if event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(event_id)
+        return self._api.bootstrap.events.get(event_id)
 
     @property
     def timelapse_url(self) -> str:
-        return f"{self.api.base_url}/protect/timelapse/{self.id}"
+        return f"{self._api.base_url}/protect/timelapse/{self.id}"
 
     @property
     def is_privacy_on(self) -> bool:
@@ -1199,7 +1199,7 @@ class Camera(ProtectMotionDeviceModel):
         motion/smart detection events.
         """
         if self.use_global:
-            return self.api.bootstrap.nvr.is_global_recording_enabled
+            return self._api.bootstrap.nvr.is_global_recording_enabled
 
         return self.recording_settings.mode is not RecordingMode.NEVER
 
@@ -1208,7 +1208,7 @@ class Camera(ProtectMotionDeviceModel):
         """Is smart detections allowed for this camera?"""
         return (
             self.is_recording_enabled
-            and self.api.bootstrap.nvr.is_smart_detections_enabled
+            and self._api.bootstrap.nvr.is_smart_detections_enabled
         )
 
     @property
@@ -1216,7 +1216,7 @@ class Camera(ProtectMotionDeviceModel):
         """Is license plate detections allowed for this camera?"""
         return (
             self.is_recording_enabled
-            and self.api.bootstrap.nvr.is_license_plate_detections_enabled
+            and self._api.bootstrap.nvr.is_license_plate_detections_enabled
         )
 
     @property
@@ -1224,22 +1224,22 @@ class Camera(ProtectMotionDeviceModel):
         """Is face detections allowed for this camera?"""
         return (
             self.is_recording_enabled
-            and self.api.bootstrap.nvr.is_face_detections_enabled
+            and self._api.bootstrap.nvr.is_face_detections_enabled
         )
 
     @property
     def active_recording_settings(self) -> RecordingSettings:
         """Get active recording settings."""
-        if self.use_global and self.api.bootstrap.nvr.global_camera_settings:
-            return self.api.bootstrap.nvr.global_camera_settings.recording_settings
+        if self.use_global and self._api.bootstrap.nvr.global_camera_settings:
+            return self._api.bootstrap.nvr.global_camera_settings.recording_settings
 
         return self.recording_settings
 
     @property
     def active_smart_detect_settings(self) -> SmartDetectSettings:
         """Get active smart detection settings."""
-        if self.use_global and self.api.bootstrap.nvr.global_camera_settings:
-            return self.api.bootstrap.nvr.global_camera_settings.smart_detect_settings
+        if self.use_global and self._api.bootstrap.nvr.global_camera_settings:
+            return self._api.bootstrap.nvr.global_camera_settings.smart_detect_settings
 
         return self.smart_detect_settings
 
@@ -1991,7 +1991,7 @@ class Camera(ProtectMotionDeviceModel):
 
         Datetime of screenshot is approximate. It may be +/- a few seconds.
         """
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.CAMERA,
             PermissionNode.READ_MEDIA,
             self,
@@ -2003,7 +2003,7 @@ class Camera(ProtectMotionDeviceModel):
         if height is None and width is None and self.high_camera_channel is not None:
             height = self.high_camera_channel.height
 
-        return await self.api.get_camera_snapshot(self.id, width, height, dt=dt)
+        return await self._api.get_camera_snapshot(self.id, width, height, dt=dt)
 
     async def get_package_snapshot(
         self,
@@ -2019,7 +2019,7 @@ class Camera(ProtectMotionDeviceModel):
         if not self.feature_flags.has_package_camera:
             raise BadRequest("Device does not have package camera")
 
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.CAMERA,
             PermissionNode.READ_MEDIA,
             self,
@@ -2031,7 +2031,9 @@ class Camera(ProtectMotionDeviceModel):
         if height is None and width is None and self.package_camera_channel is not None:
             height = self.package_camera_channel.height
 
-        return await self.api.get_package_camera_snapshot(self.id, width, height, dt=dt)
+        return await self._api.get_package_camera_snapshot(
+            self.id, width, height, dt=dt
+        )
 
     async def get_video(
         self,
@@ -2057,7 +2059,7 @@ class Camera(ProtectMotionDeviceModel):
         value. Protect app gives the options for 60x (fps=4), 120x (fps=8), 300x
         (fps=20), and 600x (fps=40).
         """
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.CAMERA,
             PermissionNode.READ_MEDIA,
             self,
@@ -2066,7 +2068,7 @@ class Camera(ProtectMotionDeviceModel):
                 f"Do not have permission to read media for camera: {self.id}",
             )
 
-        return await self.api.get_camera_video(
+        return await self._api.get_camera_video(
             self.id,
             start,
             end,
@@ -2410,7 +2412,7 @@ class Camera(ProtectMotionDeviceModel):
         if reset_at == DEFAULT:
             reset_at = (
                 utc_now()
-                + self.api.bootstrap.nvr.doorbell_settings.default_message_reset_timeout
+                + self._api.bootstrap.nvr.doorbell_settings.default_message_reset_timeout
             )
 
         def callback() -> None:
@@ -2584,7 +2586,7 @@ class Camera(ProtectMotionDeviceModel):
             pan = self.feature_flags.pan.to_native_value(pan, is_relative=True)
             tilt = self.feature_flags.tilt.to_native_value(tilt, is_relative=True)
 
-        await self.api.relative_move_ptz_camera(
+        await self._api.relative_move_ptz_camera(
             self.id,
             pan=pan,
             tilt=tilt,
@@ -2606,7 +2608,7 @@ class Camera(ProtectMotionDeviceModel):
 
         z value is zoom, but since it is capped at 1000, probably better to use `ptz_zoom`.
         """
-        await self.api.center_ptz_camera(self.id, x=x, y=y, z=z)
+        await self._api.center_ptz_camera(self.id, x=x, y=y, z=z)
 
     async def ptz_zoom(
         self,
@@ -2628,14 +2630,14 @@ class Camera(ProtectMotionDeviceModel):
         if not use_native:
             zoom = self.feature_flags.zoom.to_native_value(zoom)
 
-        await self.api.zoom_ptz_camera(self.id, zoom=zoom, speed=speed)
+        await self._api.zoom_ptz_camera(self.id, zoom=zoom, speed=speed)
 
     async def get_ptz_position(self) -> PTZPosition:
         """Get current PTZ Position."""
         if not self.feature_flags.is_ptz:
             raise BadRequest("Camera does not support PTZ features.")
 
-        return await self.api.get_position_ptz_camera(self.id)
+        return await self._api.get_position_ptz_camera(self.id)
 
     async def goto_ptz_slot(self, *, slot: int) -> None:
         """
@@ -2646,42 +2648,42 @@ class Camera(ProtectMotionDeviceModel):
         if not self.feature_flags.is_ptz:
             raise BadRequest("Camera does not support PTZ features.")
 
-        await self.api.goto_ptz_camera(self.id, slot=slot)
+        await self._api.goto_ptz_camera(self.id, slot=slot)
 
     async def create_ptz_preset(self, *, name: str) -> PTZPreset:
         """Create PTZ Preset for camera based on current camera settings."""
         if not self.feature_flags.is_ptz:
             raise BadRequest("Camera does not support PTZ features.")
 
-        return await self.api.create_preset_ptz_camera(self.id, name=name)
+        return await self._api.create_preset_ptz_camera(self.id, name=name)
 
     async def get_ptz_presets(self) -> list[PTZPreset]:
         """Get PTZ Presets for camera."""
         if not self.feature_flags.is_ptz:
             raise BadRequest("Camera does not support PTZ features.")
 
-        return await self.api.get_presets_ptz_camera(self.id)
+        return await self._api.get_presets_ptz_camera(self.id)
 
     async def delete_ptz_preset(self, *, slot: int) -> None:
         """Delete PTZ preset for camera."""
         if not self.feature_flags.is_ptz:
             raise BadRequest("Camera does not support PTZ features.")
 
-        await self.api.delete_preset_ptz_camera(self.id, slot=slot)
+        await self._api.delete_preset_ptz_camera(self.id, slot=slot)
 
     async def get_ptz_home(self) -> PTZPreset:
         """Get PTZ home preset (-1)."""
         if not self.feature_flags.is_ptz:
             raise BadRequest("Camera does not support PTZ features.")
 
-        return await self.api.get_home_ptz_camera(self.id)
+        return await self._api.get_home_ptz_camera(self.id)
 
     async def set_ptz_home(self) -> PTZPreset:
         """Get PTZ home preset (-1) to current position."""
         if not self.feature_flags.is_ptz:
             raise BadRequest("Camera does not support PTZ features.")
 
-        return await self.api.set_home_ptz_camera(self.id)
+        return await self._api.set_home_ptz_camera(self.id)
 
     # endregion
 
@@ -2704,7 +2706,7 @@ class Viewer(ProtectAdoptableDeviceModel):
     @property
     def liveview(self) -> Liveview | None:
         # user may not have permission to see the liveview
-        return self.api.bootstrap.liveviews.get(self.liveview_id)
+        return self._api.bootstrap.liveviews.get(self.liveview_id)
 
     async def set_liveview(self, liveview: Liveview) -> None:
         """
@@ -2838,7 +2840,7 @@ class Sensor(ProtectAdoptableDeviceModel):
         if self.camera_id is None:
             return None
 
-        return self.api.bootstrap.cameras[self.camera_id]
+        return self._api.bootstrap.cameras[self.camera_id]
 
     @property
     def is_tampering_detected(self) -> bool:
@@ -2889,28 +2891,28 @@ class Sensor(ProtectAdoptableDeviceModel):
         if self.last_motion_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_motion_event_id)
+        return self._api.bootstrap.events.get(self.last_motion_event_id)
 
     @property
     def last_contact_event(self) -> Event | None:
         if self.last_contact_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_contact_event_id)
+        return self._api.bootstrap.events.get(self.last_contact_event_id)
 
     @property
     def last_value_event(self) -> Event | None:
         if self.last_value_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_value_event_id)
+        return self._api.bootstrap.events.get(self.last_value_event_id)
 
     @property
     def last_alarm_event(self) -> Event | None:
         if self.last_alarm_event_id is None:
             return None
 
-        return self.api.bootstrap.events.get(self.last_alarm_event_id)
+        return self._api.bootstrap.events.get(self.last_alarm_event_id)
 
     @property
     def is_leak_detected(self) -> bool:
@@ -3065,7 +3067,7 @@ class Sensor(ProtectAdoptableDeviceModel):
 
     async def clear_tamper(self) -> None:
         """Clears tamper status for sensor"""
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.SENSOR,
             PermissionNode.WRITE,
             self,
@@ -3073,7 +3075,7 @@ class Sensor(ProtectAdoptableDeviceModel):
             raise NotAuthorized(
                 f"Do not have permission to clear tamper for sensor: {self.id}",
             )
-        await self.api.clear_tamper_sensor(self.id)
+        await self._api.clear_tamper_sensor(self.id)
 
 
 class Doorlock(ProtectAdoptableDeviceModel):
@@ -3121,7 +3123,7 @@ class Doorlock(ProtectAdoptableDeviceModel):
         if self.camera_id is None:
             return None
 
-        return self.api.bootstrap.cameras[self.camera_id]
+        return self._api.bootstrap.cameras[self.camera_id]
 
     async def set_paired_camera(self, camera: Camera | None) -> None:
         """Sets the camera paired with the sensor"""
@@ -3157,14 +3159,14 @@ class Doorlock(ProtectAdoptableDeviceModel):
         if self.lock_status != LockStatusType.OPEN:
             raise BadRequest("Lock is not open")
 
-        await self.api.close_lock(self.id)
+        await self._api.close_lock(self.id)
 
     async def open_lock(self) -> None:
         """Open doorlock (unlock)"""
         if self.lock_status != LockStatusType.CLOSED:
             raise BadRequest("Lock is not closed")
 
-        await self.api.open_lock(self.id)
+        await self._api.open_lock(self.id)
 
     async def calibrate(self) -> None:
         """
@@ -3172,7 +3174,7 @@ class Doorlock(ProtectAdoptableDeviceModel):
 
         Door must be open and lock unlocked.
         """
-        await self.api.calibrate_lock(self.id)
+        await self._api.calibrate_lock(self.id)
 
 
 class ChimeFeatureFlags(ProtectBaseObject):
@@ -3203,7 +3205,7 @@ class RingSetting(ProtectBaseObject):
         if self.camera_id is None:
             return None  # type: ignore[unreachable]
 
-        return self.api.bootstrap.cameras[self.camera_id]
+        return self._api.bootstrap.cameras[self.camera_id]
 
 
 class ChimeTrack(ProtectBaseObject):
@@ -3260,7 +3262,7 @@ class Chime(ProtectAdoptableDeviceModel):
         """Paired Cameras for chime"""
         if len(self.camera_ids) == 0:
             return []
-        return [self.api.bootstrap.cameras[c] for c in self.camera_ids]
+        return [self._api.bootstrap.cameras[c] for c in self.camera_ids]
 
     async def set_volume(self, level: int) -> None:
         """Set the volume on chime."""
@@ -3321,11 +3323,11 @@ class Chime(ProtectAdoptableDeviceModel):
         repeat_times: int | None = None,
     ) -> None:
         """Plays chime tone"""
-        await self.api.play_speaker(self.id, volume=volume, repeat_times=repeat_times)
+        await self._api.play_speaker(self.id, volume=volume, repeat_times=repeat_times)
 
     async def play_buzzer(self) -> None:
         """Plays chime buzzer"""
-        await self.api.play_buzzer(self.id)
+        await self._api.play_buzzer(self.id)
 
     async def set_repeat_times(self, value: int) -> None:
         """Set repeat times on chime."""

{uiprotect-0.15.1 → uiprotect-1.0.0}/src/uiprotect/data/nvr.py

@@ -124,11 +124,11 @@ class SmartDetectTrack(ProtectBaseObject):
 
     @property
     def camera(self) -> Camera:
-        return self.api.bootstrap.cameras[self.camera_id]
+        return self._api.bootstrap.cameras[self.camera_id]
 
     @property
     def event(self) -> Event | None:
-        return self.api.bootstrap.events.get(self.event_id)
+        return self._api.bootstrap.events.get(self.event_id)
 
 
 class LicensePlateMetadata(ProtectBaseObject):
@@ -331,28 +331,28 @@ class Event(ProtectModelWithId):
         if self.camera_id is None:
             return None
 
-        return self.api.bootstrap.cameras.get(self.camera_id)
+        return self._api.bootstrap.cameras.get(self.camera_id)
 
     @property
     def light(self) -> Light | None:
         if self.metadata is None or self.metadata.light_id is None:
             return None
 
-        return self.api.bootstrap.lights.get(self.metadata.light_id)
+        return self._api.bootstrap.lights.get(self.metadata.light_id)
 
     @property
     def sensor(self) -> Sensor | None:
         if self.metadata is None or self.metadata.sensor_id is None:
             return None
 
-        return self.api.bootstrap.sensors.get(self.metadata.sensor_id)
+        return self._api.bootstrap.sensors.get(self.metadata.sensor_id)
 
     @property
     def user(self) -> User | None:
         if self.user_id is None:
             return None
 
-        return self.api.bootstrap.users.get(self.user_id)
+        return self._api.bootstrap.users.get(self.user_id)
 
     @property
     def smart_detect_events(self) -> list[Event]:
@@ -360,9 +360,9 @@ class Event(ProtectModelWithId):
             return self._smart_detect_events
 
         self._smart_detect_events = [
-            self.api.bootstrap.events[g]
+            self._api.bootstrap.events[g]
             for g in self.smart_detect_event_ids
-            if g in self.api.bootstrap.events
+            if g in self._api.bootstrap.events
         ]
         return self._smart_detect_events
 
@@ -374,7 +374,7 @@ class Event(ProtectModelWithId):
         """Gets thumbnail for event"""
         if self.thumbnail_id is None:
             return None
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.CAMERA,
             PermissionNode.READ_MEDIA,
             self.camera,
@@ -382,7 +382,7 @@ class Event(ProtectModelWithId):
             raise NotAuthorized(
                 f"Do not have permission to read media for camera: {self.id}",
             )
-        return await self.api.get_event_thumbnail(self.thumbnail_id, width, height)
+        return await self._api.get_event_thumbnail(self.thumbnail_id, width, height)
 
     async def get_animated_thumbnail(
         self,
@@ -394,7 +394,7 @@ class Event(ProtectModelWithId):
         """Gets animated thumbnail for event"""
         if self.thumbnail_id is None:
             return None
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.CAMERA,
             PermissionNode.READ_MEDIA,
             self.camera,
@@ -402,7 +402,7 @@ class Event(ProtectModelWithId):
             raise NotAuthorized(
                 f"Do not have permission to read media for camera: {self.id}",
             )
-        return await self.api.get_event_animated_thumbnail(
+        return await self._api.get_event_animated_thumbnail(
             self.thumbnail_id,
             width,
             height,
@@ -413,7 +413,7 @@ class Event(ProtectModelWithId):
         """Gets heatmap for event"""
         if self.heatmap_id is None:
             return None
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.CAMERA,
             PermissionNode.READ_MEDIA,
             self.camera,
@@ -421,7 +421,7 @@ class Event(ProtectModelWithId):
             raise NotAuthorized(
                 f"Do not have permission to read media for camera: {self.id}",
             )
-        return await self.api.get_event_heatmap(self.heatmap_id)
+        return await self._api.get_event_heatmap(self.heatmap_id)
 
     async def get_video(
         self,
@@ -446,7 +446,7 @@ class Event(ProtectModelWithId):
         if self.end is None:
             raise BadRequest("Event is ongoing")
 
-        if not self.api.bootstrap.auth_user.can(
+        if not self._api.bootstrap.auth_user.can(
             ModelType.CAMERA,
             PermissionNode.READ_MEDIA,
             self.camera,
@@ -454,7 +454,7 @@ class Event(ProtectModelWithId):
             raise NotAuthorized(
                 f"Do not have permission to read media for camera: {self.id}",
             )
-        return await self.api.get_camera_video(
+        return await self._api.get_camera_video(
             self.camera.id,
             self.start,
             self.end,
@@ -475,7 +475,7 @@ class Event(ProtectModelWithId):
             raise BadRequest("Not a smart detect event")
 
         if self._smart_detect_track is None:
-            self._smart_detect_track = await self.api.get_event_smart_detect_track(
+            self._smart_detect_track = await self._api.get_event_smart_detect_track(
                 self.id,
             )
 
@@ -1043,7 +1043,7 @@ class NVR(ProtectDeviceModel):
         return super().unifi_dict_to_dict(data)
 
     async def _api_update(self, data: dict[str, Any]) -> None:
-        return await self.api.update_nvr(data)
+        return await self._api.update_nvr(data)
 
     @property
     def is_analytics_enabled(self) -> bool:
@@ -1051,7 +1051,7 @@ class NVR(ProtectDeviceModel):
 
     @property
     def protect_url(self) -> str:
-        return f"{self.api.base_url}/protect/devices/{self.api.bootstrap.nvr.id}"
+        return f"{self._api.base_url}/protect/devices/{self._api.bootstrap.nvr.id}"
 
     @property
     def display_name(self) -> str:
@@ -1062,7 +1062,7 @@ class NVR(ProtectDeviceModel):
         """Vault Cameras for NVR"""
         if len(self.vault_camera_ids) == 0:
             return []
-        return [self.api.bootstrap.cameras[c] for c in self.vault_camera_ids]
+        return [self._api.bootstrap.cameras[c] for c in self.vault_camera_ids]
 
     @property
     def is_global_recording_enabled(self) -> bool:
@@ -1194,7 +1194,7 @@ class NVR(ProtectDeviceModel):
 
     async def reboot(self) -> None:
         """Reboots the NVR"""
-        await self.api.reboot_nvr()
+        await self._api.reboot_nvr()
 
     async def _read_cache_file(self, file_path: Path) -> set[Version] | None:
         versions: set[Version] | None = None
@@ -1218,16 +1218,16 @@ class NVR(ProtectDeviceModel):
             return True
 
         # 2.6.14 is an EA version that looks like a release version
-        cache_file_path = self.api.cache_dir / "release_cache.json"
+        cache_file_path = self._api.cache_dir / "release_cache.json"
         versions = await self._read_cache_file(
             cache_file_path,
         ) or await self._read_cache_file(RELEASE_CACHE)
         if versions is None or self.version not in versions:
-            versions = await self.api.get_release_versions()
+            versions = await self._api.get_release_versions()
             try:
                 _LOGGER.debug("Fetching releases from APT repos...")
-                tmp = self.api.cache_dir / "release_cache.tmp.json"
-                await aos.makedirs(self.api.cache_dir, exist_ok=True)
+                tmp = self._api.cache_dir / "release_cache.tmp.json"
+                await aos.makedirs(self._api.cache_dir, exist_ok=True)
                 async with aiofiles.open(tmp, "wb") as cache_file:
                     await cache_file.write(orjson.dumps([str(v) for v in versions]))
                 await aos.rename(tmp, cache_file_path)
@@ -1487,9 +1487,9 @@ class LiveviewSlot(ProtectBaseObject):
 
         # user may not have permission to see the cameras in the liveview
         self._cameras = [
-            self.api.bootstrap.cameras[g]
+            self._api.bootstrap.cameras[g]
             for g in self.camera_ids
-            if g in self.api.bootstrap.cameras
+            if g in self._api.bootstrap.cameras
         ]
         return self._cameras
 
@@ -1519,8 +1519,8 @@ class Liveview(ProtectModelWithId):
 
         Will be none if the user only has read only access and it was not made by their user.
         """
-        return self.api.bootstrap.users.get(self.owner_id)
+        return self._api.bootstrap.users.get(self.owner_id)
 
     @property
     def protect_url(self) -> str:
-        return f"{self.api.base_url}/protect/liveview/{self.id}"
+        return f"{self._api.base_url}/protect/liveview/{self.id}"

{uiprotect-0.15.1 → uiprotect-1.0.0}/src/uiprotect/data/user.py

@@ -54,7 +54,7 @@ class Permission(ProtectBaseObject):
         if self.obj_ids == {"self"} or self.obj_ids is None:
             return None
 
-        devices = getattr(self.api.bootstrap, f"{self.model.value}s")
+        devices = getattr(self._api.bootstrap, f"{self.model.value}s")
         return [devices[oid] for oid in self.obj_ids]
 
 
@@ -110,7 +110,7 @@ class CloudAccount(ProtectModelWithId):
 
     @property
     def user(self) -> User:
-        return self.api.bootstrap.users[self.user_id]
+        return self._api.bootstrap.users[self.user_id]
 
 
 class UserFeatureFlags(ProtectBaseObject):
@@ -199,9 +199,9 @@ class User(ProtectModelWithId):
             return self._groups
 
         self._groups = [
-            self.api.bootstrap.groups[g]
+            self._api.bootstrap.groups[g]
             for g in self.group_ids
-            if g in self.api.bootstrap.groups
+            if g in self._api.bootstrap.groups
         ]
         return self._groups