Add thermostats.set_mode (#102)

* Remove thermostats.delete

* Add set_mode method

* Test /set_mode

Author: andrii-balitskyi

seamapi/thermostats.py

@@ -1,5 +1,6 @@
 from seamapi.types import (
     AbstractThermostats,
+    ActionAttempt,
     ConnectWebview,
     ConnectWebviewId,
     ConnectedAccount,
@@ -50,7 +51,9 @@ def __init__(self, seam: Seam):
         """
 
         self.seam = seam
-        self.climate_setting_schedules = ClimateSettingSchedules(seam=self.seam)
+        self.climate_setting_schedules = ClimateSettingSchedules(
+            seam=self.seam
+        )
 
     @report_error
     def list(
@@ -91,7 +94,7 @@ def list(
                 connect_webview
             )
         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]
 
         res = self.seam.make_request(
             "GET",
@@ -183,13 +186,28 @@ def update(
         return True
 
     @report_error
-    def delete(self, device: Union[DeviceId, Device]) -> bool:
-        """Deletes a device.
+    def set_mode(
+        self,
+        device: Union[DeviceId, Device],
+        automatic_heating_enabled: Optional[bool] = None,
+        automatic_cooling_enabled: Optional[bool] = None,
+        hvac_mode_setting: Optional[str] = None,
+        wait_for_action_attempt: Optional[bool] = True,
+    ) -> ActionAttempt:
+        """Sets a thermostat to a given mode.
 
         Parameters
         ----------
         device : DeviceId or Device
-            Device id or Device to delete
+            Device id or Device to update
+        automatic_heating_enabled : bool, optional
+            Enable automatic heating
+        automatic_cooling_enabled : bool, optional
+            Enable cooling heating
+        hvac_mode_setting : str, optional
+            HVAC mode eg. "heat", "cool", "heatcool" or "off"
+        wait_for_action_attempt: bool, optional
+            Should wait for action attempt to resolve
 
         Raises
         ------
@@ -198,17 +216,38 @@ def delete(self, device: Union[DeviceId, Device]) -> bool:
 
         Returns
         ------
-            None
+            ActionAttempt
         """
 
         if not device:
-            raise Exception("device is required")
+            raise Exception("Device is required")
 
-        delete_payload = {"device_id": to_device_id(device)}
-        self.seam.make_request(
-            "DELETE",
-            "/thermostats/delete",
-            json=delete_payload,
+        params = {
+            "device_id": to_device_id(device),
+        }
+
+        arguments = {
+            "automatic_heating_enabled": automatic_heating_enabled,
+            "automatic_cooling_enabled": automatic_cooling_enabled,
+            "hvac_mode_setting": hvac_mode_setting,
+        }
+
+        for name in arguments:
+            if arguments[name]:
+                params.update({name: arguments[name]})
+
+        res = self.seam.make_request(
+            "POST",
+            "/thermostats/set_mode",
+            json=params,
+        )
+        action_attempt = res["action_attempt"]
+
+        if not wait_for_action_attempt:
+            return ActionAttempt.from_dict(action_attempt)
+
+        updated_action_attempt = self.seam.action_attempts.poll_until_ready(
+            action_attempt["action_attempt_id"]
         )
 
-        return None
+        return ActionAttempt.from_dict(updated_action_attempt)

seamapi/types.py

@@ -137,8 +137,8 @@ class ActionAttempt:
     action_attempt_id: str
     action_type: str
     status: str
-    result: Optional[Any]
-    error: Optional[ActionAttemptError]
+    result: Optional[Any] = None
+    error: Optional[ActionAttemptError] = None
 
 
 @dataclass_json
@@ -620,10 +620,6 @@ def update(
     ) -> None:
         raise NotImplementedError
 
-    @abc.abstractmethod
-    def delete(self, device: Union[DeviceId, Device]) -> None:
-        raise NotImplementedError
-
 
 @dataclass
 class AbstractRoutes(abc.ABC):

tests/thermostats/test_thermostats.py

@@ -1,6 +1,7 @@
 from seamapi import Seam
 from tests.fixtures.run_nest_factory import run_nest_factory
 
+
 def test_thermostats(seam: Seam):
     run_nest_factory(seam)
 
@@ -24,14 +25,18 @@ def test_thermostats(seam: Seam):
             "hvac_mode_setting": "cool",
             "cooling_set_point_celsius": 20,
             "manual_override_allowed": True,
-        }
+        },
     )
 
     assert result == True
 
-    # Test Delete
-    result = seam.thermostats.delete(thermostat)
-    assert result == None
-
-    thermostats = seam.thermostats.list()
-    assert len(thermostats) == 2
+    assert (
+        thermostat.properties.current_climate_setting.hvac_mode_setting
+        == "heatcool"
+    )
+    seam.thermostats.set_mode(device=thermostat, hvac_mode_setting="heat")
+    updated_thermostat = seam.thermostats.get(thermostat.device_id)
+    assert (
+        updated_thermostat.properties.current_climate_setting.hvac_mode_setting
+        == "heat"
+    )