feat: Merge pull request #45 from seamapi/implement-devices-delete

fix #36: Implement `devices.delete`

Author: xplato

seamapi/devices.py

@@ -187,4 +187,36 @@ def update(
         if not res.ok:
             raise Exception(res.text)
 
-        return True
+        return True
+    
+    def delete(self, device: Union[DeviceId, Device]) -> bool:
+        """Deletes a device.
+
+        Parameters
+        ----------
+        device : DeviceId or Device
+            Device id or Device to delete
+
+        Raises
+        ------
+        Exception
+            If the API request wasn't successful.
+
+        Returns
+        ------
+            None
+        """
+
+        if not device:
+            raise Exception("device is required")
+
+        params = {"device_id": to_device_id(device)}
+        res = requests.post(
+            f"{self.seam.api_url}/devices/delete",
+            headers={"Authorization": f"Bearer {self.seam.api_key}"},
+            params=params,
+        )
+        if not res.ok:
+            raise Exception(res.text)
+
+        return None

tests/devices/test_devices.py

@@ -31,3 +31,6 @@ def test_devices(seam: Seam):
     seam.devices.update(device=(some_device), name="Updated lock")
     some_updated_lock = seam.locks.get(device=(some_device))
     assert some_updated_lock.properties.name == "Updated lock"
+
+    seam.devices.delete(device=(some_updated_lock))
+    assert len(seam.devices.list()) == len(devices) - 1