Test links

seamapi · Aug 2, 2024 · c30757e · c30757e
1 parent 7e2dddb
commit c30757e
Show file tree

Hide file tree

Showing 5 changed files with 162 additions and 1 deletion.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -165,7 +165,7 @@
   * [List Locks](api-clients/locks/list-locks.md)
 * [Access Control Systems](api-clients/access-control-systems/README.md)
   * [Systems](api-clients/access-control-systems/systems/README.md)
-    * [List Systems](api-clients/access-control-systems/systems/list-systems.md)
+    * [List Systems](api/acs/systems/list.md)
     * [Get a System](api-clients/access-control-systems/systems/get-system.md)
     * [List Compatible Credential Manager ACS Systems](api-clients/access-control-systems/systems/list-compatible-credential-manager-acs-systems.md)
   * [Users](api-clients/access-control-systems/users/README.md)

diff --git a/docs/api/README.md b/docs/api/README.md
@@ -0,0 +1 @@
+# API Reference
diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md
@@ -0,0 +1,156 @@
+---
+description: "Returns a list of all [access control systems](../../../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."
+---
+
+# List ACS Systems
+
+Returns a list of all [access control systems](../../../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.
+
+### Request and Response
+
+<table>
+  <thead>
+    <tr>
+      <th>Parameter</th>
+      <th width='112.33333333333331'>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+        <td><code>connected_account_id</code></td>
+        <td>String (UUID)<br /><em>Optional</em></td>
+        <td>ID of the connected account by which to filter the list of returned access control systems.</td>
+      </tr>
+  </tbody>
+</table>
+
+
+<table>
+  <thead>
+    <tr>
+      <th width="310">Property</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+        <td><code>acs_system_id</code></td>
+        <td>ID of the `acs_system`.</td>
+      </tr>
+      <tr>
+        <td><code>can_add_acs_users_to_acs_access_groups</code></td>
+        <td>Indicates whether the `acs_system` supports [adding users to access groups](../../../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#access-group-based-access-control-systems).</td>
+      </tr>
+      <tr>
+        <td><code>can_automate_enrollment</code></td>
+        <td>Indicates whether it is possible to [launch enrollment automations](../../../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`.</td>
+      </tr>
+      <tr>
+        <td><code>can_create_acs_access_groups</code></td>
+        <td>Indicates whether the `acs_system` supports creating [access groups](../../../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#access-group-based-access-control-systems).</td>
+      </tr>
+      <tr>
+        <td><code>can_remove_acs_users_from_acs_access_groups</code></td>
+        <td>Indicates whether the `acs_system` supports [removing users from access groups](../../../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#access-group-based-access-control-systems).</td>
+      </tr>
+      <tr>
+        <td><code>connected_account_ids</code></td>
+        <td>IDs of the [connected accounts](../../../core-concepts/connected-accounts) associated with the `acs_system`.</td>
+      </tr>
+      <tr>
+        <td><code>created_at</code></td>
+        <td>Date and time at which the `acs_system` was created.</td>
+      </tr>
+      <tr>
+        <td><code>errors</code></td>
+        <td>Errors associated with the `acs_system`.</td>
+      </tr>
+      <tr>
+        <td><code>external_type</code></td>
+        <td>Brand-specific terminology for the `acs_system` type.</td>
+      </tr>
+      <tr>
+        <td><code>external_type_display_name</code></td>
+        <td>Display name that corresponds to the brand-specific terminology for the `acs_system` type.</td>
+      </tr>
+      <tr>
+        <td><code>image_alt_text</code></td>
+        <td>Alternative text for the `acs_system` image.</td>
+      </tr>
+      <tr>
+        <td><code>image_url</code></td>
+        <td>URL for the image that represents the `acs_system`.</td>
+      </tr>
+      <tr>
+        <td><code>name</code></td>
+        <td>Name of the `acs_system`.</td>
+      </tr>
+      <tr>
+        <td><code>system_type</code></td>
+        <td></td>
+      </tr>
+      <tr>
+        <td><code>system_type_display_name</code></td>
+        <td></td>
+      </tr>
+      <tr>
+        <td><code>visionline_metadata</code></td>
+        <td></td>
+      </tr>
+      <tr>
+        <td><code>warnings</code></td>
+        <td></td>
+      </tr>
+      <tr>
+        <td><code>workspace_id</code></td>
+        <td>ID of the [workspace](../../../core-concepts/workspaces) that contains the `acs_system`.</td>
+      </tr>
+  </tbody>
+</table>
+
+## Samples
+
+{% 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
+  AcsSystems(0={"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 %}
+{% endtabs %}
diff --git a/docs/sdk/README.md b/docs/sdk/README.md
@@ -0,0 +1 @@
+# SDK Reference
diff --git a/docs/sdk/javascript/acs/systems/list.md b/docs/sdk/javascript/acs/systems/list.md
@@ -0,0 +1,3 @@
+#
+
+