diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 3018427a..08e809de 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -207,11 +207,11 @@
* [List Noise Thresholds](api-clients/noise_sensors/noise_thresholds/list.md)
* [Update Noise Threshold](api-clients/noise_sensors/noise_thresholds/update.md)
* [Delete Noise Threshold](api-clients/noise_sensors/noise_thresholds/delete.md)
-* [Phones](api/phones/README.md)
- * [Get a Phone](api/phones/get-a-phone.md)
- * [List Phones](api/phones/list-phones.md)
- * [Create a Sandbox Phone](api/phones/create-a-sandbox-phone.md)
- * [Deactivate a Phone](api/phones/deactivate-a-phone.md)
+* [Phones](api-clients/phones/README.md)
+ * [Get a Phone](api-clients/phones/get-a-phone.md)
+ * [List Phones](api-clients/phones/list-phones.md)
+ * [Create a Sandbox Phone](api-clients/phones/create-a-sandbox-phone.md)
+ * [Deactivate a Phone](api-clients/phones/deactivate-a-phone.md)
* [Thermostats](api/thermostats/README.md)
* [List Thermostats](api/thermostats/list.md)
* [Set to Heat Mode](api/thermostats/heat.md)
diff --git a/docs/api/phones/README.md b/docs/api-clients/phones/README.md
similarity index 99%
rename from docs/api/phones/README.md
rename to docs/api-clients/phones/README.md
index 3daf5c25..d6432617 100644
--- a/docs/api/phones/README.md
+++ b/docs/api-clients/phones/README.md
@@ -14,7 +14,7 @@ ID of the `phone`.
### `device_type`
-Format: `Enum`
+Format: `Enum`
Type of phone.
diff --git a/docs/api/phones/create-a-sandbox-phone.md b/docs/api-clients/phones/create-a-sandbox-phone.md
similarity index 100%
rename from docs/api/phones/create-a-sandbox-phone.md
rename to docs/api-clients/phones/create-a-sandbox-phone.md
diff --git a/docs/api/phones/deactivate-a-phone.md b/docs/api-clients/phones/deactivate-a-phone.md
similarity index 100%
rename from docs/api/phones/deactivate-a-phone.md
rename to docs/api-clients/phones/deactivate-a-phone.md
diff --git a/docs/api/phones/get-a-phone.md b/docs/api-clients/phones/get-a-phone.md
similarity index 100%
rename from docs/api/phones/get-a-phone.md
rename to docs/api-clients/phones/get-a-phone.md
diff --git a/docs/api/phones/list-phones.md b/docs/api-clients/phones/list-phones.md
similarity index 100%
rename from docs/api/phones/list-phones.md
rename to docs/api-clients/phones/list-phones.md
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
index ba00b0a0..a8e83651 100644
--- a/docs/api/acs/systems/README.md
+++ b/docs/api/acs/systems/README.md
@@ -10,7 +10,8 @@ Format: `ID`
ID of the `acs_system`.
-***
+
+---
### `can_add_acs_users_to_acs_access_groups`
@@ -18,7 +19,8 @@ Format: `Boolean`
Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences.md#access-group-based-access-control-systems).
-***
+
+---
### `can_automate_enrollment`
@@ -26,7 +28,8 @@ Format: `Boolean`
Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`.
-***
+
+---
### `can_create_acs_access_groups`
@@ -34,7 +37,8 @@ Format: `Boolean`
Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences.md#access-group-based-access-control-systems).
-***
+
+---
### `can_remove_acs_users_from_acs_access_groups`
@@ -42,15 +46,17 @@ Format: `Boolean`
Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences.md#access-group-based-access-control-systems).
-***
+
+---
### `connected_account_id`
Format: `ID`
-ID of the [connected account](../../../core-concepts/connected-accounts/) associated with the `acs_system`.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the `acs_system`.
+
-***
+---
### `connected_account_ids`
@@ -60,9 +66,10 @@ ID of the [connected account](../../../core-concepts/connected-accounts/) associ
Format: `List`
-IDs of the [connected accounts](../../../core-concepts/connected-accounts/) associated with the `acs_system`.
+IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the `acs_system`.
-***
+
+---
### `created_at`
@@ -70,15 +77,17 @@ Format: `Datetime`
Date and time at which the `acs_system` was created.
-***
+
+---
### `default_credential_manager_acs_system_id`
Format: `ID`
-ID of the default credential manager acs\_system for this access control system.
+ID of the default credential manager acs_system for this access control system.
-***
+
+---
### `errors`
@@ -86,7 +95,8 @@ Format: `List`
Errors associated with the `acs_system`.
-***
+
+---
### `external_type`
@@ -95,22 +105,22 @@ Format: `Enum`
Brand-specific terminology for the `acs_system` type.
Possible enum values:
-
-* `pti_site`
-* `alta_org`
-* `salto_ks_site`
-* `salto_space_system`
-* `brivo_account`
-* `hid_credential_manager_organization`
-* `visionline_system`
-* `assa_abloy_credential_service`
-* `latch_building`
-* `dormakaba_community_site`
-* `legic_connect_credential_service`
-* `assa_abloy_vostio`
-* `assa_abloy_vostio_credential_service`
-
-***
+- `pti_site`
+- `alta_org`
+- `salto_ks_site`
+- `salto_space_system`
+- `brivo_account`
+- `hid_credential_manager_organization`
+- `visionline_system`
+- `assa_abloy_credential_service`
+- `latch_building`
+- `dormakaba_community_site`
+- `legic_connect_credential_service`
+- `assa_abloy_vostio`
+- `assa_abloy_vostio_credential_service`
+
+
+---
### `external_type_display_name`
@@ -118,7 +128,8 @@ Format: `String`
Display name that corresponds to the brand-specific terminology for the `acs_system` type.
-***
+
+---
### `image_alt_text`
@@ -126,7 +137,8 @@ Format: `String`
Alternative text for the `acs_system` image.
-***
+
+---
### `image_url`
@@ -134,7 +146,8 @@ Format: `String`
URL for the image that represents the `acs_system`.
-***
+
+---
### `is_credential_manager`
@@ -142,7 +155,8 @@ Format: `Boolean`
Indicates if the `acs_system` is a credential manager.
-***
+
+---
### `location`
@@ -156,7 +170,8 @@ Time zone in which the `acs_system` is located.
-***
+
+---
### `name`
@@ -164,7 +179,8 @@ Format: `String`
Name of the `acs_system`.
-***
+
+---
### `system_type`
@@ -175,22 +191,22 @@ Name of the `acs_system`.
Format: `Enum`
Possible enum values:
-
-* `pti_site`
-* `alta_org`
-* `salto_ks_site`
-* `salto_space_system`
-* `brivo_account`
-* `hid_credential_manager_organization`
-* `visionline_system`
-* `assa_abloy_credential_service`
-* `latch_building`
-* `dormakaba_community_site`
-* `legic_connect_credential_service`
-* `assa_abloy_vostio`
-* `assa_abloy_vostio_credential_service`
-
-***
+- `pti_site`
+- `alta_org`
+- `salto_ks_site`
+- `salto_space_system`
+- `brivo_account`
+- `hid_credential_manager_organization`
+- `visionline_system`
+- `assa_abloy_credential_service`
+- `latch_building`
+- `dormakaba_community_site`
+- `legic_connect_credential_service`
+- `assa_abloy_vostio`
+- `assa_abloy_vostio_credential_service`
+
+
+---
### `system_type_display_name`
@@ -200,7 +216,8 @@ Possible enum values:
Format: `String`
-***
+
+---
### `visionline_metadata`
@@ -230,7 +247,8 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i
-***
+
+---
### `warnings`
@@ -238,41 +256,42 @@ Format: `List`
Warnings associated with the `acs_system`.
-***
+
+---
### `workspace_id`
Format: `ID`
-ID of the [workspace](../../../core-concepts/workspaces/) that contains the `acs_system`.
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the `acs_system`.
+
-***
+---
## Endpoints
-### [`/acs/systems/get`](get.md)
+### [`/acs/systems/get`](./get.md)
Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-
-### [`/acs/systems/list`](list.md)
+### [`/acs/systems/list`](./list.md)
Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
+### [`/acs/systems/list_compatible_credential_manager_acs_systems`](./list_compatible_credential_manager_acs_systems.md)
-### [`/acs/systems/list_compatible_credential_manager_acs_systems`](list_compatible_credential_manager_acs_systems.md)
-
-Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+Returns a list of all credential manager ACS systems that are compatible with a specified
+[access control system](https://docs.seam.co/latest/capability-guides/access-systems).
## Events
### `acs_system.connected`
-An ACS system was connected.
+An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
acs_system_id Format: ID
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -280,7 +299,7 @@ ID of the ACS system.
connected_account_id Format: ID
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -288,7 +307,7 @@ ID of the connected account.
created_at Format: Datetime
-Time at which the event was created.
+Date and time at which the event was created.
@@ -304,15 +323,13 @@ ID of the event.
event_type Format: String
-
-
occurred_at Format: Datetime
-Time when the event occurred.
+Date and time at which the event occurred.
@@ -320,21 +337,21 @@ Time when the event occurred.
workspace_id Format: ID
-ID of the [workspace](../../../core-concepts/workspaces/).
+ID of the [workspace](../../../core-concepts/workspaces/README.md).
-***
+---
### `acs_system.added`
-An ACS system was added.
+An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
acs_system_id Format: ID
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -342,7 +359,7 @@ ID of the ACS system.
connected_account_id Format: ID
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -350,7 +367,7 @@ ID of the connected account.
created_at Format: Datetime
-Time at which the event was created.
+Date and time at which the event was created.
@@ -366,15 +383,13 @@ ID of the event.
event_type Format: String
-
-
occurred_at Format: Datetime
-Time when the event occurred.
+Date and time at which the event occurred.
@@ -382,21 +397,21 @@ Time when the event occurred.
workspace_id Format: ID
-ID of the [workspace](../../../core-concepts/workspaces/).
+ID of the [workspace](../../../core-concepts/workspaces/README.md).
-***
+---
### `acs_system.disconnected`
-An ACS system was disconnected.
+An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
acs_system_id Format: ID
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -404,7 +419,7 @@ ID of the ACS system.
connected_account_id Format: ID
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -412,7 +427,7 @@ ID of the connected account.
created_at Format: Datetime
-Time at which the event was created.
+Date and time at which the event was created.
@@ -428,15 +443,13 @@ ID of the event.
event_type Format: String
-
-
occurred_at Format: Datetime
-Time when the event occurred.
+Date and time at which the event occurred.
@@ -444,8 +457,9 @@ Time when the event occurred.
workspace_id Format: ID
-ID of the [workspace](../../../core-concepts/workspaces/).
+ID of the [workspace](../../../core-concepts/workspaces/README.md).
-***
+---
+
diff --git a/docs/api/user_identities/update-a-user-identity.md b/docs/api/user_identities/update.md
similarity index 67%
rename from docs/api/user_identities/update-a-user-identity.md
rename to docs/api/user_identities/update.md
index 28b3332d..a9b53b7d 100644
--- a/docs/api/user_identities/update-a-user-identity.md
+++ b/docs/api/user_identities/update.md
@@ -4,17 +4,20 @@
PATCH /user_identities/update ⇒ void
```
+
+
## Authentication Methods
-* API key
-* Personal access token\
- Must also include the `seam-workspace` header in the request.
+- API key
+- Personal access token
+ Must also include the `seam-workspace` header in the request.
## Request Parameters
### `email_address`
-Type: `string` Required: No
+Type: `string`
+Required: No
Unique email address for the user identity.
@@ -22,13 +25,17 @@ Unique email address for the user identity.
### `full_name`
-Type: `string` Required: No
+Type: `string`
+Required: No
+
+
***
### `phone_number`
-Type: `string` Required: No
+Type: `string`
+Required: No
Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
@@ -36,7 +43,8 @@ Unique phone number for the user identity in [E.164 format](https://www.itu.int/
### `user_identity_id`
-Type: `string` Required: Yes
+Type: `string`
+Required: Yes
ID of the user identity.
@@ -44,7 +52,8 @@ ID of the user identity.
### `user_identity_key`
-Type: `string` Required: No
+Type: `string`
+Required: No
Unique key for the user identity.
diff --git a/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace.md b/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace.md
index e629cee6..3e4d4dd0 100644
--- a/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace.md
+++ b/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace.md
@@ -4,7 +4,7 @@ Seam's sandbox workspaces enable you to develop integrations without access to a
## Creating a Simulated Phone for a User Identity
-When issuing mobile credentials, some systems require the user identity to have a provisioned phone. While you are developing and testing your integration, you can add a simulated phone in your sandbox workspace. Use the following flow to [add a simulated phone](../../api/phones/create-a-sandbox-phone.md) for a user identity:
+When issuing mobile credentials, some systems require the user identity to have a provisioned phone. While you are developing and testing your integration, you can add a simulated phone in your sandbox workspace. Use the following flow to [add a simulated phone](../../api-clients/phones/create-a-sandbox-phone.md) for a user identity:
{% tabs %}
{% tab title="Python" %}
diff --git a/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity.md b/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity.md
index 824426dd..c6fabda7 100644
--- a/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity.md
+++ b/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity.md
@@ -22,7 +22,7 @@ If an app user loses their phone or wants to deactivate it, you can deactivate t
-To [deactivate](../../api/phones/deactivate-a-phone.md) a phone, provide the ID of the phone. When a phone is deactivated, Seam also revokes all the credentials issued to the deactivated phone. Seam also removes the associated ACS credentials from the ACS.
+To [deactivate](../../api-clients/phones/deactivate-a-phone.md) a phone, provide the ID of the phone. When a phone is deactivated, Seam also revokes all the credentials issued to the deactivated phone. Seam also removes the associated ACS credentials from the ACS.
{% tabs %}
{% tab title="Python" %}
@@ -169,7 +169,7 @@ nil
## Retrieving Phones for a User Identity
-To retrieve the list of phones that the mobile app user has used to sign in to their account, use the [List Phones](../../api/phones/list-phones.md) endpoint and include the ID of the user identity.
+To retrieve the list of phones that the mobile app user has used to sign in to their account, use the [List Phones](../../api-clients/phones/list-phones.md) endpoint and include the ID of the user identity.
{% tabs %}
{% tab title="Python" %}
@@ -409,7 +409,7 @@ return nil
Coming soon!
{% endhint %}
-To retrieve a phone by its ID, use the [Get Phone](../../api/phones/get-a-phone.md) endpoint and include the `device_id` of the phone.
+To retrieve a phone by its ID, use the [Get Phone](../../api-clients/phones/get-a-phone.md) endpoint and include the `device_id` of the phone.
{% tabs %}
{% tab title="Python" %}
 (1).png)