From 9034808dece21311d30e11c50ded9f16409c25f3 Mon Sep 17 00:00:00 2001 From: Mike Wu Date: Fri, 23 May 2025 18:21:38 +0900 Subject: [PATCH 1/6] fix: make property names italics --- src/layouts/partials/property-non-collapsible.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-non-collapsible.hbs b/src/layouts/partials/property-non-collapsible.hbs index 689e69867..7e6392c4a 100644 --- a/src/layouts/partials/property-non-collapsible.hbs +++ b/src/layouts/partials/property-non-collapsible.hbs @@ -1,4 +1,4 @@ -**`{{name}}`** Format: `{{format}}`{{#if listItemFormat}}, Item format: `{{listItemFormat}}`{{/if}} +**`{{name}}`** *Format: `{{format}}`{{#if listItemFormat}}, Item format: `{{listItemFormat}}`{{/if}}* {{> property-content}} From 36c40540ef89123c6d7be62a1c4faff5c49bf61f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 23 May 2025 09:22:44 +0000 Subject: [PATCH 2/6] ci: Generate docs --- docs/api/_blueprint.json | 32 +- docs/api/access_codes/README.md | 400 +++++++++++----------- docs/api/access_codes/unmanaged/README.md | 400 +++++++++++----------- docs/api/acs/credentials/README.md | 36 +- docs/api/acs/systems/README.md | 58 ++-- docs/api/acs/users/README.md | 112 +++--- 6 files changed, 519 insertions(+), 519 deletions(-) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index c55edd3c6..1006fef2f 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -9423,7 +9423,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) for which you want to create a client session.", + "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9640,7 +9640,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session (or that are already associated with the existing client session).", + "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9726,7 +9726,7 @@ "title": "Grant Access to a Client Session", "name": "grant_access", "path": "/client_sessions/grant_access", - "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](../core-concepts/connect-webviews/README.md), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", + "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9761,7 +9761,7 @@ }, { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session.", + "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9868,7 +9868,7 @@ }, { "name": "connect_webview_id", - "description": "ID of the [Connect Webview](../core-concepts/connect-webviews/README.md) for which you want to retrieve client sessions.", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9993,7 +9993,7 @@ "title": "Create a Connect Webview", "name": "create", "path": "/connect_webviews/create", - "description": "Creates a new [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](../core-concepts/connect-webviews/connect-webview-process.md).", + "description": "Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10015,7 +10015,7 @@ "parameters": [ { "name": "accepted_providers", - "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", + "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10532,7 +10532,7 @@ }, { "name": "automatically_manage_new_devices", - "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10547,7 +10547,7 @@ }, { "name": "custom_metadata", - "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md).", + "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10711,7 +10711,7 @@ }, { "name": "wait_for_device_creation", - "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10739,7 +10739,7 @@ "title": "Delete a Connect Webview", "name": "delete", "path": "/connect_webviews/delete", - "description": "Deletes a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", + "description": "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10785,7 +10785,7 @@ "title": "Get a Connect Webview", "name": "get", "path": "/connect_webviews/get", - "description": "Returns a specified [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", + "description": "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10834,7 +10834,7 @@ "title": "List Connect Webviews", "name": "list", "path": "/connect_webviews/list", - "description": "Returns a list of all [Connect Webviews](../core-concepts/connect-webviews/README.md).", + "description": "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10856,7 +10856,7 @@ "parameters": [ { "name": "custom_metadata_has", - "description": "Custom metadata pairs by which you want to [filter Connect Webviews](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", + "description": "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12963,7 +12963,7 @@ "title": "List Device Providers", "name": "list_device_providers", "path": "/devices/list_device_providers", - "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](../core-concepts/connect-webviews/README.md), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).", + "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities/README.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40223,7 +40223,7 @@ "jsonType": "string" } ], - "description": "Represents a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", + "description": "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", "isDeprecated": false, "routePath": "/connect_webviews", "deprecationMessage": "", diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 6b8a02a8e..f1a8cb760 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -119,7 +119,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -127,7 +127,7 @@ Failed to set code on SmartThings device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -140,7 +140,7 @@ Failed to set code on SmartThings device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -148,7 +148,7 @@ Failed to set code on SmartThings device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -160,7 +160,7 @@ Failed to set code on SmartThings device. Failed to set code after multiple retries. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -168,7 +168,7 @@ Failed to set code after multiple retries. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -181,7 +181,7 @@ Failed to set code after multiple retries. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -189,7 +189,7 @@ Failed to set code after multiple retries. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -201,7 +201,7 @@ Failed to set code after multiple retries. No free slots available on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -209,7 +209,7 @@ No free slots available on the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -222,7 +222,7 @@ No free slots available on the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -230,7 +230,7 @@ No free slots available on the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -242,7 +242,7 @@ No free slots available on the device. Failed to set code on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -250,7 +250,7 @@ Failed to set code on device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -263,7 +263,7 @@ Failed to set code on device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -271,7 +271,7 @@ Failed to set code on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -283,7 +283,7 @@ Failed to set code on device. Failed to remove code from device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -291,7 +291,7 @@ Failed to remove code from device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -304,7 +304,7 @@ Failed to remove code from device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -312,7 +312,7 @@ Failed to remove code from device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -324,7 +324,7 @@ Failed to remove code from device. Duplicate access code detected on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -332,7 +332,7 @@ Duplicate access code detected on device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -345,7 +345,7 @@ Duplicate access code detected on device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -353,7 +353,7 @@ Duplicate access code detected on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -365,7 +365,7 @@ Duplicate access code detected on device. An attempt to modify this access code was prevented. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -373,7 +373,7 @@ An attempt to modify this access code was prevented. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -386,7 +386,7 @@ An attempt to modify this access code was prevented. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -394,7 +394,7 @@ An attempt to modify this access code was prevented. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -406,7 +406,7 @@ An attempt to modify this access code was prevented. No space for access code on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -414,7 +414,7 @@ No space for access code on device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -427,7 +427,7 @@ No space for access code on device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -435,7 +435,7 @@ No space for access code on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -447,7 +447,7 @@ No space for access code on device. Igloohome bridge has too many pending jobs in the queue. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -455,7 +455,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -468,7 +468,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -476,7 +476,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -488,7 +488,7 @@ Igloohome bridge has too many pending jobs in the queue. Igloohome bridge is offline. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -496,7 +496,7 @@ Igloohome bridge is offline. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -509,7 +509,7 @@ Igloohome bridge is offline. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -517,7 +517,7 @@ Igloohome bridge is offline. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -529,7 +529,7 @@ Igloohome bridge is offline. Lock has reached maximum amount of codes. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -537,7 +537,7 @@ Lock has reached maximum amount of codes. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -550,7 +550,7 @@ Lock has reached maximum amount of codes. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -558,7 +558,7 @@ Lock has reached maximum amount of codes. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -570,7 +570,7 @@ Lock has reached maximum amount of codes. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -578,7 +578,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -591,7 +591,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -599,7 +599,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -611,7 +611,7 @@ Unable to confirm that the access code is set on Kwikset device. Unable to confirm the deletion of the access code on Kwikset device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -619,7 +619,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -632,7 +632,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -640,7 +640,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -652,7 +652,7 @@ Unable to confirm the deletion of the access code on Kwikset device. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -660,7 +660,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -673,7 +673,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -681,7 +681,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -693,7 +693,7 @@ Code was modified or removed externally after Seam successfully set it on the de Invalid code length for August lock. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -701,7 +701,7 @@ Invalid code length for August lock. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -714,7 +714,7 @@ Invalid code length for August lock. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -722,7 +722,7 @@ Invalid code length for August lock. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -734,7 +734,7 @@ Invalid code length for August lock. Access code has not yet been fully moved to the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -742,7 +742,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -755,7 +755,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -763,7 +763,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -775,7 +775,7 @@ Access code has not yet been fully moved to the device. All access code slots on the device are full. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -783,7 +783,7 @@ All access code slots on the device are full. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -796,7 +796,7 @@ All access code slots on the device are full. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -804,7 +804,7 @@ All access code slots on the device are full. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -816,7 +816,7 @@ All access code slots on the device are full. August lock is missing a keypad. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -824,7 +824,7 @@ August lock is missing a keypad. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -837,7 +837,7 @@ August lock is missing a keypad. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -845,7 +845,7 @@ August lock is missing a keypad. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -857,7 +857,7 @@ August lock is missing a keypad. August lock is temporarily offline. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -865,7 +865,7 @@ August lock is temporarily offline. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -878,7 +878,7 @@ August lock is temporarily offline. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -886,7 +886,7 @@ August lock is temporarily offline. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -898,7 +898,7 @@ August lock is temporarily offline. Salto site user is not subscribed. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -906,7 +906,7 @@ Salto site user is not subscribed. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -919,7 +919,7 @@ Salto site user is not subscribed. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -927,7 +927,7 @@ Salto site user is not subscribed. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -939,7 +939,7 @@ Salto site user is not subscribed. Access code has not yet been fully moved to the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -947,7 +947,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -960,7 +960,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -968,7 +968,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -980,7 +980,7 @@ Access code has not yet been fully moved to the device. No free positions available on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -988,7 +988,7 @@ No free positions available on the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1001,7 +1001,7 @@ No free positions available on the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -1009,7 +1009,7 @@ No free positions available on the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1021,7 +1021,7 @@ No free positions available on the device. Duplicate access code name detected. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1029,7 +1029,7 @@ Duplicate access code name detected. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1042,7 +1042,7 @@ Duplicate access code name detected. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -1050,7 +1050,7 @@ Duplicate access code name detected. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1062,7 +1062,7 @@ Duplicate access code name detected. Potential duplicate access code detected. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1070,7 +1070,7 @@ Potential duplicate access code detected. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1083,7 +1083,7 @@ Potential duplicate access code detected. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -1091,7 +1091,7 @@ Potential duplicate access code detected. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1103,7 +1103,7 @@ Potential duplicate access code detected. No valid user level for Oracode. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1111,7 +1111,7 @@ No valid user level for Oracode. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1124,7 +1124,7 @@ No valid user level for Oracode. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -1132,7 +1132,7 @@ No valid user level for Oracode. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1144,13 +1144,13 @@ No valid user level for Oracode. Account is disconnected - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1163,19 +1163,19 @@ Account is disconnected --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1185,13 +1185,13 @@ Account is disconnected Salto site user limit reached. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1204,19 +1204,19 @@ Salto site user limit reached. --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1226,13 +1226,13 @@ Salto site user limit reached. Device is offline - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1245,13 +1245,13 @@ Device is offline --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1261,13 +1261,13 @@ Device is offline Device has been removed - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1280,13 +1280,13 @@ Device has been removed --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1296,13 +1296,13 @@ Device has been removed Hub is disconnected - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1315,13 +1315,13 @@ Hub is disconnected --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1331,13 +1331,13 @@ Hub is disconnected Device is disconnected - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1350,13 +1350,13 @@ Device is disconnected --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1366,13 +1366,13 @@ Device is disconnected The backup access code pool is empty. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1385,13 +1385,13 @@ The backup access code pool is empty. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1401,13 +1401,13 @@ The backup access code pool is empty. User is not authorized to use the August Lock. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1420,13 +1420,13 @@ User is not authorized to use the August Lock. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1436,13 +1436,13 @@ User is not authorized to use the August Lock. Lock is not connected to the Seam Bridge. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1455,13 +1455,13 @@ Lock is not connected to the Seam Bridge. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1471,13 +1471,13 @@ Lock is not connected to the Seam Bridge. Lock is not paired with a Gateway. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1490,13 +1490,13 @@ Lock is not paired with a Gateway. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1506,13 +1506,13 @@ Lock is not paired with a Gateway. Missing device credentials. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1525,13 +1525,13 @@ Missing device credentials. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1541,13 +1541,13 @@ Missing device credentials. The auxiliary heat is running. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1560,13 +1560,13 @@ The auxiliary heat is running. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1576,13 +1576,13 @@ The auxiliary heat is running. Subscription required to connect. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1595,13 +1595,13 @@ Subscription required to connect. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1611,7 +1611,7 @@ Subscription required to connect. Credentials provided were invalid. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1619,7 +1619,7 @@ Credentials provided were invalid. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1632,19 +1632,19 @@ Credentials provided were invalid. --- - **`is_bridge_error`** Format: `Boolean` + **`is_bridge_error`** *Format: `Boolean`* --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1655,7 +1655,7 @@ Credentials provided were invalid. 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1663,7 +1663,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1676,19 +1676,19 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili --- - **`is_bridge_error`** Format: `Boolean` + **`is_bridge_error`** *Format: `Boolean`* --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1849,7 +1849,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1857,7 +1857,7 @@ Failed to set code on SmartThings device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1865,7 +1865,7 @@ Failed to set code on SmartThings device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1882,7 +1882,7 @@ Failed to set code on SmartThings device. Duplicate access code detected. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1890,7 +1890,7 @@ Duplicate access code detected. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1898,7 +1898,7 @@ Duplicate access code detected. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1915,7 +1915,7 @@ Duplicate access code detected. Received an error when attempting to create this code. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1923,7 +1923,7 @@ Received an error when attempting to create this code. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1931,7 +1931,7 @@ Received an error when attempting to create this code. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1948,7 +1948,7 @@ Received an error when attempting to create this code. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1956,7 +1956,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1964,7 +1964,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1981,7 +1981,7 @@ Code was modified or removed externally after Seam successfully set it on the de Delay in setting code on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1989,7 +1989,7 @@ Delay in setting code on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1997,7 +1997,7 @@ Delay in setting code on device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2014,7 +2014,7 @@ Delay in setting code on device. Delay in removing code from device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2022,7 +2022,7 @@ Delay in removing code from device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2030,7 +2030,7 @@ Delay in removing code from device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2047,7 +2047,7 @@ Delay in removing code from device. Third-party integration detected that may cause access codes to fail. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2055,7 +2055,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2063,7 +2063,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2080,7 +2080,7 @@ Third-party integration detected that may cause access codes to fail. Access code has not yet been fully moved to the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2088,7 +2088,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2096,7 +2096,7 @@ Access code has not yet been fully moved to the device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2113,7 +2113,7 @@ Access code has not yet been fully moved to the device. August lock is temporarily offline. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2121,7 +2121,7 @@ August lock is temporarily offline. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2129,7 +2129,7 @@ August lock is temporarily offline. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -2146,7 +2146,7 @@ August lock is temporarily offline. Algopins must be used within 24 hours. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2154,7 +2154,7 @@ Algopins must be used within 24 hours. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2162,7 +2162,7 @@ Algopins must be used within 24 hours. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2179,7 +2179,7 @@ Algopins must be used within 24 hours. Management was transferred to another workspace. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2187,7 +2187,7 @@ Management was transferred to another workspace. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2195,7 +2195,7 @@ Management was transferred to another workspace. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2212,7 +2212,7 @@ Management was transferred to another workspace. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2220,7 +2220,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2228,7 +2228,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index c59c504ef..976267001 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -105,7 +105,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -113,7 +113,7 @@ Failed to set code on SmartThings device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -126,7 +126,7 @@ Failed to set code on SmartThings device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -134,7 +134,7 @@ Failed to set code on SmartThings device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -146,7 +146,7 @@ Failed to set code on SmartThings device. Failed to set code after multiple retries. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -154,7 +154,7 @@ Failed to set code after multiple retries. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -167,7 +167,7 @@ Failed to set code after multiple retries. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -175,7 +175,7 @@ Failed to set code after multiple retries. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -187,7 +187,7 @@ Failed to set code after multiple retries. No free slots available on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -195,7 +195,7 @@ No free slots available on the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -208,7 +208,7 @@ No free slots available on the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -216,7 +216,7 @@ No free slots available on the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -228,7 +228,7 @@ No free slots available on the device. Failed to set code on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -236,7 +236,7 @@ Failed to set code on device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -249,7 +249,7 @@ Failed to set code on device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -257,7 +257,7 @@ Failed to set code on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -269,7 +269,7 @@ Failed to set code on device. Failed to remove code from device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -277,7 +277,7 @@ Failed to remove code from device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -290,7 +290,7 @@ Failed to remove code from device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -298,7 +298,7 @@ Failed to remove code from device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -310,7 +310,7 @@ Failed to remove code from device. Duplicate access code detected on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -318,7 +318,7 @@ Duplicate access code detected on device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -331,7 +331,7 @@ Duplicate access code detected on device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -339,7 +339,7 @@ Duplicate access code detected on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -351,7 +351,7 @@ Duplicate access code detected on device. An attempt to modify this access code was prevented. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -359,7 +359,7 @@ An attempt to modify this access code was prevented. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -372,7 +372,7 @@ An attempt to modify this access code was prevented. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -380,7 +380,7 @@ An attempt to modify this access code was prevented. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -392,7 +392,7 @@ An attempt to modify this access code was prevented. No space for access code on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -400,7 +400,7 @@ No space for access code on device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -413,7 +413,7 @@ No space for access code on device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -421,7 +421,7 @@ No space for access code on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -433,7 +433,7 @@ No space for access code on device. Igloohome bridge has too many pending jobs in the queue. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -441,7 +441,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -454,7 +454,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -462,7 +462,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -474,7 +474,7 @@ Igloohome bridge has too many pending jobs in the queue. Igloohome bridge is offline. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -482,7 +482,7 @@ Igloohome bridge is offline. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -495,7 +495,7 @@ Igloohome bridge is offline. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -503,7 +503,7 @@ Igloohome bridge is offline. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -515,7 +515,7 @@ Igloohome bridge is offline. Lock has reached maximum amount of codes. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -523,7 +523,7 @@ Lock has reached maximum amount of codes. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -536,7 +536,7 @@ Lock has reached maximum amount of codes. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -544,7 +544,7 @@ Lock has reached maximum amount of codes. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -556,7 +556,7 @@ Lock has reached maximum amount of codes. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -564,7 +564,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -577,7 +577,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -585,7 +585,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -597,7 +597,7 @@ Unable to confirm that the access code is set on Kwikset device. Unable to confirm the deletion of the access code on Kwikset device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -605,7 +605,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -618,7 +618,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -626,7 +626,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -638,7 +638,7 @@ Unable to confirm the deletion of the access code on Kwikset device. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -646,7 +646,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -659,7 +659,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -667,7 +667,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -679,7 +679,7 @@ Code was modified or removed externally after Seam successfully set it on the de Invalid code length for August lock. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -687,7 +687,7 @@ Invalid code length for August lock. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -700,7 +700,7 @@ Invalid code length for August lock. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -708,7 +708,7 @@ Invalid code length for August lock. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -720,7 +720,7 @@ Invalid code length for August lock. Access code has not yet been fully moved to the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -728,7 +728,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -741,7 +741,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -749,7 +749,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -761,7 +761,7 @@ Access code has not yet been fully moved to the device. All access code slots on the device are full. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -769,7 +769,7 @@ All access code slots on the device are full. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -782,7 +782,7 @@ All access code slots on the device are full. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -790,7 +790,7 @@ All access code slots on the device are full. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -802,7 +802,7 @@ All access code slots on the device are full. August lock is missing a keypad. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -810,7 +810,7 @@ August lock is missing a keypad. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -823,7 +823,7 @@ August lock is missing a keypad. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -831,7 +831,7 @@ August lock is missing a keypad. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -843,7 +843,7 @@ August lock is missing a keypad. August lock is temporarily offline. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -851,7 +851,7 @@ August lock is temporarily offline. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -864,7 +864,7 @@ August lock is temporarily offline. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -872,7 +872,7 @@ August lock is temporarily offline. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -884,7 +884,7 @@ August lock is temporarily offline. Salto site user is not subscribed. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -892,7 +892,7 @@ Salto site user is not subscribed. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -905,7 +905,7 @@ Salto site user is not subscribed. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -913,7 +913,7 @@ Salto site user is not subscribed. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -925,7 +925,7 @@ Salto site user is not subscribed. Access code has not yet been fully moved to the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -933,7 +933,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -946,7 +946,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -954,7 +954,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -966,7 +966,7 @@ Access code has not yet been fully moved to the device. No free positions available on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -974,7 +974,7 @@ No free positions available on the device. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -987,7 +987,7 @@ No free positions available on the device. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -995,7 +995,7 @@ No free positions available on the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1007,7 +1007,7 @@ No free positions available on the device. Duplicate access code name detected. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1015,7 +1015,7 @@ Duplicate access code name detected. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1028,7 +1028,7 @@ Duplicate access code name detected. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -1036,7 +1036,7 @@ Duplicate access code name detected. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1048,7 +1048,7 @@ Duplicate access code name detected. Potential duplicate access code detected. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1056,7 +1056,7 @@ Potential duplicate access code detected. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1069,7 +1069,7 @@ Potential duplicate access code detected. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -1077,7 +1077,7 @@ Potential duplicate access code detected. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1089,7 +1089,7 @@ Potential duplicate access code detected. No valid user level for Oracode. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1097,7 +1097,7 @@ No valid user level for Oracode. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1110,7 +1110,7 @@ No valid user level for Oracode. --- - **`is_access_code_error`** Format: `Boolean` + **`is_access_code_error`** *Format: `Boolean`* Indicates that this is an access code error. @@ -1118,7 +1118,7 @@ No valid user level for Oracode. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1130,13 +1130,13 @@ No valid user level for Oracode. Account is disconnected - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1149,19 +1149,19 @@ Account is disconnected --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1171,13 +1171,13 @@ Account is disconnected Salto site user limit reached. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1190,19 +1190,19 @@ Salto site user limit reached. --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1212,13 +1212,13 @@ Salto site user limit reached. Device is offline - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1231,13 +1231,13 @@ Device is offline --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1247,13 +1247,13 @@ Device is offline Device has been removed - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1266,13 +1266,13 @@ Device has been removed --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1282,13 +1282,13 @@ Device has been removed Hub is disconnected - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1301,13 +1301,13 @@ Hub is disconnected --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1317,13 +1317,13 @@ Hub is disconnected Device is disconnected - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1336,13 +1336,13 @@ Device is disconnected --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1352,13 +1352,13 @@ Device is disconnected The backup access code pool is empty. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1371,13 +1371,13 @@ The backup access code pool is empty. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1387,13 +1387,13 @@ The backup access code pool is empty. User is not authorized to use the August Lock. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1406,13 +1406,13 @@ User is not authorized to use the August Lock. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1422,13 +1422,13 @@ User is not authorized to use the August Lock. Lock is not connected to the Seam Bridge. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1441,13 +1441,13 @@ Lock is not connected to the Seam Bridge. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1457,13 +1457,13 @@ Lock is not connected to the Seam Bridge. Lock is not paired with a Gateway. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1476,13 +1476,13 @@ Lock is not paired with a Gateway. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1492,13 +1492,13 @@ Lock is not paired with a Gateway. Missing device credentials. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1511,13 +1511,13 @@ Missing device credentials. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1527,13 +1527,13 @@ Missing device credentials. The auxiliary heat is running. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1546,13 +1546,13 @@ The auxiliary heat is running. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1562,13 +1562,13 @@ The auxiliary heat is running. Subscription required to connect. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1581,13 +1581,13 @@ Subscription required to connect. --- - **`is_device_error`** Format: `Boolean` + **`is_device_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1597,7 +1597,7 @@ Subscription required to connect. Credentials provided were invalid. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1605,7 +1605,7 @@ Credentials provided were invalid. --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1618,19 +1618,19 @@ Credentials provided were invalid. --- - **`is_bridge_error`** Format: `Boolean` + **`is_bridge_error`** *Format: `Boolean`* --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1641,7 +1641,7 @@ Credentials provided were invalid. 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -1649,7 +1649,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1662,19 +1662,19 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`is_bridge_error`** Format: `Boolean` + **`is_bridge_error`** *Format: `Boolean`* --- - **`is_connected_account_error`** Format: `Boolean` + **`is_connected_account_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* @@ -1759,7 +1759,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1767,7 +1767,7 @@ Failed to set code on SmartThings device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1775,7 +1775,7 @@ Failed to set code on SmartThings device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1792,7 +1792,7 @@ Failed to set code on SmartThings device. Duplicate access code detected. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1800,7 +1800,7 @@ Duplicate access code detected. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1808,7 +1808,7 @@ Duplicate access code detected. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1825,7 +1825,7 @@ Duplicate access code detected. Received an error when attempting to create this code. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1833,7 +1833,7 @@ Received an error when attempting to create this code. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1841,7 +1841,7 @@ Received an error when attempting to create this code. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1858,7 +1858,7 @@ Received an error when attempting to create this code. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1866,7 +1866,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1874,7 +1874,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1891,7 +1891,7 @@ Code was modified or removed externally after Seam successfully set it on the de Delay in setting code on device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1899,7 +1899,7 @@ Delay in setting code on device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1907,7 +1907,7 @@ Delay in setting code on device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1924,7 +1924,7 @@ Delay in setting code on device. Delay in removing code from device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1932,7 +1932,7 @@ Delay in removing code from device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1940,7 +1940,7 @@ Delay in removing code from device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1957,7 +1957,7 @@ Delay in removing code from device. Third-party integration detected that may cause access codes to fail. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1965,7 +1965,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1973,7 +1973,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1990,7 +1990,7 @@ Third-party integration detected that may cause access codes to fail. Access code has not yet been fully moved to the device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -1998,7 +1998,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2006,7 +2006,7 @@ Access code has not yet been fully moved to the device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2023,7 +2023,7 @@ Access code has not yet been fully moved to the device. August lock is temporarily offline. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2031,7 +2031,7 @@ August lock is temporarily offline. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2039,7 +2039,7 @@ August lock is temporarily offline. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -2056,7 +2056,7 @@ August lock is temporarily offline. Algopins must be used within 24 hours. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2064,7 +2064,7 @@ Algopins must be used within 24 hours. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2072,7 +2072,7 @@ Algopins must be used within 24 hours. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2089,7 +2089,7 @@ Algopins must be used within 24 hours. Management was transferred to another workspace. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2097,7 +2097,7 @@ Management was transferred to another workspace. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2105,7 +2105,7 @@ Management was transferred to another workspace. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2122,7 +2122,7 @@ Management was transferred to another workspace. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -2130,7 +2130,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2138,7 +2138,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 4be7db332..a5991aa8e 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -348,7 +348,7 @@ Variants: Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -356,7 +356,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -364,7 +364,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -381,7 +381,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -389,7 +389,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -397,7 +397,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -414,7 +414,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -422,7 +422,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -430,7 +430,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -447,7 +447,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -455,7 +455,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -463,7 +463,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -480,7 +480,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -488,7 +488,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -496,7 +496,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -513,7 +513,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -521,7 +521,7 @@ Access permissions for the [credential](../../../capability-guides/access-system --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -529,7 +529,7 @@ Access permissions for the [credential](../../../capability-guides/access-system --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index b22d6ddc0..116cb67f6 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -243,7 +243,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -251,7 +251,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -264,7 +264,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -277,7 +277,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -285,7 +285,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -298,13 +298,13 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`is_bridge_error`** Format: `Boolean` + **`is_bridge_error`** *Format: `Boolean`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -318,7 +318,7 @@ 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -326,7 +326,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -339,7 +339,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -351,7 +351,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -359,7 +359,7 @@ Indicates that the maximum number of users allowed for the site has been reached --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -372,7 +372,7 @@ Indicates that the maximum number of users allowed for the site has been reached --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -384,7 +384,7 @@ Indicates that the maximum number of users allowed for the site has been reached 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -392,7 +392,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -405,7 +405,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -417,7 +417,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -425,7 +425,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -438,7 +438,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -450,7 +450,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -458,7 +458,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -471,7 +471,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -646,7 +646,7 @@ Variants: 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -654,7 +654,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -662,7 +662,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -679,7 +679,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -687,7 +687,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -695,7 +695,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui --- - **`misconfigured_acs_entrance_ids`** Format: `List`, Item format: `UUID` + **`misconfigured_acs_entrance_ids`** *Format: `List`, Item format: `UUID`* {% hint style="warning" %} @@ -705,7 +705,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index c5528a6a8..6f9ef7fc2 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -141,7 +141,7 @@ Variants: 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -149,7 +149,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`*
Enum values: @@ -160,7 +160,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -172,7 +172,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -180,7 +180,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`*
Enum values: @@ -191,7 +191,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -203,7 +203,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -211,7 +211,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`*
Enum values: @@ -222,7 +222,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -234,7 +234,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -242,7 +242,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`*
Enum values: @@ -253,7 +253,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -265,7 +265,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -273,7 +273,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`*
Enum values: @@ -284,7 +284,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -296,7 +296,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the error. @@ -304,7 +304,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** Format: `Enum` + **`error_code`** *Format: `Enum`*
Enum values: @@ -315,7 +315,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -403,7 +403,7 @@ Variants: Seam is in the process of pushing a user creation to the integrated access system. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which the mutation was created. @@ -411,7 +411,7 @@ Seam is in the process of pushing a user creation to the integrated access syste --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the mutation. @@ -419,7 +419,7 @@ Seam is in the process of pushing a user creation to the integrated access syste --- - **`mutation_code`** Format: `Enum` + **`mutation_code`** *Format: `Enum`*
Enum values: @@ -434,7 +434,7 @@ Seam is in the process of pushing a user creation to the integrated access syste Seam is in the process of pushing a user deletion to the integrated access system. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which the mutation was created. @@ -442,7 +442,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the mutation. @@ -450,7 +450,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`mutation_code`** Format: `Enum` + **`mutation_code`** *Format: `Enum`*
Enum values: @@ -463,7 +463,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste
updating_user_information - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which the mutation was created. @@ -471,13 +471,13 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`from`** Format: `Object` + **`from`** *Format: `Object`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the mutation. @@ -485,7 +485,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`mutation_code`** Format: `Enum` + **`mutation_code`** *Format: `Enum`*
Enum values: @@ -496,7 +496,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`to`** Format: `Object` + **`to`** *Format: `Object`* @@ -506,7 +506,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste Seam is in the process of pushing an access schedule update to the integrated access system. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which the mutation was created. @@ -514,13 +514,13 @@ Seam is in the process of pushing an access schedule update to the integrated ac --- - **`from`** Format: `Object` + **`from`** *Format: `Object`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the mutation. @@ -528,7 +528,7 @@ Seam is in the process of pushing an access schedule update to the integrated ac --- - **`mutation_code`** Format: `Enum` + **`mutation_code`** *Format: `Enum`*
Enum values: @@ -539,7 +539,7 @@ Seam is in the process of pushing an access schedule update to the integrated ac --- - **`to`** Format: `Object` + **`to`** *Format: `Object`* @@ -549,7 +549,7 @@ Seam is in the process of pushing an access schedule update to the integrated ac Seam is in the process of pushing a suspension state update to the integrated access system. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which the mutation was created. @@ -557,13 +557,13 @@ Seam is in the process of pushing a suspension state update to the integrated ac --- - **`from`** Format: `Object` + **`from`** *Format: `Object`* --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the mutation. @@ -571,7 +571,7 @@ Seam is in the process of pushing a suspension state update to the integrated ac --- - **`mutation_code`** Format: `Enum` + **`mutation_code`** *Format: `Enum`*
Enum values: @@ -582,7 +582,7 @@ Seam is in the process of pushing a suspension state update to the integrated ac --- - **`to`** Format: `Object` + **`to`** *Format: `Object`* @@ -592,7 +592,7 @@ Seam is in the process of pushing a suspension state update to the integrated ac Seam is in the process of pushing an access group membership update to the integrated access system. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which the mutation was created. @@ -600,7 +600,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`from`** Format: `Object` + **`from`** *Format: `Object`* Old access group membership. @@ -608,7 +608,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the mutation. @@ -616,7 +616,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`mutation_code`** Format: `Enum` + **`mutation_code`** *Format: `Enum`*
Enum values: @@ -627,7 +627,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`to`** Format: `Object` + **`to`** *Format: `Object`* New access group membership. @@ -697,7 +697,7 @@ Variants: 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -705,7 +705,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -713,7 +713,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`*
Enum values: @@ -728,7 +728,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -736,7 +736,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -744,7 +744,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`*
Enum values: @@ -759,7 +759,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -767,7 +767,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -775,7 +775,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`*
Enum values: @@ -790,7 +790,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. - **`created_at`** Format: `Datetime` + **`created_at`** *Format: `Datetime`* Date and time at which Seam created the warning. @@ -798,7 +798,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** Format: `String` + **`message`** *Format: `String`* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -806,7 +806,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`warning_code`** Format: `Enum` + **`warning_code`** *Format: `Enum`*
Enum values: From 2cb15f0df3d0a485501269daa073c1588bdf09c3 Mon Sep 17 00:00:00 2001 From: Mike Wu Date: Sat, 24 May 2025 09:55:35 +0900 Subject: [PATCH 3/6] Update property-non-collapsible.hbs Co-authored-by: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> --- src/layouts/partials/property-non-collapsible.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-non-collapsible.hbs b/src/layouts/partials/property-non-collapsible.hbs index 7e6392c4a..f0cf9761b 100644 --- a/src/layouts/partials/property-non-collapsible.hbs +++ b/src/layouts/partials/property-non-collapsible.hbs @@ -1,4 +1,4 @@ -**`{{name}}`** *Format: `{{format}}`{{#if listItemFormat}}, Item format: `{{listItemFormat}}`{{/if}}* +{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} {{> property-content}} From 386970ee45cf18c262f76adeede1f5a7c58a0a6b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sat, 24 May 2025 00:56:31 +0000 Subject: [PATCH 4/6] ci: Generate docs --- docs/api/access_codes/README.md | 400 +++++++++++----------- docs/api/access_codes/unmanaged/README.md | 400 +++++++++++----------- docs/api/acs/credentials/README.md | 36 +- docs/api/acs/systems/README.md | 58 ++-- docs/api/acs/users/README.md | 112 +++--- 5 files changed, 503 insertions(+), 503 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index f1a8cb760..77f01132b 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -119,7 +119,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -127,7 +127,7 @@ Failed to set code on SmartThings device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -140,7 +140,7 @@ Failed to set code on SmartThings device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -148,7 +148,7 @@ Failed to set code on SmartThings device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -160,7 +160,7 @@ Failed to set code on SmartThings device. Failed to set code after multiple retries. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -168,7 +168,7 @@ Failed to set code after multiple retries. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -181,7 +181,7 @@ Failed to set code after multiple retries. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -189,7 +189,7 @@ Failed to set code after multiple retries. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -201,7 +201,7 @@ Failed to set code after multiple retries. No free slots available on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -209,7 +209,7 @@ No free slots available on the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -222,7 +222,7 @@ No free slots available on the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -230,7 +230,7 @@ No free slots available on the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -242,7 +242,7 @@ No free slots available on the device. Failed to set code on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -250,7 +250,7 @@ Failed to set code on device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -263,7 +263,7 @@ Failed to set code on device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -271,7 +271,7 @@ Failed to set code on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -283,7 +283,7 @@ Failed to set code on device. Failed to remove code from device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -291,7 +291,7 @@ Failed to remove code from device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -304,7 +304,7 @@ Failed to remove code from device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -312,7 +312,7 @@ Failed to remove code from device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -324,7 +324,7 @@ Failed to remove code from device. Duplicate access code detected on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -332,7 +332,7 @@ Duplicate access code detected on device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -345,7 +345,7 @@ Duplicate access code detected on device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -353,7 +353,7 @@ Duplicate access code detected on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -365,7 +365,7 @@ Duplicate access code detected on device. An attempt to modify this access code was prevented. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -373,7 +373,7 @@ An attempt to modify this access code was prevented. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -386,7 +386,7 @@ An attempt to modify this access code was prevented. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -394,7 +394,7 @@ An attempt to modify this access code was prevented. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -406,7 +406,7 @@ An attempt to modify this access code was prevented. No space for access code on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -414,7 +414,7 @@ No space for access code on device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -427,7 +427,7 @@ No space for access code on device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -435,7 +435,7 @@ No space for access code on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -447,7 +447,7 @@ No space for access code on device. Igloohome bridge has too many pending jobs in the queue. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -455,7 +455,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -468,7 +468,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -476,7 +476,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -488,7 +488,7 @@ Igloohome bridge has too many pending jobs in the queue. Igloohome bridge is offline. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -496,7 +496,7 @@ Igloohome bridge is offline. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -509,7 +509,7 @@ Igloohome bridge is offline. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -517,7 +517,7 @@ Igloohome bridge is offline. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -529,7 +529,7 @@ Igloohome bridge is offline. Lock has reached maximum amount of codes. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -537,7 +537,7 @@ Lock has reached maximum amount of codes. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -550,7 +550,7 @@ Lock has reached maximum amount of codes. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -558,7 +558,7 @@ Lock has reached maximum amount of codes. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -570,7 +570,7 @@ Lock has reached maximum amount of codes. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -578,7 +578,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -591,7 +591,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -599,7 +599,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -611,7 +611,7 @@ Unable to confirm that the access code is set on Kwikset device. Unable to confirm the deletion of the access code on Kwikset device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -619,7 +619,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -632,7 +632,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -640,7 +640,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -652,7 +652,7 @@ Unable to confirm the deletion of the access code on Kwikset device. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -660,7 +660,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -673,7 +673,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -681,7 +681,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -693,7 +693,7 @@ Code was modified or removed externally after Seam successfully set it on the de Invalid code length for August lock. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -701,7 +701,7 @@ Invalid code length for August lock. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -714,7 +714,7 @@ Invalid code length for August lock. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -722,7 +722,7 @@ Invalid code length for August lock. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -734,7 +734,7 @@ Invalid code length for August lock. Access code has not yet been fully moved to the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -742,7 +742,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -755,7 +755,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -763,7 +763,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -775,7 +775,7 @@ Access code has not yet been fully moved to the device. All access code slots on the device are full. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -783,7 +783,7 @@ All access code slots on the device are full. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -796,7 +796,7 @@ All access code slots on the device are full. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -804,7 +804,7 @@ All access code slots on the device are full. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -816,7 +816,7 @@ All access code slots on the device are full. August lock is missing a keypad. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -824,7 +824,7 @@ August lock is missing a keypad. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -837,7 +837,7 @@ August lock is missing a keypad. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -845,7 +845,7 @@ August lock is missing a keypad. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -857,7 +857,7 @@ August lock is missing a keypad. August lock is temporarily offline. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -865,7 +865,7 @@ August lock is temporarily offline. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -878,7 +878,7 @@ August lock is temporarily offline. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -886,7 +886,7 @@ August lock is temporarily offline. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -898,7 +898,7 @@ August lock is temporarily offline. Salto site user is not subscribed. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -906,7 +906,7 @@ Salto site user is not subscribed. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -919,7 +919,7 @@ Salto site user is not subscribed. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -927,7 +927,7 @@ Salto site user is not subscribed. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -939,7 +939,7 @@ Salto site user is not subscribed. Access code has not yet been fully moved to the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -947,7 +947,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -960,7 +960,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -968,7 +968,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -980,7 +980,7 @@ Access code has not yet been fully moved to the device. No free positions available on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -988,7 +988,7 @@ No free positions available on the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1001,7 +1001,7 @@ No free positions available on the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -1009,7 +1009,7 @@ No free positions available on the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1021,7 +1021,7 @@ No free positions available on the device. Duplicate access code name detected. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1029,7 +1029,7 @@ Duplicate access code name detected. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1042,7 +1042,7 @@ Duplicate access code name detected. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -1050,7 +1050,7 @@ Duplicate access code name detected. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1062,7 +1062,7 @@ Duplicate access code name detected. Potential duplicate access code detected. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1070,7 +1070,7 @@ Potential duplicate access code detected. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1083,7 +1083,7 @@ Potential duplicate access code detected. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -1091,7 +1091,7 @@ Potential duplicate access code detected. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1103,7 +1103,7 @@ Potential duplicate access code detected. No valid user level for Oracode. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1111,7 +1111,7 @@ No valid user level for Oracode. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1124,7 +1124,7 @@ No valid user level for Oracode. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -1132,7 +1132,7 @@ No valid user level for Oracode. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1144,13 +1144,13 @@ No valid user level for Oracode. Account is disconnected - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1163,19 +1163,19 @@ Account is disconnected --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1185,13 +1185,13 @@ Account is disconnected Salto site user limit reached. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1204,19 +1204,19 @@ Salto site user limit reached. --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1226,13 +1226,13 @@ Salto site user limit reached. Device is offline - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1245,13 +1245,13 @@ Device is offline --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1261,13 +1261,13 @@ Device is offline Device has been removed - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1280,13 +1280,13 @@ Device has been removed --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1296,13 +1296,13 @@ Device has been removed Hub is disconnected - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1315,13 +1315,13 @@ Hub is disconnected --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1331,13 +1331,13 @@ Hub is disconnected Device is disconnected - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1350,13 +1350,13 @@ Device is disconnected --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1366,13 +1366,13 @@ Device is disconnected The backup access code pool is empty. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1385,13 +1385,13 @@ The backup access code pool is empty. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1401,13 +1401,13 @@ The backup access code pool is empty. User is not authorized to use the August Lock. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1420,13 +1420,13 @@ User is not authorized to use the August Lock. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1436,13 +1436,13 @@ User is not authorized to use the August Lock. Lock is not connected to the Seam Bridge. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1455,13 +1455,13 @@ Lock is not connected to the Seam Bridge. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1471,13 +1471,13 @@ Lock is not connected to the Seam Bridge. Lock is not paired with a Gateway. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1490,13 +1490,13 @@ Lock is not paired with a Gateway. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1506,13 +1506,13 @@ Lock is not paired with a Gateway. Missing device credentials. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1525,13 +1525,13 @@ Missing device credentials. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1541,13 +1541,13 @@ Missing device credentials. The auxiliary heat is running. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1560,13 +1560,13 @@ The auxiliary heat is running. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1576,13 +1576,13 @@ The auxiliary heat is running. Subscription required to connect. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1595,13 +1595,13 @@ Subscription required to connect. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1611,7 +1611,7 @@ Subscription required to connect. Credentials provided were invalid. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1619,7 +1619,7 @@ Credentials provided were invalid. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1632,19 +1632,19 @@ Credentials provided were invalid. --- - **`is_bridge_error`** *Format: `Boolean`* + **`is_bridge_error`** *Boolean* --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1655,7 +1655,7 @@ Credentials provided were invalid. 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1663,7 +1663,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1676,19 +1676,19 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili --- - **`is_bridge_error`** *Format: `Boolean`* + **`is_bridge_error`** *Boolean* --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1849,7 +1849,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1857,7 +1857,7 @@ Failed to set code on SmartThings device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1865,7 +1865,7 @@ Failed to set code on SmartThings device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1882,7 +1882,7 @@ Failed to set code on SmartThings device. Duplicate access code detected. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1890,7 +1890,7 @@ Duplicate access code detected. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1898,7 +1898,7 @@ Duplicate access code detected. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1915,7 +1915,7 @@ Duplicate access code detected. Received an error when attempting to create this code. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1923,7 +1923,7 @@ Received an error when attempting to create this code. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1931,7 +1931,7 @@ Received an error when attempting to create this code. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1948,7 +1948,7 @@ Received an error when attempting to create this code. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1956,7 +1956,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1964,7 +1964,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1981,7 +1981,7 @@ Code was modified or removed externally after Seam successfully set it on the de Delay in setting code on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1989,7 +1989,7 @@ Delay in setting code on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1997,7 +1997,7 @@ Delay in setting code on device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2014,7 +2014,7 @@ Delay in setting code on device. Delay in removing code from device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2022,7 +2022,7 @@ Delay in removing code from device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2030,7 +2030,7 @@ Delay in removing code from device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2047,7 +2047,7 @@ Delay in removing code from device. Third-party integration detected that may cause access codes to fail. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2055,7 +2055,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2063,7 +2063,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2080,7 +2080,7 @@ Third-party integration detected that may cause access codes to fail. Access code has not yet been fully moved to the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2088,7 +2088,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2096,7 +2096,7 @@ Access code has not yet been fully moved to the device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2113,7 +2113,7 @@ Access code has not yet been fully moved to the device. August lock is temporarily offline. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2121,7 +2121,7 @@ August lock is temporarily offline. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2129,7 +2129,7 @@ August lock is temporarily offline. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -2146,7 +2146,7 @@ August lock is temporarily offline. Algopins must be used within 24 hours. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2154,7 +2154,7 @@ Algopins must be used within 24 hours. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2162,7 +2162,7 @@ Algopins must be used within 24 hours. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2179,7 +2179,7 @@ Algopins must be used within 24 hours. Management was transferred to another workspace. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2187,7 +2187,7 @@ Management was transferred to another workspace. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2195,7 +2195,7 @@ Management was transferred to another workspace. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2212,7 +2212,7 @@ Management was transferred to another workspace. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2220,7 +2220,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2228,7 +2228,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 976267001..ffae1e7a3 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -105,7 +105,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -113,7 +113,7 @@ Failed to set code on SmartThings device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -126,7 +126,7 @@ Failed to set code on SmartThings device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -134,7 +134,7 @@ Failed to set code on SmartThings device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -146,7 +146,7 @@ Failed to set code on SmartThings device. Failed to set code after multiple retries. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -154,7 +154,7 @@ Failed to set code after multiple retries. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -167,7 +167,7 @@ Failed to set code after multiple retries. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -175,7 +175,7 @@ Failed to set code after multiple retries. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -187,7 +187,7 @@ Failed to set code after multiple retries. No free slots available on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -195,7 +195,7 @@ No free slots available on the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -208,7 +208,7 @@ No free slots available on the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -216,7 +216,7 @@ No free slots available on the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -228,7 +228,7 @@ No free slots available on the device. Failed to set code on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -236,7 +236,7 @@ Failed to set code on device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -249,7 +249,7 @@ Failed to set code on device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -257,7 +257,7 @@ Failed to set code on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -269,7 +269,7 @@ Failed to set code on device. Failed to remove code from device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -277,7 +277,7 @@ Failed to remove code from device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -290,7 +290,7 @@ Failed to remove code from device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -298,7 +298,7 @@ Failed to remove code from device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -310,7 +310,7 @@ Failed to remove code from device. Duplicate access code detected on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -318,7 +318,7 @@ Duplicate access code detected on device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -331,7 +331,7 @@ Duplicate access code detected on device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -339,7 +339,7 @@ Duplicate access code detected on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -351,7 +351,7 @@ Duplicate access code detected on device. An attempt to modify this access code was prevented. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -359,7 +359,7 @@ An attempt to modify this access code was prevented. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -372,7 +372,7 @@ An attempt to modify this access code was prevented. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -380,7 +380,7 @@ An attempt to modify this access code was prevented. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -392,7 +392,7 @@ An attempt to modify this access code was prevented. No space for access code on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -400,7 +400,7 @@ No space for access code on device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -413,7 +413,7 @@ No space for access code on device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -421,7 +421,7 @@ No space for access code on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -433,7 +433,7 @@ No space for access code on device. Igloohome bridge has too many pending jobs in the queue. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -441,7 +441,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -454,7 +454,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -462,7 +462,7 @@ Igloohome bridge has too many pending jobs in the queue. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -474,7 +474,7 @@ Igloohome bridge has too many pending jobs in the queue. Igloohome bridge is offline. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -482,7 +482,7 @@ Igloohome bridge is offline. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -495,7 +495,7 @@ Igloohome bridge is offline. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -503,7 +503,7 @@ Igloohome bridge is offline. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -515,7 +515,7 @@ Igloohome bridge is offline. Lock has reached maximum amount of codes. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -523,7 +523,7 @@ Lock has reached maximum amount of codes. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -536,7 +536,7 @@ Lock has reached maximum amount of codes. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -544,7 +544,7 @@ Lock has reached maximum amount of codes. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -556,7 +556,7 @@ Lock has reached maximum amount of codes. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -564,7 +564,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -577,7 +577,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -585,7 +585,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -597,7 +597,7 @@ Unable to confirm that the access code is set on Kwikset device. Unable to confirm the deletion of the access code on Kwikset device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -605,7 +605,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -618,7 +618,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -626,7 +626,7 @@ Unable to confirm the deletion of the access code on Kwikset device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -638,7 +638,7 @@ Unable to confirm the deletion of the access code on Kwikset device. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -646,7 +646,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -659,7 +659,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -667,7 +667,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -679,7 +679,7 @@ Code was modified or removed externally after Seam successfully set it on the de Invalid code length for August lock. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -687,7 +687,7 @@ Invalid code length for August lock. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -700,7 +700,7 @@ Invalid code length for August lock. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -708,7 +708,7 @@ Invalid code length for August lock. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -720,7 +720,7 @@ Invalid code length for August lock. Access code has not yet been fully moved to the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -728,7 +728,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -741,7 +741,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -749,7 +749,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -761,7 +761,7 @@ Access code has not yet been fully moved to the device. All access code slots on the device are full. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -769,7 +769,7 @@ All access code slots on the device are full. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -782,7 +782,7 @@ All access code slots on the device are full. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -790,7 +790,7 @@ All access code slots on the device are full. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -802,7 +802,7 @@ All access code slots on the device are full. August lock is missing a keypad. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -810,7 +810,7 @@ August lock is missing a keypad. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -823,7 +823,7 @@ August lock is missing a keypad. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -831,7 +831,7 @@ August lock is missing a keypad. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -843,7 +843,7 @@ August lock is missing a keypad. August lock is temporarily offline. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -851,7 +851,7 @@ August lock is temporarily offline. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -864,7 +864,7 @@ August lock is temporarily offline. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -872,7 +872,7 @@ August lock is temporarily offline. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -884,7 +884,7 @@ August lock is temporarily offline. Salto site user is not subscribed. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -892,7 +892,7 @@ Salto site user is not subscribed. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -905,7 +905,7 @@ Salto site user is not subscribed. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -913,7 +913,7 @@ Salto site user is not subscribed. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -925,7 +925,7 @@ Salto site user is not subscribed. Access code has not yet been fully moved to the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -933,7 +933,7 @@ Access code has not yet been fully moved to the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -946,7 +946,7 @@ Access code has not yet been fully moved to the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -954,7 +954,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -966,7 +966,7 @@ Access code has not yet been fully moved to the device. No free positions available on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -974,7 +974,7 @@ No free positions available on the device. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -987,7 +987,7 @@ No free positions available on the device. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -995,7 +995,7 @@ No free positions available on the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1007,7 +1007,7 @@ No free positions available on the device. Duplicate access code name detected. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1015,7 +1015,7 @@ Duplicate access code name detected. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1028,7 +1028,7 @@ Duplicate access code name detected. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -1036,7 +1036,7 @@ Duplicate access code name detected. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1048,7 +1048,7 @@ Duplicate access code name detected. Potential duplicate access code detected. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1056,7 +1056,7 @@ Potential duplicate access code detected. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1069,7 +1069,7 @@ Potential duplicate access code detected. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -1077,7 +1077,7 @@ Potential duplicate access code detected. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1089,7 +1089,7 @@ Potential duplicate access code detected. No valid user level for Oracode. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1097,7 +1097,7 @@ No valid user level for Oracode. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1110,7 +1110,7 @@ No valid user level for Oracode. --- - **`is_access_code_error`** *Format: `Boolean`* + **`is_access_code_error`** *Boolean* Indicates that this is an access code error. @@ -1118,7 +1118,7 @@ No valid user level for Oracode. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -1130,13 +1130,13 @@ No valid user level for Oracode. Account is disconnected - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1149,19 +1149,19 @@ Account is disconnected --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1171,13 +1171,13 @@ Account is disconnected Salto site user limit reached. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1190,19 +1190,19 @@ Salto site user limit reached. --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1212,13 +1212,13 @@ Salto site user limit reached. Device is offline - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1231,13 +1231,13 @@ Device is offline --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1247,13 +1247,13 @@ Device is offline Device has been removed - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1266,13 +1266,13 @@ Device has been removed --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1282,13 +1282,13 @@ Device has been removed Hub is disconnected - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1301,13 +1301,13 @@ Hub is disconnected --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1317,13 +1317,13 @@ Hub is disconnected Device is disconnected - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1336,13 +1336,13 @@ Device is disconnected --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1352,13 +1352,13 @@ Device is disconnected The backup access code pool is empty. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1371,13 +1371,13 @@ The backup access code pool is empty. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1387,13 +1387,13 @@ The backup access code pool is empty. User is not authorized to use the August Lock. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1406,13 +1406,13 @@ User is not authorized to use the August Lock. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1422,13 +1422,13 @@ User is not authorized to use the August Lock. Lock is not connected to the Seam Bridge. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1441,13 +1441,13 @@ Lock is not connected to the Seam Bridge. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1457,13 +1457,13 @@ Lock is not connected to the Seam Bridge. Lock is not paired with a Gateway. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1476,13 +1476,13 @@ Lock is not paired with a Gateway. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1492,13 +1492,13 @@ Lock is not paired with a Gateway. Missing device credentials. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1511,13 +1511,13 @@ Missing device credentials. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1527,13 +1527,13 @@ Missing device credentials. The auxiliary heat is running. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1546,13 +1546,13 @@ The auxiliary heat is running. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1562,13 +1562,13 @@ The auxiliary heat is running. Subscription required to connect. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1581,13 +1581,13 @@ Subscription required to connect. --- - **`is_device_error`** *Format: `Boolean`* + **`is_device_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1597,7 +1597,7 @@ Subscription required to connect. Credentials provided were invalid. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1605,7 +1605,7 @@ Credentials provided were invalid. --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1618,19 +1618,19 @@ Credentials provided were invalid. --- - **`is_bridge_error`** *Format: `Boolean`* + **`is_bridge_error`** *Boolean* --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1641,7 +1641,7 @@ Credentials provided were invalid. 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -1649,7 +1649,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -1662,19 +1662,19 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`is_bridge_error`** *Format: `Boolean`* + **`is_bridge_error`** *Boolean* --- - **`is_connected_account_error`** *Format: `Boolean`* + **`is_connected_account_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* @@ -1759,7 +1759,7 @@ Variants: Failed to set code on SmartThings device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1767,7 +1767,7 @@ Failed to set code on SmartThings device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1775,7 +1775,7 @@ Failed to set code on SmartThings device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1792,7 +1792,7 @@ Failed to set code on SmartThings device. Duplicate access code detected. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1800,7 +1800,7 @@ Duplicate access code detected. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1808,7 +1808,7 @@ Duplicate access code detected. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1825,7 +1825,7 @@ Duplicate access code detected. Received an error when attempting to create this code. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1833,7 +1833,7 @@ Received an error when attempting to create this code. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1841,7 +1841,7 @@ Received an error when attempting to create this code. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1858,7 +1858,7 @@ Received an error when attempting to create this code. Code was modified or removed externally after Seam successfully set it on the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1866,7 +1866,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1874,7 +1874,7 @@ Code was modified or removed externally after Seam successfully set it on the de --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1891,7 +1891,7 @@ Code was modified or removed externally after Seam successfully set it on the de Delay in setting code on device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1899,7 +1899,7 @@ Delay in setting code on device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1907,7 +1907,7 @@ Delay in setting code on device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1924,7 +1924,7 @@ Delay in setting code on device. Delay in removing code from device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1932,7 +1932,7 @@ Delay in removing code from device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1940,7 +1940,7 @@ Delay in removing code from device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1957,7 +1957,7 @@ Delay in removing code from device. Third-party integration detected that may cause access codes to fail. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1965,7 +1965,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -1973,7 +1973,7 @@ Third-party integration detected that may cause access codes to fail. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -1990,7 +1990,7 @@ Third-party integration detected that may cause access codes to fail. Access code has not yet been fully moved to the device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -1998,7 +1998,7 @@ Access code has not yet been fully moved to the device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2006,7 +2006,7 @@ Access code has not yet been fully moved to the device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2023,7 +2023,7 @@ Access code has not yet been fully moved to the device. August lock is temporarily offline. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2031,7 +2031,7 @@ August lock is temporarily offline. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2039,7 +2039,7 @@ August lock is temporarily offline. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -2056,7 +2056,7 @@ August lock is temporarily offline. Algopins must be used within 24 hours. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2064,7 +2064,7 @@ Algopins must be used within 24 hours. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2072,7 +2072,7 @@ Algopins must be used within 24 hours. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2089,7 +2089,7 @@ Algopins must be used within 24 hours. Management was transferred to another workspace. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2097,7 +2097,7 @@ Management was transferred to another workspace. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2105,7 +2105,7 @@ Management was transferred to another workspace. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -2122,7 +2122,7 @@ Management was transferred to another workspace. Unable to confirm that the access code is set on Kwikset device. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -2130,7 +2130,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -2138,7 +2138,7 @@ Unable to confirm that the access code is set on Kwikset device. --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index a5991aa8e..967fb8b5b 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -348,7 +348,7 @@ Variants: Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -356,7 +356,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -364,7 +364,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -381,7 +381,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -389,7 +389,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -397,7 +397,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -414,7 +414,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -422,7 +422,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -430,7 +430,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -447,7 +447,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -455,7 +455,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -463,7 +463,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -480,7 +480,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -488,7 +488,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -496,7 +496,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -513,7 +513,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -521,7 +521,7 @@ Access permissions for the [credential](../../../capability-guides/access-system --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -529,7 +529,7 @@ Access permissions for the [credential](../../../capability-guides/access-system --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 116cb67f6..bb2b82d43 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -243,7 +243,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -251,7 +251,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -264,7 +264,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -277,7 +277,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -285,7 +285,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -298,13 +298,13 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- - **`is_bridge_error`** *Format: `Boolean`* + **`is_bridge_error`** *Boolean* --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -318,7 +318,7 @@ 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -326,7 +326,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -339,7 +339,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -351,7 +351,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -359,7 +359,7 @@ Indicates that the maximum number of users allowed for the site has been reached --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -372,7 +372,7 @@ Indicates that the maximum number of users allowed for the site has been reached --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -384,7 +384,7 @@ Indicates that the maximum number of users allowed for the site has been reached 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -392,7 +392,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -405,7 +405,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -417,7 +417,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -425,7 +425,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -438,7 +438,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -450,7 +450,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -458,7 +458,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum* Unique identifier of the type of error. Enables quick recognition and categorization of the issue. @@ -471,7 +471,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -646,7 +646,7 @@ Variants: 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -654,7 +654,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -662,7 +662,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -679,7 +679,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -687,7 +687,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -695,7 +695,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui --- - **`misconfigured_acs_entrance_ids`** *Format: `List`, Item format: `UUID`* + **`misconfigured_acs_entrance_ids`** *List* *of UUIDs* {% hint style="warning" %} @@ -705,7 +705,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 6f9ef7fc2..0c13c3281 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -141,7 +141,7 @@ Variants: 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -149,7 +149,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum*
Enum values: @@ -160,7 +160,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -172,7 +172,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -180,7 +180,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum*
Enum values: @@ -191,7 +191,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -203,7 +203,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -211,7 +211,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum*
Enum values: @@ -222,7 +222,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -234,7 +234,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -242,7 +242,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum*
Enum values: @@ -253,7 +253,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -265,7 +265,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -273,7 +273,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum*
Enum values: @@ -284,7 +284,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -296,7 +296,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the error. @@ -304,7 +304,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`error_code`** *Format: `Enum`* + **`error_code`** *Enum*
Enum values: @@ -315,7 +315,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -403,7 +403,7 @@ Variants: Seam is in the process of pushing a user creation to the integrated access system. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which the mutation was created. @@ -411,7 +411,7 @@ Seam is in the process of pushing a user creation to the integrated access syste --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the mutation. @@ -419,7 +419,7 @@ Seam is in the process of pushing a user creation to the integrated access syste --- - **`mutation_code`** *Format: `Enum`* + **`mutation_code`** *Enum*
Enum values: @@ -434,7 +434,7 @@ Seam is in the process of pushing a user creation to the integrated access syste Seam is in the process of pushing a user deletion to the integrated access system. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which the mutation was created. @@ -442,7 +442,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the mutation. @@ -450,7 +450,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`mutation_code`** *Format: `Enum`* + **`mutation_code`** *Enum*
Enum values: @@ -463,7 +463,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste
updating_user_information - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which the mutation was created. @@ -471,13 +471,13 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`from`** *Format: `Object`* + **`from`** *Object* --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the mutation. @@ -485,7 +485,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`mutation_code`** *Format: `Enum`* + **`mutation_code`** *Enum*
Enum values: @@ -496,7 +496,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste --- - **`to`** *Format: `Object`* + **`to`** *Object* @@ -506,7 +506,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste Seam is in the process of pushing an access schedule update to the integrated access system. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which the mutation was created. @@ -514,13 +514,13 @@ Seam is in the process of pushing an access schedule update to the integrated ac --- - **`from`** *Format: `Object`* + **`from`** *Object* --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the mutation. @@ -528,7 +528,7 @@ Seam is in the process of pushing an access schedule update to the integrated ac --- - **`mutation_code`** *Format: `Enum`* + **`mutation_code`** *Enum*
Enum values: @@ -539,7 +539,7 @@ Seam is in the process of pushing an access schedule update to the integrated ac --- - **`to`** *Format: `Object`* + **`to`** *Object* @@ -549,7 +549,7 @@ Seam is in the process of pushing an access schedule update to the integrated ac Seam is in the process of pushing a suspension state update to the integrated access system. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which the mutation was created. @@ -557,13 +557,13 @@ Seam is in the process of pushing a suspension state update to the integrated ac --- - **`from`** *Format: `Object`* + **`from`** *Object* --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the mutation. @@ -571,7 +571,7 @@ Seam is in the process of pushing a suspension state update to the integrated ac --- - **`mutation_code`** *Format: `Enum`* + **`mutation_code`** *Enum*
Enum values: @@ -582,7 +582,7 @@ Seam is in the process of pushing a suspension state update to the integrated ac --- - **`to`** *Format: `Object`* + **`to`** *Object* @@ -592,7 +592,7 @@ Seam is in the process of pushing a suspension state update to the integrated ac Seam is in the process of pushing an access group membership update to the integrated access system. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which the mutation was created. @@ -600,7 +600,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`from`** *Format: `Object`* + **`from`** *Object* Old access group membership. @@ -608,7 +608,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the mutation. @@ -616,7 +616,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`mutation_code`** *Format: `Enum`* + **`mutation_code`** *Enum*
Enum values: @@ -627,7 +627,7 @@ Seam is in the process of pushing an access group membership update to the integ --- - **`to`** *Format: `Object`* + **`to`** *Object* New access group membership. @@ -697,7 +697,7 @@ Variants: 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -705,7 +705,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -713,7 +713,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum*
Enum values: @@ -728,7 +728,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -736,7 +736,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -744,7 +744,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum*
Enum values: @@ -759,7 +759,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce 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. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -767,7 +767,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -775,7 +775,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum*
Enum values: @@ -790,7 +790,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. - **`created_at`** *Format: `Datetime`* + **`created_at`** *Datetime* Date and time at which Seam created the warning. @@ -798,7 +798,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`message`** *Format: `String`* + **`message`** *String* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. @@ -806,7 +806,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce --- - **`warning_code`** *Format: `Enum`* + **`warning_code`** *Enum*
Enum values: From 256a993963efc8390517d74a766bf818159c97c9 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sat, 24 May 2025 02:37:09 +0000 Subject: [PATCH 5/6] ci: Generate docs --- docs/api/_blueprint.json | 32 +++++++++---------- .../update-multiple-linked-access-codes.md | 8 ----- docs/api/devices/device-provider-metadata.md | 2 -- 3 files changed, 16 insertions(+), 26 deletions(-) delete mode 100644 docs/api/access_codes/update-multiple-linked-access-codes.md delete mode 100644 docs/api/devices/device-provider-metadata.md diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index 1006fef2f..c55edd3c6 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -9423,7 +9423,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) for which you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9640,7 +9640,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session (or that are already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9726,7 +9726,7 @@ "title": "Grant Access to a Client Session", "name": "grant_access", "path": "/client_sessions/grant_access", - "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", + "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](../core-concepts/connect-webviews/README.md), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9761,7 +9761,7 @@ }, { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9868,7 +9868,7 @@ }, { "name": "connect_webview_id", - "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.", + "description": "ID of the [Connect Webview](../core-concepts/connect-webviews/README.md) for which you want to retrieve client sessions.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9993,7 +9993,7 @@ "title": "Create a Connect Webview", "name": "create", "path": "/connect_webviews/create", - "description": "Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).", + "description": "Creates a new [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](../core-concepts/connect-webviews/connect-webview-process.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10015,7 +10015,7 @@ "parameters": [ { "name": "accepted_providers", - "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", + "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10532,7 +10532,7 @@ }, { "name": "automatically_manage_new_devices", - "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10547,7 +10547,7 @@ }, { "name": "custom_metadata", - "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).", + "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10711,7 +10711,7 @@ }, { "name": "wait_for_device_creation", - "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10739,7 +10739,7 @@ "title": "Delete a Connect Webview", "name": "delete", "path": "/connect_webviews/delete", - "description": "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", + "description": "Deletes a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10785,7 +10785,7 @@ "title": "Get a Connect Webview", "name": "get", "path": "/connect_webviews/get", - "description": "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", + "description": "Returns a specified [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10834,7 +10834,7 @@ "title": "List Connect Webviews", "name": "list", "path": "/connect_webviews/list", - "description": "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).", + "description": "Returns a list of all [Connect Webviews](../core-concepts/connect-webviews/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10856,7 +10856,7 @@ "parameters": [ { "name": "custom_metadata_has", - "description": "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", + "description": "Custom metadata pairs by which you want to [filter Connect Webviews](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12963,7 +12963,7 @@ "title": "List Device Providers", "name": "list_device_providers", "path": "/devices/list_device_providers", - "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities/README.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", + "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](../core-concepts/connect-webviews/README.md), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40223,7 +40223,7 @@ "jsonType": "string" } ], - "description": "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", + "description": "Represents a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", "isDeprecated": false, "routePath": "/connect_webviews", "deprecationMessage": "", diff --git a/docs/api/access_codes/update-multiple-linked-access-codes.md b/docs/api/access_codes/update-multiple-linked-access-codes.md deleted file mode 100644 index 306c22bc7..000000000 --- a/docs/api/access_codes/update-multiple-linked-access-codes.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -description: >- - Update the starting and ending times for a set of linked access codes across - multiple devices. ---- - -# Update Multiple Linked Access Codes - diff --git a/docs/api/devices/device-provider-metadata.md b/docs/api/devices/device-provider-metadata.md deleted file mode 100644 index 6428342fc..000000000 --- a/docs/api/devices/device-provider-metadata.md +++ /dev/null @@ -1,2 +0,0 @@ -# Device Provider Metadata - From 7a124efcc8fb741d8571732e47c065a487783ff6 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 25 May 2025 23:06:10 +0000 Subject: [PATCH 6/6] ci: Generate docs --- docs/api/_blueprint.json | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index 1006fef2f..c55edd3c6 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -9423,7 +9423,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) for which you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9640,7 +9640,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session (or that are already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9726,7 +9726,7 @@ "title": "Grant Access to a Client Session", "name": "grant_access", "path": "/client_sessions/grant_access", - "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", + "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](../core-concepts/connect-webviews/README.md), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9761,7 +9761,7 @@ }, { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9868,7 +9868,7 @@ }, { "name": "connect_webview_id", - "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.", + "description": "ID of the [Connect Webview](../core-concepts/connect-webviews/README.md) for which you want to retrieve client sessions.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9993,7 +9993,7 @@ "title": "Create a Connect Webview", "name": "create", "path": "/connect_webviews/create", - "description": "Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).", + "description": "Creates a new [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](../core-concepts/connect-webviews/connect-webview-process.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10015,7 +10015,7 @@ "parameters": [ { "name": "accepted_providers", - "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", + "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10532,7 +10532,7 @@ }, { "name": "automatically_manage_new_devices", - "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10547,7 +10547,7 @@ }, { "name": "custom_metadata", - "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).", + "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10711,7 +10711,7 @@ }, { "name": "wait_for_device_creation", - "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10739,7 +10739,7 @@ "title": "Delete a Connect Webview", "name": "delete", "path": "/connect_webviews/delete", - "description": "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", + "description": "Deletes a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10785,7 +10785,7 @@ "title": "Get a Connect Webview", "name": "get", "path": "/connect_webviews/get", - "description": "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", + "description": "Returns a specified [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10834,7 +10834,7 @@ "title": "List Connect Webviews", "name": "list", "path": "/connect_webviews/list", - "description": "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).", + "description": "Returns a list of all [Connect Webviews](../core-concepts/connect-webviews/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10856,7 +10856,7 @@ "parameters": [ { "name": "custom_metadata_has", - "description": "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", + "description": "Custom metadata pairs by which you want to [filter Connect Webviews](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12963,7 +12963,7 @@ "title": "List Device Providers", "name": "list_device_providers", "path": "/devices/list_device_providers", - "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities/README.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", + "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](../core-concepts/connect-webviews/README.md), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40223,7 +40223,7 @@ "jsonType": "string" } ], - "description": "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", + "description": "Represents a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", "isDeprecated": false, "routePath": "/connect_webviews", "deprecationMessage": "",