ci: Generate docs

seamapi · Jan 8, 2025 · dfa4fb5 · dfa4fb5
1 parent 9a22450
commit dfa4fb5
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 53 deletions.
diff --git a/docs/api/_report.md b/docs/api/_report.md
@@ -7,6 +7,8 @@
 - `/access_codes`
 - `/access_codes/simulate`
 - `/access_codes/unmanaged`
+- `/acs/encoders`
+- `/acs/encoders/simulate`
 - `/action_attempts`
 - `/client_sessions`
 - `/connect_webviews`
@@ -106,8 +108,6 @@ These items are intentionally undocumented.
 - `/acs/credential_pools`: No undocumented message provided
 - `/acs/credential_provisioning_automations`: No undocumented message provided
 - `/acs/credentials/unmanaged`: No undocumented message provided
-- `/acs/encoders`: No undocumented message provided
-- `/acs/encoders/simulate`: No undocumented message provided
 - `/acs/users/unmanaged`: No undocumented message provided
 
 ### Resource properties
@@ -125,13 +125,6 @@ These items are intentionally undocumented.
 - `/acs/credentials/create_offline_code`: Unreleased.
 - `/acs/credentials/unmanaged/get`: No unmanaged credentials are currently implemented.
 - `/acs/credentials/unmanaged/list`: No unmanaged credentials are currently implemented.
-- `/acs/encoders/encode_credential`: Encoders are in alpha.
-- `/acs/encoders/list`: Encoders are in alpha.
-- `/acs/encoders/scan_credential`: Encoders are in alpha.
-- `/acs/encoders/simulate/next_credential_encode_will_fail`: Encoder simulations are in alpha.
-- `/acs/encoders/simulate/next_credential_encode_will_succeed`: Encoder simulations are in alpha.
-- `/acs/encoders/simulate/next_credential_scan_will_fail`: Encoder simulations are in alpha.
-- `/acs/encoders/simulate/next_credential_scan_will_succeed`: Encoder simulations are in alpha.
 - `/acs/users/unmanaged/get`: No unmanaged users are currently implemented.
 - `/acs/users/unmanaged/list`: No unmanaged users are currently implemented.
 - `/devices/delete`: Deleting a device is no longer supported and will be removed.
@@ -341,13 +334,6 @@ Items that are intentionally undocumented are not included in this section.
 - `/access_codes/unmanaged/update`
 - `/acs/credential_pools/list`
 - `/acs/credential_provisioning_automations/launch`
-- `/acs/encoders/encode_credential`
-- `/acs/encoders/list`
-- `/acs/encoders/scan_credential`
-- `/acs/encoders/simulate/next_credential_encode_will_fail`
-- `/acs/encoders/simulate/next_credential_encode_will_succeed`
-- `/acs/encoders/simulate/next_credential_scan_will_fail`
-- `/acs/encoders/simulate/next_credential_scan_will_succeed`
 - `/acs/entrances/grant_access`
 - `/acs/users/unmanaged/get`
 - `/acs/users/unmanaged/list`
@@ -519,9 +505,6 @@ Items that are intentionally undocumented are not included in this section.
     - `credential_manager_acs_system_id`
     - `credential_manager_acs_user_id`
     - `user_identity_id`
-- `/acs/encoders/simulate/next_credential_encode_will_succeed`
-    - `acs_encoder_id`
-    - `scenario`
 - `/acs/entrances/get`
     - `acs_entrance_id`
 - `/acs/entrances/grant_access`

diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md
@@ -149,3 +149,72 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/
 ### [`/acs/access_groups/remove_user`](./remove_user.md)
 
 Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
+
+## Events
+
+### `acs_access_group.deleted`
+
+An ACS access group was deleted.
+
+<details>
+
+<summary><code>acs_access_group_id</code> Format: <code>ID</code></summary>
+
+</details>
+
+<details>
+
+<summary><code>acs_system_id</code> Format: <code>ID</code></summary>
+
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+</details>
+
+<details>
+
+<summary><code>connected_account_id</code> Format: <code>ID</code></summary>
+
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
+</details>
+
+<details>
+
+<summary><code>created_at</code> Format: <code>Datetime</code></summary>
+
+Date and time at which the event was created.
+
+</details>
+
+<details>
+
+<summary><code>event_id</code> Format: <code>ID</code></summary>
+
+ID of the event.
+
+</details>
+
+<details>
+
+<summary><code>event_type</code> Format: <code>String</code></summary>
+
+</details>
+
+<details>
+
+<summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
+
+Date and time at which the event occurred.
+
+</details>
+
+<details>
+
+<summary><code>workspace_id</code> Format: <code>ID</code></summary>
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md).
+
+</details>
+
+---
+
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
@@ -319,7 +319,7 @@ Updates the code and ends at date and time for a specified [credential](../../..
 
 ### `acs_credential.deleted`
 
-An ACS credential was deleted.
+An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted.
 
 <details>
 
@@ -331,23 +331,23 @@ An ACS credential was deleted.
 
 <summary><code>acs_system_id</code> Format: <code>ID</code></summary>
 
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
 
 </details>
 
 <details>
 
 <summary><code>connected_account_id</code> Format: <code>ID</code></summary>
 
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
 
 </details>
 
 <details>
 
 <summary><code>created_at</code> Format: <code>Datetime</code></summary>
 
-Time at which the event was created.
+Date and time at which the event was created.
 
 </details>
 
@@ -369,7 +369,7 @@ ID of the event.
 
 <summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
 
-Time when the event occurred.
+Date and time at which the event occurred.
 
 </details>
 
@@ -385,7 +385,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md).
 
 ### `acs_credential.issued`
 
-An ACS credential was issued.
+An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was issued.
 
 <details>
 
@@ -397,23 +397,23 @@ An ACS credential was issued.
 
 <summary><code>acs_system_id</code> Format: <code>ID</code></summary>
 
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
 
 </details>
 
 <details>
 
 <summary><code>connected_account_id</code> Format: <code>ID</code></summary>
 
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
 
 </details>
 
 <details>
 
 <summary><code>created_at</code> Format: <code>Datetime</code></summary>
 
-Time at which the event was created.
+Date and time at which the event was created.
 
 </details>
 
@@ -435,7 +435,7 @@ ID of the event.
 
 <summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
 
-Time when the event occurred.
+Date and time at which the event occurred.
 
 </details>
 

diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
@@ -285,29 +285,29 @@ Returns a list of all credential manager ACS systems that are compatible with a
 
 ### `acs_system.connected`
 
-An ACS system was connected.
+An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
 
 <details>
 
 <summary><code>acs_system_id</code> Format: <code>ID</code></summary>
 
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
 
 </details>
 
 <details>
 
 <summary><code>connected_account_id</code> Format: <code>ID</code></summary>
 
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
 
 </details>
 
 <details>
 
 <summary><code>created_at</code> Format: <code>Datetime</code></summary>
 
-Time at which the event was created.
+Date and time at which the event was created.
 
 </details>
 
@@ -329,7 +329,7 @@ ID of the event.
 
 <summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
 
-Time when the event occurred.
+Date and time at which the event occurred.
 
 </details>
 
@@ -345,29 +345,29 @@ 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.
 
 <details>
 
 <summary><code>acs_system_id</code> Format: <code>ID</code></summary>
 
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
 
 </details>
 
 <details>
 
 <summary><code>connected_account_id</code> Format: <code>ID</code></summary>
 
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
 
 </details>
 
 <details>
 
 <summary><code>created_at</code> Format: <code>Datetime</code></summary>
 
-Time at which the event was created.
+Date and time at which the event was created.
 
 </details>
 
@@ -389,7 +389,7 @@ ID of the event.
 
 <summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
 
-Time when the event occurred.
+Date and time at which the event occurred.
 
 </details>
 
@@ -405,29 +405,29 @@ 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.
 
 <details>
 
 <summary><code>acs_system_id</code> Format: <code>ID</code></summary>
 
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
 
 </details>
 
 <details>
 
 <summary><code>connected_account_id</code> Format: <code>ID</code></summary>
 
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
 
 </details>
 
 <details>
 
 <summary><code>created_at</code> Format: <code>Datetime</code></summary>
 
-Time at which the event was created.
+Date and time at which the event was created.
 
 </details>
 
@@ -449,7 +449,7 @@ ID of the event.
 
 <summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
 
-Time when the event occurred.
+Date and time at which the event occurred.
 
 </details>
 

diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
@@ -255,13 +255,13 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/cap
 
 ### `acs_user.deleted`
 
-An ACS user was deleted.
+An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
 
 <details>
 
 <summary><code>acs_system_id</code> Format: <code>ID</code></summary>
 
-ID of the ACS system.
+ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
 
 </details>
 
@@ -275,15 +275,15 @@ ID of the ACS system.
 
 <summary><code>connected_account_id</code> Format: <code>ID</code></summary>
 
-ID of the connected account.
+ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
 
 </details>
 
 <details>
 
 <summary><code>created_at</code> Format: <code>Datetime</code></summary>
 
-Time at which the event was created.
+Date and time at which the event was created.
 
 </details>
 
@@ -305,7 +305,7 @@ ID of the event.
 
 <summary><code>occurred_at</code> Format: <code>Datetime</code></summary>
 
-Time when the event occurred.
+Date and time at which the event occurred.
 
 </details>