api example, connect webview abstraction

seveibar · seveibar · commit 463d8a0bad51 · 2022-01-02T17:30:35.000-08:00
diff --git a/README.md b/README.md
@@ -16,7 +16,10 @@ from seamapi import Seam
 # export SEAM_API_KEY=***
 seam = Seam()
 
-some_lock = next(seam.locks.list())
+some_lock = seam.locks.get(
+  name="Front Door",
+  location="123 Amy Lane"
+)
 
 seam.locks.lock_door(some_lock)
 ```
diff --git a/seamapi/types.py b/seamapi/types.py
@@ -10,6 +10,7 @@
 @dataclass
 class Device:
     device_id: DeviceId
+    name: Optional[str]
 
 
 @dataclass
@@ -24,6 +25,11 @@ class Workspace:
     name: str
 
 
+@dataclass
+class ConnectWebview:
+    connect_webview_id: str
+
+
 @dataclass
 class AbstractSeam(abc.ABC):
     api_key: str
@@ -75,3 +81,11 @@ def reset_sandbox(
         self, workspace_id: Optional[str] = None, sandbox_type: Optional[str] = None
     ) -> None:
         raise NotImplementedError
+
+
+class AbstractConnectWebviews(abc.ABC):
+    def list(self) -> List[ConnectWebview]:
+        raise NotImplementedError
+
+    def get(self, workspace_id: Optional[str] = None) -> ConnectWebview:
+        raise NotImplementedError
