Document Seam workspace scope (#483)

Co-authored-by: Seam Bot <[email protected]>
seamapi · Jan 15, 2025 · db282ec · db282ec
1 parent a977180
commit db282ec
Show file tree

Hide file tree

Showing 67 changed files with 71 additions and 0 deletions.
diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md
@@ -123,6 +123,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md
@@ -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
 

diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md
@@ -189,6 +189,7 @@ func main() {
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md
@@ -164,6 +164,7 @@ func main() {
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md
@@ -222,6 +222,7 @@ func main() {
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md
@@ -123,6 +123,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md
@@ -123,6 +123,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md
@@ -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
 

diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md
@@ -114,6 +114,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md
@@ -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
 

diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md
@@ -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
 

diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md
@@ -209,6 +209,7 @@ func main() {
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md
@@ -123,6 +123,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md
@@ -119,6 +119,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md
@@ -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
 

diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md
@@ -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
 

diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md
@@ -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
 

diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md
@@ -115,6 +115,7 @@ func main() {
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md
@@ -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
 

diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
@@ -123,6 +123,7 @@ func main() {
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md
@@ -123,6 +123,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md
@@ -184,6 +184,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
 

diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md
@@ -112,6 +112,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md
@@ -158,6 +158,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
 

diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md
@@ -149,6 +149,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
 

diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md
@@ -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
 

diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md
@@ -123,6 +123,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md
@@ -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
 

diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md
@@ -112,6 +112,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md
@@ -114,6 +114,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md
@@ -122,6 +122,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md
@@ -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
 

diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md
@@ -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
 

diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md
@@ -152,6 +152,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md
@@ -121,6 +121,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md
@@ -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
 

diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md
@@ -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
 

diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md
@@ -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
 

diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md
@@ -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
 

diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md
@@ -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
 

diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md
@@ -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
 

diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md
@@ -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
 

diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md
@@ -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
 

diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md
@@ -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
 

diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md
@@ -121,6 +121,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md
@@ -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
 

diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md
@@ -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
 

diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md
@@ -127,6 +127,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md
@@ -132,6 +132,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
 

diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md
@@ -122,6 +122,7 @@ nil
 
 - API key
 - Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
 
 ## Request Parameters
-Original file 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 @@