fix: Add update noise threshold method (#87)

* Add update noise threshold method

* Update seamapi/noise_thresholds.py

* Update seamapi/noise_thresholds.py

* Update noise_thresholds.update method

* Update methods' docs

* Test update noise thresholds

Author: andrii-balitskyi

seamapi/noise_thresholds.py

@@ -28,9 +28,14 @@ class NoiseThresholds(AbstractNoiseThresholds):
     -------
     list(device_id)
         Gets a list of noise thresholds of a noise-monitoring device
-    create(device_id, starts_daily_at, ends_daily_at, sync=None, noise_threshold_decibels=None, noise_threshold_nrs=None)
+
+    create(device_id, starts_daily_at, ends_daily_at, name=None noise_threshold_decibels=None, noise_threshold_nrs=None, wait_for_action_attempt=True)
         Creates a noise threshold on a noise-monitoring device
-    delete(noise_threshold_id, device_id, sync=None)
+
+    update(device_id, noise_threshold_id, name=None, starts_daily_at=None, ends_daily_at=None, noise_threshold_decibels=None, noise_threshold_nrs=None, wait_for_action_attempt=True)
+        Updates a noise threshold on a noise-monitoring device
+
+    delete(noise_threshold_id, device_id, wait_for_action_attempt=True)
         Deletes a noise threshold on a noise-monitoring device
     """
 
@@ -105,6 +110,7 @@ def create(
             The noise level in decibels
         noise_threshold_nrs: Optional[float],
             Noise Level in Noiseaware Noise Risk Score (NRS)
+
         Raises
         ------
         Exception
@@ -168,8 +174,99 @@ def create(
         return NoiseThreshold.from_dict(noise_threshold)
 
     @report_error
-    def update(self, noise_threshold_id):
-        raise NotImplementedError()
+    def update(
+        self,
+        device_id: str,
+        noise_threshold_id: str,
+        name: Optional[str] = None,
+        starts_daily_at: Optional[str] = None,
+        ends_daily_at: Optional[str] = None,
+        noise_threshold_decibels: Optional[float] = None,
+        noise_threshold_nrs: Optional[float] = None,
+        wait_for_action_attempt: Optional[bool] = True,
+    ) -> Union[ActionAttempt, NoiseThreshold]:
+        """Updates a noise threshold.
+        Parameters
+        ----------
+        device_id : str
+            Device ID of a device to update noise threshold of
+        noise_threshold_id : str
+            Id of a noise threshold to update
+        name: Optional[str]
+            Noise threshold name
+        starts_daily_at: Optional[str],
+            Time when noise threshold becomes active
+        ends_daily_at: Optional[str],
+            Time when noise threshold becomes inactive
+        noise_threshold_decibels: Optional[float],
+            Noise level in decibels
+        noise_threshold_nrs: Optional[float],
+            Noise Level in Noiseaware Noise Risk Score (NRS)
+        wait_for_action_attempt: Optional[bool]
+            Should wait for action attempt to resolve
+
+        Raises
+        ------
+        Exception
+            If the API request wasn't successful.
+
+        Returns
+        ------
+            ActionAttempt or NoiseThreshold
+        """
+        params = {
+            "device_id": device_id,
+            "noise_threshold_id": noise_threshold_id,
+        }
+
+        arguments = {
+            "name": name,
+            "starts_daily_at": starts_daily_at,
+            "ends_daily_at": ends_daily_at,
+            "noise_threshold_decibels": noise_threshold_decibels,
+            "noise_threshold_nrs": noise_threshold_nrs,
+        }
+
+        for name in arguments:
+            if arguments[name]:
+                params.update({name: arguments[name]})
+
+        res = self.seam.make_request(
+            "PUT",
+            "/noise_sensors/noise_thresholds/update",
+            json=params,
+        )
+
+        json_aa = res["action_attempt"]
+        aa_error = None
+        if "error" in json_aa and json_aa["error"] is not None:
+            aa_error = ActionAttemptError(
+                type=json_aa["error"]["type"],
+                message=json_aa["error"]["message"],
+            )
+
+        if not wait_for_action_attempt or aa_error:
+            return ActionAttempt(
+                action_attempt_id=json_aa["action_attempt_id"],
+                status=json_aa["status"],
+                action_type=json_aa["action_type"],
+                result=json_aa["result"],
+                error=aa_error,
+            )
+
+        updated_action_attempt = self.seam.action_attempts.poll_until_ready(
+            json_aa["action_attempt_id"]
+        )
+
+        action_attempt_result = getattr(updated_action_attempt, "result", None)
+        noise_threshold = action_attempt_result.get("noise_threshold", None)
+        if not action_attempt_result or not noise_threshold:
+            raise Exception(
+                "Failed to create noise_threshold: no noise_threshold returned: "
+                + json.dumps(asdict(updated_action_attempt))
+            )
+
+        return NoiseThreshold.from_dict(noise_threshold)
 
     @report_error
     def delete(

seamapi/types.py

@@ -294,18 +294,22 @@ def create(
         name: Optional[str],
         noise_threshold_decibels: Optional[float] = None,
         noise_threshold_nrs: Optional[float] = None,
-        sync: Optional[bool] = None,
-    ) -> NoiseThreshold:
+        wait_for_action_attempt: Optional[bool] = True,
+    ) -> Union[ActionAttempt, NoiseThreshold]:
         raise NotImplementedError
 
     @abc.abstractmethod
     def update(
         self,
+        device_id: str,
         noise_threshold_id: str,
         name: Optional[str] = None,
+        starts_daily_at: Optional[str] = None,
+        ends_daily_at: Optional[str] = None,
         noise_threshold_decibels: Optional[str] = None,
         noise_threshold_nrs: Optional[str] = None,
-    ) -> None:
+        wait_for_action_attempt: Optional[bool] = True,
+    ) -> Union[ActionAttempt, NoiseThreshold]:
         raise NotImplementedError
 
     @abc.abstractmethod
@@ -320,8 +324,8 @@ def delete(
         self,
         noise_threshold_id: str,
         device_id: str,
-        sync: Optional[bool] = None,
-    ) -> None:
+        wait_for_action_attempt: Optional[bool] = True,
+    ) -> ActionAttempt:
         raise NotImplementedError
 
 

tests/connected_accounts/test_connected_accounts.py

@@ -1,7 +1,8 @@
 from seamapi import Seam
 from tests.fixtures.run_august_factory import run_august_factory
 
-EMAIL = "[email protected]"
+EMAIL = "[email protected]"
+
 
 def test_connected_accounts(seam: Seam):
     run_august_factory(seam)
@@ -24,5 +25,7 @@ def test_connected_accounts(seam: Seam):
     try:
         seam.connected_accounts.get()
     except Exception as e:
-        assert str(e) == "Must provide either ConnectedAccount (ConnectedAccount or ConnectedAccountId) or Email"
-    
+        assert (
+            str(e)
+            == "Must provide either ConnectedAccount (ConnectedAccount or ConnectedAccountId) or Email"
+        )

tests/noise_sensors/noise_thresholds/test_noise_thresholds.py

@@ -30,11 +30,18 @@ def get_minut_device_noise_thresholds():
     noise_thresholds = get_minut_device_noise_thresholds()
     assert len(noise_thresholds) == 1
 
-    seam.noise_sensors.noise_thresholds.create(
+    noise_threshold = seam.noise_sensors.noise_thresholds.create(
         device_id=device.device_id,
         starts_daily_at="20:00:00[America/Los_Angeles]",
         ends_daily_at="08:00:00[America/Los_Angeles]",
         noise_threshold_decibels=75,
     )
     noise_thresholds = get_minut_device_noise_thresholds()
     assert len(noise_thresholds) == 2
+
+    updated_noise_threshold = seam.noise_sensors.noise_thresholds.update(
+        device_id=device.device_id,
+        noise_threshold_id=noise_threshold.noise_threshold_id,
+        noise_threshold_decibels=80,
+    )
+    assert updated_noise_threshold.noise_threshold_decibels == 80