Skip to content
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

Document Seam workspace scope #483

Merged
merged 8 commits into from
Jan 15, 2025
Merged

Document Seam workspace scope #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a52ca08
Document Seam workspace scope
andrii-balitskyi Jan 14, 2025
dfef193
ci: Generate docs
seambot Jan 14, 2025
6af1d20
Add missing periods, remove nested bulleted list
andrii-balitskyi Jan 14, 2025
f495396
ci: Generate docs
seambot Jan 14, 2025
1a9caf0
Change indentation
andrii-balitskyi Jan 14, 2025
2f64d9d
ci: Generate docs
seambot Jan 14, 2025
cd77757
Add break line tag
andrii-balitskyi Jan 14, 2025
5140b85
ci: Generate docs
seambot Jan 14, 2025
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
1 change: 1 addition & 0 deletions docs/api/acs/access_groups/add_user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/access_groups/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/access_groups/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ func main() {

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/access_groups/list_accessible_entrances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ func main() {

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/access_groups/list_users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ func main() {

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/access_groups/remove_user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/assign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ func main() {
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/list_accessible_entrances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ func main() {

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/unassign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/credentials/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/entrances/grant_access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ POST /acs/entrances/grant_access ⇒ void

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/entrances/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ func main() {
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/entrances/list_credentials_with_access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ func main() {
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/systems/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ func main() {

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/systems/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ func main() {
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ func main() {

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/add_to_access_group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/list_accessible_entrances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/remove_from_access_group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/revoke_access_to_all_entrances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances)

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/suspend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/unsuspend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/acs/users/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/activate_climate_preset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/cool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/create_climate_preset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/delete_climate_preset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/heat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/heat_cool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ func main() {
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/off.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/schedules/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/schedules/delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ nil
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/schedules/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/schedules/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ func main() {
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/schedules/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ nil
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/set_fallback_climate_preset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/set_fan_mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/set_hvac_mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu
- API key
- Client session token
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/set_temperature_threshold.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/thermostats/update_climate_preset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
1 change: 1 addition & 0 deletions docs/api/user_identities/add_acs_user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ nil

- API key
- Personal access token
<br>Must also include the `seam-workspace` header in the request.

## Request Parameters

Expand Down
Loading
Loading