Skip to content

Add readme instructions on how to use SeamMultiWorkspace client #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-balitskyi merged 2 commits into from
May 20, 2024
Merged

Add readme instructions on how to use SeamMultiWorkspace client #57

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8b1cf0
Add readme instruction on how to use SeamMultiWorkspace
andrii-balitskyi May 17, 2024
afc2fe4
Fix code-block lint error
andrii-balitskyi May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~

Expand Down