From 4610d86cd42f24ce190d77dd5b6cca4043eb0f0d Mon Sep 17 00:00:00 2001 From: Evan Sosenko Date: Mon, 2 Jun 2025 13:03:01 -0700 Subject: [PATCH 1/2] Revert "Update types to v1.406.2 (#615)" This reverts commit 393355f09611cf365651c179e122938325211e04. --- docs/api/_blueprint.json | 2731 ++++++----------- docs/api/_report.md | 77 +- docs/api/access_codes/README.md | 138 +- docs/api/access_codes/create.md | 8 +- docs/api/access_codes/create_multiple.md | 8 +- docs/api/access_codes/unmanaged/README.md | 58 +- docs/api/access_codes/update.md | 8 +- docs/api/access_codes/update_multiple.md | 8 +- docs/api/acs/access_groups/README.md | 8 +- docs/api/acs/credentials/README.md | 32 +- docs/api/acs/encoders/README.md | 16 +- docs/api/acs/entrances/README.md | 12 +- docs/api/acs/entrances/grant_access.md | 10 +- docs/api/acs/systems/README.md | 118 +- docs/api/acs/users/README.md | 28 +- docs/api/acs/users/delete.md | 16 +- docs/api/acs/users/get.md | 16 +- .../acs/users/list_accessible_entrances.md | 16 +- .../api/acs/users/remove_from_access_group.md | 10 +- .../users/revoke_access_to_all_entrances.md | 16 +- docs/api/acs/users/suspend.md | 16 +- docs/api/acs/users/unsuspend.md | 16 +- docs/api/acs/users/update.md | 20 +- docs/api/pagination.md | 1177 +++++++ docs/api/phones/README.md | 27 +- docs/api/thermostats/README.md | 80 +- docs/api/unstable_partner/README.md | 12 - .../enrollment_automations/README.md | 4 +- package-lock.json | 16 +- package.json | 4 +- src/data/paths.yaml | 3 - 31 files changed, 2562 insertions(+), 2147 deletions(-) create mode 100644 docs/api/pagination.md delete mode 100644 docs/api/unstable_partner/README.md diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index b71be856c..b843a3939 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -217,7 +217,7 @@ }, { "name": "name", - "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -561,7 +561,7 @@ }, { "name": "name", - "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1329,7 +1329,7 @@ }, { "name": "name", - "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1526,7 +1526,7 @@ }, { "name": "name", - "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", + "description": "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6416,22 +6416,8 @@ }, { "name": "acs_user_id", - "description": "ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.", - "isRequired": false, + "description": "ID of the access system user to whom you want to grant access to an entrance.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7858,38 +7844,10 @@ "semanticMethod": "POST", "preferredMethod": "POST", "parameters": [ - { - "name": "acs_system_id", - "description": "ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "acs_user_id", - "description": "ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.", - "isRequired": false, + "description": "ID of the access system user that you want to delete.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8014,38 +7972,10 @@ "semanticMethod": "POST", "preferredMethod": "POST", "parameters": [ - { - "name": "acs_system_id", - "description": "ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "acs_user_id", - "description": "ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, + "description": "ID of the access system user that you want to get.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8418,38 +8348,10 @@ "semanticMethod": "POST", "preferredMethod": "POST", "parameters": [ - { - "name": "acs_system_id", - "description": "ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "acs_user_id", - "description": "ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, + "description": "ID of the access system user for whom you want to list accessible entrances.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8509,22 +8411,8 @@ }, { "name": "acs_user_id", - "description": "ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, + "description": "ID of the access system user that you want to remove from an access group.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8647,38 +8535,10 @@ "semanticMethod": "POST", "preferredMethod": "POST", "parameters": [ - { - "name": "acs_system_id", - "description": "ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "acs_user_id", - "description": "ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, + "description": "ID of the access system user for whom you want to revoke access.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8721,38 +8581,10 @@ "semanticMethod": "POST", "preferredMethod": "POST", "parameters": [ - { - "name": "acs_system_id", - "description": "ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "acs_user_id", - "description": "ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", - "isRequired": false, + "description": "ID of the access system user that you want to suspend.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8874,38 +8706,10 @@ "semanticMethod": "POST", "preferredMethod": "POST", "parameters": [ - { - "name": "acs_system_id", - "description": "ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "acs_user_id", - "description": "ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.", - "isRequired": false, + "description": "ID of the access system user that you want to unsuspend.", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9072,24 +8876,10 @@ } ] }, - { - "name": "acs_system_id", - "description": "ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "acs_user_id", - "description": "ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.", - "isRequired": false, + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isRequired": true, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9169,20 +8959,6 @@ "hasDefault": false, "format": "string", "jsonType": "string" - }, - { - "name": "user_identity_id", - "description": "ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" } ] }, @@ -9717,34 +9493,6 @@ "jsonType": "array", "itemFormat": "string" }, - { - "name": "customer_id", - "description": "", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "string", - "jsonType": "string" - }, - { - "name": "customer_key", - "description": "", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "string", - "jsonType": "string" - }, { "name": "expires_at", "description": "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", @@ -10885,20 +10633,6 @@ "format": "string", "jsonType": "string" }, - { - "name": "customer_id", - "description": "", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, { "name": "device_selection_mode", "description": "", @@ -11182,20 +10916,6 @@ "format": "record", "jsonType": "object" }, - { - "name": "customer_id", - "description": "", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "string", - "jsonType": "string" - }, { "name": "limit", "description": "Maximum number of records to return per page.", @@ -11479,52 +11199,6 @@ "workspaceScope": "required", "codeSamples": [] }, - { - "title": "Sync a Connected Account", - "name": "sync", - "path": "/connected_accounts/sync", - "description": "Request a [connected account](../core-concepts/connected-accounts/README.md) sync attempt for the specified connected_account_id.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "response": { - "responseType": "void", - "description": "OK" - }, - "request": { - "methods": [ - "POST" - ], - "semanticMethod": "POST", - "preferredMethod": "POST", - "parameters": [ - { - "name": "connected_account_id", - "description": "ID of the connected account that you want to sync.", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - } - ] - }, - "hasPagination": false, - "authMethods": [ - "api_key", - "personal_access_token" - ], - "workspaceScope": "required", - "codeSamples": [] - }, { "title": "Update a Connected Account", "name": "update", @@ -13173,7 +12847,7 @@ "draftMessage": "" }, { - "name": "dormakaba_oracode", + "name": "smartthings", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13183,7 +12857,7 @@ "draftMessage": "" }, { - "name": "tedee", + "name": "dormakaba_oracode", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13193,7 +12867,7 @@ "draftMessage": "" }, { - "name": "akiles", + "name": "tedee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13203,7 +12877,7 @@ "draftMessage": "" }, { - "name": "ecobee", + "name": "akiles", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13213,7 +12887,7 @@ "draftMessage": "" }, { - "name": "honeywell_resideo", + "name": "ecobee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13223,7 +12897,7 @@ "draftMessage": "" }, { - "name": "kwikset2", + "name": "honeywell_resideo", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13281,16 +12955,6 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" - }, - { - "name": "smartthings", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" } ] }, @@ -15247,7 +14911,7 @@ "draftMessage": "" }, { - "name": "dormakaba_oracode", + "name": "smartthings", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -15257,7 +14921,7 @@ "draftMessage": "" }, { - "name": "tedee", + "name": "dormakaba_oracode", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -15267,7 +14931,7 @@ "draftMessage": "" }, { - "name": "akiles", + "name": "tedee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -15277,7 +14941,7 @@ "draftMessage": "" }, { - "name": "ecobee", + "name": "akiles", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -15287,7 +14951,7 @@ "draftMessage": "" }, { - "name": "honeywell_resideo", + "name": "ecobee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -15297,7 +14961,7 @@ "draftMessage": "" }, { - "name": "kwikset2", + "name": "honeywell_resideo", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -15355,16 +15019,6 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" - }, - { - "name": "smartthings", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" } ] }, @@ -15519,7 +15173,7 @@ "parameters": [ { "name": "device_id", - "description": "Unique identifier for the device that triggered the event that you want to get.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15533,7 +15187,7 @@ }, { "name": "event_id", - "description": "Unique identifier for the event that you want to get.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15547,7 +15201,7 @@ }, { "name": "event_type", - "description": "Type of the event that you want to get.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15597,7 +15251,7 @@ "parameters": [ { "name": "access_code_id", - "description": "ID of the access code for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15611,7 +15265,7 @@ }, { "name": "access_code_ids", - "description": "IDs of the access codes for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15626,7 +15280,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15640,7 +15294,7 @@ }, { "name": "acs_system_ids", - "description": "IDs of the access systems for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15655,7 +15309,7 @@ }, { "name": "between", - "description": "Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15671,7 +15325,7 @@ }, { "name": "connect_webview_id", - "description": "IDs of the connected accounts for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15685,7 +15339,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15699,7 +15353,7 @@ }, { "name": "customer_ids", - "description": "IDs of the customers for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15714,7 +15368,7 @@ }, { "name": "device_id", - "description": "ID of the device for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15728,7 +15382,7 @@ }, { "name": "device_ids", - "description": "IDs of the devices for which you want to list events.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15743,7 +15397,7 @@ }, { "name": "event_ids", - "description": "IDs of the events that you want to list.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -15758,7 +15412,7 @@ }, { "name": "event_type", - "description": "Type of the events that you want to list.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -16654,7 +16308,7 @@ }, { "name": "event_types", - "description": "Types of the events that you want to list.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17551,7 +17205,7 @@ }, { "name": "limit", - "description": "Numerical limit on the number of events to return.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17566,7 +17220,7 @@ }, { "name": "since", - "description": "Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17580,7 +17234,7 @@ }, { "name": "unstable_offset", - "description": "Offset for the events that you want to list.", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -18810,6 +18464,16 @@ "isDraft": false, "draftMessage": "" }, + { + "name": "smartthings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, { "name": "wyze", "description": "", @@ -18919,26 +18583,6 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" - }, - { - "name": "kwikset2", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "smartthings", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" } ] }, @@ -21461,68 +21105,6 @@ "isDeprecated": false, "isDraft": false }, - { - "path": "/seam/partner/v1/resources", - "name": "resources", - "namespace": { - "path": "/seam/partner/v1", - "isDeprecated": false, - "isUndocumented": true, - "isDraft": false - }, - "endpoints": [ - { - "title": "List partner resources at Seam", - "name": "list", - "path": "/seam/partner/v1/resources/list", - "description": "List partner resources that have been pushed to Seam.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Partner building blocks/UI only.", - "isDraft": false, - "draftMessage": "", - "response": { - "responseType": "resource_list", - "responseKey": "partner_resources", - "resourceType": "unknown", - "description": "OK", - "actionAttemptType": null - }, - "request": { - "methods": [ - "POST" - ], - "semanticMethod": "POST", - "preferredMethod": "POST", - "parameters": [ - { - "name": "resource_type_alias", - "description": "Filter by resource type alias.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "string", - "jsonType": "string" - } - ] - }, - "hasPagination": false, - "authMethods": [], - "workspaceScope": "none", - "codeSamples": [] - } - ], - "subroutes": [], - "isUndocumented": true, - "isDeprecated": false, - "isDraft": false - }, { "path": "/thermostats", "name": "thermostats", @@ -23394,16 +22976,6 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" - }, - { - "name": "smartthings", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" } ] }, @@ -25072,7 +24644,7 @@ { "name": "name", "description": "User-friendly name to identify the thermostat daily program.", - "isRequired": true, + "isRequired": false, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -25215,7 +24787,7 @@ { "name": "name", "description": "User-friendly name to identify the thermostat daily program that you want to update.", - "isRequired": true, + "isRequired": false, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -26705,52 +26277,6 @@ "workspaceScope": "required", "codeSamples": [] }, - { - "title": "Delete an Access Grant", - "name": "delete", - "path": "/unstable_access_grants/delete", - "description": "Delete an access grant.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Unreleased.", - "isDraft": false, - "draftMessage": "", - "response": { - "responseType": "void", - "description": "OK" - }, - "request": { - "methods": [ - "POST" - ], - "semanticMethod": "POST", - "preferredMethod": "POST", - "parameters": [ - { - "name": "access_grant_id", - "description": "ID of access grant to delete.", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - } - ] - }, - "hasPagination": false, - "authMethods": [ - "personal_access_token", - "api_key" - ], - "workspaceScope": "required", - "codeSamples": [] - }, { "title": "Get an Access Grant", "name": "get", @@ -26903,10 +26429,10 @@ "namespace": null, "endpoints": [ { - "title": "Delete an Access Method", - "name": "delete", - "path": "/unstable_access_methods/delete", - "description": "Delete an access method.", + "title": "Get an Access Method", + "name": "get", + "path": "/unstable_access_methods/get", + "description": "Get an access method.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": true, @@ -26914,57 +26440,11 @@ "isDraft": false, "draftMessage": "", "response": { - "responseType": "void", - "description": "OK" - }, - "request": { - "methods": [ - "POST" - ], - "semanticMethod": "POST", - "preferredMethod": "POST", - "parameters": [ - { - "name": "access_method_id", - "description": "ID of access method to get.", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - } - ] - }, - "hasPagination": false, - "authMethods": [ - "personal_access_token", - "api_key" - ], - "workspaceScope": "required", - "codeSamples": [] - }, - { - "title": "Get an Access Method", - "name": "get", - "path": "/unstable_access_methods/get", - "description": "Get an access method.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Unreleased.", - "isDraft": false, - "draftMessage": "", - "response": { - "responseType": "resource", - "responseKey": "access_method", - "resourceType": "unknown", - "description": "OK", - "actionAttemptType": null + "responseType": "resource", + "responseKey": "access_method", + "resourceType": "unknown", + "description": "OK", + "actionAttemptType": null }, "request": { "methods": [ @@ -27698,103 +27178,13 @@ "isDeprecated": false, "isDraft": false }, - { - "path": "/unstable_partner/building_blocks", - "name": "building_blocks", - "namespace": { - "path": "/unstable_partner", - "isDeprecated": false, - "isUndocumented": false, - "isDraft": false - }, - "endpoints": [ - { - "title": "Generate a building block magic link", - "name": "generate_link", - "path": "/unstable_partner/building_blocks/generate_link", - "description": "Creates a new bridge client session.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "response": { - "responseType": "resource", - "responseKey": "bridge_client_session", - "resourceType": "unknown", - "description": "OK", - "actionAttemptType": null - }, - "request": { - "methods": [ - "POST" - ], - "semanticMethod": "POST", - "preferredMethod": "POST", - "parameters": [ - { - "name": "bridge_client_machine_identifier_key", - "description": "", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "string", - "jsonType": "string" - }, - { - "name": "bridge_client_name", - "description": "", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "string", - "jsonType": "string" - }, - { - "name": "bridge_client_time_zone", - "description": "", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "string", - "jsonType": "string" - } - ] - }, - "hasPagination": false, - "authMethods": [], - "workspaceScope": "none", - "codeSamples": [] - } - ], - "subroutes": [], - "isUndocumented": false, - "isDeprecated": false, - "isDraft": false - }, { "path": "/unstable_partner/resources", "name": "resources", "namespace": { "path": "/unstable_partner", "isDeprecated": false, - "isUndocumented": false, + "isUndocumented": true, "isDraft": false }, "endpoints": [ @@ -27890,6 +27280,20 @@ "format": "string", "jsonType": "string" }, + { + "name": "icon_url", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, { "name": "location_keys", "description": "", @@ -34063,7 +33467,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -34076,7 +33480,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -34089,7 +33493,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -34145,7 +33549,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -34158,7 +33562,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -34171,7 +33575,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -34183,7 +33587,7 @@ "jsonType": "string" } ], - "description": "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)." + "description": "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.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -34293,7 +33697,7 @@ }, { "name": "name", - "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", + "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -34332,7 +33736,7 @@ }, { "name": "status", - "description": "Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).", + "description": "Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -35592,7 +34996,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -36020,7 +35423,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -36917,7 +36319,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "door_name", @@ -37066,7 +36467,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "access_point_name", @@ -37137,7 +36537,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "accessibility_type", @@ -37205,7 +36604,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "battery_level", @@ -37325,7 +36723,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "door_description", @@ -37380,7 +36777,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "door_category", @@ -37590,6 +36986,136 @@ "format": "number", "jsonType": "number" }, + { + "name": "can_add_acs_users_to_acs_access_groups", + "description": "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_automate_enrollment", + "description": "Indicates whether it is possible to [launch enrollment automations](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_create_acs_access_groups", + "description": "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_create_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_delete_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remove_acs_users_from_acs_access_groups", + "description": "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_group_membership", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_information", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_schedule", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_supension_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, { "name": "connected_account_id", "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", @@ -38274,7 +37800,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "time_zone", @@ -38474,7 +37999,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "lan_address", @@ -38731,7 +38255,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "ends_at", @@ -38787,19 +38310,6 @@ "format": "id", "jsonType": "string" }, - { - "name": "connected_account_id", - "description": "\n The ID of the [connected account](../core-concepts/connected-accounts/README.md) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).\n ", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, { "name": "created_at", "description": "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", @@ -39522,7 +39032,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "email_address", @@ -39615,7 +39124,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "email_address", @@ -39688,7 +39196,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "ends_at", @@ -39768,7 +39275,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "ends_at", @@ -39828,7 +39334,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "is_suspended", @@ -39895,7 +39400,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "is_suspended", @@ -39942,7 +39446,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "acs_access_group_id", @@ -40009,7 +39512,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "acs_access_group_id", @@ -40529,7 +40031,7 @@ }, { "name": "accepted_providers", - "description": "List of accepted [provider keys](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40556,7 +40058,7 @@ }, { "name": "any_provider_allowed", - "description": "Indicates whether any provider is allowed.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40569,7 +40071,7 @@ }, { "name": "authorized_at", - "description": "Date and time at which the user authorized (through the Connect Webview) the management of their devices.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40582,7 +40084,7 @@ }, { "name": "automatically_manage_new_devices", - "description": "Indicates whether Seam should [import all new devices](../core-concepts/connect-webviews/customizing-connect-webviews.md#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40595,7 +40097,7 @@ }, { "name": "connect_webview_id", - "description": "ID of the Connect Webview.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40608,7 +40110,7 @@ }, { "name": "connected_account_id", - "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md) associated with the Connect Webview.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40621,7 +40123,7 @@ }, { "name": "created_at", - "description": "Date and time at which the Connect Webview was created.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40634,7 +40136,7 @@ }, { "name": "custom_metadata", - "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md), [connected account](../core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md), or [device](../core-concepts/devices/adding-custom-metadata-to-a-device.md), enables you to store custom information, like customer details or internal IDs from your application.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40647,7 +40149,7 @@ }, { "name": "custom_redirect_failure_url", - "description": "URL to which the Connect Webview should redirect when an unexpected error occurs.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40660,7 +40162,7 @@ }, { "name": "custom_redirect_url", - "description": "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40718,7 +40220,7 @@ }, { "name": "login_successful", - "description": "Indicates whether the user logged in successfully using the Connect Webview.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40731,7 +40233,7 @@ }, { "name": "selected_provider", - "description": "Selected provider of the Connect Webview, one of the [provider keys](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40744,7 +40246,7 @@ }, { "name": "status", - "description": "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40789,7 +40291,7 @@ }, { "name": "url", - "description": "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40802,7 +40304,7 @@ }, { "name": "wait_for_device_creation", - "description": "Indicates whether Seam should [finish syncing all devices](../core-concepts/connect-webviews/customizing-connect-webviews.md#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40815,7 +40317,7 @@ }, { "name": "workspace_id", - "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the Connect Webview.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40843,7 +40345,7 @@ "properties": [ { "name": "account_type", - "description": "Type of connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40856,7 +40358,7 @@ }, { "name": "account_type_display_name", - "description": "Display name for the connected account type.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40869,7 +40371,7 @@ }, { "name": "automatically_manage_new_devices", - "description": "Indicates whether Seam should [import all new devices](../core-concepts/connect-webviews/customizing-connect-webviews.md#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40882,7 +40384,7 @@ }, { "name": "connected_account_id", - "description": "Unique identifier for the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40895,7 +40397,7 @@ }, { "name": "created_at", - "description": "Date and time at which the connected account was created.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40908,7 +40410,7 @@ }, { "name": "custom_metadata", - "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md), [connected account](../core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md), or [device](../core-concepts/devices/adding-custom-metadata-to-a-device.md), enables you to store custom information, like customer details or internal IDs from your application.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40921,7 +40423,7 @@ }, { "name": "errors", - "description": "Errors associated with the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40976,7 +40478,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40989,7 +40491,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41002,7 +40504,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41058,7 +40560,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41071,7 +40573,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41084,7 +40586,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41140,7 +40642,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41153,7 +40655,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41166,7 +40668,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41178,7 +40680,7 @@ "jsonType": "string" } ], - "description": "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)." + "description": "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.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." }, { "properties": [ @@ -41222,7 +40724,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41235,7 +40737,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41248,7 +40750,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41261,7 +40763,7 @@ }, { "name": "salto_ks_metadata", - "description": "Salto KS metadata associated with the connected account that has an error.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41271,11 +40773,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "sites", - "description": "Salto sites associated with the connected account that has an error.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41289,7 +40790,7 @@ "itemProperties": [ { "name": "site_id", - "description": "ID of a Salto site associated with the connected account that has an error.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41302,7 +40803,7 @@ }, { "name": "site_name", - "description": "Name of a Salto site associated with the connected account that has an error.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41315,7 +40816,7 @@ }, { "name": "site_user_subscription_limit", - "description": "Subscription limit of site users for a Salto site associated with the connected account that has an error.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41328,7 +40829,7 @@ }, { "name": "subscribed_site_user_count", - "description": "Count of subscribed site users for a Salto site associated with the connected account that has an error.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41350,7 +40851,7 @@ }, { "name": "user_identifier", - "description": "User identifier associated with the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41360,11 +40861,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "api_url", - "description": "API URL for the user identifier associated with the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41377,7 +40877,7 @@ }, { "name": "email", - "description": "Email address of the user identifier associated with the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41390,7 +40890,7 @@ }, { "name": "exclusive", - "description": "Indicates whether the user identifier associated with the connected account is exclusive.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41403,7 +40903,7 @@ }, { "name": "phone", - "description": "Phone number of the user identifier associated with the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41416,7 +40916,7 @@ }, { "name": "username", - "description": "Username of the user identifier associated with the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41431,7 +40931,7 @@ }, { "name": "warnings", - "description": "Warnings associated with the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41461,7 +40961,7 @@ }, { "name": "message", - "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41498,7 +40998,7 @@ ] } ], - "description": "Scheduled downtime planned for the connected account." + "description": "Scheduled downtime for account planned." }, { "properties": [ @@ -41517,7 +41017,7 @@ }, { "name": "message", - "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41554,7 +41054,7 @@ ] } ], - "description": "An unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account." + "description": "An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account." }, { "properties": [ @@ -41573,7 +41073,7 @@ }, { "name": "message", - "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41586,7 +41086,7 @@ }, { "name": "salto_ks_metadata", - "description": "Salto KS metadata associated with the connected account that has a warning.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41596,11 +41096,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "sites", - "description": "Salto sites associated with the connected account that has a warning.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41614,7 +41113,7 @@ "itemProperties": [ { "name": "site_id", - "description": "ID of a Salto site associated with the connected account that has a warning.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41627,7 +41126,7 @@ }, { "name": "site_name", - "description": "Name of a Salto site associated with the connected account that has a warning.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41640,7 +41139,7 @@ }, { "name": "site_user_subscription_limit", - "description": "Subscription limit of site users for a Salto site associated with the connected account that has a warning.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41653,7 +41152,7 @@ }, { "name": "subscribed_site_user_count", - "description": "Count of subscribed site users for a Salto site associated with the connected account that has a warning.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41694,7 +41193,7 @@ ] } ], - "description": "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." + "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this." } ] } @@ -41858,7 +41357,7 @@ }, { "name": "capabilities_supported", - "description": "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags).\n ", + "description": "Collection of capabilities that the device supports when connected to Seam. Values are \"access_code,\" which indicates that the device can manage and utilize digital PIN codes for secure access; \"lock,\" which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; \"noise_detection,\" which indicates that the device supports monitoring and responding to ambient noise levels; \"thermostat,\" which indicates that the device can regulate and adjust indoor temperatures; and \"battery,\" which indicates that the device can manage battery life and health.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -41960,7 +41459,7 @@ }, { "name": "custom_metadata", - "description": "Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md), [connected account](../core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md), or [device](../core-concepts/devices/adding-custom-metadata-to-a-device.md), enables you to store custom information, like customer details or internal IDs from your application.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43362,7 +42861,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43375,7 +42874,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43388,7 +42887,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43444,7 +42943,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43457,7 +42956,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43470,7 +42969,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43482,7 +42981,7 @@ "jsonType": "string" } ], - "description": "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)." + "description": "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.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -43508,14 +43007,13 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "location_name", - "description": "Name of the device location.\n ", + "description": "Name of the device location.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43528,7 +43026,7 @@ }, { "name": "timezone", - "description": "Time zone of the device location.\n ", + "description": "Time zone of the device location.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43566,54 +43064,23 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": { - "access_codes": { - "name": "Access Codes", - "propertyGroupKey": "access_codes" - }, - "hardware": { - "name": "Hardware", - "propertyGroupKey": "hardware" - }, - "locks": { - "name": "Locks", - "propertyGroupKey": "locks" - }, - "noise_sensors": { - "name": "Noise Sensors", - "propertyGroupKey": "noise_sensors" - }, - "phones": { - "name": "Phones", - "propertyGroupKey": "phones" - }, - "provider_metadata": { - "name": "Provider Metadata", - "propertyGroupKey": "provider_metadata" - }, - "thermostats": { - "name": "Thermostats", - "propertyGroupKey": "thermostats" - } - }, "properties": [ { "name": "accessory_keypad", - "description": "Accessory keypad properties and state.", + "description": "Represents the accessory keypad state.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "battery", - "description": "Keypad battery properties.\n ", + "description": "Indicates if the keypad battery properties.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43623,7 +43090,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "level", @@ -43642,7 +43108,7 @@ }, { "name": "is_connected", - "description": "Indicates if an accessory keypad is connected to the device.\n ", + "description": "Indicates if the accessory_keypad is connected to the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43657,17 +43123,16 @@ }, { "name": "appearance", - "description": "Appearance-related properties, as reported by the device.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "name", @@ -43686,21 +43151,20 @@ }, { "name": "battery", - "description": "Represents the current status of the battery charge level.", + "description": "Represents the current status of the battery charge level. Values are \"critical,\" which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; \"low,\" which signifies that the battery is under the preferred threshold and should be charged soon; \"good,\" which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and \"full,\" which represents a battery that is fully charged, providing the maximum duration of usage.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "level", - "description": "Battery charge level as a value between 0 and 1, inclusive.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43713,7 +43177,7 @@ }, { "name": "status", - "description": "Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43777,7 +43241,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, @@ -43790,7 +43254,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "noise_sensors", + "propertyGroupKey": null, "format": "list", "jsonType": "array", "itemFormat": "string" @@ -43804,7 +43268,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, @@ -43817,7 +43281,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, @@ -43830,7 +43294,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, @@ -43843,13 +43307,13 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, { "name": "model", - "description": "Device model-related properties.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43859,7 +43323,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "accessory_keypad_supported", @@ -43876,7 +43339,7 @@ }, { "name": "can_connect_accessory_keypad", - "description": "\n Indicates whether the device can connect a accessory keypad.\n ", + "description": "Indicates whether the device can connect a accessory keypad.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43889,7 +43352,7 @@ }, { "name": "display_name", - "description": "\n Display name of the device model.\n ", + "description": "Display name of the device model.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43902,7 +43365,7 @@ }, { "name": "has_built_in_keypad", - "description": "\n Indicates whether the device has a built in accessory keypad.\n ", + "description": "Indicates whether the device has a built in accessory keypad.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43915,7 +43378,7 @@ }, { "name": "manufacturer_display_name", - "description": "\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ", + "description": "Display name that corresponds to the manufacturer-specific terminology for the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43928,9 +43391,9 @@ }, { "name": "offline_access_codes_supported", - "description": "", - "isDeprecated": true, - "deprecationMessage": "use device.can_program_offline_access_codes.", + "description": "Indicates whether the device supports offline access codes.", + "isDeprecated": false, + "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, @@ -43941,9 +43404,9 @@ }, { "name": "online_access_codes_supported", - "description": "", - "isDeprecated": true, - "deprecationMessage": "use device.can_program_online_access_codes.", + "description": "Indicates whether the device supports online access codes.", + "isDeprecated": false, + "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, @@ -43976,7 +43439,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "noise_sensors", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, @@ -43989,7 +43452,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, @@ -44015,7 +43478,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, @@ -44028,7 +43491,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, @@ -44041,7 +43504,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, @@ -44054,7 +43517,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, @@ -44070,7 +43533,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "endpoints", @@ -44141,7 +43603,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "has_active_phone", @@ -44160,7 +43621,7 @@ }, { "name": "akiles_metadata", - "description": "Metadata for an Akiles device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44170,11 +43631,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "_member_group_id", - "description": "Group ID to which to add users for an Akiles device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44187,7 +43647,7 @@ }, { "name": "gadget_id", - "description": "Gadget ID for an Akiles device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44200,7 +43660,7 @@ }, { "name": "gadget_name", - "description": "Gadget name for an Akiles device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44213,7 +43673,7 @@ }, { "name": "product_name", - "description": "Product name for an Akiles device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44228,7 +43688,7 @@ }, { "name": "assa_abloy_vostio_metadata", - "description": "Metadata for an ASSA ABLOY Vostio system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44238,11 +43698,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "encoder_name", - "description": "Encoder name for an ASSA ABLOY Vostio system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44257,7 +43716,7 @@ }, { "name": "august_metadata", - "description": "Metadata for an August device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44267,11 +43726,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "has_keypad", - "description": "Indicates whether an August device has a keypad.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44284,7 +43742,7 @@ }, { "name": "house_id", - "description": "House ID for an August device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44297,7 +43755,7 @@ }, { "name": "house_name", - "description": "House name for an August device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44310,7 +43768,7 @@ }, { "name": "keypad_battery_level", - "description": "Keypad battery level for an August device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44323,7 +43781,7 @@ }, { "name": "lock_id", - "description": "Lock ID for an August device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44336,7 +43794,7 @@ }, { "name": "lock_name", - "description": "Lock name for an August device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44349,7 +43807,7 @@ }, { "name": "model", - "description": "Model for an August device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44364,7 +43822,7 @@ }, { "name": "avigilon_alta_metadata", - "description": "Metadata for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44374,11 +43832,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "entry_name", - "description": "Entry name for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44391,7 +43848,7 @@ }, { "name": "entry_relays_total_count", - "description": "Total count of entry relays for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44404,7 +43861,7 @@ }, { "name": "org_name", - "description": "Organization name for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44417,7 +43874,7 @@ }, { "name": "site_id", - "description": "Site ID for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44430,7 +43887,7 @@ }, { "name": "site_name", - "description": "Site name for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44443,7 +43900,7 @@ }, { "name": "zone_id", - "description": "Zone ID for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44456,7 +43913,7 @@ }, { "name": "zone_name", - "description": "Zone name for an Avigilon Alta system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44471,7 +43928,7 @@ }, { "name": "brivo_metadata", - "description": "Metadata for a Brivo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44481,11 +43938,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_name", - "description": "Device name for a Brivo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44500,7 +43956,7 @@ }, { "name": "controlbyweb_metadata", - "description": "Metadata for a ControlByWeb device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44510,11 +43966,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a ControlByWeb device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44527,7 +43982,7 @@ }, { "name": "device_name", - "description": "Device name for a ControlByWeb device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44540,7 +43995,7 @@ }, { "name": "relay_name", - "description": "Relay name for a ControlByWeb device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44555,7 +44010,7 @@ }, { "name": "dormakaba_oracode_metadata", - "description": "Metadata for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44565,11 +44020,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44579,12 +44033,11 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { "name": "door_id", - "description": "Door ID for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44597,7 +44050,7 @@ }, { "name": "door_is_wireless", - "description": "Indicates whether a door is wireless for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44610,7 +44063,7 @@ }, { "name": "door_name", - "description": "Door name for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44623,7 +44076,7 @@ }, { "name": "iana_timezone", - "description": "IANA time zone for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44636,7 +44089,7 @@ }, { "name": "predefined_time_slots", - "description": "Predefined time slots for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44650,7 +44103,7 @@ "itemProperties": [ { "name": "check_in_time", - "description": "Check in time for a time slot for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44663,7 +44116,7 @@ }, { "name": "check_out_time", - "description": "Checkout time for a time slot for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44676,7 +44129,7 @@ }, { "name": "dormakaba_oracode_user_level_id", - "description": "ID of a user level for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44689,7 +44142,7 @@ }, { "name": "ext_dormakaba_oracode_user_level_prefix", - "description": "Prefix for a user level for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44702,7 +44155,7 @@ }, { "name": "is_24_hour", - "description": "Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44715,7 +44168,7 @@ }, { "name": "is_biweekly_mode", - "description": "Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44728,7 +44181,7 @@ }, { "name": "is_master", - "description": "Indicates whether a time slot for a dormakaba Oracode device is a master time slot.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44741,7 +44194,7 @@ }, { "name": "is_one_shot", - "description": "Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44754,7 +44207,7 @@ }, { "name": "name", - "description": "Name of a time slot for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44767,7 +44220,7 @@ }, { "name": "prefix", - "description": "Prefix for a time slot for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44782,9 +44235,9 @@ }, { "name": "site_id", - "description": "Site ID for a dormakaba Oracode device.", - "isDeprecated": true, - "deprecationMessage": "Previously marked as \"@DEPRECATED.\"", + "description": "@DEPRECATED", + "isDeprecated": false, + "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, @@ -44795,7 +44248,7 @@ }, { "name": "site_name", - "description": "Site name for a dormakaba Oracode device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44810,7 +44263,7 @@ }, { "name": "ecobee_metadata", - "description": "Metadata for an ecobee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44820,11 +44273,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_name", - "description": "Device name for an ecobee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44837,7 +44289,7 @@ }, { "name": "ecobee_device_id", - "description": "Device ID for an ecobee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44852,7 +44304,7 @@ }, { "name": "four_suites_metadata", - "description": "Metadata for a 4SUITES device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44862,11 +44314,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a 4SUITES device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44879,7 +44330,7 @@ }, { "name": "device_name", - "description": "Device name for a 4SUITES device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44892,7 +44343,7 @@ }, { "name": "reclose_delay_in_seconds", - "description": "Reclose delay, in seconds, for a 4SUITES device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44907,7 +44358,7 @@ }, { "name": "genie_metadata", - "description": "Metadata for a Genie device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44917,11 +44368,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_name", - "description": "Lock name for a Genie device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44934,7 +44384,7 @@ }, { "name": "door_name", - "description": "Door name for a Genie device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44949,7 +44399,7 @@ }, { "name": "honeywell_resideo_metadata", - "description": "Metadata for a Honeywell Resideo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44959,11 +44409,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_name", - "description": "Device name for a Honeywell Resideo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44976,7 +44425,7 @@ }, { "name": "honeywell_resideo_device_id", - "description": "Device ID for a Honeywell Resideo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44991,7 +44440,7 @@ }, { "name": "hubitat_metadata", - "description": "Metadata for a Hubitat device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45001,11 +44450,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Hubitat device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45018,7 +44466,7 @@ }, { "name": "device_label", - "description": "Device label for a Hubitat device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45031,7 +44479,7 @@ }, { "name": "device_name", - "description": "Device name for a Hubitat device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45046,7 +44494,7 @@ }, { "name": "igloo_metadata", - "description": "Metadata for an igloo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45056,11 +44504,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "bridge_id", - "description": "Bridge ID for an igloo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45073,7 +44520,7 @@ }, { "name": "device_id", - "description": "Device ID for an igloo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45086,7 +44533,7 @@ }, { "name": "model", - "description": "Model for an igloo device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45101,7 +44548,7 @@ }, { "name": "igloohome_metadata", - "description": "Metadata for an igloohome device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45111,11 +44558,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "bridge_id", - "description": "Bridge ID for an igloohome device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45128,7 +44574,7 @@ }, { "name": "bridge_name", - "description": "Bridge name for an igloohome device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45141,7 +44587,7 @@ }, { "name": "device_id", - "description": "Device ID for an igloohome device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45154,7 +44600,7 @@ }, { "name": "device_name", - "description": "Device name for an igloohome device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45167,7 +44613,7 @@ }, { "name": "keypad_id", - "description": "Keypad ID for an igloohome device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45182,7 +44628,7 @@ }, { "name": "kwikset_metadata", - "description": "Metadata for a Kwikset device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45192,11 +44638,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Kwikset device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45209,7 +44654,7 @@ }, { "name": "device_name", - "description": "Device name for a Kwikset device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45222,7 +44667,7 @@ }, { "name": "model_number", - "description": "Model number for a Kwikset device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45237,7 +44682,7 @@ }, { "name": "lockly_metadata", - "description": "Metadata for a Lockly device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45247,11 +44692,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Lockly device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45264,7 +44708,7 @@ }, { "name": "device_name", - "description": "Device name for a Lockly device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45277,7 +44721,7 @@ }, { "name": "model", - "description": "Model for a Lockly device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45292,7 +44736,7 @@ }, { "name": "minut_metadata", - "description": "Metadata for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45302,11 +44746,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45319,7 +44762,7 @@ }, { "name": "device_name", - "description": "Device name for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45332,7 +44775,7 @@ }, { "name": "latest_sensor_values", - "description": "Latest sensor values for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45342,11 +44785,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "accelerometer_z", - "description": "Latest accelerometer Z-axis reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45356,11 +44798,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "time", - "description": "Time of latest accelerometer Z-axis reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45373,7 +44814,7 @@ }, { "name": "value", - "description": "Value of latest accelerometer Z-axis reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45388,7 +44829,7 @@ }, { "name": "humidity", - "description": "Latest humidity reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45398,11 +44839,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "time", - "description": "Time of latest humidity reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45415,7 +44855,7 @@ }, { "name": "value", - "description": "Value of latest humidity reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45430,7 +44870,7 @@ }, { "name": "pressure", - "description": "Latest pressure reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45440,11 +44880,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "time", - "description": "Time of latest pressure reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45457,7 +44896,7 @@ }, { "name": "value", - "description": "Value of latest pressure reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45472,7 +44911,7 @@ }, { "name": "sound", - "description": "Latest sound reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45482,11 +44921,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "time", - "description": "Time of latest sound reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45499,7 +44937,7 @@ }, { "name": "value", - "description": "Value of latest sound reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45514,7 +44952,7 @@ }, { "name": "temperature", - "description": "Latest temperature reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45524,11 +44962,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "time", - "description": "Time of latest temperature reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45541,7 +44978,7 @@ }, { "name": "value", - "description": "Value of latest temperature reading for a Minut device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45560,7 +44997,7 @@ }, { "name": "nest_metadata", - "description": "Metadata for a Google Nest device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45570,11 +45007,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_custom_name", - "description": "Custom device name for a Google Nest device. The device owner sets this value.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45587,7 +45023,7 @@ }, { "name": "device_name", - "description": "Device name for a Google Nest device. Google sets this value.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45600,7 +45036,7 @@ }, { "name": "display_name", - "description": "Display name for a Google Nest device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45613,7 +45049,7 @@ }, { "name": "nest_device_id", - "description": "Device ID for a Google Nest device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45628,7 +45064,7 @@ }, { "name": "noiseaware_metadata", - "description": "Metadata for a NoiseAware device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45638,11 +45074,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a NoiseAware device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45655,7 +45090,7 @@ }, { "name": "device_model", - "description": "Device model for a NoiseAware device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45690,7 +45125,7 @@ }, { "name": "device_name", - "description": "Device name for a NoiseAware device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45703,7 +45138,7 @@ }, { "name": "noise_level_decibel", - "description": "Noise level, in decibels, for a NoiseAware device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45716,7 +45151,7 @@ }, { "name": "noise_level_nrs", - "description": "Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45731,7 +45166,7 @@ }, { "name": "nuki_metadata", - "description": "Metadata for a Nuki device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45741,11 +45176,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Nuki device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45758,7 +45192,7 @@ }, { "name": "device_name", - "description": "Device name for a Nuki device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45771,7 +45205,7 @@ }, { "name": "keypad_2_paired", - "description": "Indicates whether keypad 2 is paired for a Nuki device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45784,7 +45218,7 @@ }, { "name": "keypad_battery_critical", - "description": "Indicates whether the keypad battery is in a critical state for a Nuki device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45797,7 +45231,7 @@ }, { "name": "keypad_paired", - "description": "Indicates whether the keypad is paired for a Nuki device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45812,7 +45246,7 @@ }, { "name": "salto_ks_metadata", - "description": "Metadata for a Salto KS device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45822,11 +45256,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "battery_level", - "description": "Battery level for a Salto KS device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45839,7 +45272,7 @@ }, { "name": "customer_reference", - "description": "Customer reference for a Salto KS device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45852,7 +45285,7 @@ }, { "name": "lock_id", - "description": "Lock ID for a Salto KS device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45865,7 +45298,7 @@ }, { "name": "lock_type", - "description": "Lock type for a Salto KS device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45878,7 +45311,7 @@ }, { "name": "locked_state", - "description": "Locked state for a Salto KS device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45891,7 +45324,7 @@ }, { "name": "model", - "description": "Model for a Salto KS device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45906,9 +45339,9 @@ }, { "name": "salto_metadata", - "description": "Metada for a Salto device.", - "isDeprecated": true, - "deprecationMessage": "Use `salto_ks_metadata ` instead.", + "description": "\n ---\n deprecated: Use `salto_ks_metadata ` instead.\n ", + "isDeprecated": false, + "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, @@ -45916,11 +45349,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "battery_level", - "description": "Battery level for a Salto device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45933,7 +45365,7 @@ }, { "name": "customer_reference", - "description": "Customer reference for a Salto device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45946,7 +45378,7 @@ }, { "name": "lock_id", - "description": "Lock ID for a Salto device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45959,7 +45391,7 @@ }, { "name": "lock_type", - "description": "Lock type for a Salto device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45972,7 +45404,7 @@ }, { "name": "locked_state", - "description": "Locked state for a Salto device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45985,7 +45417,7 @@ }, { "name": "model", - "description": "Model for a Salto device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46000,7 +45432,7 @@ }, { "name": "schlage_metadata", - "description": "Metadata for a Schlage device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46010,11 +45442,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Schlage device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46027,7 +45458,7 @@ }, { "name": "device_name", - "description": "Device name for a Schlage device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46040,7 +45471,7 @@ }, { "name": "model", - "description": "Model for a Schlage device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46055,7 +45486,7 @@ }, { "name": "seam_bridge_metadata", - "description": "Metadata for Seam Bridge.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46065,11 +45496,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_num", - "description": "Device number for Seam Bridge.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46082,7 +45512,7 @@ }, { "name": "name", - "description": "Name for Seam Bridge.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46095,7 +45525,7 @@ }, { "name": "unlock_method", - "description": "Unlock method for Seam Bridge.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46132,7 +45562,7 @@ }, { "name": "sensi_metadata", - "description": "Metadata for a Sensi device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46142,11 +45572,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Sensi device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46159,7 +45588,7 @@ }, { "name": "device_name", - "description": "Device name for a Sensi device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46172,7 +45601,7 @@ }, { "name": "product_type", - "description": "Product type for a Sensi device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46187,7 +45616,7 @@ }, { "name": "smartthings_metadata", - "description": "Metadata for a SmartThings device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46197,11 +45626,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a SmartThings device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46214,7 +45642,7 @@ }, { "name": "device_name", - "description": "Device name for a SmartThings device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46227,7 +45655,7 @@ }, { "name": "location_id", - "description": "Location ID for a SmartThings device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46240,7 +45668,7 @@ }, { "name": "model", - "description": "Model for a SmartThings device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46255,7 +45683,7 @@ }, { "name": "tado_metadata", - "description": "Metadata for a tado° device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46265,11 +45693,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_type", - "description": "Device type for a tado° device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46282,7 +45709,7 @@ }, { "name": "serial_no", - "description": "Serial number for a tado° device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46297,7 +45724,7 @@ }, { "name": "tedee_metadata", - "description": "Metadata for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46307,11 +45734,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "bridge_id", - "description": "Bridge ID for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46324,7 +45750,7 @@ }, { "name": "bridge_name", - "description": "Bridge name for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46337,7 +45763,7 @@ }, { "name": "device_id", - "description": "Device ID for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46350,7 +45776,7 @@ }, { "name": "device_model", - "description": "Device model for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46363,7 +45789,7 @@ }, { "name": "device_name", - "description": "Device name for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46376,7 +45802,7 @@ }, { "name": "keypad_id", - "description": "Keypad ID for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46389,7 +45815,7 @@ }, { "name": "serial_number", - "description": "Serial number for a Tedee device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46404,7 +45830,7 @@ }, { "name": "ttlock_metadata", - "description": "Metadata for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46414,11 +45840,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "feature_value", - "description": "Feature value for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46431,7 +45856,7 @@ }, { "name": "features", - "description": "Features for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46441,11 +45866,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "incomplete_keyboard_passcode", - "description": "Indicates whether a TTLock device supports an incomplete keyboard passcode.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46458,7 +45882,7 @@ }, { "name": "lock_command", - "description": "Indicates whether a TTLock device supports the lock command.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46471,7 +45895,7 @@ }, { "name": "passcode", - "description": "Indicates whether a TTLock device supports a passcode.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46484,7 +45908,7 @@ }, { "name": "passcode_management", - "description": "Indicates whether a TTLock device supports passcode management.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46497,7 +45921,7 @@ }, { "name": "unlock_via_gateway", - "description": "Indicates whether a TTLock device supports unlock via gateway.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46510,7 +45934,7 @@ }, { "name": "wifi", - "description": "Indicates whether a TTLock device supports Wi-Fi.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46525,7 +45949,7 @@ }, { "name": "has_gateway", - "description": "Indicates whether a TTLock device has a gateway.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46538,7 +45962,7 @@ }, { "name": "lock_alias", - "description": "Lock alias for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46551,7 +45975,7 @@ }, { "name": "lock_id", - "description": "Lock ID for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46564,7 +45988,7 @@ }, { "name": "wireless_keypads", - "description": "Wireless keypads for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46578,7 +46002,7 @@ "itemProperties": [ { "name": "wireless_keypad_id", - "description": "ID for a wireless keypad for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46591,7 +46015,7 @@ }, { "name": "wireless_keypad_name", - "description": "Name for a wireless keypad for a TTLock device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46608,7 +46032,7 @@ }, { "name": "two_n_metadata", - "description": "Metadata for a 2N device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46618,11 +46042,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a 2N device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46635,7 +46058,7 @@ }, { "name": "device_name", - "description": "Device name for a 2N device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46650,7 +46073,7 @@ }, { "name": "visionline_metadata", - "description": "Metadata for an ASSA ABLOY Visionline system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46660,11 +46083,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "encoder_id", - "description": "Encoder ID for an ASSA ABLOY Visionline system.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46679,7 +46101,7 @@ }, { "name": "wyze_metadata", - "description": "Metadata for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46689,11 +46111,10 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "device_id", - "description": "Device ID for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46706,7 +46127,7 @@ }, { "name": "device_info_model", - "description": "Device information model for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46719,7 +46140,7 @@ }, { "name": "device_name", - "description": "Device name for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46732,7 +46153,7 @@ }, { "name": "keypad_uuid", - "description": "Keypad UUID for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46745,7 +46166,7 @@ }, { "name": "locker_status_hardlock", - "description": "Locker status (hardlock) for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46758,7 +46179,7 @@ }, { "name": "product_model", - "description": "Product model for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46771,7 +46192,7 @@ }, { "name": "product_name", - "description": "Product name for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46784,7 +46205,7 @@ }, { "name": "product_type", - "description": "Product type for a Wyze device.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46802,8 +46223,8 @@ "description": "", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Marked as experimental.", + "isUndocumented": false, + "undocumentedMessage": "", "isDraft": false, "draftMessage": "", "propertyGroupKey": null, @@ -46820,7 +46241,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "list", "jsonType": "array", "itemFormat": "object", @@ -46962,7 +46383,7 @@ }, { "name": "max_length", - "description": "Maximum name length constraint for access codes.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46975,7 +46396,7 @@ }, { "name": "min_length", - "description": "Minimum name length constraint for access codes.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -46990,47 +46411,46 @@ }, { "name": "door_open", - "description": "Indicates whether the door is open.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "locks", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "has_native_entry_events", - "description": "Indicates whether the device supports native entry events.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "keypad_battery", - "description": "Keypad battery status.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "level", - "description": "Keypad battery charge level.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -47045,70 +46465,69 @@ }, { "name": "locked", - "description": "Indicates whether the lock is locked.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "locks", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "max_active_codes_supported", - "description": "Maximum number of active access codes that the device supports.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "supported_code_lengths", - "description": "Supported code lengths for access codes.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "list", "jsonType": "array", "itemFormat": "number" }, { "name": "supports_backup_access_code_pool", - "description": "Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "active_thermostat_schedule", - "description": "Active [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "description": "Represents a [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "climate_preset_key", @@ -47286,14 +46705,14 @@ }, { "name": "available_climate_presets", - "description": "Available [climate presets](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "list", "jsonType": "array", "itemFormat": "object", @@ -47545,14 +46964,14 @@ }, { "name": "available_fan_mode_settings", - "description": "Fan mode settings that the thermostat supports.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "list", "jsonType": "array", "itemFormat": "enum", @@ -47591,14 +47010,14 @@ }, { "name": "available_hvac_mode_settings", - "description": "HVAC mode settings that the thermostat supports.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "list", "jsonType": "array", "itemFormat": "enum", @@ -47647,17 +47066,16 @@ }, { "name": "current_climate_setting", - "description": "Current climate setting.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "can_delete", @@ -47913,10 +47331,9 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "can_delete", @@ -48165,14 +47582,14 @@ }, { "name": "fallback_climate_preset_key", - "description": "Key of the [fallback climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) for the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, @@ -48180,12 +47597,12 @@ "name": "fan_mode_setting", "description": "", "isDeprecated": true, - "deprecationMessage": "Use `current_climate_setting.fan_mode_setting` instead.", + "deprecationMessage": "use current_climate_setting.fan_mode_setting instead.", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "enum", "jsonType": "string", "values": [ @@ -48223,242 +47640,241 @@ }, { "name": "is_cooling", - "description": "Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "is_fan_running", - "description": "Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "is_heating", - "description": "Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "is_temporary_manual_override_active", - "description": "Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, { "name": "max_cooling_set_point_celsius", - "description": "Maximum [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#cooling-set-point) in °C.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "max_cooling_set_point_fahrenheit", - "description": "Maximum [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#cooling-set-point) in °F.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "max_heating_set_point_celsius", - "description": "Maximum [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#heating-set-point) in °C.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "max_heating_set_point_fahrenheit", - "description": "Maximum [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#heating-set-point) in °F.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "min_cooling_set_point_celsius", - "description": "Minimum [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#cooling-set-point) in °C.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "min_cooling_set_point_fahrenheit", - "description": "Minimum [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#cooling-set-point) in °F.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "min_heating_cooling_delta_celsius", - "description": "Minimum [temperature difference](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "min_heating_cooling_delta_fahrenheit", - "description": "Minimum [temperature difference](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "min_heating_set_point_celsius", - "description": "Minimum [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#heating-set-point) in °C.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "min_heating_set_point_fahrenheit", - "description": "Minimum [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md#heating-set-point) in °F.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "relative_humidity", - "description": "Reported relative humidity, as a value between 0 and 1, inclusive.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "temperature_celsius", - "description": "Reported temperature in °C.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "temperature_fahrenheit", - "description": "Reported temperature in °F.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, { "name": "temperature_threshold", - "description": "Current [temperature threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) set for the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "lower_limit_celsius", - "description": "Lower limit in °C within the current [temperature threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) set for the thermostat.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -48471,7 +47887,7 @@ }, { "name": "lower_limit_fahrenheit", - "description": "Lower limit in °F within the current [temperature threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) set for the thermostat.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -48484,7 +47900,7 @@ }, { "name": "upper_limit_celsius", - "description": "Upper limit in °C within the current [temperature threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) set for the thermostat.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -48497,7 +47913,7 @@ }, { "name": "upper_limit_fahrenheit", - "description": "Upper limit in °F within the current [temperature threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) set for the thermostat.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -48512,14 +47928,14 @@ }, { "name": "thermostat_daily_programs", - "description": "Configured [daily programs](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) for the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "list", "jsonType": "array", "itemFormat": "object", @@ -48635,17 +48051,16 @@ }, { "name": "thermostat_weekly_program", - "description": "Current [weekly program](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) for the thermostat.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "thermostats", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "created_at", @@ -49746,36 +49161,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroups": { - "access_codes": { - "name": "Access Codes", - "propertyGroupKey": "access_codes" - }, - "hardware": { - "name": "Hardware", - "propertyGroupKey": "hardware" - }, - "locks": { - "name": "Locks", - "propertyGroupKey": "locks" - }, - "noise_sensors": { - "name": "Noise Sensors", - "propertyGroupKey": "noise_sensors" - }, - "phones": { - "name": "Phones", - "propertyGroupKey": "phones" - }, - "provider_metadata": { - "name": "Provider Metadata", - "propertyGroupKey": "provider_metadata" - }, - "thermostats": { - "name": "Thermostats", - "propertyGroupKey": "thermostats" - } - }, + "propertyGroups": {}, "resourceSamples": [] }, "device_provider": { @@ -51532,7 +50918,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51839,7 +51225,7 @@ "properties": [ { "name": "created_at", - "description": "Date and time at which the phone was created.\n ", + "description": "Date and time at which the `phone` was created.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51852,7 +51238,7 @@ }, { "name": "custom_metadata", - "description": "Optional [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone.\n ", + "description": "Optional [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51865,7 +51251,7 @@ }, { "name": "device_id", - "description": "ID of the phone.\n ", + "description": "ID of the `phone`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51878,7 +51264,7 @@ }, { "name": "device_type", - "description": "Device type for phones.\n ", + "description": "Type of phone.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51913,7 +51299,7 @@ }, { "name": "display_name", - "description": "Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.\n ", + "description": "Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51926,7 +51312,7 @@ }, { "name": "errors", - "description": "Errors associated with the phone.", + "description": "Errors associated with the `phone`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51968,7 +51354,7 @@ }, { "name": "nickname", - "description": "Optional nickname to describe the phone, settable through Seam.\n ", + "description": "Optional nickname to describe the phone, settable through Seam.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51981,7 +51367,7 @@ }, { "name": "properties", - "description": "\n Properties of the phone.\n ", + "description": "Properties of the phone.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -51991,7 +51377,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "assa_abloy_credential_service_metadata", @@ -52005,7 +51390,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "endpoints", @@ -52076,7 +51460,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "has_active_phone", @@ -52097,7 +51480,7 @@ }, { "name": "warnings", - "description": "Warnings associated with the phone.", + "description": "Warnings associated with the `phone`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -52139,7 +51522,7 @@ }, { "name": "workspace_id", - "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the phone.\n ", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the `phone`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -52159,12 +51542,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroups": { - "phones": { - "name": "Phones", - "propertyGroupKey": "phones" - } - }, + "propertyGroups": {}, "resourceSamples": [] }, "phone_session": { @@ -52321,7 +51699,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "door_name", @@ -52470,7 +51847,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "access_point_name", @@ -52541,7 +51917,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "accessibility_type", @@ -52609,7 +51984,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "battery_level", @@ -52729,7 +52103,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "door_description", @@ -52784,7 +52157,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "door_category", @@ -52980,7 +52352,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -53408,7 +52779,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -53685,7 +53055,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "is_being_activated", @@ -56702,7 +56071,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -56715,7 +56084,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -56728,7 +56097,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -56784,7 +56153,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -56797,7 +56166,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -56810,7 +56179,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -56822,7 +56191,7 @@ "jsonType": "string" } ], - "description": "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)." + "description": "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.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -56841,7 +56210,7 @@ }, { "name": "name", - "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", + "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -58087,7 +57456,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -58515,7 +57883,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -59041,7 +58408,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "ends_at", @@ -59097,19 +58463,6 @@ "format": "id", "jsonType": "string" }, - { - "name": "connected_account_id", - "description": "\n The ID of the [connected account](../core-concepts/connected-accounts/README.md) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).\n ", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, { "name": "created_at", "description": "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", @@ -59832,7 +59185,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "email_address", @@ -59925,7 +59277,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "email_address", @@ -59998,7 +59349,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "ends_at", @@ -60078,7 +59428,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "ends_at", @@ -60138,7 +59487,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "is_suspended", @@ -60205,7 +59553,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "is_suspended", @@ -60252,7 +59599,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "acs_access_group_id", @@ -60319,7 +59665,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "acs_access_group_id", @@ -60820,7 +60165,7 @@ }, { "name": "capabilities_supported", - "description": "\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags).\n ", + "description": "Collection of capabilities that the device supports when connected to Seam. Values are \"access_code,\" which indicates that the device can manage and utilize digital PIN codes for secure access; \"lock,\" which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; \"noise_detection,\" which indicates that the device supports monitoring and responding to ambient noise levels; \"thermostat,\" which indicates that the device can regulate and adjust indoor temperatures; and \"battery,\" which indicates that the device can manage battery life and health.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62298,7 +61643,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62311,7 +61656,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62324,7 +61669,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62380,7 +61725,7 @@ }, { "name": "is_bridge_error", - "description": "Indicates whether the error is related to Seam Bridge.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62393,7 +61738,7 @@ }, { "name": "is_connected_account_error", - "description": "Indicates whether the error is related specifically to the connected account.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62406,7 +61751,7 @@ }, { "name": "message", - "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62418,7 +61763,7 @@ "jsonType": "string" } ], - "description": "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)." + "description": "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.\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." } ] }, @@ -62444,14 +61789,13 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "location_name", - "description": "Name of the device location.\n ", + "description": "Name of the device location.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62464,7 +61808,7 @@ }, { "name": "timezone", - "description": "Time zone of the device location.\n ", + "description": "Time zone of the device location.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62479,7 +61823,7 @@ }, { "name": "properties", - "description": "properties of the device.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62489,54 +61833,23 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": { - "access_codes": { - "name": "access codes", - "propertyGroupKey": "access_codes" - }, - "hardware": { - "name": "hardware", - "propertyGroupKey": "hardware" - }, - "locks": { - "name": "locks", - "propertyGroupKey": "locks" - }, - "noise_sensors": { - "name": "noise sensors", - "propertyGroupKey": "noise_sensors" - }, - "phones": { - "name": "phones", - "propertyGroupKey": "phones" - }, - "provider_metadata": { - "name": "provider metadata", - "propertyGroupKey": "provider_metadata" - }, - "thermostats": { - "name": "thermostats", - "propertyGroupKey": "thermostats" - } - }, "properties": [ { "name": "accessory_keypad", - "description": "Accessory keypad properties and state.", + "description": "Represents the accessory keypad state.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "battery", - "description": "Keypad battery properties.\n ", + "description": "Indicates if the keypad battery properties.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62546,7 +61859,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "level", @@ -62565,7 +61877,7 @@ }, { "name": "is_connected", - "description": "Indicates if an accessory keypad is connected to the device.\n ", + "description": "Indicates if the accessory_keypad is connected to the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62580,21 +61892,20 @@ }, { "name": "battery", - "description": "Represents the current status of the battery charge level.", + "description": "Represents the current status of the battery charge level. Values are \"critical,\" which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; \"low,\" which signifies that the battery is under the preferred threshold and should be charged soon; \"good,\" which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and \"full,\" which represents a battery that is fully charged, providing the maximum duration of usage.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "level", - "description": "Battery charge level as a value between 0 and 1, inclusive.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62607,7 +61918,7 @@ }, { "name": "status", - "description": "Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62671,7 +61982,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "number", "jsonType": "number" }, @@ -62684,7 +61995,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, @@ -62697,7 +62008,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, @@ -62710,13 +62021,13 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "hardware", + "propertyGroupKey": null, "format": "string", "jsonType": "string" }, { "name": "model", - "description": "Device model-related properties.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62726,7 +62037,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "accessory_keypad_supported", @@ -62743,7 +62053,7 @@ }, { "name": "can_connect_accessory_keypad", - "description": "\n Indicates whether the device can connect a accessory keypad.\n ", + "description": "Indicates whether the device can connect a accessory keypad.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62756,7 +62066,7 @@ }, { "name": "display_name", - "description": "\n Display name of the device model.\n ", + "description": "Display name of the device model.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62769,7 +62079,7 @@ }, { "name": "has_built_in_keypad", - "description": "\n Indicates whether the device has a built in accessory keypad.\n ", + "description": "Indicates whether the device has a built in accessory keypad.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62782,7 +62092,7 @@ }, { "name": "manufacturer_display_name", - "description": "\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ", + "description": "Display name that corresponds to the manufacturer-specific terminology for the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -62795,9 +62105,9 @@ }, { "name": "offline_access_codes_supported", - "description": "", - "isDeprecated": true, - "deprecationMessage": "use device.can_program_offline_access_codes.", + "description": "Indicates whether the device supports offline access codes.", + "isDeprecated": false, + "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, @@ -62808,9 +62118,9 @@ }, { "name": "online_access_codes_supported", - "description": "", - "isDeprecated": true, - "deprecationMessage": "use device.can_program_online_access_codes.", + "description": "Indicates whether the device supports online access codes.", + "isDeprecated": false, + "deprecationMessage": "", "isUndocumented": false, "undocumentedMessage": "", "isDraft": false, @@ -62843,7 +62153,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" }, @@ -62869,7 +62179,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroupKey": "access_codes", + "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" } @@ -63866,36 +63176,7 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "", - "propertyGroups": { - "access_codes": { - "name": "Access Codes", - "propertyGroupKey": "access_codes" - }, - "hardware": { - "name": "Hardware", - "propertyGroupKey": "hardware" - }, - "locks": { - "name": "Locks", - "propertyGroupKey": "locks" - }, - "noise_sensors": { - "name": "Noise Sensors", - "propertyGroupKey": "noise_sensors" - }, - "phones": { - "name": "Phones", - "propertyGroupKey": "phones" - }, - "provider_metadata": { - "name": "Provider Metadata", - "propertyGroupKey": "provider_metadata" - }, - "thermostats": { - "name": "Thermostats", - "propertyGroupKey": "thermostats" - } - }, + "propertyGroups": {}, "resourceSamples": [] }, "user_identity": { @@ -64126,7 +63407,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "inviter_logo_url", @@ -64333,7 +63613,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64346,7 +63626,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64372,7 +63652,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64436,7 +63716,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64465,7 +63745,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64478,7 +63758,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64504,7 +63784,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64568,7 +63848,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64597,7 +63877,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64610,7 +63890,7 @@ }, { "name": "code", - "description": "Code for the affected access code.", + "description": "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64623,7 +63903,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64649,7 +63929,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64713,7 +63993,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64742,7 +64022,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64755,7 +64035,7 @@ }, { "name": "code", - "description": "Code for the affected access code.", + "description": "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64768,7 +64048,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64794,7 +64074,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64858,7 +64138,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64887,7 +64167,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64900,7 +64180,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64926,7 +64206,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -64990,7 +64270,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65019,7 +64299,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65032,7 +64312,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65058,7 +64338,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65122,7 +64402,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65151,7 +64431,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65164,7 +64444,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65190,7 +64470,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65254,7 +64534,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65283,7 +64563,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65296,7 +64576,7 @@ }, { "name": "code", - "description": "Code for the affected access code.", + "description": "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65309,7 +64589,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65335,7 +64615,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65399,7 +64679,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65428,7 +64708,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65441,7 +64721,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65467,7 +64747,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65531,7 +64811,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65560,7 +64840,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65573,7 +64853,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65599,7 +64879,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65663,7 +64943,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65692,7 +64972,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65705,7 +64985,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65731,7 +65011,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65795,7 +65075,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65824,7 +65104,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65837,7 +65117,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65863,7 +65143,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65927,7 +65207,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65956,7 +65236,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -65982,7 +65262,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66008,7 +65288,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66072,7 +65352,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66101,7 +65381,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66114,7 +65394,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66140,7 +65420,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66204,7 +65484,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66233,7 +65513,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66246,7 +65526,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66272,7 +65552,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66336,7 +65616,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66365,7 +65645,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66378,7 +65658,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66404,7 +65684,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66468,7 +65748,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66497,7 +65777,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the affected access code.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66510,7 +65790,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the affected access codes.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66536,7 +65816,7 @@ }, { "name": "device_id", - "description": "ID of the device associated with the affected access code.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66600,7 +65880,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66629,7 +65909,7 @@ "properties": [ { "name": "access_grant_id", - "description": "ID of the affected access grant.", + "description": "ID of the access grant.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66706,7 +65986,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66735,7 +66015,7 @@ "properties": [ { "name": "access_grant_id", - "description": "ID of the affected access grant.", + "description": "ID of the access grant.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66812,7 +66092,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66841,7 +66121,7 @@ "properties": [ { "name": "access_grant_id", - "description": "ID of the affected access grant.", + "description": "ID of the access grant.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66918,7 +66198,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66947,7 +66227,7 @@ "properties": [ { "name": "access_grant_id", - "description": "ID of the affected access grant.", + "description": "ID of the access grant.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -66960,7 +66240,7 @@ }, { "name": "acs_entrance_id", - "description": "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).", + "description": "ID of the door, an [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67037,7 +66317,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67066,7 +66346,7 @@ "properties": [ { "name": "access_grant_id", - "description": "ID of the affected access grant.", + "description": "ID of the access grant.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67079,7 +66359,7 @@ }, { "name": "acs_entrance_id", - "description": "ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).", + "description": "ID of the door, an [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67156,7 +66436,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67185,7 +66465,7 @@ "properties": [ { "name": "access_method_id", - "description": "ID of the affected access method.", + "description": "ID of the access method.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67262,7 +66542,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67291,7 +66571,7 @@ "properties": [ { "name": "access_method_id", - "description": "ID of the affected access method.", + "description": "ID of the access method.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67368,7 +66648,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67397,7 +66677,7 @@ "properties": [ { "name": "access_method_id", - "description": "ID of the affected access method.", + "description": "ID of the access method.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67474,7 +66754,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67503,7 +66783,7 @@ "properties": [ { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67516,7 +66796,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67593,7 +66873,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67605,7 +66885,7 @@ "jsonType": "string" } ], - "description": "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.", + "description": "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.", "isDeprecated": false, "routePath": "/acs/systems", "deprecationMessage": "", @@ -67622,7 +66902,7 @@ "properties": [ { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67635,7 +66915,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67712,7 +66992,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67724,7 +67004,7 @@ "jsonType": "string" } ], - "description": "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was added.", + "description": "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.", "isDeprecated": false, "routePath": "/acs/systems", "deprecationMessage": "", @@ -67741,7 +67021,7 @@ "properties": [ { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67754,7 +67034,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67831,7 +67111,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67843,7 +67123,7 @@ "jsonType": "string" } ], - "description": "An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.", + "description": "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.", "isDeprecated": false, "routePath": "/acs/systems", "deprecationMessage": "", @@ -67860,7 +67140,7 @@ "properties": [ { "name": "acs_credential_id", - "description": "ID of the affected credential.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67873,7 +67153,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67886,7 +67166,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67963,7 +67243,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -67992,7 +67272,7 @@ "properties": [ { "name": "acs_credential_id", - "description": "ID of the affected credential.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68005,7 +67285,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68018,7 +67298,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68095,7 +67375,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68124,7 +67404,7 @@ "properties": [ { "name": "acs_credential_id", - "description": "ID of the affected credential.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68137,7 +67417,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68150,7 +67430,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68227,7 +67507,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68256,7 +67536,7 @@ "properties": [ { "name": "acs_credential_id", - "description": "ID of the affected credential.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68269,7 +67549,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68282,7 +67562,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68359,7 +67639,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68388,7 +67668,7 @@ "properties": [ { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68414,7 +67694,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68491,7 +67771,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68503,7 +67783,7 @@ "jsonType": "string" } ], - "description": "An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", + "description": "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", "isDeprecated": false, "routePath": "/acs/users", "deprecationMessage": "", @@ -68520,7 +67800,7 @@ "properties": [ { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68546,7 +67826,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68623,7 +67903,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68635,7 +67915,7 @@ "jsonType": "string" } ], - "description": "An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.", + "description": "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.", "isDeprecated": false, "routePath": "/acs/users", "deprecationMessage": "", @@ -68652,7 +67932,7 @@ "properties": [ { "name": "acs_encoder_id", - "description": "ID of the affected encoder.", + "description": "ID of the [ACS encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68665,7 +67945,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68678,7 +67958,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68755,7 +68035,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68784,7 +68064,7 @@ "properties": [ { "name": "acs_encoder_id", - "description": "ID of the affected encoder.", + "description": "ID of the [ACS encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68797,7 +68077,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68810,7 +68090,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68887,7 +68167,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68916,7 +68196,7 @@ "properties": [ { "name": "acs_access_group_id", - "description": "ID of the affected access group.", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68929,7 +68209,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -68942,7 +68222,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69019,7 +68299,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69061,7 +68341,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69074,7 +68354,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69151,7 +68431,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69193,7 +68473,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access system.", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69206,7 +68486,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69283,7 +68563,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69312,7 +68592,7 @@ "properties": [ { "name": "client_session_id", - "description": "ID of the affected client session.", + "description": "ID of the [client session](../core-concepts/authentication/client-session-tokens/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69389,7 +68669,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69418,7 +68698,7 @@ "properties": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview associated with the event.", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69431,7 +68711,7 @@ }, { "name": "connected_account_id", - "description": "ID of the affected connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69508,7 +68788,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69537,7 +68817,7 @@ "properties": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview associated with the event.", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69550,7 +68830,7 @@ }, { "name": "connected_account_id", - "description": "ID of the affected connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69627,7 +68907,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69656,7 +68936,7 @@ "properties": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview associated with the event.", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69669,7 +68949,7 @@ }, { "name": "connected_account_id", - "description": "ID of the affected connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69746,7 +69026,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69775,7 +69055,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the affected connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69852,7 +69132,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69881,7 +69161,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the affected connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69958,7 +69238,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -69987,7 +69267,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the affected connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70064,7 +69344,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70093,7 +69373,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the affected connected account.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70170,7 +69450,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70199,7 +69479,7 @@ "properties": [ { "name": "action_attempt_id", - "description": "ID of the affected action attempt.", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70212,7 +69492,7 @@ }, { "name": "action_type", - "description": "Type of the action.", + "description": "Type of action.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70302,7 +69582,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70331,7 +69611,7 @@ "properties": [ { "name": "action_attempt_id", - "description": "ID of the affected action attempt.", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70344,7 +69624,7 @@ }, { "name": "action_type", - "description": "Type of the action.", + "description": "Type of action.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70434,7 +69714,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70463,7 +69743,7 @@ "properties": [ { "name": "action_attempt_id", - "description": "ID of the affected action attempt.", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70476,7 +69756,7 @@ }, { "name": "action_type", - "description": "Type of the action.", + "description": "Type of action.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70566,7 +69846,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70595,7 +69875,7 @@ "properties": [ { "name": "action_attempt_id", - "description": "ID of the affected action attempt.", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70608,7 +69888,7 @@ }, { "name": "action_type", - "description": "Type of the action.", + "description": "Type of action.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70698,7 +69978,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70727,7 +70007,7 @@ "properties": [ { "name": "connect_webview_id", - "description": "ID of the affected Connect Webview.", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70740,7 +70020,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70817,7 +70097,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70846,7 +70126,7 @@ "properties": [ { "name": "connect_webview_id", - "description": "ID of the affected Connect Webview.", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70923,7 +70203,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70952,7 +70232,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -70978,7 +70258,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71042,7 +70322,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71071,7 +70351,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71097,7 +70377,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71161,7 +70441,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71190,7 +70470,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71216,7 +70496,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71280,7 +70560,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71309,7 +70589,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71335,7 +70615,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71399,7 +70679,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71428,7 +70708,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71454,7 +70734,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71518,7 +70798,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71547,7 +70827,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71573,7 +70853,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71682,7 +70962,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71711,7 +70991,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71737,7 +71017,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71846,7 +71126,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71875,7 +71155,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71901,7 +71181,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71965,7 +71245,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -71994,7 +71274,7 @@ "properties": [ { "name": "battery_level", - "description": "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.", + "description": "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72007,7 +71287,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72033,7 +71313,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72097,7 +71377,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72126,7 +71406,7 @@ "properties": [ { "name": "battery_level", - "description": "Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.", + "description": "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72139,7 +71419,7 @@ }, { "name": "battery_status", - "description": "Battery status of the affected device, calculated from the numeric `battery_level` value.", + "description": "Battery status of the device, calculated from the numeric `battery_level` value.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72194,7 +71474,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72220,7 +71500,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72284,7 +71564,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72313,7 +71593,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72339,7 +71619,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72403,7 +71683,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72432,7 +71712,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72458,7 +71738,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72522,7 +71802,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72551,7 +71831,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72577,7 +71857,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72641,7 +71921,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72670,7 +71950,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72696,7 +71976,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72760,7 +72040,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72789,7 +72069,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72815,7 +72095,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72879,7 +72159,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72908,7 +72188,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72934,7 +72214,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -72998,7 +72278,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73027,7 +72307,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73053,7 +72333,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73117,7 +72397,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73146,7 +72426,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73172,7 +72452,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73236,7 +72516,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73265,7 +72545,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73291,7 +72571,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73355,7 +72635,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73384,7 +72664,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73410,7 +72690,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73474,7 +72754,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73503,7 +72783,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73529,7 +72809,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73593,7 +72873,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73622,7 +72902,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73648,7 +72928,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73712,7 +72992,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73741,7 +73021,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73767,7 +73047,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73857,7 +73137,7 @@ }, { "name": "noise_threshold_id", - "description": "ID of the noise threshold that was triggered.", + "description": "ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73870,7 +73150,7 @@ }, { "name": "noise_threshold_name", - "description": "Name of the noise threshold that was triggered.", + "description": "Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73909,7 +73189,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73938,7 +73218,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the access code that was used to lock the device.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73951,7 +73231,7 @@ }, { "name": "action_attempt_id", - "description": "ID of the action attempt associated with the lock action.", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md) associated with the lock action.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73964,7 +73244,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -73990,7 +73270,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74041,7 +73321,7 @@ }, { "name": "method", - "description": "Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.", + "description": "Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74119,7 +73399,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74148,7 +73428,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the access code that was used to unlock the affected device.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74161,7 +73441,7 @@ }, { "name": "action_attempt_id", - "description": "ID of the action attempt associated with the unlock action.", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md) associated with the unlock action.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74174,7 +73454,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74200,7 +73480,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74251,7 +73531,7 @@ }, { "name": "method", - "description": "Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.", + "description": "Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74329,7 +73609,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74358,7 +73638,7 @@ "properties": [ { "name": "access_code_id", - "description": "ID of the access code that was used in the unlock attempts.", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74371,7 +73651,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74397,7 +73677,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74461,7 +73741,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74490,7 +73770,7 @@ "properties": [ { "name": "climate_preset_key", - "description": "Key of the climate preset that was activated.", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74503,7 +73783,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74529,7 +73809,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74580,7 +73860,7 @@ }, { "name": "is_fallback_climate_preset", - "description": "Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat.", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated is the [fallback climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74606,7 +73886,7 @@ }, { "name": "thermostat_schedule_id", - "description": "ID of the thermostat schedule that prompted the affected climate preset to be activated.", + "description": "ID of the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that prompted the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to be activated.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74619,7 +73899,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74648,7 +73928,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74700,7 +73980,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74877,7 +74157,7 @@ }, { "name": "method", - "description": "Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.", + "description": "Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74925,7 +74205,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74954,7 +74234,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -74980,7 +74260,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75031,7 +74311,7 @@ }, { "name": "lower_limit_celsius", - "description": "Lower temperature limit, in °C, defined by the set threshold.", + "description": "Lower temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75044,7 +74324,7 @@ }, { "name": "lower_limit_fahrenheit", - "description": "Lower temperature limit, in °F, defined by the set threshold.", + "description": "Lower temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75070,7 +74350,7 @@ }, { "name": "temperature_celsius", - "description": "Temperature, in °C, reported by the affected thermostat.", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75083,7 +74363,7 @@ }, { "name": "temperature_fahrenheit", - "description": "Temperature, in °F, reported by the affected thermostat.", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75096,7 +74376,7 @@ }, { "name": "upper_limit_celsius", - "description": "Upper temperature limit, in °C, defined by the set threshold.", + "description": "Upper temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75109,7 +74389,7 @@ }, { "name": "upper_limit_fahrenheit", - "description": "Upper temperature limit, in °F, defined by the set threshold.", + "description": "Upper temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75122,7 +74402,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75151,7 +74431,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75177,7 +74457,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75228,7 +74508,7 @@ }, { "name": "lower_limit_celsius", - "description": "Lower temperature limit, in °C, defined by the set threshold.", + "description": "Lower temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75241,7 +74521,7 @@ }, { "name": "lower_limit_fahrenheit", - "description": "Lower temperature limit, in °F, defined by the set threshold.", + "description": "Lower temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75267,7 +74547,7 @@ }, { "name": "temperature_celsius", - "description": "Temperature, in °C, reported by the affected thermostat.", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75280,7 +74560,7 @@ }, { "name": "temperature_fahrenheit", - "description": "Temperature, in °F, reported by the affected thermostat.", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75293,7 +74573,7 @@ }, { "name": "upper_limit_celsius", - "description": "Upper temperature limit, in °C, defined by the set threshold.", + "description": "Upper temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75306,7 +74586,7 @@ }, { "name": "upper_limit_fahrenheit", - "description": "Upper temperature limit, in °F, defined by the set threshold.", + "description": "Upper temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75319,7 +74599,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75348,7 +74628,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75374,7 +74654,7 @@ }, { "name": "desired_temperature_celsius", - "description": "Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point.", + "description": "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75387,7 +74667,7 @@ }, { "name": "desired_temperature_fahrenheit", - "description": "Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point.", + "description": "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75400,7 +74680,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75464,7 +74744,7 @@ }, { "name": "temperature_celsius", - "description": "Temperature, in °C, reported by the affected thermostat.", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75477,7 +74757,7 @@ }, { "name": "temperature_fahrenheit", - "description": "Temperature, in °F, reported by the affected thermostat.", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75490,7 +74770,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75519,7 +74799,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75545,7 +74825,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75609,7 +74889,7 @@ }, { "name": "temperature_celsius", - "description": "Temperature, in °C, reported by the affected thermostat.", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75622,7 +74902,7 @@ }, { "name": "temperature_fahrenheit", - "description": "Temperature, in °F, reported by the affected thermostat.", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75635,7 +74915,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75664,7 +74944,7 @@ "properties": [ { "name": "connected_account_id", - "description": "ID of the connected account associated with the event.", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75690,7 +74970,7 @@ }, { "name": "device_id", - "description": "ID of the affected device.", + "description": "ID of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75703,7 +74983,7 @@ }, { "name": "device_name", - "description": "The new name of the affected device.", + "description": "The new name of the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75767,7 +75047,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75809,7 +75089,7 @@ }, { "name": "enrollment_automation_id", - "description": "ID of the affected enrollment automation.", + "description": "ID of the [enrollment automation](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75873,7 +75153,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75915,7 +75195,7 @@ }, { "name": "device_id", - "description": "ID of the affected phone device.", + "description": "ID of the [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -75979,7 +75259,7 @@ }, { "name": "workspace_id", - "description": "ID of the workspace associated with the event.", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -76058,7 +75338,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -76100,7 +75379,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -76214,7 +75492,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -76256,7 +75533,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -76370,7 +75646,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -76444,7 +75719,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "acs_credential_on_encoder", @@ -76458,7 +75732,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "card_number", @@ -76537,7 +75810,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "cancelled", @@ -76735,7 +76007,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "access_method", @@ -76846,7 +76117,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -77274,7 +76544,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -77716,7 +76985,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -77810,7 +77078,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "access_method_id", @@ -78061,7 +77328,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -78155,7 +77421,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "access_method", @@ -78266,7 +77531,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -78694,7 +77958,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "auto_join", @@ -79070,7 +78333,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -79112,7 +78374,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -79226,7 +78487,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -79268,7 +78528,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -79382,7 +78641,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -79424,7 +78682,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -79538,7 +78795,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -79580,7 +78836,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -79694,7 +78949,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -79736,7 +78990,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -79850,7 +79103,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -79892,7 +79144,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -80006,7 +79257,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -80048,7 +79298,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -80162,7 +79411,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -80204,7 +79452,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -80318,7 +79565,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -80360,7 +79606,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -80474,7 +79719,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -80516,7 +79760,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -80630,7 +79873,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -80672,7 +79914,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -80786,7 +80027,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -80828,7 +80068,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -80942,7 +80181,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -80984,7 +80222,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { @@ -81098,7 +80335,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [ { "name": "message", @@ -81140,7 +80376,6 @@ "propertyGroupKey": null, "format": "object", "jsonType": "object", - "propertyGroups": {}, "properties": [] }, { diff --git a/docs/api/_report.md b/docs/api/_report.md index 9c4c73d0f..6b0e40439 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -18,7 +18,6 @@ - `/noise_sensors/noise_thresholds` - `/noise_sensors/simulate` - `/thermostats/daily_programs` -- `/unstable_partner/building_blocks` - `/webhooks` - `/workspaces` @@ -66,7 +65,6 @@ These items are intentionally undocumented. - `/seam/instant_key/v1/client_sessions`: No undocumented message provided - `/seam/mobile_sdk/v1/acs/credentials`: No undocumented message provided - `/seam/mobile_sdk/v1/phone_sessions`: No undocumented message provided -- `/seam/partner/v1/resources`: No undocumented message provided - `/unstable_access_grants`: No undocumented message provided - `/unstable_access_methods`: No undocumented message provided - `/unstable_locations`: No undocumented message provided @@ -90,7 +88,7 @@ These items are intentionally undocumented. - `/seam/instant_key/v1`: No undocumented message provided - `/seam/mobile_sdk/v1/acs`: No undocumented message provided - `/seam/mobile_sdk/v1`: No undocumented message provided -- `/seam/partner/v1`: No undocumented message provided +- `/unstable_partner`: No undocumented message provided ### Endpoints @@ -117,13 +115,10 @@ These items are intentionally undocumented. - `/seam/instant_key/v1/client_sessions/exchange_short_code`: Seam Instant Key only. - `/seam/mobile_sdk/v1/acs/credentials/list`: Mobile SDK only. - `/seam/mobile_sdk/v1/phone_sessions/get_or_create`: Mobile SDK only. -- `/seam/partner/v1/resources/list`: Partner building blocks/UI only. - `/thermostats/get`: Will be removed. - `/unstable_access_grants/create`: Unreleased. -- `/unstable_access_grants/delete`: Unreleased. - `/unstable_access_grants/get`: Unreleased. - `/unstable_access_grants/list`: Unreleased. -- `/unstable_access_methods/delete`: Unreleased. - `/unstable_access_methods/get`: Unreleased. - `/unstable_access_methods/list`: Unreleased. - `/unstable_locations/add_acs_entrances`: Experimental locations. @@ -226,6 +221,12 @@ Items that are intentionally undocumented are not included in this section. - `acs_credential_provisioning_automation.workspace_id` - `acs_system.acs_access_group_count` - `acs_system.acs_user_count` +- `acs_system.can_create_user` +- `acs_system.can_delete_user` +- `acs_system.can_update_user_group_membership` +- `acs_system.can_update_user_information` +- `acs_system.can_update_user_schedule` +- `acs_system.can_update_user_supension_state` - `acs_system.location` - `acs_system.system_type` - `acs_system.system_type_display_name` @@ -244,8 +245,33 @@ Items that are intentionally undocumented are not included in this section. - `client_session.user_identity_ids` - `client_session.workspace_id` - `connect_webview.accepted_devices` +- `connect_webview.accepted_providers` - `connect_webview.any_device_allowed` +- `connect_webview.any_provider_allowed` +- `connect_webview.authorized_at` +- `connect_webview.automatically_manage_new_devices` +- `connect_webview.connect_webview_id` +- `connect_webview.connected_account_id` +- `connect_webview.created_at` +- `connect_webview.custom_metadata` +- `connect_webview.custom_redirect_failure_url` +- `connect_webview.custom_redirect_url` - `connect_webview.device_selection_mode` +- `connect_webview.login_successful` +- `connect_webview.selected_provider` +- `connect_webview.status` +- `connect_webview.url` +- `connect_webview.wait_for_device_creation` +- `connect_webview.workspace_id` +- `connected_account.account_type` +- `connected_account.account_type_display_name` +- `connected_account.automatically_manage_new_devices` +- `connected_account.connected_account_id` +- `connected_account.created_at` +- `connected_account.custom_metadata` +- `connected_account.errors` +- `connected_account.user_identifier` +- `connected_account.warnings` - `device.can_hvac_cool` - `device.can_hvac_heat` - `device.can_hvac_heat_cool` @@ -257,6 +283,7 @@ Items that are intentionally undocumented are not included in this section. - `device.can_simulate_disconnection` - `device.can_simulate_removal` - `device.can_turn_off_hvac` +- `device.custom_metadata` - `device_provider.can_hvac_cool` - `device_provider.can_hvac_heat` - `device_provider.can_hvac_heat_cool` @@ -313,6 +340,7 @@ Items that are intentionally undocumented are not included in this section. - `unmanaged_device.can_simulate_removal` - `unmanaged_device.can_turn_off_hvac` - `unmanaged_device.is_managed` +- `unmanaged_device.properties` - `user_identity.display_name` - `user_identity.full_name` - `webhook.event_types` @@ -383,14 +411,8 @@ Items that are intentionally undocumented are not included in this section. - `/acs/users/update` - `email` - `hid_acs_system_id` -- `/client_sessions/create` - - `customer_id` - - `customer_key` - `/connect_webviews/create` - - `customer_id` - `device_selection_mode` -- `/connect_webviews/list` - - `customer_id` - `/connected_accounts/delete` - `sync` - `/connected_accounts/list` @@ -405,6 +427,27 @@ Items that are intentionally undocumented are not included in this section. - `customer_ids` - `exclude_if` - `include_if` +- `/events/get` + - `device_id` + - `event_id` + - `event_type` +- `/events/list` + - `access_code_id` + - `access_code_ids` + - `acs_system_id` + - `acs_system_ids` + - `between` + - `connect_webview_id` + - `connected_account_id` + - `customer_ids` + - `device_id` + - `device_ids` + - `event_ids` + - `event_type` + - `event_types` + - `limit` + - `since` + - `unstable_offset` - `/locks/get` - `device_id` - `name` @@ -514,16 +557,13 @@ Items that are intentionally undocumented are not included in this section. - `location_id` - `name` - `time_zone` -- `/unstable_partner/building_blocks/generate_link` - - `bridge_client_machine_identifier_key` - - `bridge_client_name` - - `bridge_client_time_zone` - `/unstable_partner/resources/push` - `custom_metadata` - `customer_key` - `description` - `email_address` - `ends_at` + - `icon_url` - `location_keys` - `name` - `partner_resource_key` @@ -685,7 +725,6 @@ These items are deprecated. - `/connected_accounts/delete` - `/connected_accounts/get` - `/connected_accounts/list` -- `/connected_accounts/sync` - `/connected_accounts/update` - `/devices/delete` - `/devices/get` @@ -728,7 +767,6 @@ These items are deprecated. - `/seam/instant_key/v1/client_sessions/exchange_short_code` - `/seam/mobile_sdk/v1/acs/credentials/list` - `/seam/mobile_sdk/v1/phone_sessions/get_or_create` -- `/seam/partner/v1/resources/list` - `/thermostats/get` - `/thermostats/update_weekly_program` - `/thermostats/daily_programs/create` @@ -737,10 +775,8 @@ These items are deprecated. - `/thermostats/simulate/hvac_mode_adjusted` - `/thermostats/simulate/temperature_reached` - `/unstable_access_grants/create` -- `/unstable_access_grants/delete` - `/unstable_access_grants/get` - `/unstable_access_grants/list` -- `/unstable_access_methods/delete` - `/unstable_access_methods/get` - `/unstable_access_methods/list` - `/unstable_locations/add_acs_entrances` @@ -752,7 +788,6 @@ These items are deprecated. - `/unstable_locations/remove_acs_entrances` - `/unstable_locations/remove_devices` - `/unstable_locations/update` -- `/unstable_partner/building_blocks/generate_link` - `/unstable_partner/resources/push` - `/user_identities/generate_instant_key` - `/user_identities/update` diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 0267cf3b0..d6751c8dc 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -1596,30 +1596,25 @@ Credentials provided were invalid. **`is_bridge_error`** *Boolean* - Indicates whether the error is related to Seam Bridge. - --- **`is_connected_account_error`** *Boolean* - Indicates whether the error is related specifically to the connected account. - --- **`message`** *String* - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
bridge_disconnected -Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). +Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + 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`** *Datetime* @@ -1644,24 +1639,18 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili **`is_bridge_error`** *Boolean* - Indicates whether the error is related to Seam Bridge. - --- **`is_connected_account_error`** *Boolean* - Indicates whether the error is related specifically to the connected account. - --- **`message`** *String* - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
@@ -1741,7 +1730,13 @@ Indicates whether the access code is waiting for a code assignment. **`name`** *String* -Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). +Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). @@ -1768,7 +1763,7 @@ Date and time at which the time-bound access code becomes active. **`status`** *Enum* -Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). +Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
@@ -2435,7 +2430,8 @@ Credentials provided were invalid. **`bridge_disconnected`** -Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). +Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). --- @@ -2527,11 +2523,11 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2539,7 +2535,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2555,7 +2551,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md).
--- @@ -2570,11 +2566,11 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2582,7 +2578,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2598,7 +2594,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2613,15 +2609,15 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). code String - Code for the affected access code. + Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2629,7 +2625,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2645,7 +2641,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2660,15 +2656,15 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). code String - Code for the affected access code. + Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2676,7 +2672,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2692,7 +2688,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2707,11 +2703,11 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2719,7 +2715,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2735,7 +2731,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2750,11 +2746,11 @@ There was an unusually long delay in setting an [access code](https://docs.seam. access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2762,7 +2758,7 @@ There was an unusually long delay in setting an [access code](https://docs.seam. device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2778,7 +2774,7 @@ There was an unusually long delay in setting an [access code](https://docs.seam. workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2793,11 +2789,11 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2805,7 +2801,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2821,7 +2817,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2836,15 +2832,15 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). code String - Code for the affected access code. + Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2852,7 +2848,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2868,7 +2864,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2883,11 +2879,11 @@ There was an unusually long delay in removing an [access code](https://docs.seam access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2895,7 +2891,7 @@ There was an unusually long delay in removing an [access code](https://docs.seam device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2911,7 +2907,7 @@ There was an unusually long delay in removing an [access code](https://docs.seam workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2926,11 +2922,11 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2938,7 +2934,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2954,7 +2950,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -2969,11 +2965,11 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2981,7 +2977,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -2997,7 +2993,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -3012,11 +3008,11 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -3024,7 +3020,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -3040,7 +3036,7 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -3055,13 +3051,13 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). backup_access_code_id String connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -3069,7 +3065,7 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -3085,7 +3081,7 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 60b4b121d..d7daf2fd2 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -88,7 +88,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https **`name`** *String* -Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). +Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). --- diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index f96f6bde8..c4a5a5f04 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -96,7 +96,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https **`name`** *String* -Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). +Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). --- diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 6a5d7bc46..ed04827e3 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -1582,30 +1582,25 @@ Credentials provided were invalid. **`is_bridge_error`** *Boolean* - Indicates whether the error is related to Seam Bridge. - --- **`is_connected_account_error`** *Boolean* - Indicates whether the error is related specifically to the connected account. - --- **`message`** *String* - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
bridge_disconnected -Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). +Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + 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`** *Datetime* @@ -1630,24 +1625,18 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab **`is_bridge_error`** *Boolean* - Indicates whether the error is related to Seam Bridge. - --- **`is_connected_account_error`** *Boolean* - Indicates whether the error is related specifically to the connected account. - --- **`message`** *String* - Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
@@ -1664,7 +1653,13 @@ Indicates that Seam does not manage the access code. **`name`** *String* -Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). +Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). @@ -2345,7 +2340,8 @@ Credentials provided were invalid. **`bridge_disconnected`** -Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). +Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). --- @@ -2437,11 +2433,11 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2449,7 +2445,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../../core-concepts/devices/README.md). event_id UUID @@ -2465,7 +2461,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -2480,11 +2476,11 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2492,7 +2488,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../../core-concepts/devices/README.md). event_id UUID @@ -2508,7 +2504,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -2523,11 +2519,11 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2535,7 +2531,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../../core-concepts/devices/README.md). event_id UUID @@ -2551,7 +2547,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -2566,11 +2562,11 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id UUID - ID of the affected access code. + ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). connected_account_id UUID - ID of the connected account associated with the affected access codes. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -2578,7 +2574,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l device_id UUID - ID of the device associated with the affected access code. + ID of the [device](../../../core-concepts/devices/README.md). event_id UUID @@ -2594,7 +2590,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index e71215988..1d4ddea23 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -96,7 +96,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https **`name`** *String* -Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). +Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). --- diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 50cd4930c..7ad1a1f2d 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -46,7 +46,13 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h **`name`** *String* -Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). +Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. + + To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. + + To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). --- diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index d51ebf50d..4407518a0 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -199,15 +199,13 @@ An ACS access group was deleted. acs_access_group_id UUID - ID of the affected access group. - acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -227,7 +225,7 @@ An ACS access group was deleted. workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 714c868a8..13ccac4e7 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -599,15 +599,13 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia acs_credential_id UUID - ID of the affected credential. - acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -627,7 +625,7 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -642,15 +640,13 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia acs_credential_id UUID - ID of the affected credential. - acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -670,7 +666,7 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -685,15 +681,13 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia acs_credential_id UUID - ID of the affected credential. - acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -713,7 +707,7 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -728,15 +722,13 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia acs_credential_id UUID - ID of the affected credential. - acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -756,7 +748,7 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 3e748f61d..22c3d942f 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -126,15 +126,15 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc acs_encoder_id UUID - ID of the affected encoder. + ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -154,7 +154,7 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -169,15 +169,15 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc acs_encoder_id UUID - ID of the affected encoder. + ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -197,7 +197,7 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 0c58b6b62..6c255f3c0 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -261,11 +261,11 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -285,7 +285,7 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- @@ -302,11 +302,11 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -326,7 +326,7 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 83e253d37..69de48616 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -33,15 +33,9 @@ ID of the entrance to which you want to grant an access system user access. --- -**`acs_user_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. - ---- - -**`user_identity_id`** *String* - -ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. +ID of the access system user to whom you want to grant access to an entrance. --- diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 833a4b333..2341c5115 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -43,6 +43,16 @@ For details about the resources associated with an access control system, see th acs_access_group_count: [example value], acs_system_id: [example value], acs_user_count: [example value], + can_add_acs_users_to_acs_access_groups: [example value], + can_automate_enrollment: [example value], + can_create_acs_access_groups: [example value], + can_create_user: [example value], + can_delete_user: [example value], + can_remove_acs_users_from_acs_access_groups: [example value], + can_update_user_group_membership: [example value], + can_update_user_information: [example value], + can_update_user_schedule: [example value], + can_update_user_supension_state: [example value], connected_account_id: [example value], connected_account_ids: [example value], created_at: [example value], @@ -91,6 +101,90 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ +--- + +**`can_add_acs_users_to_acs_access_groups`** *Boolean* + +Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + + + + +--- + +**`can_automate_enrollment`** *Boolean* + +Indicates whether it is possible to [launch enrollment automations](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + + + + +--- + +**`can_create_acs_access_groups`** *Boolean* + +Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + + + + +--- + +**`can_create_user`** *Boolean* + + + + + +--- + +**`can_delete_user`** *Boolean* + + + + + +--- + +**`can_remove_acs_users_from_acs_access_groups`** *Boolean* + +Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + + + + +--- + +**`can_update_user_group_membership`** *Boolean* + + + + + +--- + +**`can_update_user_information`** *Boolean* + + + + + +--- + +**`can_update_user_schedule`** *Boolean* + + + + + +--- + +**`can_update_user_supension_state`** *Boolean* + + + + + --- **`connected_account_id`** *UUID* @@ -696,7 +790,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui **`acs_system.connected`** -An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected. +An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
@@ -704,11 +798,11 @@ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -728,14 +822,14 @@ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md).
--- **`acs_system.added`** -An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was added. +An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
@@ -743,11 +837,11 @@ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -767,14 +861,14 @@ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md).
--- **`acs_system.disconnected`** -An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected. +An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
@@ -782,11 +876,11 @@ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -806,7 +900,7 @@ An [access system](https://docs.seam.co/latest/capability-guides/access-systems) workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md).
--- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 9f904acb7..ed534fde9 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -22,7 +22,6 @@ For details about how to configure `acs_user`s in your access control system, se access_schedule: [example value], acs_system_id: [example value], acs_user_id: [example value], - connected_account_id: [example value], created_at: [example value], display_name: [example value], email: [example value], @@ -87,17 +86,6 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system ---- - -**`connected_account_id`** *UUID* - - - The ID of the [connected account](../../../core-concepts/connected-accounts/README.md) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - - - - - --- **`created_at`** *Datetime* @@ -895,7 +883,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce **`acs_user.created`** -An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. +An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
@@ -903,13 +891,13 @@ An [access system user](https://docs.seam.co/latest/capability-guides/access-sys acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). acs_user_id UUID connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -929,14 +917,14 @@ An [access system user](https://docs.seam.co/latest/capability-guides/access-sys workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md).
--- **`acs_user.deleted`** -An [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted. +An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
@@ -944,13 +932,13 @@ An [access system user](https://docs.seam.co/latest/capability-guides/access-sys acs_system_id UUID - ID of the access system. + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). acs_user_id UUID connected_account_id UUID - ID of the connected account. + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -970,7 +958,7 @@ An [access system user](https://docs.seam.co/latest/capability-guides/access-sys workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md).
--- diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 605ce98c1..8c966e274 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -27,21 +27,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id. - ---- - -**`acs_user_id`** *String* - -ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id - ---- - -**`user_identity_id`** *String* - -ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. +ID of the access system user that you want to delete. --- diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index dd29f4969..7367d5d32 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -27,21 +27,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id. - ---- - -**`acs_user_id`** *String* - -ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id. - ---- - -**`user_identity_id`** *String* - -ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id. +ID of the access system user that you want to get. --- diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index fe008b6cc..cefb818a0 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -28,21 +28,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id. - ---- - -**`acs_user_id`** *String* - -ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id. - ---- - -**`user_identity_id`** *String* - -ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id. +ID of the access system user for whom you want to list accessible entrances. --- diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 38c17d994..7e8ffc4a9 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -33,15 +33,9 @@ ID of the access group from which you want to remove an access system user. --- -**`acs_user_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id. - ---- - -**`user_identity_id`** *String* - -ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id. +ID of the access system user that you want to remove from an access group. --- diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 59f2d009b..380a1f839 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -27,21 +27,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id. - ---- - -**`acs_user_id`** *String* - -ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. - ---- - -**`user_identity_id`** *String* - -ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. +ID of the access system user for whom you want to revoke access. --- diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 6aff8d0c1..dd6f96dc4 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -27,21 +27,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. - ---- - -**`acs_user_id`** *String* - -ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. - ---- - -**`user_identity_id`** *String* - -ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. +ID of the access system user that you want to suspend. --- diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index dd5a8da0f..244cf6433 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -27,21 +27,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. - ---- - -**`acs_user_id`** *String* - -ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. - ---- - -**`user_identity_id`** *String* - -ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. +ID of the access system user that you want to unsuspend. --- diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 8cd70d3c2..1c2627692 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -27,21 +27,15 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_schedule`** *Object* - -`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. - ---- - -**`acs_system_id`** *String* +**`acs_user_id`** *String* (Required) -ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. +ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`acs_user_id`** *String* +**`access_schedule`** *Object* -ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id. +`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. --- @@ -71,12 +65,6 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- -**`user_identity_id`** *String* - -ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. - ---- - ## Response diff --git a/docs/api/pagination.md b/docs/api/pagination.md new file mode 100644 index 000000000..892d1e9e4 --- /dev/null +++ b/docs/api/pagination.md @@ -0,0 +1,1177 @@ +--- +description: Learn how to use pagination in the Seam API. +--- + +# Pagination + +For endpoints that can return long lists of resources, using pagination makes your app faster and more efficient. The Seam API and our JavaScript, Python, PHP, and Ruby SDKs support pagination for `list` endpoints. + +{% hint style="info" %} +Currently, we support pagination for devices, access codes, access system users, and connected accounts. +{% endhint %} + +To fetch and process resources across multiple pages in the Seam API, use the `limit` and `page_cursor` parameters, along with the `pagination` response object. The `pagination` object provides the following information: + +
PropertyTypeDescription
next_page_cursorStringOpaque value that you use to select the next page of results through the page_cursor parameter.
has_next_pageBooleanIndicates whether there is another page of results after this one.
next_page_urlString (URI)URL to get the next page of results.
+ +For pagination in the Seam SDKs, use the corresponding paginator class, for example, `SeamPaginator` in the Seam JavaScript and Python SDKs and `Paginator` in the Seam PHP and Ruby SDKs. + +The following examples show you how to use pagination in a variety of scenarios: + +## Manually Fetch Pages + +You can specify the number of records per page and the desired page of results. The first `list` request returns the first set of records, as well as the `pagination` object. If `pagination.has_next_page` is `true`, you can request an additional page of records. For all `list` requests after the first, use the `pagination.next_page_cursor` as the value for the `page_cursor` parameter. + +The following example gets the first page of 20 devices and then the second page of 20 devices: + +{% tabs %} +{% tab title="Python" %} +**Code:** + +```python +paginator = seam.create_paginator(seam.devices.list, {"limit": 20}) + +devices, pagination = paginator.first_page() + +if pagination.has_next_page: + more_devices, _ = paginator.next_page(pagination.next_page_cursor) +``` + +**Output:** + +``` +[ + Device( + device_id='11111111-1111-1111-1111-444444444444', + ... + ), + ... +] +``` +{% endtab %} + +{% tab title="cURL (bash)" %} +**Request:** + +```bash +# Use GET or POST. +curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d '{ + "limit": 20 + }' + +curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"limit\": 20 + \"page_cursor\": \"${next_page_cursor}\" + }" +``` + +**Response:** + +```json +{ + "devices": [ + { + "device_id": "11111111-1111-1111-1111-444444444444", + ... + }, + ... + ], + "pagination": { + "next_page_cursor": "[string]", + "has_next_page": true, + "next_page_url": "[URI]" + }, + "ok": true +} +``` +{% endtab %} + +{% tab title="JavaScript" %} +**Code:** + +```javascript +const pages = seam.createPaginator( + seam.devices.list({ + limit: 20, + }), +) + +const [devices, { hasNextPage, nextPageCursor }] = await pages.firstPage() + +if (hasNextPage) { + const [moreDevices] = await pages.nextPage(nextPageCursor) +} +``` + +**Output:** + +```json +[ + { + device_id: '11111111-1111-1111-1111-444444444444', + ... + }, + ... +] +``` +{% endtab %} + +{% tab title="Ruby" %} +**Code:** + +```ruby +paginator = seam.create_paginator(seam.devices.method(:list), {limit: 20}) + +devices, pagination = paginator.first_page + +if pagination.has_next_page? + more_devices, _ = paginator.next_page(pagination.next_page_cursor) +end +``` + +**Output:** + +``` +[ + , + ... +] +``` +{% endtab %} + +{% tab title="PHP" %} +**Code:** + +```php +$pages = $seam->createPaginator( + fn($params) => $seam->devices->list(...$params), + ["limit" => 2] +); + +[$devices, $pagination] = $pages->firstPage(); + +if ($pagination->has_next_page) { + [$moreDevices] = $pages->nextPage($pagination->next_page_cursor); +} +``` + +**Output:** + +```json +[ + { + "device_id": "11111111-1111-1111-1111-444444444444", + ... + }, + ... +] +``` +{% endtab %} + +{% tab title="C#" %} +**Code:** + +```csharp +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Java" %} +**Code:** + +```java +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Go" %} +**Code:** + +```go +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} +{% endtabs %} + +*** + +## Resume Pagination + +You can get the first page on initial load, store the state, and then get the next page at a later time using the stored state. + +The following example gets the first page of 20 records from the list of devices and, later, gets the next page of 20 devices: + +{% tabs %} +{% tab title="Python" %} +**Code:** + +```python +# Get the first page. +params = {"limit": 20} +paginator = seam.create_paginator(seam.devices.list, params) + +devices, pagination = paginator.first_page() + +# Store the state, for example, in memory, a file, or a database. +pagination_state = { + "params": params, + "next_page_cursor": pagination.next_page_cursor, + "has_next_page": pagination.has_next_page, +} +with open("/tmp/seam_devices_list.json", "w") as f: + json.dump(pagination_state, f) + +# Get the next page at a later time using the stored state. +with open("/tmp/seam_devices_list.json", "r") as f: + pagination_state = json.load(f) + +if pagination_state.get("has_next_page"): + paginator = seam.create_paginator( + seam.devices.list, pagination_state["params"] + ) + more_devices, _ = paginator.next_page( + pagination_state["next_page_cursor"] + ) +``` + +**Output:** + +``` +[ + Device( + device_id='11111111-1111-1111-1111-444444444444', + ... + ), + ... +] + +[ + Device( + device_id='11111111-1111-1111-2222-444444444444', + ... + ), + ... +] +``` +{% endtab %} + +{% tab title="cURL (bash)" %} +**Request:** + +```bash +# Get the first page. +# Use GET or POST. +curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d '{ + "limit": 20 + }' + +# Store the state, for example, in memory, a file, or a database. + +# At a later time, retrieve the stored state. +# Then, get the next page using the stored state. +curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"limit\": 20 + \"page_cursor\": \"${next_page_cursor}\" + }" +``` + +**Response:** + +```json +{ + "devices": [ + { + "device_id": "11111111-1111-1111-1111-444444444444", + ... + }, + ... + ], + "pagination": { + "next_page_cursor": "[string]", + "has_next_page": true, + "next_page_url": "[URI]" + }, + "ok": true +} + +{ + "devices": [ + { + "device_id": "11111111-1111-1111-2222-444444444444", + ... + }, + ... + ], + "pagination": { + "next_page_cursor": "[string]", + "has_next_page": true, + "next_page_url": "[URI]" + }, + "ok": true +} +``` +{% endtab %} + +{% tab title="JavaScript" %} +**Code:** + +```javascript +// Get the first page of devices. +const params = { limit: 20 } + +const pages = seam.createPaginator(seam.devices.list(params)) + +const [devices, pagination] = await pages.firstPage() + +// Store the state, for example, in memory, a file, or a database. +localStorage.setItem('/seam/devices/list', JSON.stringify([params, pagination])) + +// Later, get the next page of devices. +const [params = {}, { hasNextPage = false, nextPageCursor = null } = {}] = + JSON.parse(localStorage.getItem('/seam/devices/list') ?? '[]') + +if (hasNextPage) { + const pages = seam.createPaginator(seam.devices.list(params)) + const [moreDevices] = await pages.nextPage(nextPageCursor) +} +``` + +**Output:** + +```json +[ + { + device_id: '11111111-1111-1111-1111-444444444444', + ... + }, + ... +] + +[ + { + device_id: '11111111-1111-1111-2222-444444444444', + ... + }, + ... +] +``` +{% endtab %} + +{% tab title="Ruby" %} +**Code:** + +```ruby +# Get the first page. +params = {limit: 20} +paginator = seam.create_paginator(seam.devices.method(:list), params) + +devices, pagination = paginator.first_page + +# Store the state, for example, in memory, a file, or a database. +pagination_state = { + "params" => params, + "next_page_cursor" => pagination.next_page_cursor, + "has_next_page" => pagination.has_next_page? +} +File.write("/tmp/seam_devices_list.json", JSON.dump(pagination_state)) + +# Get the next page at a later time using the stored state. +pagination_state_json = File.read("/tmp/seam_devices_list.json") +pagination_state = JSON.parse(pagination_state_json) + +if pagination_state["has_next_page"] + paginator = seam.create_paginator( + seam.devices.method(:list), pagination_state["params"] + ) + more_devices, _ = paginator.next_page( + pagination_state["next_page_cursor"] + ) +``` + +**Output:** + +``` +[ + , + ... +] + +[ + , + ... +] +``` +{% endtab %} + +{% tab title="PHP" %} +**Code:** + +```php +// Get the first page. +$params = ["limit" => 20]; + +$pages = $seam->createPaginator( + fn($p) => $seam->devices->list(...$p), + $params +); + +[$devices, $pagination] = $pages->firstPage(); + +// Store the state, for example, in memory, a file, or a database. +file_put_contents( + "/tmp/seam_devices_list.json", + json_encode([$params, $pagination]) +); + +// Get the next page at a later time using the stored state. +$stored_data = json_decode( + file_get_contents("/tmp/seam_devices_list.json") ?: "[]", + false +); + +$params = $stored_data[0] ?? []; +$pagination = + $stored_data[1] ?? + (object) ["has_next_page" => false, "next_page_cursor" => null]; + +if ($pagination->has_next_page) { + $pages = $seam->createPaginator( + fn($p) => $seam->devices->list(...$p), + $params + ); + [$moreDevices] = $pages->nextPage($pagination->next_page_cursor); +} +``` + +**Output:** + +```json +[ + { + "device_id": "11111111-1111-1111-1111-444444444444", + ... + }, + ... +] + +[ + { + "device_id": "11111111-1111-1111-2222-444444444444", + ... + }, + ... +] +``` +{% endtab %} + +{% tab title="C#" %} +**Code:** + +```csharp +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Java" %} +**Code:** + +```java +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Go" %} +**Code:** + +```go +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} +{% endtabs %} + +*** + +## Iterate Over All Pages + +You can iterate over all pages of records. + +The following example uses a loop to get all pages of records for a list of 65 devices, at 20 records per page: + +{% tabs %} +{% tab title="Python" %} +**Code:** + +```python +pages = seam.create_paginator( + seam.devices.list( + limit=20 + ) +) + +for devices in pages: + pprint(f"There are {len(devices)} devices on this page.") +``` + +**Output:** + +``` +There are 20 devices on this page. +There are 20 devices on this page. +There are 20 devices on this page. +There are 5 devices on this page. +``` +{% endtab %} + +{% tab title="cURL (bash)" %} +**Request:** + +```bash +# Get the first page. +# Use GET or POST. +response=$(curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d '{ + "limit": 20 + }') + +echo "$response" | jq -r '.devices | length' | xargs -I {} echo "There are {} devices on this page." + +# Extract pagination info. +next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') +has_next=$(echo "$response" | jq -r '.pagination.has_next_page') + +# Process subsequent pages. +while [ "$has_next" = "true" ] && [ ! -z "$next_cursor" ]; do + response=$(curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"limit\": 20, + \"page_cursor\": \"${next_cursor}\" + }") + + echo "$response" | jq -r '.devices | length' | xargs -I {} echo "There are {} devices on this page." + + # Update pagination info. + next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') + has_next=$(echo "$response" | jq -r '.pagination.has_next_page') +done +``` + +**Response:** + +``` +There are 20 devices on this page. +There are 20 devices on this page. +There are 20 devices on this page. +There are 5 devices on this page. +``` +{% endtab %} + +{% tab title="JavaScript" %} +**Code:** + +```javascript +const pages = seam.createPaginator( + seam.devices.list({ + limit: 20, + }), +) + +for await (const devices of pages) { + console.log(`There are ${devices.length} devices on this page.`) +} +``` + +**Output:** + +``` +There are 20 devices on this page. +There are 20 devices on this page. +There are 20 devices on this page. +There are 5 devices on this page. +``` +{% endtab %} + +{% tab title="Ruby" %} +**Code:** + +```ruby +params = {limit: 20} +pages = seam.create_paginator(seam.devices.method(:list), params) + +pages.each do |devices| + puts "There are #{devices.length} devices on this page." +end +``` + +**Output:** + +``` +There are 20 devices on this page. +There are 20 devices on this page. +There are 20 devices on this page. +There are 5 devices on this page. +``` +{% endtab %} + +{% tab title="PHP" %} +**Code:** + +```php +$params = ["limit" => 20]; + +$paginator = $seam->createPaginator( + fn($p) => $seam->devices->list(...$p), + $params +); + +foreach ($paginator as $page) { + $devices = $page->devices; + echo "There are " . count($devices) . " devices on this page." . PHP_EOL; +} +``` + +**Output:** + +``` +There are 20 devices on this page. +There are 20 devices on this page. +There are 20 devices on this page. +There are 5 devices on this page. +``` +{% endtab %} + +{% tab title="C#" %} +**Code:** + +```csharp +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Java" %} +**Code:** + +```java +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Go" %} +**Code:** + +```go +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} +{% endtabs %} + +*** + +## Iterate Over All Resources + +You can iterate over all resources within all pages. + +The following example uses a loop to get all records for a list of devices, at 20 records per page, and then prints out the device ID for each record: + +{% tabs %} +{% tab title="Python" %} +**Code:** + +```python +paginator = seam.create_paginator(seam.devices.list, {"limit": 20}) + +for device in paginator.flatten(): + print(device.device_id) +``` + +**Output:** + +``` +'11111111-1111-1111-1111-444444444444' +'11111111-1111-1111-2222-444444444444' +... +``` +{% endtab %} + +{% tab title="cURL (bash)" %} +**Request:** + +```bash +# Get the first page. +# Use GET or POST. +response=$(curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d '{ + "limit": 20 + }') + +# Process all pages. +while true; do + # Extract and print the device IDs from the current page. + echo "$response" | jq -r '.devices[].device_id' + + # Check whether there are more pages. + has_next=$(echo "$response" | jq -r '.pagination.has_next_page') + if [ "$has_next" != "true" ]; then + break + fi + + # Get the next page cursor. + next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') + if [ -z "$next_cursor" ] || [ "$next_cursor" = "null" ]; then + break + fi + + # Fetch the next page. + response=$(curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"limit\": 20, + \"page_cursor\": \"${next_cursor}\" + }") +done +``` + +**Response:** + +``` +"11111111-1111-1111-1111-444444444444" +"11111111-1111-1111-2222-444444444444" +... +``` +{% endtab %} + +{% tab title="JavaScript" %} +**Code:** + +```javascript +const pages = seam.createPaginator( + seam.devices.list({ + limit: 20, + }), +) + +for await (const device of pages.flatten()) { + console.log(device.device_id) +} +``` + +**Output:** + +``` +'11111111-1111-1111-1111-444444444444' +'11111111-1111-1111-2222-444444444444' +... +``` +{% endtab %} + +{% tab title="Ruby" %} +**Code:** + +```ruby +paginator = seam.create_paginator(seam.devices.method(:list), {limit: 20}) + +paginator.flatten.each do |device| + puts device.device_id +end +``` + +**Output:** + +``` +"11111111-1111-1111-1111-444444444444" +"11111111-1111-1111-2222-444444444444" +... +``` +{% endtab %} + +{% tab title="PHP" %} +**Code:** + +```php +$pages = $seam->createPaginator( + fn($p) => $seam->devices->list(...$p), + ["limit" => 20] +); + +foreach ($pages->flatten() as $device) { + print $device->device_id . "\n"; +} +``` + +**Output:** + +```json +"11111111-1111-1111-1111-444444444444" +"11111111-1111-1111-2222-444444444444" +... +``` +{% endtab %} + +{% tab title="C#" %} +**Code:** + +```csharp +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Java" %} +**Code:** + +```java +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Go" %} +**Code:** + +```go +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} +{% endtabs %} + +*** + +## Return All Resources Across All Pages as an Array + +You can iterate over all resources within all pages and return a single array or list. + +The following example returns an array containing all devices: + +{% tabs %} +{% tab title="Python" %} +**Code:** + +```python +paginator = seam.create_paginator(seam.devices.list, {"limit": 20}) + +all_devices = paginator.flatten_to_list() +``` + +**Output:** + +``` +[ + Device( + device_id='11111111-1111-1111-1111-444444444444', + ... + ), + Device( + device_id='11111111-1111-1111-2222-444444444444', + ... + ), + ... +] +``` +{% endtab %} + +{% tab title="cURL (bash)" %} +**Request:** + +```bash +# Get the first page. +# Use GET or POST. +response=$(curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d '{ + "limit": 20 + }') + +# Process all pages. +while true; do + # Extract all devices from the current page and add them + # the all_devices array. + devices=$(echo "$response" | jq -c '.devices[]') + while IFS= read -r device; do + [ -n "$device" ] && all_devices+=("$device") + done <<< "$devices" + + # Check whether there are more pages. + has_next=$(echo "$response" | jq -r '.pagination.has_next_page') + if [ "$has_next" != "true" ]; then + break + fi + + # Get the next page cursor. + next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') + if [ -z "$next_cursor" ] || [ "$next_cursor" = "null" ]; then + break + fi + + # Fetch the next page. + response=$(curl -X 'GET' \ + 'https://connect.getseam.com/devices/list' \ + -H 'accept: application/json' \ + -H "Authorization: Bearer ${SEAM_API_KEY}" \ + -H 'Content-Type: application/json' \ + -d "{ + \"limit\": 20, + \"page_cursor\": \"${next_cursor}\" + }") +done +``` + +**Response:** + +```json +[ + { + device_id: '11111111-1111-1111-1111-444444444444', + ... + }, + { + device_id: '11111111-1111-1111-2222-444444444444', + ... + }, + ... +] +``` +{% endtab %} + +{% tab title="JavaScript" %} +**Code:** + +```javascript +const pages = seam.createPaginator( + seam.devices.list({ + limit: 20, + }), +) + +const devices = await pages.flattenToArray() +``` + +**Output:** + +```json +[ + { + device_id: '11111111-1111-1111-1111-444444444444', + ... + }, + { + device_id: '11111111-1111-1111-2222-444444444444', + ... + }, + ... +] +``` +{% endtab %} + +{% tab title="Ruby" %} +**Code:** + +```ruby +paginator = seam.create_paginator(seam.devices.method(:list), {limit: 20}) + +all_devices = paginator.flatten_to_list +``` + +**Output:** + +``` +[ + , + , + ... +] +``` +{% endtab %} + +{% tab title="PHP" %} +**Code:** + +```php +$pages = $seam->createPaginator( + fn($p) => $seam->devices->list(...$p), + ["limit" => 20] +); + +$deviecs = $pages->flattenToArray(); +``` + +**Output:** + +```json +[ + { + "device_id": "11111111-1111-1111-1111-444444444444", + ... + }, + { + "device_id": "11111111-1111-1111-2222-444444444444", + ... + }, + ... +] +``` +{% endtab %} + +{% tab title="C#" %} +**Code:** + +```csharp +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Java" %} +**Code:** + +```java +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} + +{% tab title="Go" %} +**Code:** + +```go +// Coming soon! +``` + +**Output:** + +```json +// Coming soon! +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 0bb02928e..4ffddc72c 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -35,8 +35,7 @@ Represents an app user's mobile phone. **`created_at`** *Datetime* -Date and time at which the phone was created. - +Date and time at which the `phone` was created. @@ -46,7 +45,6 @@ Date and time at which the phone was created. **`custom_metadata`** *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. - @@ -55,8 +53,7 @@ Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to **`device_id`** *UUID* -ID of the phone. - +ID of the `phone`. @@ -65,8 +62,7 @@ ID of the phone. **`device_type`** *Enum* -Device type for phones. - +Type of phone.
@@ -82,7 +78,6 @@ Device type for phones. **`display_name`** *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. - @@ -91,7 +86,7 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. **`errors`** *List* *of Objects* -Errors associated with the phone. +Errors associated with the `phone`. @@ -106,7 +101,6 @@ Errors associated with the phone. **`nickname`** *String* Optional nickname to describe the phone, settable through Seam. - @@ -115,9 +109,7 @@ Optional nickname to describe the phone, settable through Seam. **`properties`** *Object* - - Properties of the phone. - +Properties of the phone. @@ -160,7 +152,7 @@ Optional nickname to describe the phone, settable through Seam. **`warnings`** *List* *of Objects* -Warnings associated with the phone. +Warnings associated with the `phone`. @@ -174,8 +166,7 @@ Warnings associated with the phone. **`workspace_id`** *UUID* -ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the phone. - +ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. @@ -199,7 +190,7 @@ A phone device was deactivated. device_id UUID - ID of the affected phone device. + ID of the [device](../../core-concepts/devices/README.md). event_id UUID @@ -215,7 +206,7 @@ A phone device was deactivated. workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md).
--- diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 906ff86f2..70eb19995 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -13,11 +13,11 @@ A thermostat [climate preset](../../capability-guides/thermostats/creating-and-m climate_preset_key String - Key of the climate preset that was activated. + Key of the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated. connected_account_id UUID - ID of the connected account associated with the event. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -25,7 +25,7 @@ A thermostat [climate preset](../../capability-guides/thermostats/creating-and-m device_id UUID - ID of the affected device. + ID of the device. event_id UUID @@ -37,7 +37,7 @@ A thermostat [climate preset](../../capability-guides/thermostats/creating-and-m is_fallback_climate_preset Boolean - Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat. + Indicates whether the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated is the [fallback climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). occurred_at Datetime @@ -45,11 +45,11 @@ A thermostat [climate preset](../../capability-guides/thermostats/creating-and-m thermostat_schedule_id UUID - ID of the thermostat schedule that prompted the affected climate preset to be activated. + ID of the [thermostat schedule](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that prompted the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to be activated. workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -64,7 +64,7 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad connected_account_id UUID - ID of the connected account associated with the event. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). cooling_set_point_celsius Number @@ -80,7 +80,7 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad device_id UUID - ID of the affected device. + ID of the device. event_id UUID @@ -123,7 +123,7 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad method Enum - Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat. + Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
Enum values: @@ -137,7 +137,7 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md).
--- @@ -152,7 +152,7 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp connected_account_id UUID - ID of the connected account associated with the event. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -160,7 +160,7 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp device_id UUID - ID of the affected device. + ID of the device. event_id UUID @@ -172,11 +172,11 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp lower_limit_celsius Number - Lower temperature limit, in °C, defined by the set threshold. + Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). lower_limit_fahrenheit Number - Lower temperature limit, in °F, defined by the set threshold. + Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). occurred_at Datetime @@ -184,23 +184,23 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp temperature_celsius Number - Temperature, in °C, reported by the affected thermostat. + Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). temperature_fahrenheit Number - Temperature, in °F, reported by the affected thermostat. + Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). upper_limit_celsius Number - Upper temperature limit, in °C, defined by the set threshold. + Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). upper_limit_fahrenheit Number - Upper temperature limit, in °F, defined by the set threshold. + Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -215,7 +215,7 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp connected_account_id UUID - ID of the connected account associated with the event. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -223,7 +223,7 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp device_id UUID - ID of the affected device. + ID of the device. event_id UUID @@ -235,11 +235,11 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp lower_limit_celsius Number - Lower temperature limit, in °C, defined by the set threshold. + Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). lower_limit_fahrenheit Number - Lower temperature limit, in °F, defined by the set threshold. + Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). occurred_at Datetime @@ -247,23 +247,23 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp temperature_celsius Number - Temperature, in °C, reported by the affected thermostat. + Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). temperature_fahrenheit Number - Temperature, in °F, reported by the affected thermostat. + Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). upper_limit_celsius Number - Upper temperature limit, in °C, defined by the set threshold. + Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). upper_limit_fahrenheit Number - Upper temperature limit, in °F, defined by the set threshold. + Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -278,7 +278,7 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp connected_account_id UUID - ID of the connected account associated with the event. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -286,15 +286,15 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp desired_temperature_celsius Number - Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point. + Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). desired_temperature_fahrenheit Number - Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point. + Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). device_id UUID - ID of the affected device. + ID of the device. event_id UUID @@ -310,15 +310,15 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp temperature_celsius Number - Temperature, in °C, reported by the affected thermostat. + Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). temperature_fahrenheit Number - Temperature, in °F, reported by the affected thermostat. + Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- @@ -333,7 +333,7 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) repo connected_account_id UUID - ID of the connected account associated with the event. + ID of the [connected account](../../core-concepts/connected-accounts/README.md). created_at Datetime @@ -341,7 +341,7 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) repo device_id UUID - ID of the affected device. + ID of the device. event_id UUID @@ -357,15 +357,15 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) repo temperature_celsius Number - Temperature, in °C, reported by the affected thermostat. + Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). temperature_fahrenheit Number - Temperature, in °F, reported by the affected thermostat. + Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../core-concepts/workspaces/README.md). --- diff --git a/docs/api/unstable_partner/README.md b/docs/api/unstable_partner/README.md deleted file mode 100644 index 949fbf279..000000000 --- a/docs/api/unstable_partner/README.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -description: ---- - -# Partner - - - -## Resources - -The Partner namespace contains the following resources: - diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index c199a05d2..252a94299 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -90,7 +90,7 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi enrollment_automation_id UUID - ID of the affected enrollment automation. + ID of the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut). event_id UUID @@ -106,7 +106,7 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi workspace_id UUID - ID of the workspace associated with the event. + ID of the [workspace](../../../core-concepts/workspaces/README.md). --- diff --git a/package-lock.json b/package-lock.json index 2cfbce186..f1187a002 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,9 +12,9 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.43.5", + "@seamapi/blueprint": "^0.43.3", "@seamapi/smith": "^0.4.4", - "@seamapi/types": "1.406.2", + "@seamapi/types": "^1.402.0", "change-case": "^5.4.4", "command-exists": "^1.2.9", "execa": "^9.3.1", @@ -752,9 +752,9 @@ "peer": true }, "node_modules/@seamapi/blueprint": { - "version": "0.43.5", - "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.43.5.tgz", - "integrity": "sha512-8NiaXDXoXEGxGOddILQDVlSA0M3T1hHwAsqgrlSjsjvbx3jChbR+i+yxmIQO/tK2kO1GevuCRLXBCLS8+kAHZQ==", + "version": "0.43.3", + "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.43.3.tgz", + "integrity": "sha512-yehJ/h+DdMH6W9gPAIn7x7l3lNA1pau04rI1/0q5C5izMhcsw8IWT9JFh0iZEqcz3E6p6yXzzg+N9KpTbLHTOw==", "license": "MIT", "dependencies": { "change-case": "^5.4.4", @@ -798,9 +798,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.406.2", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.406.2.tgz", - "integrity": "sha512-FclxrgGjw/rrUoPp3BaYEYpour8d6WtxJQZAGFuMDuhqdOly3/PxQZybESoD3gxcYQIk2JQj18RUwWyFInOrBw==", + "version": "1.402.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.402.0.tgz", + "integrity": "sha512-pcnjm9Bei7Av6hNzVJ0/za9RdhFALD2pCIirO/LQYjV2sG5GLd/dmfgz9BM0vS8sDCLMlmOMHh0JOUA9+TboBQ==", "license": "MIT", "engines": { "node": ">=18.12.0", diff --git a/package.json b/package.json index b9093904e..e599ba2b2 100644 --- a/package.json +++ b/package.json @@ -32,9 +32,9 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.43.5", + "@seamapi/blueprint": "^0.43.3", "@seamapi/smith": "^0.4.4", - "@seamapi/types": "1.406.2", + "@seamapi/types": "^1.402.0", "change-case": "^5.4.4", "command-exists": "^1.2.9", "execa": "^9.3.1", diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 55e647b35..f27f7831e 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -93,6 +93,3 @@ /access_codes/simulate: title: Access Code Simulations - -/unstable_partner: - title: Partner From a7fe46b94b91d47bf0de78a61020bbb565cb0f93 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 2 Jun 2025 20:04:01 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/pagination.md | 1177 ---------------------------------------- 1 file changed, 1177 deletions(-) delete mode 100644 docs/api/pagination.md diff --git a/docs/api/pagination.md b/docs/api/pagination.md deleted file mode 100644 index 892d1e9e4..000000000 --- a/docs/api/pagination.md +++ /dev/null @@ -1,1177 +0,0 @@ ---- -description: Learn how to use pagination in the Seam API. ---- - -# Pagination - -For endpoints that can return long lists of resources, using pagination makes your app faster and more efficient. The Seam API and our JavaScript, Python, PHP, and Ruby SDKs support pagination for `list` endpoints. - -{% hint style="info" %} -Currently, we support pagination for devices, access codes, access system users, and connected accounts. -{% endhint %} - -To fetch and process resources across multiple pages in the Seam API, use the `limit` and `page_cursor` parameters, along with the `pagination` response object. The `pagination` object provides the following information: - -
PropertyTypeDescription
next_page_cursorStringOpaque value that you use to select the next page of results through the page_cursor parameter.
has_next_pageBooleanIndicates whether there is another page of results after this one.
next_page_urlString (URI)URL to get the next page of results.
- -For pagination in the Seam SDKs, use the corresponding paginator class, for example, `SeamPaginator` in the Seam JavaScript and Python SDKs and `Paginator` in the Seam PHP and Ruby SDKs. - -The following examples show you how to use pagination in a variety of scenarios: - -## Manually Fetch Pages - -You can specify the number of records per page and the desired page of results. The first `list` request returns the first set of records, as well as the `pagination` object. If `pagination.has_next_page` is `true`, you can request an additional page of records. For all `list` requests after the first, use the `pagination.next_page_cursor` as the value for the `page_cursor` parameter. - -The following example gets the first page of 20 devices and then the second page of 20 devices: - -{% tabs %} -{% tab title="Python" %} -**Code:** - -```python -paginator = seam.create_paginator(seam.devices.list, {"limit": 20}) - -devices, pagination = paginator.first_page() - -if pagination.has_next_page: - more_devices, _ = paginator.next_page(pagination.next_page_cursor) -``` - -**Output:** - -``` -[ - Device( - device_id='11111111-1111-1111-1111-444444444444', - ... - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -**Request:** - -```bash -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "limit": 20 - }' - -curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d "{ - \"limit\": 20 - \"page_cursor\": \"${next_page_cursor}\" - }" -``` - -**Response:** - -```json -{ - "devices": [ - { - "device_id": "11111111-1111-1111-1111-444444444444", - ... - }, - ... - ], - "pagination": { - "next_page_cursor": "[string]", - "has_next_page": true, - "next_page_url": "[URI]" - }, - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -**Code:** - -```javascript -const pages = seam.createPaginator( - seam.devices.list({ - limit: 20, - }), -) - -const [devices, { hasNextPage, nextPageCursor }] = await pages.firstPage() - -if (hasNextPage) { - const [moreDevices] = await pages.nextPage(nextPageCursor) -} -``` - -**Output:** - -```json -[ - { - device_id: '11111111-1111-1111-1111-444444444444', - ... - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -**Code:** - -```ruby -paginator = seam.create_paginator(seam.devices.method(:list), {limit: 20}) - -devices, pagination = paginator.first_page - -if pagination.has_next_page? - more_devices, _ = paginator.next_page(pagination.next_page_cursor) -end -``` - -**Output:** - -``` -[ - , - ... -] -``` -{% endtab %} - -{% tab title="PHP" %} -**Code:** - -```php -$pages = $seam->createPaginator( - fn($params) => $seam->devices->list(...$params), - ["limit" => 2] -); - -[$devices, $pagination] = $pages->firstPage(); - -if ($pagination->has_next_page) { - [$moreDevices] = $pages->nextPage($pagination->next_page_cursor); -} -``` - -**Output:** - -```json -[ - { - "device_id": "11111111-1111-1111-1111-444444444444", - ... - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -**Code:** - -```csharp -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Java" %} -**Code:** - -```java -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -**Code:** - -```go -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} -{% endtabs %} - -*** - -## Resume Pagination - -You can get the first page on initial load, store the state, and then get the next page at a later time using the stored state. - -The following example gets the first page of 20 records from the list of devices and, later, gets the next page of 20 devices: - -{% tabs %} -{% tab title="Python" %} -**Code:** - -```python -# Get the first page. -params = {"limit": 20} -paginator = seam.create_paginator(seam.devices.list, params) - -devices, pagination = paginator.first_page() - -# Store the state, for example, in memory, a file, or a database. -pagination_state = { - "params": params, - "next_page_cursor": pagination.next_page_cursor, - "has_next_page": pagination.has_next_page, -} -with open("/tmp/seam_devices_list.json", "w") as f: - json.dump(pagination_state, f) - -# Get the next page at a later time using the stored state. -with open("/tmp/seam_devices_list.json", "r") as f: - pagination_state = json.load(f) - -if pagination_state.get("has_next_page"): - paginator = seam.create_paginator( - seam.devices.list, pagination_state["params"] - ) - more_devices, _ = paginator.next_page( - pagination_state["next_page_cursor"] - ) -``` - -**Output:** - -``` -[ - Device( - device_id='11111111-1111-1111-1111-444444444444', - ... - ), - ... -] - -[ - Device( - device_id='11111111-1111-1111-2222-444444444444', - ... - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -**Request:** - -```bash -# Get the first page. -# Use GET or POST. -curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "limit": 20 - }' - -# Store the state, for example, in memory, a file, or a database. - -# At a later time, retrieve the stored state. -# Then, get the next page using the stored state. -curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d "{ - \"limit\": 20 - \"page_cursor\": \"${next_page_cursor}\" - }" -``` - -**Response:** - -```json -{ - "devices": [ - { - "device_id": "11111111-1111-1111-1111-444444444444", - ... - }, - ... - ], - "pagination": { - "next_page_cursor": "[string]", - "has_next_page": true, - "next_page_url": "[URI]" - }, - "ok": true -} - -{ - "devices": [ - { - "device_id": "11111111-1111-1111-2222-444444444444", - ... - }, - ... - ], - "pagination": { - "next_page_cursor": "[string]", - "has_next_page": true, - "next_page_url": "[URI]" - }, - "ok": true -} -``` -{% endtab %} - -{% tab title="JavaScript" %} -**Code:** - -```javascript -// Get the first page of devices. -const params = { limit: 20 } - -const pages = seam.createPaginator(seam.devices.list(params)) - -const [devices, pagination] = await pages.firstPage() - -// Store the state, for example, in memory, a file, or a database. -localStorage.setItem('/seam/devices/list', JSON.stringify([params, pagination])) - -// Later, get the next page of devices. -const [params = {}, { hasNextPage = false, nextPageCursor = null } = {}] = - JSON.parse(localStorage.getItem('/seam/devices/list') ?? '[]') - -if (hasNextPage) { - const pages = seam.createPaginator(seam.devices.list(params)) - const [moreDevices] = await pages.nextPage(nextPageCursor) -} -``` - -**Output:** - -```json -[ - { - device_id: '11111111-1111-1111-1111-444444444444', - ... - }, - ... -] - -[ - { - device_id: '11111111-1111-1111-2222-444444444444', - ... - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -**Code:** - -```ruby -# Get the first page. -params = {limit: 20} -paginator = seam.create_paginator(seam.devices.method(:list), params) - -devices, pagination = paginator.first_page - -# Store the state, for example, in memory, a file, or a database. -pagination_state = { - "params" => params, - "next_page_cursor" => pagination.next_page_cursor, - "has_next_page" => pagination.has_next_page? -} -File.write("/tmp/seam_devices_list.json", JSON.dump(pagination_state)) - -# Get the next page at a later time using the stored state. -pagination_state_json = File.read("/tmp/seam_devices_list.json") -pagination_state = JSON.parse(pagination_state_json) - -if pagination_state["has_next_page"] - paginator = seam.create_paginator( - seam.devices.method(:list), pagination_state["params"] - ) - more_devices, _ = paginator.next_page( - pagination_state["next_page_cursor"] - ) -``` - -**Output:** - -``` -[ - , - ... -] - -[ - , - ... -] -``` -{% endtab %} - -{% tab title="PHP" %} -**Code:** - -```php -// Get the first page. -$params = ["limit" => 20]; - -$pages = $seam->createPaginator( - fn($p) => $seam->devices->list(...$p), - $params -); - -[$devices, $pagination] = $pages->firstPage(); - -// Store the state, for example, in memory, a file, or a database. -file_put_contents( - "/tmp/seam_devices_list.json", - json_encode([$params, $pagination]) -); - -// Get the next page at a later time using the stored state. -$stored_data = json_decode( - file_get_contents("/tmp/seam_devices_list.json") ?: "[]", - false -); - -$params = $stored_data[0] ?? []; -$pagination = - $stored_data[1] ?? - (object) ["has_next_page" => false, "next_page_cursor" => null]; - -if ($pagination->has_next_page) { - $pages = $seam->createPaginator( - fn($p) => $seam->devices->list(...$p), - $params - ); - [$moreDevices] = $pages->nextPage($pagination->next_page_cursor); -} -``` - -**Output:** - -```json -[ - { - "device_id": "11111111-1111-1111-1111-444444444444", - ... - }, - ... -] - -[ - { - "device_id": "11111111-1111-1111-2222-444444444444", - ... - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -**Code:** - -```csharp -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Java" %} -**Code:** - -```java -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -**Code:** - -```go -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} -{% endtabs %} - -*** - -## Iterate Over All Pages - -You can iterate over all pages of records. - -The following example uses a loop to get all pages of records for a list of 65 devices, at 20 records per page: - -{% tabs %} -{% tab title="Python" %} -**Code:** - -```python -pages = seam.create_paginator( - seam.devices.list( - limit=20 - ) -) - -for devices in pages: - pprint(f"There are {len(devices)} devices on this page.") -``` - -**Output:** - -``` -There are 20 devices on this page. -There are 20 devices on this page. -There are 20 devices on this page. -There are 5 devices on this page. -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -**Request:** - -```bash -# Get the first page. -# Use GET or POST. -response=$(curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "limit": 20 - }') - -echo "$response" | jq -r '.devices | length' | xargs -I {} echo "There are {} devices on this page." - -# Extract pagination info. -next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') -has_next=$(echo "$response" | jq -r '.pagination.has_next_page') - -# Process subsequent pages. -while [ "$has_next" = "true" ] && [ ! -z "$next_cursor" ]; do - response=$(curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d "{ - \"limit\": 20, - \"page_cursor\": \"${next_cursor}\" - }") - - echo "$response" | jq -r '.devices | length' | xargs -I {} echo "There are {} devices on this page." - - # Update pagination info. - next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') - has_next=$(echo "$response" | jq -r '.pagination.has_next_page') -done -``` - -**Response:** - -``` -There are 20 devices on this page. -There are 20 devices on this page. -There are 20 devices on this page. -There are 5 devices on this page. -``` -{% endtab %} - -{% tab title="JavaScript" %} -**Code:** - -```javascript -const pages = seam.createPaginator( - seam.devices.list({ - limit: 20, - }), -) - -for await (const devices of pages) { - console.log(`There are ${devices.length} devices on this page.`) -} -``` - -**Output:** - -``` -There are 20 devices on this page. -There are 20 devices on this page. -There are 20 devices on this page. -There are 5 devices on this page. -``` -{% endtab %} - -{% tab title="Ruby" %} -**Code:** - -```ruby -params = {limit: 20} -pages = seam.create_paginator(seam.devices.method(:list), params) - -pages.each do |devices| - puts "There are #{devices.length} devices on this page." -end -``` - -**Output:** - -``` -There are 20 devices on this page. -There are 20 devices on this page. -There are 20 devices on this page. -There are 5 devices on this page. -``` -{% endtab %} - -{% tab title="PHP" %} -**Code:** - -```php -$params = ["limit" => 20]; - -$paginator = $seam->createPaginator( - fn($p) => $seam->devices->list(...$p), - $params -); - -foreach ($paginator as $page) { - $devices = $page->devices; - echo "There are " . count($devices) . " devices on this page." . PHP_EOL; -} -``` - -**Output:** - -``` -There are 20 devices on this page. -There are 20 devices on this page. -There are 20 devices on this page. -There are 5 devices on this page. -``` -{% endtab %} - -{% tab title="C#" %} -**Code:** - -```csharp -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Java" %} -**Code:** - -```java -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -**Code:** - -```go -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} -{% endtabs %} - -*** - -## Iterate Over All Resources - -You can iterate over all resources within all pages. - -The following example uses a loop to get all records for a list of devices, at 20 records per page, and then prints out the device ID for each record: - -{% tabs %} -{% tab title="Python" %} -**Code:** - -```python -paginator = seam.create_paginator(seam.devices.list, {"limit": 20}) - -for device in paginator.flatten(): - print(device.device_id) -``` - -**Output:** - -``` -'11111111-1111-1111-1111-444444444444' -'11111111-1111-1111-2222-444444444444' -... -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -**Request:** - -```bash -# Get the first page. -# Use GET or POST. -response=$(curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "limit": 20 - }') - -# Process all pages. -while true; do - # Extract and print the device IDs from the current page. - echo "$response" | jq -r '.devices[].device_id' - - # Check whether there are more pages. - has_next=$(echo "$response" | jq -r '.pagination.has_next_page') - if [ "$has_next" != "true" ]; then - break - fi - - # Get the next page cursor. - next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') - if [ -z "$next_cursor" ] || [ "$next_cursor" = "null" ]; then - break - fi - - # Fetch the next page. - response=$(curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d "{ - \"limit\": 20, - \"page_cursor\": \"${next_cursor}\" - }") -done -``` - -**Response:** - -``` -"11111111-1111-1111-1111-444444444444" -"11111111-1111-1111-2222-444444444444" -... -``` -{% endtab %} - -{% tab title="JavaScript" %} -**Code:** - -```javascript -const pages = seam.createPaginator( - seam.devices.list({ - limit: 20, - }), -) - -for await (const device of pages.flatten()) { - console.log(device.device_id) -} -``` - -**Output:** - -``` -'11111111-1111-1111-1111-444444444444' -'11111111-1111-1111-2222-444444444444' -... -``` -{% endtab %} - -{% tab title="Ruby" %} -**Code:** - -```ruby -paginator = seam.create_paginator(seam.devices.method(:list), {limit: 20}) - -paginator.flatten.each do |device| - puts device.device_id -end -``` - -**Output:** - -``` -"11111111-1111-1111-1111-444444444444" -"11111111-1111-1111-2222-444444444444" -... -``` -{% endtab %} - -{% tab title="PHP" %} -**Code:** - -```php -$pages = $seam->createPaginator( - fn($p) => $seam->devices->list(...$p), - ["limit" => 20] -); - -foreach ($pages->flatten() as $device) { - print $device->device_id . "\n"; -} -``` - -**Output:** - -```json -"11111111-1111-1111-1111-444444444444" -"11111111-1111-1111-2222-444444444444" -... -``` -{% endtab %} - -{% tab title="C#" %} -**Code:** - -```csharp -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Java" %} -**Code:** - -```java -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -**Code:** - -```go -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} -{% endtabs %} - -*** - -## Return All Resources Across All Pages as an Array - -You can iterate over all resources within all pages and return a single array or list. - -The following example returns an array containing all devices: - -{% tabs %} -{% tab title="Python" %} -**Code:** - -```python -paginator = seam.create_paginator(seam.devices.list, {"limit": 20}) - -all_devices = paginator.flatten_to_list() -``` - -**Output:** - -``` -[ - Device( - device_id='11111111-1111-1111-1111-444444444444', - ... - ), - Device( - device_id='11111111-1111-1111-2222-444444444444', - ... - ), - ... -] -``` -{% endtab %} - -{% tab title="cURL (bash)" %} -**Request:** - -```bash -# Get the first page. -# Use GET or POST. -response=$(curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d '{ - "limit": 20 - }') - -# Process all pages. -while true; do - # Extract all devices from the current page and add them - # the all_devices array. - devices=$(echo "$response" | jq -c '.devices[]') - while IFS= read -r device; do - [ -n "$device" ] && all_devices+=("$device") - done <<< "$devices" - - # Check whether there are more pages. - has_next=$(echo "$response" | jq -r '.pagination.has_next_page') - if [ "$has_next" != "true" ]; then - break - fi - - # Get the next page cursor. - next_cursor=$(echo "$response" | jq -r '.pagination.next_page_cursor') - if [ -z "$next_cursor" ] || [ "$next_cursor" = "null" ]; then - break - fi - - # Fetch the next page. - response=$(curl -X 'GET' \ - 'https://connect.getseam.com/devices/list' \ - -H 'accept: application/json' \ - -H "Authorization: Bearer ${SEAM_API_KEY}" \ - -H 'Content-Type: application/json' \ - -d "{ - \"limit\": 20, - \"page_cursor\": \"${next_cursor}\" - }") -done -``` - -**Response:** - -```json -[ - { - device_id: '11111111-1111-1111-1111-444444444444', - ... - }, - { - device_id: '11111111-1111-1111-2222-444444444444', - ... - }, - ... -] -``` -{% endtab %} - -{% tab title="JavaScript" %} -**Code:** - -```javascript -const pages = seam.createPaginator( - seam.devices.list({ - limit: 20, - }), -) - -const devices = await pages.flattenToArray() -``` - -**Output:** - -```json -[ - { - device_id: '11111111-1111-1111-1111-444444444444', - ... - }, - { - device_id: '11111111-1111-1111-2222-444444444444', - ... - }, - ... -] -``` -{% endtab %} - -{% tab title="Ruby" %} -**Code:** - -```ruby -paginator = seam.create_paginator(seam.devices.method(:list), {limit: 20}) - -all_devices = paginator.flatten_to_list -``` - -**Output:** - -``` -[ - , - , - ... -] -``` -{% endtab %} - -{% tab title="PHP" %} -**Code:** - -```php -$pages = $seam->createPaginator( - fn($p) => $seam->devices->list(...$p), - ["limit" => 20] -); - -$deviecs = $pages->flattenToArray(); -``` - -**Output:** - -```json -[ - { - "device_id": "11111111-1111-1111-1111-444444444444", - ... - }, - { - "device_id": "11111111-1111-1111-2222-444444444444", - ... - }, - ... -] -``` -{% endtab %} - -{% tab title="C#" %} -**Code:** - -```csharp -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Java" %} -**Code:** - -```java -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} - -{% tab title="Go" %} -**Code:** - -```go -// Coming soon! -``` - -**Output:** - -```json -// Coming soon! -``` -{% endtab %} -{% endtabs %}