version 0.2.2, add access_code support

Author: seveibar

examples/interactive_set_access_codes/__init__.py

@@ -0,0 +1,68 @@
+"""
+This program resets a sandbox, creates a webview, asks a user to login to
+that webview, retrieves the locks they own, then sets a code on the front door.
+"""
+from seamapi import Seam
+from dotenv import load_dotenv
+from examples.utils import bcolors, yes_strings
+from pprint import pprint
+import sys
+
+load_dotenv()
+
+if input("This will reset your workspace sandbox, continue? (Y/n) ") not in yes_strings:
+    raise Exception("Stopped by user")
+
+seam = Seam()
+
+print("Reseting sandbox...")
+seam.workspaces.reset_sandbox()
+
+print("Creating a Connect Webview...")
+webview = seam.connect_webviews.create(accepted_providers=["august"])
+
+print("This is my webview:")
+pprint(webview)
+
+print(
+    bcolors.OKCYAN
+    + f"\nGo to the URL below and login\n\n{webview.url}\n\n\t[email protected]\n\t1234\n\n"
+    + bcolors.ENDC
+)
+
+input("Press enter when you're done:")
+
+updated_webview = seam.connect_webviews.get(webview.connect_webview_id)
+
+print("This is my updated webview:")
+pprint(updated_webview)
+
+if updated_webview.login_successful:
+    print(bcolors.OKGREEN + "Successfully logged in!" + bcolors.ENDC)
+else:
+    print(
+        bcolors.FAIL
+        + "\nWebview wasn't logged in, did you forget to log in?\n"
+        + bcolors.ENDC
+    )
+    sys.exit(1)
+
+
+print("Listing all the connected locks for our new account:")
+locks = seam.locks.list()
+pprint(locks)
+
+# We can probably replace this with seam.locks.get and a filter
+front_door = next(
+    lock
+    for lock in locks
+    if lock.properties["august_metadata"]["lock_name"] == "FRONT DOOR"
+)
+
+print("Setting the code 123459 on FRONT DOOR")
+seam.access_codes.create(
+    device=front_door, name="My Personal Entry Code", code="123459"
+)
+
+all_access_codes_on_front_door = seam.access_codes.list(device=front_door)
+pprint(all_access_codes_on_front_door)

examples/interactive_set_access_codes/interactive_set_access_codes.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "seamapi"
-version = "0.1.2"
+version = "0.2.2"
 description = "A Python Library for Seam's API https://getseam.com"
 authors = ["Severin Ibarluzea <[email protected]>"]
 license = "MIT"

pyproject.toml

@@ -0,0 +1,51 @@
+from seamapi.types import (
+    AbstractAccessCodes,
+    AccessCode,
+    Device,
+    DeviceId,
+    ActionAttempt,
+    AbstractSeam as Seam,
+)
+from typing import List, Union
+import requests
+
+
+def to_device_id(device: Union[DeviceId, Device]) -> str:
+    if isinstance(device, str):
+        return device
+    return device.device_id
+
+
+class AccessCodes(AbstractAccessCodes):
+    seam: Seam
+
+    def __init__(self, seam: Seam):
+        self.seam = seam
+
+    def list(self, device: Union[DeviceId, Device]) -> List[AccessCode]:
+        device_id = to_device_id(device)
+        res = requests.get(
+            f"{self.seam.api_url}/access_codes/list?device_id={device_id}",
+            headers={"Authorization": f"Bearer {self.seam.api_key}"},
+        )
+        if not res.ok:
+            raise Exception(res.text)
+        access_codes = res.json()["access_codes"]
+        return [AccessCode.from_dict(ac) for ac in access_codes]
+
+    def create(
+        self, device: Union[DeviceId, Device], name: str, code: str
+    ) -> ActionAttempt:
+        device_id = to_device_id(device)
+        res = requests.post(
+            f"{self.seam.api_url}/access_codes/create",
+            headers={"Authorization": f"Bearer {self.seam.api_key}"},
+            json={
+                "device_id": device_id,
+                "name": name,
+                "code": code,
+            },
+        )
+        if not res.ok:
+            raise Exception(res.text)
+        return ActionAttempt(action_attempt_id="", status="pending")

seamapi/access_codes.py

@@ -4,6 +4,7 @@
 from .devices import Devices
 from .connect_webviews import ConnectWebviews
 from .locks import Locks
+from .access_codes import AccessCodes
 from .types import AbstractSeam
 
 
@@ -24,3 +25,4 @@ def __init__(self, api_key: Optional[str] = None):
         self.connect_webviews = ConnectWebviews(seam=self)
         self.devices = Devices(seam=self)
         self.locks = Locks(seam=self)
+        self.access_codes = AccessCodes(seam=self)

seamapi/seam.py

@@ -43,6 +43,14 @@ class ConnectWebview:
     third_party_account_id: Optional[str]
 
 
+@dataclass_json
+@dataclass
+class AccessCode:
+    access_code_id: str
+    type: str
+    code: str
+
+
 class AbstractLocks(abc.ABC):
     @abc.abstractmethod
     def list(self) -> List[Device]:
@@ -61,6 +69,18 @@ def unlock_door(self, device: Union[DeviceId, Device]) -> ActionAttempt:
         raise NotImplementedError
 
 
+class AbstractAccessCodes(abc.ABC):
+    @abc.abstractmethod
+    def list(self, device: Union[DeviceId, Device]) -> List[AccessCode]:
+        raise NotImplementedError
+
+    @abc.abstractmethod
+    def create(
+        self, device: Union[DeviceId, Device], name: str, code: str
+    ) -> ActionAttempt:
+        raise NotImplementedError
+
+
 class AbstractActionAttempt(abc.ABC):
     @abc.abstractmethod
     def list(self) -> List[ActionAttempt]:
@@ -122,6 +142,7 @@ class AbstractSeam(abc.ABC):
     connect_webviews: AbstractConnectWebviews
     locks: AbstractLocks
     devices: AbstractDevices
+    access_codes: AbstractAccessCodes
 
     @abc.abstractmethod
     def __init__(self, api_key: Optional[str] = None):