ci: Generate docs

seambot · seambot · commit 755fe224123d · 2025-05-06T14:13:44.000Z
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md
@@ -299,13 +299,21 @@ Item format: `Object`
 
 Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
 
-The items in this list are objects. The specific structure of each object depends on the value of its `warning_code` field. Each object will be one of the following variants:
+The items in this list are objects. The specific structure of each object depends on the value of its `warning_code` field.
+The `warning_code` field can be one of the following values:
+- `waiting_to_be_issued`
+- `schedule_externally_modified`
+- `schedule_modified`
+- `being_deleted`
+- `unknown_issue_with_acs_credential`
+- `needs_to_be_reissued`
+
+Each object will be one of the following variants:
 {% tabs %}
 {% tab title="waiting_to_be_issued" %}
 
 Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
 
-Variant Properties:
 
 <details>
 
@@ -332,7 +340,6 @@ Possible enum values:
 
 Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
 
-Variant Properties:
 
 <details>
 
@@ -359,7 +366,6 @@ Possible enum values:
 
 Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past.
 
-Variant Properties:
 
 <details>
 
@@ -386,7 +392,6 @@ Possible enum values:
 
 Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.
 
-Variant Properties:
 
 <details>
 
@@ -413,7 +418,6 @@ Possible enum values:
 
 An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential.
 
-Variant Properties:
 
 <details>
 
@@ -440,7 +444,6 @@ Possible enum values:
 
 Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential.
 
-Variant Properties:
 
 <details>
 
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md
@@ -106,15 +106,24 @@ Item format: `Object`
 
 Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
 
-The items in this list are objects. The specific structure of each object depends on the value of its `error_code` field. Each object will be one of the following variants:
+The items in this list are objects. The specific structure of each object depends on the value of its `error_code` field.
+The `error_code` field can be one of the following values:
+- `seam_bridge_disconnected`
+- `bridge_disconnected`
+- `visionline_instance_unreachable`
+- `salto_ks_subscription_limit_exceeded`
+- `acs_system_disconnected`
+- `account_disconnected`
+- `salto_ks_certification_expired`
+
+Each object will be one of the following variants:
 {% tabs %}
 {% tab title="seam_bridge_disconnected" %}
 
 Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
   This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md).
   See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
 
-Variant Properties:
 
 <details>
 
@@ -142,7 +151,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
     See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
 
-Variant Properties:
 
 <details>
 
@@ -175,7 +183,6 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct
   For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md).
   See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).
 
-Variant Properties:
 
 <details>
 
@@ -202,7 +209,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
 
-Variant Properties:
 
 <details>
 
@@ -229,7 +235,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue.
 
-Variant Properties:
 
 <details>
 
@@ -256,7 +261,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.
 
-Variant Properties:
 
 <details>
 
@@ -283,7 +287,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
 
-Variant Properties:
 
 <details>
 
@@ -456,13 +459,17 @@ Item format: `Object`
 
 Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
 
-The items in this list are objects. The specific structure of each object depends on the value of its `warning_code` field. Each object will be one of the following variants:
+The items in this list are objects. The specific structure of each object depends on the value of its `warning_code` field.
+The `warning_code` field can be one of the following values:
+- `salto_ks_subscription_limit_almost_reached`
+- `time_zone_does_not_match_location`
+
+Each object will be one of the following variants:
 {% tabs %}
 {% tab title="salto_ks_subscription_limit_almost_reached" %}
 
 Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.
 
-Variant Properties:
 
 <details>
 
@@ -489,7 +496,6 @@ Possible enum values:
 
 Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
 
-Variant Properties:
 
 <details>
 
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md
@@ -88,13 +88,20 @@ Item format: `Object`
 
 Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
 
-The items in this list are objects. The specific structure of each object depends on the value of its `error_code` field. Each object will be one of the following variants:
+The items in this list are objects. The specific structure of each object depends on the value of its `error_code` field.
+The `error_code` field can be one of the following values:
+- `deleted_externally`
+- `salto_ks_subscription_limit_exceeded`
+- `failed_to_create_on_acs_system`
+- `failed_to_update_on_acs_system`
+- `failed_to_delete_on_acs_system`
+
+Each object will be one of the following variants:
 {% tabs %}
 {% tab title="deleted_externally" %}
 
 Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
 
-Variant Properties:
 
 <details>
 
@@ -119,7 +126,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
 
-Variant Properties:
 
 <details>
 
@@ -144,7 +150,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
 
-Variant Properties:
 
 <details>
 
@@ -169,7 +174,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
 
-Variant Properties:
 
 <details>
 
@@ -194,7 +198,6 @@ Detailed description of the error. Provides insights into the issue and potentia
 
 Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
 
-Variant Properties:
 
 <details>
 
@@ -320,13 +323,18 @@ Item format: `Object`
 
 Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
 
-The items in this list are objects. The specific structure of each object depends on the value of its `warning_code` field. Each object will be one of the following variants:
+The items in this list are objects. The specific structure of each object depends on the value of its `warning_code` field.
+The `warning_code` field can be one of the following values:
+- `being_deleted`
+- `salto_ks_user_not_subscribed`
+- `unknown_issue_with_acs_user`
+
+Each object will be one of the following variants:
 {% tabs %}
 {% tab title="being_deleted" %}
 
 Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.
 
-Variant Properties:
 
 <details>
 
@@ -351,7 +359,6 @@ Possible enum values:
 
 Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
 
-Variant Properties:
 
 <details>
 
@@ -376,7 +383,6 @@ Possible enum values:
 
 An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
 
-Variant Properties:
 
 <details>
 
