fix: Update Devices and UnmanagedDevices clients (#101)

* Update Devices and UnmanagedDevices clients

* Update types + test new params

* Fix types, test list_device_providers

* Fix import

* More updates for types and params

* Minor fixes

Author: andrii-balitskyi

seamapi/access_codes.py

@@ -18,7 +18,7 @@
 
 class AccessCodes(AbstractAccessCodes):
     """
-    A class used to retreive access code data
+    A class used to retrieve access code data
     through interaction with Seam API
 
     ...

seamapi/connected_accounts.py

@@ -71,7 +71,7 @@ def list(self) -> List[ConnectedAccount]:
                 user_identifier=json_account["user_identifier"],
                 account_type=json_account["account_type"],
                 errors=json_account.get("errors", []),
-                custom_metadata=json_account.get("custom_metadata", {})
+                custom_metadata=json_account.get("custom_metadata", {}),
             )
             for json_account in json_accounts
         ]

seamapi/devices.py

@@ -11,7 +11,7 @@
     AbstractSeam as Seam,
     DeviceType,
 )
-from typing import List, Union, Optional
+from typing import Any, List, Union, Optional, Dict
 from seamapi.utils.convert_to_id import (
     to_connect_webview_id,
     to_connected_account_id,
@@ -34,12 +34,14 @@ class Devices(AbstractDevices):
 
     Methods
     -------
-    list(connected_account=None, connect_webview=None, device_type=None, device_ids=None)
+    list(connected_account=None, connected_accounts=None, connect_webview=None, device_type=None, device_ids=None, manufacturer=None)
         Gets a list of devices
     get(device=None, name=None)
         Gets a device
     update(device, name=None, properties=None, location=None)
         Updates a device
+    list_device_providers(provider_category=None):
+        Gets a list of device providers
     """
 
     seam: Seam
@@ -59,22 +61,33 @@ def __init__(self, seam: Seam):
     def list(
         self,
         connected_account: Union[ConnectedAccountId, ConnectedAccount] = None,
+        connected_accounts: List[
+            Union[ConnectedAccountId, ConnectedAccount]
+        ] = None,
         connect_webview: Union[ConnectWebviewId, ConnectWebview] = None,
         device_type: Optional[DeviceType] = None,
-        device_ids: Optional[list] = None,
+        device_types: Optional[List[DeviceType]] = None,
+        device_ids: Optional[List[Union[DeviceId, Device]]] = None,
+        manufacturer: Optional[str] = None,
     ) -> List[Device]:
         """Gets a list of devices.
 
         Parameters
         ----------
         connected_account : ConnectedAccountId or ConnectedAccount, optional
             Connected account id or ConnectedAccount to get devices associated with
+        connected_accounts : ConnectedAccountId(s) or ConnectedAccount(s), optional
+            Connected account ids or ConnectedAccount(s) to get devices associated with
         connect_webview : ConnectWebviewId or ConnectWebview, optional
             Connect webview id or ConnectWebview to get devices associated with
         device_type : DeviceType, optional
             Device type e.g. august_lock
-        device_ids : Optional[list]
+        device_types : List[DeviceType], optional
+            List of device types e.g. august_lock
+        device_ids : Optional[List[Union[DeviceId, Device]]]
             Device IDs to filter devices by
+        manufacturer : Optional[str]
+            Manufacturer name to filter devices by e.g. august, schlage
 
         Raises
         ------
@@ -88,9 +101,12 @@ def list(
 
         params = parse_list_params(
             connected_account,
+            connected_accounts,
             connect_webview,
             device_type,
-            device_ids
+            device_types,
+            device_ids,
+            manufacturer,
         )
 
         res = self.seam.make_request(
@@ -209,7 +225,7 @@ def delete(self, device: Union[DeviceId, Device]) -> bool:
 
         Returns
         ------
-            None
+            Boolean
         """
 
         if not device:
@@ -222,7 +238,41 @@ def delete(self, device: Union[DeviceId, Device]) -> bool:
             json=delete_payload,
         )
 
-        return None
+        return True
+
+    @report_error
+    def list_device_providers(
+        self, provider_category: Optional[str] = None
+    ) -> List[Dict[str, Any]]:
+        """Retrieve a list of device providers
+
+        Parameters
+        ----------
+        provider_category : Optional[str]
+            Provider category to filter by eg. stable
+
+        Raises
+        ------
+        Exception
+            If the API request wasn't successful.
+
+        Returns
+        ------
+            List of device providers
+        """
+        params = {}
+
+        if provider_category:
+            params["provider_category"] = provider_category
+
+        res = self.seam.make_request(
+            "GET",
+            "/devices/list_device_providers",
+            params=params,
+        )
+
+        return res["device_providers"]
+
 
 class UnmanagedDevices(AbstractUnmanagedDevices):
     """
@@ -238,9 +288,9 @@ class UnmanagedDevices(AbstractUnmanagedDevices):
 
     Methods
     -------
-    list(connected_account=None, connect_webview=None, device_type=None, device_ids=None)
+    list(connected_account=None, connected_accounts=None, connect_webview=None, device_type=None, device_ids=None, manufacturer=None)
         Gets a list of unmanaged devices
-    update(device, is_managed=False)
+    update(device, is_managed)
         Updates an unmanaged device
     """
 
@@ -260,22 +310,33 @@ def __init__(self, seam: Seam):
     def list(
         self,
         connected_account: Union[ConnectedAccountId, ConnectedAccount] = None,
+        connected_accounts: List[
+            Union[ConnectedAccountId, ConnectedAccount]
+        ] = None,
         connect_webview: Union[ConnectWebviewId, ConnectWebview] = None,
         device_type: Optional[DeviceType] = None,
-        device_ids: Optional[list] = None,
-    ) -> List[Device]:
-        """Gets a list of devices.
+        device_types: Optional[List[DeviceType]] = None,
+        device_ids: Optional[List[Union[DeviceId, Device]]] = None,
+        manufacturer: Optional[str] = None,
+    ) -> List[UnmanagedDevice]:
+        """Gets a list of unmanaged devices.
 
         Parameters
         ----------
         connected_account : ConnectedAccountId or ConnectedAccount, optional
             Connected account id or ConnectedAccount to get devices associated with
+        connected_accounts : ConnectedAccountId(s) or ConnectedAccount(s), optional
+            Connected account ids or ConnectedAccount(s) to get devices associated with
         connect_webview : ConnectWebviewId or ConnectWebview, optional
             Connect webview id or ConnectWebview to get devices associated with
         device_type : DeviceType, optional
             Device type e.g. august_lock
-        device_ids : Optional[list]
+        device_types : List[DeviceType], optional
+            List of device types e.g. august_lock
+        device_ids : Optional[List[Union[DeviceId, Device]]]
             Device IDs to filter devices by
+        manufacturer : Optional[str]
+            Manufacturer name to filter devices by e.g. august, schlage
 
         Raises
         ------
@@ -284,14 +345,17 @@ def list(
 
         Returns
         ------
-            A list of devices.
+            A list of unmanaged devices.
         """
 
         params = parse_list_params(
             connected_account,
+            connected_accounts,
             connect_webview,
             device_type,
-            device_ids
+            device_types,
+            device_ids,
+            manufacturer,
         )
 
         res = self.seam.make_request(
@@ -307,15 +371,15 @@ def list(
     def update(
         self,
         device: Union[DeviceId, UnmanagedDevice],
-        is_managed: Optional[bool] = False,
+        is_managed: bool,
     ) -> bool:
-        """Updates a device.
+        """Updates a device transitioning it from an unmanaged state to a managed one.
 
         Parameters
         ----------
         device : DeviceId or Device
             Device id or Device to update
-        is_managed : bool, optional
+        is_managed : bool
             The managed state of the device
 
         Raises
@@ -331,37 +395,44 @@ def update(
         if not device:
             raise Exception("device is required")
 
-        update_payload = {
-            "device_id": to_device_id(device),
-        }
-        if is_managed is not None:
-            update_payload["is_managed"] = is_managed
-
         self.seam.make_request(
             "POST",
             "/devices/unmanaged/update",
-            json=update_payload,
+            json={
+                "device_id": to_device_id(device),
+                "is_managed": is_managed,
+            },
         )
 
         return True
 
-def parse_list_params (
+
+def parse_list_params(
     connected_account,
+    connected_accounts,
     connect_webview,
     device_type,
+    device_types,
     device_ids,
+    manufacturer,
 ):
     params = {}
     if connected_account:
         params["connected_account_id"] = to_connected_account_id(
             connected_account
         )
+    if connected_accounts:
+        params["connected_account_ids"] = [
+            to_connected_account_id(ca) for ca in connected_accounts
+        ]
     if connect_webview:
-        params["connect_webview_id"] = to_connect_webview_id(
-            connect_webview
-        )
+        params["connect_webview_id"] = to_connect_webview_id(connect_webview)
     if device_type:
         params["device_type"] = device_type
+    if device_types is not None:
+        params["device_types"] = device_types
     if device_ids is not None:
-        params["device_ids"] =  [to_device_id(d) for d in device_ids]
+        params["device_ids"] = [to_device_id(d) for d in device_ids]
+    if manufacturer:
+        params["manufacturer"] = manufacturer
     return params