Merge branch 'main' of github.com:seamapi/python-next into update-str…

…ucture-and-imports

README.rst

@@ -191,6 +191,24 @@ Using the ``wait_for_action_attempt`` option:
   except SeamActionAttemptTimeoutError as e:
       print("Door took too long to unlock")
 
+Interacting with Multiple Workspaces
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Some Seam API endpoints interact with multiple workspaces. The ``SeamMultiWorkspace`` client is not bound to a specific workspace and may use those endpoints with a personal access token authentication method.
+
+A Personal Access Token is scoped to a Seam Console user. Obtain one from the Seam Console.
+
+.. code-block:: python
+
+  # Pass as an option the constructor
+  seam = SeamMultiWorkspace(personal_access_token="your-personal-access-token")
+
+  # Use the factory method
+  seam = SeamMultiWorkspace.from_personal_access_token("your-personal-access-token")
+
+  # List workspaces authorized for this Personal Access Token
+  workspaces = seam.workspaces.list()
+
 Advanced Usage
 ~~~~~~~~~~~~~~
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "seam"
-version = "0.7.0"
+version = "0.7.1"
 description = "SDK for the Seam API written in Python."
 authors = ["Seam Labs, Inc. <[email protected]>"]
 license = "MIT"

seam/__init__.py

@@ -6,7 +6,7 @@
 from .options import SeamHttpInvalidOptionsError
 from .auth import SeamHttpInvalidTokenError
 from .exceptions import (
-    SeamApiException,
+    SeamHttpApiError,
     SeamActionAttemptError,
     SeamActionAttemptFailedError,
     SeamActionAttemptTimeoutError,

seam/exceptions.py

@@ -3,7 +3,7 @@
 
 
 # HTTP
-class SeamApiException(Exception):
+class SeamHttpApiError(Exception):
     def __init__(
         self,
         response: Response,

seam/request.py

@@ -2,7 +2,7 @@
 from importlib.metadata import version
 
 from .models import AbstractRequestMixin
-from .exceptions import SeamApiException
+from .exceptions import SeamHttpApiError
 
 
 class RequestMixin(AbstractRequestMixin):
@@ -21,7 +21,7 @@ def make_request(self, method: str, path: str, **kwargs):
 
         Raises
         ------
-        SeamApiException: If the response status code is not successful.
+        SeamHttpApiError: If the response status code is not successful.
         """
 
         url = self._endpoint + path
@@ -40,7 +40,7 @@ def make_request(self, method: str, path: str, **kwargs):
         response = requests.request(method, url, headers=headers, **kwargs)
 
         if response.status_code != 200:
-            raise SeamApiException(response)
+            raise SeamHttpApiError(response)
 
         if "application/json" in response.headers["content-type"]:
             return response.json()

test/access_codes/test_access_codes.py

@@ -1,4 +1,4 @@
-from seam import Seam, SeamApiException
+from seam import Seam, SeamHttpApiError
 import pytest
 
 
@@ -30,7 +30,7 @@ def test_access_codes(seam: Seam):
     )
     assert access_code.code == "4444"
 
-    with pytest.raises(SeamApiException):
+    with pytest.raises(SeamHttpApiError):
         seam.access_codes.create(
             device_id=some_device.device_id, name="Duplicate Access Code", code="4444"
         )

test/connected_accounts/test_connected_accounts.py

@@ -1,4 +1,4 @@
-from seam import Seam, SeamApiException
+from seam import Seam, SeamHttpApiError
 
 EMAIL = "[email protected]"
 
@@ -26,5 +26,5 @@ def test_connected_accounts(seam: Seam):
     # connected_account and email parameters are not provided.
     try:
         seam.connected_accounts.get()
-    except SeamApiException as e:
+    except SeamHttpApiError as e:
         assert e.metadata["message"] == "Invalid input"

test/devices/test_devices.py

@@ -1,4 +1,4 @@
-from seam import Seam, SeamApiException
+from seam import Seam, SeamHttpApiError
 
 
 def test_devices(seam: Seam):
@@ -60,7 +60,7 @@ def test_devices(seam: Seam):
     try:
         seam.devices.get(name="foo")
         assert False
-    except SeamApiException as error:
+    except SeamHttpApiError as error:
         assert error.status_code == 404
         assert type(error.request_id) == str
         assert error.metadata["type"] == "device_not_found"

test/events/test_events.py

@@ -1,4 +1,4 @@
-from seam import Seam, SeamApiException
+from seam import Seam, SeamHttpApiError
 
 
 SINCE = "2021-01-01T00:00:00.000Z"
@@ -22,5 +22,5 @@ def test_events(seam: Seam):
 
     try:
         seam.events.get(event_id=FAKE_UUID)
-    except SeamApiException as e:
+    except SeamHttpApiError as e:
         assert e.metadata["message"] == "Event not found"

test/noise_sensors/noise_thresholds/test_noise_thresholds.py

@@ -1,6 +1,4 @@
-import time
-from seam import Seam, SeamApiException
-import pytest
+from seam import Seam
 
 
 def test_noise_thresholds(seam: Seam):