Release generated ACS systems API reference pages (#316)

* Test v1.0 * Test 1.1 * Test v1.2 * Update types.ts * Generation example * Small adjustments * Template test * Cosmetic adjustments * Tags problem solved * v2.0 * Revert * Delete .DS_Store * v1.01 * v1.02 * Minor fix * Braces fix * Table fixes * Requested changes * Minor changes * Test commit * Update list.md * Sample request fixed * Update blueprint version * ci: Generate docs * Update .hbs pattern * Update sample response layout * Requested changes * Update SUMMARY.md * Requested changes * modified setFileContext function * Update blueprint * Update .prettierignore * Set noEscape true for hbs * Use resourceType * Use urls from root * Use relative links * Add .md extension to links * Tables removed * Remove hbs override from eslint * Update api-clients to api * fix: move files to match api file structure (#312) * Update API reference page template (#311) * Update api-reference template, add responseKey to file response context * Update blueprint package registry url * Remove license * Add eq helper * ci: Generate docs * Change default return value to {} * ci: Generate docs * Bump seam types to 1.229.1 * ci: Generate docs * Remove default value when no code samples are provided * Default to void when there's not responseKey * Add type to request params * ci: Generate docs * Bump blueprint to 0.14.0 and fix req param types * ci: Generate docs * Fix setEndpointTemplateContext * ci: Generate docs --------- Co-authored-by: Seam Bot <[email protected]> * Generate `/docs/acs/systems/README.md` with `acs_system` resource and properties (#314) * Update api-reference template, add responseKey to file response context * Update blueprint package registry url * Remove license * Add eq helper * ci: Generate docs * Change default return value to {} * ci: Generate docs * Bump seam types to 1.229.1 * ci: Generate docs * Remove default value when no code samples are provided * Default to void when there's not responseKey * Add type to request params * ci: Generate docs * Create api resource page template * Set context for resource page * Update reference.ts to actually set context for resource pages * ci: Generate docs * Add missing new line to the end of src/layouts/api-resource.hbs * Fix indentation * ci: Generate docs * Bump blueprint to 0.14.0 and fix req param types * ci: Generate docs * Fix setEndpointTemplateContext * ci: Generate docs * Update src/layouts/api-resource.hbs * ci: Generate docs * Update src/layouts/api-resource.hbs * ci: Generate docs * Update src/layouts/api-resource.hbs Co-authored-by: Evan Sosenko <[email protected]> * ci: Generate docs * Rename api-resource template to api-route + the set context fn * Rename src/layouts/api-resource.hbs to src/layouts/api-route.hbs --------- Co-authored-by: Seam Bot <[email protected]> Co-authored-by: Evan Sosenko <[email protected]> * Do not generate sdk pages (#315) * Do not generate sdk pages * Remove empty sdk files * ci: Generate docs * Update metalsmith.ts * Disable SDK gen * ci: Format code * Do not generate any SDKs * Set type * Remove sdk from src * Remove generated sdk pages --------- Co-authored-by: Seam Bot <[email protected]> * fix: update paths to match api (#313) * wip: rename paths * rename paths * revert gitbook * add missing redirect directories * revert overview.md * Apply suggestions from code review --------- Co-authored-by: Evan Sosenko <[email protected]> * Move helpers to handlebars-helpers * Replace /acs/systems ref with generated pages * Fix more old api ref paths (#317) * rename reset-workspace -> reset_sandbox * get-workspace * revoke-access-to-a-device-from-a-user-identity.md * user_identities/remove_acs_user * list_acs_users * list_acs_systems * list_accessible_devices * list-user-identities * grant_access_to_device * get-a-user-identity * list-enrollmnent-automations * launch-an-enrollment-automation.md * enrollment_automations/get * get-an-enrollment-automation.md * rename user-identities -> user_identities * rename enrollment-automations -> enrollment_automations * enrollment_automations/README.md * add user_identities/enrollment_automations/README.md * rename delete-a-user-identity * rename create-a-user-identity * add_acs_user * update-noise-threshold * create-noise-threshold * rename noise thresholds * unlock-a-lock * locks * list-locks * get-lock * list-events * get-an-event * update-device * update-unmanaged-device * list-unmanaged-device * list-device-providers * list-devices * list-devices * get-device-1 * delete-device * list-connected-accounts * get-a-connected-account * delete-a-connected-account * connected_accounts/README.md * list-connect-webview * get-a-connect-webview * delete-a-connect-webview * create-a-connect-webview * connect_webviews * list-client-sessions * grant-access-to-a-client-session * get-or-create-a-client-session * get-a-client-session * delete-a-client-session * client_sessions * action_attempts * uesrs * systems * list-credentials-with-access-to-an-entrance * list-entrances * get-an-entrance * entrances * update-a-credential * unassign-a-credential-from-a-user * list-accessible-entrances * list-credentials * get-credential * delete-credential * create-credential-for-user * assign-a-credential-to-a-user * credentials * list-users-in-access-group * list-access-groups * get-access-group * access_groups * acs * update-an-access-code * list-unmanaged-access-codes * delete-an-unmanaged-access-code * convert-an-unmanaged-access-code * pull-backup-access-code * list-access-codes * get-an-access-code * delete-an-access-code * create-many-access-codes * create-many-access-codes * access_codes * access-control-systems * acs /client-sessions * /connect-webviews * connected_accounts * noise-sensors * docs/api-clients/acs/access_groups/README.md * revert overview.md * Nest Noise Thresholds * Use generated docs for /acs/systems * Page templates improvements (#318) * Change property details order and add line break between type and format in api-route.hbs * Capitalize boolean type * Fix resource property deprecation message and format * Un-italicize return type, add line break btw type and required in api-reference.hbs * REmove italic text from api-reference.hbs * Make return type a heading parallel to request params in api-reference layout * Bump blueprint to 0.14.2 * ci: Generate docs * Add resource description * Remove type from api-route page, use capitalized format only * Add "Properties" header after resource name in api-route layout * Decrease all heading levels by one in api-route.hbs * Endpoints section includes only first paragraph from the endpoint description * Remove console log * Fix heading levels of events and endpoints sections in api-route.hbs * Move resource description after its name * Test adding a new line in the beginning of endpoint page to render h1 header * Test adding forward slash * Remove forward slash * All caps format if it's 'id' * Add property enum values * Fix line break syntax * Move enum values after description --------- Co-authored-by: Seam Bot <[email protected]> * Only generate relative links to files that exist (#320) * Adjust link targets * ci: Generate docs * Remove +1 in link path * ci: Generate docs * Update links to /acs/systems * Only generate relative links to files that exist * ci: Generate docs * Fix link back to README.md * ci: Generate docs * Include hash in link * Fix relative path --------- Co-authored-by: Seam Bot <[email protected]> --------- Co-authored-by: Andrii <[email protected]> Co-authored-by: Seam Bot <[email protected]> Co-authored-by: Andrii <[email protected]> Co-authored-by: Mike Wu <[email protected]> Co-authored-by: Andrii Balitskyi <[email protected]>
seamapi · Aug 30, 2024 · 7020e66 · 7020e66
1 parent eadc628
commit 7020e66
Show file tree

Hide file tree

Showing 26 changed files with 727 additions and 49 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -9,6 +9,7 @@
 docs
 seam-sdk-playground
 gitbook-plugin
+*.hbs
 
 # TypeScript build output
 *.d.ts

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -156,10 +156,10 @@
   * [Unlock a Lock](api-clients/locks/unlock\_door.md)
   * [List Locks](api-clients/locks/list.md)
 * [Access Control Systems](api-clients/acs/README.md)
-  * [Systems](api-clients/acs/systems/README.md)
-    * [List Systems](api-clients/acs/systems/list.md)
-    * [Get a System](api-clients/acs/systems/get.md)
-    * [List Compatible Credential Manager ACS Systems](api-clients/acs/systems/list\_compatible\_credential\_manager\_acs\_systems.md)
+  * [Systems](api/acs/systems/README.md)
+    * [List Systems](api/acs/systems/list.md)
+    * [Get a System](api/acs/systems/get.md)
+    * [List Compatible Credential Manager ACS Systems](api/acs/systems/list_compatible_credential_manager_acs_systems.md)
   * [Users](api-clients/acs/users/README.md)
     * [Create a User](api-clients/acs/users/create.md)
     * [List Users](api-clients/acs/users/list.md)

diff --git a/generated-docs/api/README.md → docs/api/README.md b/generated-docs/api/README.md → docs/api/README.md
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
@@ -0,0 +1,194 @@
+# `acs_system`
+
+Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+## Properties
+
+### `acs_system_id`
+
+Format: `ID`
+
+ID of the `acs_system`.
+
+---
+
+### `can_add_acs_users_to_acs_access_groups`
+
+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`
+
+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`
+
+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`
+
+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_ids`
+
+Format: `List`
+
+IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the `acs_system`.
+
+---
+
+### `created_at`
+
+Format: `Datetime`
+
+Date and time at which the `acs_system` was created.
+
+---
+
+### `errors`
+
+Format: `List`
+
+Errors associated with the `acs_system`.
+
+---
+
+### `external_type`
+
+Format: `Enum`
+
+Brand-specific terminology for the `acs_system` type.
+
+Possible enum values:
+- `pti_site`
+- `alta_org`
+- `salto_site`
+- `brivo_account`
+- `hid_credential_manager_organization`
+- `visionline_system`
+- `assa_abloy_credential_service`
+- `latch_building`
+
+---
+
+### `external_type_display_name`
+
+Format: `String`
+
+Display name that corresponds to the brand-specific terminology for the `acs_system` type.
+
+---
+
+### `image_alt_text`
+
+Format: `String`
+
+Alternative text for the `acs_system` image.
+
+---
+
+### `image_url`
+
+Format: `String`
+
+URL for the image that represents the `acs_system`.
+
+---
+
+### `name`
+
+Format: `String`
+
+Name of the `acs_system`.
+
+---
+
+### `system_type`
+
+{% hint style="warning" %}
+**Deprecated**. Use `external_type`.
+{% endhint %}
+
+Format: `Enum`
+
+Possible enum values:
+- `pti_site`
+- `alta_org`
+- `salto_site`
+- `brivo_account`
+- `hid_credential_manager_organization`
+- `visionline_system`
+- `assa_abloy_credential_service`
+- `latch_building`
+
+---
+
+### `system_type_display_name`
+
+{% hint style="warning" %}
+**Deprecated**. Use `external_type_display_name`.
+{% endhint %}
+
+Format: `String`
+
+---
+
+### `visionline_metadata`
+
+Format: `Record`
+
+---
+
+### `warnings`
+
+Format: `List`
+
+Warnings associated with the `acs_system`.
+
+---
+
+### `workspace_id`
+
+Format: `ID`
+
+ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the `acs_system`.
+
+---
+
+# Endpoints
+
+## [`/acs/systems/get`](.//acs/systems/get.md)
+
+Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+---
+
+## [`/acs/systems/list`](.//acs/systems/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`](.//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).
+
+---
+
+# Events
diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md
@@ -0,0 +1,24 @@
+# Get an ACS System
+
+```
+POST /acs/systems/get ⇒ { acs_system }
+```
+
+Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+
+Specify the desired access control system by including the corresponding `acs_system_id` in the request body.
+
+## Request Parameters
+
+### `acs_system_id`
+
+Type: `string`\
+Required: Yes
+
+ID of the desired access control system.
+
+---
+
+## Return Type
+
+[acs_system](./README.md)
diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md
@@ -0,0 +1,85 @@
+# List ACS Systems
+
+```
+POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
+```
+
+Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
+
+To filter the list of returned access control systems by a specific connected account ID, include the 
+`connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the 
+response includes all access control systems connected to your workspace.
+
+{% tabs %}
+    {% tab title="JavaScript" %}
+  ### Request
+  ```javascript
+  await seam.acs.systems.list({"connected_account_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"})
+  ```
+
+  ### Response
+  ```javascript
+  [{"acs_system_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"}]
+  ```
+    {% endtab %}
+    {% tab title="Python" %}
+  ### Request
+  ```python
+  seam.acs.systems.list(connected_account_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+  ```
+
+  ### Response
+  ```python
+  [AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")]
+  ```
+    {% endtab %}
+    {% tab title="Ruby" %}
+  ### Request
+  ```ruby
+  seam.acs.systems.list(connected_account_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+  ```
+
+  ### Response
+  ```ruby
+  [<Seam::AcsSystems:0x00000
+acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33">]
+  ```
+    {% endtab %}
+    {% tab title="PHP" %}
+  ### Request
+  ```php
+  $seam->acs->systems->list(connected_account_id:"8d7e0b3a-b889-49a7-9164-4b71a0506a33")
+  ```
+
+  ### Response
+  ```php
+  [{"acs_system_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"}]
+  ```
+    {% endtab %}
+    {% tab title="Seam CLI" %}
+  ### Request
+  ```seam_cli
+  seam acs systems list --connected_account_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33"
+  ```
+
+  ### Response
+  ```seam_cli
+  [{"acs_system_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"}]
+  ```
+    {% endtab %}
+{% endtabs %}
+
+## Request Parameters
+
+### `connected_account_id`
+
+Type: `string`\
+Required: No
+
+ID of the connected account by which to filter the list of returned access control systems.
+
+---
+
+## Return Type
+
+Array<[acs_system](./README.md)>
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
@@ -0,0 +1,26 @@
+# List Compatible Credential Manager ACS Systems
+
+```
+POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] }
+```
+
+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).
+
+Specify the ACS system for which you want to retrieve all compatible credential manager ACS 
+systems by including the corresponding `acs_system_id` in the request body.
+
+## Request Parameters
+
+### `acs_system_id`
+
+Type: `string`\
+Required: Yes
+
+ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.
+
+---
+
+## Return Type
+
+Array<[acs_system](./README.md)>
diff --git a/docs/capability-guides/access-systems/retrieving-acs-system-details.md b/docs/capability-guides/access-systems/retrieving-acs-system-details.md
@@ -4,13 +4,13 @@ description: Learn how to list and get information about your ACS systems.
 
 # Retrieving ACS System Details
 
-You can list details for all the ACSs in your [workspace](../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](../../api-clients/acs/systems/) resource. When you want to [create ACS users](../../products/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users.
+You can list details for all the ACSs in your [workspace](../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](../../api/acs/systems/) resource. When you want to [create ACS users](../../products/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users.
 
 ***
 
 ## List ACS Systems
 
-You can [list all `acs_system` resources](../../api-clients/acs/systems/list.md) in your workspace. Note the `acs_system_id` in the response.
+You can [list all `acs_system` resources](../../api/acs/systems/list.md) in your workspace. Note the `acs_system_id` in the response.
 
 {% tabs %}
 {% tab title="Python" %}
@@ -184,7 +184,7 @@ acs_systems, uErr := client.Acs.Systems.List(
 
 ## Get an ACS System
 
-You can [get the details of a specific `acs_system`](../../api-clients/acs/systems/get.md) in your workspace. These details include the `acs_system_id`, date and time at which the `acs_system` was created in Seam, the name and type of the `acs_system`, and so on.
+You can [get the details of a specific `acs_system`](../../api/acs/systems/get.md) in your workspace. These details include the `acs_system_id`, date and time at which the `acs_system` was created in Seam, the name and type of the `acs_system`, and so on.
 
 {% tabs %}
 {% tab title="Python" %}

diff --git a/...bility-guides/access-systems/understanding-access-control-system-differences.md b/...bility-guides/access-systems/understanding-access-control-system-differences.md
@@ -64,7 +64,7 @@ In a credential-based ACS, the [`acs_credential`](../../api-clients/acs/credenti
 
 The following process describes the configuration steps for your application to grant access in a credential-based ACS:
 
-1. When the ACS connects to Seam, Seam automatically creates the [`acs_system`](../../api-clients/acs/systems/). Seam also syncs the entrances from the connected ACS as `acs_entrance` resources. Note that because Seam automatically syncs these entrance resources from the ACS, you cannot create, edit, or delete them using the Seam API.
+1. When the ACS connects to Seam, Seam automatically creates the [`acs_system`](../../api/acs/systems/). Seam also syncs the entrances from the connected ACS as `acs_entrance` resources. Note that because Seam automatically syncs these entrance resources from the ACS, you cannot create, edit, or delete them using the Seam API.
 2. Your application [creates](../../products/access-systems/user-management.md#create-a-user) an [`acs_user`](../../api-clients/acs/users/) for each user within this ACS. Each `acs_user` is configured with a set of attributes, such their name, email address, and phone number, as applicable.\
    If you need to grant a single application user access to multiple ACSs—for example, if an application user needs access to multiple buildings, each of which uses a separate ACS—you can use Seam [user identities](../../api-clients/user_identities/) to link `acs_user`s in different `acs_system`s.
 3.  Your application [creates](managing-credentials.md#create-a-credential-for-a-user) `acs_credential`s with the following attributes:

diff --git a/docs/products/access-systems/README.md b/docs/products/access-systems/README.md
@@ -45,7 +45,7 @@ The following diagram shows an example of one ACS, including the ACS resources a
 
 The following table provides a brief description of each of the Seam ACS resources:
 
-<table><thead><tr><th width="248">ACS Resource</th><th>Description</th></tr></thead><tbody><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-system_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-system_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/systems/"><code>acs_system</code></a></p></td><td>The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.<br>For more information, see <a href="../../capability-guides/access-systems/retrieving-acs-system-details.md">Retrieving ACS System Details</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-user_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-user_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/users/"><code>acs_user</code></a></p></td><td>The set of users who access the entrances.<br>For more information, see <a href="user-management.md">Managing ACS Users</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-access-group_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-access-group_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/access-groups/"><code>acs_access_group</code></a></p></td><td>Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.<br>For more information, see <a href="assigning-users-to-access-groups.md">Assigning ACS Users to Access Groups</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-credential_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-credential_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/credentials/"><code>acs_credential</code></a></p></td><td>A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.<br>For more information, see <a href="../../capability-guides/access-systems/managing-credentials.md">Managing Credentials</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-entrance_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-entrance_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/entrances/"><code>acs_entrance</code></a></p></td><td>The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.<br>For more information, see <a href="../../capability-guides/access-systems/retrieving-entrance-details.md">Retrieving Entrance Details</a>.</td></tr></tbody></table>
+<table><thead><tr><th width="248">ACS Resource</th><th>Description</th></tr></thead><tbody><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-system_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-system_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api/acs/systems/"><code>acs_system</code></a></p></td><td>The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.<br>For more information, see <a href="../../capability-guides/access-systems/retrieving-acs-system-details.md">Retrieving ACS System Details</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-user_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-user_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/users/"><code>acs_user</code></a></p></td><td>The set of users who access the entrances.<br>For more information, see <a href="user-management.md">Managing ACS Users</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-access-group_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-access-group_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/access-groups/"><code>acs_access_group</code></a></p></td><td>Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.<br>For more information, see <a href="assigning-users-to-access-groups.md">Assigning ACS Users to Access Groups</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-credential_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-credential_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/credentials/"><code>acs_credential</code></a></p></td><td>A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.<br>For more information, see <a href="../../capability-guides/access-systems/managing-credentials.md">Managing Credentials</a>.</td></tr><tr><td><p><picture><source srcset="../../.gitbook/assets/acs-entrance_dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/acs-entrance_light.png" alt="" data-size="line"></picture></p><p> <a href="../../api-clients/acs/entrances/"><code>acs_entrance</code></a></p></td><td>The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.<br>For more information, see <a href="../../capability-guides/access-systems/retrieving-entrance-details.md">Retrieving Entrance Details</a>.</td></tr></tbody></table>
 
 {% hint style="info" %}
 You configure the access schedules for your ACS users either through access groups or credentials, depending on your specific ACS. There is no separate schedule resource in the Seam API.
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ @@
     docs
     seam-sdk-playground
     gitbook-plugin
+    *.hbs
     # TypeScript build output
     *.d.ts
@@ Expand Down @@