feat: Merge pull request #46 from seamapi/get-connected-account-by-email

fix #28: Add support for `connected_account.get` via email

Author: xplato

seamapi/connected_accounts.py

@@ -3,6 +3,7 @@
     ConnectedAccount,
     AbstractSeam as Seam,
     ConnectedAccountId,
+    Email,
 )
 
 import requests
@@ -75,30 +76,43 @@ def list(self) -> List[ConnectedAccount]:
 
     def get(
         self,
-        connected_account: Union[ConnectedAccountId, ConnectedAccount],
+        connected_account: Union[ConnectedAccountId, ConnectedAccount, None] = None,
+        email: Email = None,
     ) -> ConnectedAccount:
         """Gets a connected account.
 
         Parameters
         ----------
-        connected_account : ConnectedAccountId or ConnectedAccount
+        connected_account : ConnectedAccountId or ConnectedAccount, optional (required if email is None)
             Connected account id or ConnectedAccount to get the latest version of
+        email : Email (str), optional (required if connected_account is None)
+            Email to get the latest connected account for
 
         Raises
         ------
+        Exception
+            If both connected_account and email are not provided.
         Exception
             If the API request wasn't successful.
 
         Returns
         ------
             ConnectedAccount
         """
+        params = {}
 
-        connected_account_id = to_connected_account_id(connected_account)
+        if connected_account:
+            params["connected_account_id"] = to_connected_account_id(connected_account)
+        if email:
+            params["email"] = email
+
+        if not connected_account and not email:
+            raise Exception("Must provide either ConnectedAccount (ConnectedAccount or ConnectedAccountId) or Email")
+        
         res = requests.get(
             f"{self.seam.api_url}/connected_accounts/get",
             headers={"Authorization": f"Bearer {self.seam.api_key}"},
-            params={"connected_account_id": connected_account_id},
+            params=params,
         )
         if not res.ok:
             raise Exception(res.text)

seamapi/types.py

@@ -12,6 +12,7 @@
 AcceptedProvider = str  # e.g. august or noiseaware
 ConnectWebviewId = str
 ConnectedAccountId = str
+Email = str
 DeviceType = str  # e.g. august_lock
 WorkspaceId = str
 

tests/connected_accounts/test_connected_accounts.py

@@ -1,6 +1,7 @@
 from seamapi import Seam
 from tests.fixtures.run_august_factory import run_august_factory
 
+EMAIL = "[email protected]"
 
 def test_connected_accounts(seam: Seam):
     run_august_factory(seam)
@@ -10,7 +11,18 @@ def test_connected_accounts(seam: Seam):
 
     connected_account_id = connected_accounts[0].connected_account_id
     connected_account = seam.connected_accounts.get(connected_account_id)
+    email_account = seam.connected_accounts.get(email=EMAIL)
+
     assert connected_account.connected_account_id == connected_account_id
+    assert email_account.connected_account_id == connected_account_id
 
     seam.connected_accounts.delete(connected_account)
-    assert len(seam.connected_accounts.list()) == 0
+    assert len(seam.connected_accounts.list()) == 0
+
+    # Assert that an Exception is raised for the .get() method when
+    # connected_account and email parameters are not provided.
+    try:
+        seam.connected_accounts.get()
+    except Exception as e:
+        assert str(e) == "Must provide either ConnectedAccount (ConnectedAccount or ConnectedAccountId) or Email"
+