From 8ac48f3b4d5fbb3eec70f4ee5aca2022d4ecc6ad Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 22 May 2025 23:30:02 +0000 Subject: [PATCH 1/2] feat(deps): bump @seamapi/types from 1.395.1 to 1.402.0 Bumps [@seamapi/types](https://github.com/seamapi/types) from 1.395.1 to 1.402.0. - [Release notes](https://github.com/seamapi/types/releases) - [Changelog](https://github.com/seamapi/types/blob/main/.releaserc.json) - [Commits](https://github.com/seamapi/types/compare/v1.395.1...v1.402.0) --- updated-dependencies: - dependency-name: "@seamapi/types" dependency-version: 1.402.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 41fb31bc5..ebd7ef16e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.42.0", - "@seamapi/types": "1.395.1", + "@seamapi/types": "1.402.0", "change-case": "^5.4.4", "command-exists": "^1.2.9", "del": "^8.0.0", @@ -781,9 +781,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.395.1", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.395.1.tgz", - "integrity": "sha512-n13LTzgH6cJioTFIqWubdOrXk4pvxOs/SXcWbTGBFG84AWnZOQ6uEky5kRgDq1wTrlrzzAh1Jgieq72C3sxXcA==", + "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 27bedd577..e4be5e987 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.42.0", - "@seamapi/types": "1.395.1", + "@seamapi/types": "1.402.0", "change-case": "^5.4.4", "command-exists": "^1.2.9", "del": "^8.0.0", From 94916bcd888e71bf782cba9c1501ce5fc735b6ab Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 22 May 2025 23:31:01 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/_blueprint.json | 4020 +++++++++++++---- docs/api/_report.md | 251 +- docs/api/access_codes/README.md | 13 +- docs/api/access_codes/create.md | 10 +- docs/api/access_codes/create_multiple.md | 10 +- docs/api/access_codes/delete.md | 4 +- docs/api/access_codes/generate_code.md | 49 + .../access_codes/pull_backup_access_code.md | 4 +- .../access_codes/report_device_constraints.md | 4 +- docs/api/access_codes/unmanaged/README.md | 10 + .../unmanaged/convert_to_managed.md | 4 +- docs/api/access_codes/unmanaged/delete.md | 2 +- .../update-multiple-linked-access-codes.md | 8 - docs/api/access_codes/update.md | 8 +- docs/api/access_codes/update_multiple.md | 8 +- docs/api/acs/access_groups/README.md | 6 +- docs/api/acs/access_groups/add_user.md | 14 +- docs/api/acs/access_groups/get.md | 2 +- docs/api/acs/access_groups/list.md | 10 +- docs/api/acs/access_groups/list_users.md | 4 +- docs/api/acs/access_groups/remove_user.md | 14 +- docs/api/acs/credentials/README.md | 4 +- docs/api/acs/credentials/assign.md | 14 +- docs/api/acs/credentials/create.md | 16 +- docs/api/acs/credentials/delete.md | 2 +- docs/api/acs/credentials/get.md | 2 +- docs/api/acs/credentials/list.md | 4 +- .../credentials/list_accessible_entrances.md | 2 +- docs/api/acs/credentials/unassign.md | 14 +- docs/api/acs/credentials/update.md | 4 +- docs/api/acs/encoders/get.md | 2 +- docs/api/acs/encoders/list.md | 8 +- docs/api/acs/encoders/scan_credential.md | 2 +- docs/api/acs/entrances/README.md | 6 +- docs/api/acs/entrances/get.md | 4 +- docs/api/acs/entrances/grant_access.md | 6 +- docs/api/acs/entrances/list.md | 6 +- .../entrances/list_credentials_with_access.md | 4 + docs/api/acs/systems/README.md | 6 +- docs/api/acs/systems/get.md | 6 +- docs/api/acs/systems/list.md | 6 +- ...mpatible_credential_manager_acs_systems.md | 6 +- docs/api/acs/users/README.md | 22 +- docs/api/acs/users/add_to_access_group.md | 6 +- docs/api/acs/users/create.md | 12 +- docs/api/acs/users/delete.md | 4 +- docs/api/acs/users/get.md | 4 +- docs/api/acs/users/list.md | 14 +- .../acs/users/list_accessible_entrances.md | 4 +- .../api/acs/users/remove_from_access_group.md | 6 +- .../users/revoke_access_to_all_entrances.md | 4 +- docs/api/acs/users/suspend.md | 4 +- docs/api/acs/users/unsuspend.md | 4 +- docs/api/acs/users/update.md | 4 +- docs/api/devices/device-provider-metadata.md | 2 - docs/api/thermostats/README.md | 5 + .../thermostats/activate_climate_preset.md | 4 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/create_climate_preset.md | 2 +- docs/api/thermostats/delete_climate_preset.md | 4 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/list.md | 25 +- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/schedules/README.md | 12 +- .../set_fallback_climate_preset.md | 4 +- docs/api/thermostats/set_fan_mode.md | 2 + docs/api/thermostats/set_hvac_mode.md | 2 +- .../thermostats/set_temperature_threshold.md | 2 +- docs/api/thermostats/update_climate_preset.md | 2 +- docs/api/thermostats/update_weekly_program.md | 97 + docs/api/user_identities/README.md | 4 +- docs/api/user_identities/create.md | 6 + docs/api/user_identities/delete.md | 2 +- 74 files changed, 3615 insertions(+), 1235 deletions(-) create mode 100644 docs/api/access_codes/generate_code.md delete mode 100644 docs/api/access_codes/update-multiple-linked-access-codes.md delete mode 100644 docs/api/devices/device-provider-metadata.md create mode 100644 docs/api/thermostats/update_weekly_program.md diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index f06374ac3..6aa992e0b 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -88,7 +88,7 @@ }, { "name": "device_id", - "description": "ID of the device for which to create the new access code.", + "description": "ID of the device for which you want to create the new access code.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -215,7 +215,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "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": "", @@ -427,7 +427,7 @@ }, { "name": "device_ids", - "description": "IDs of the devices for which to create the new access codes.", + "description": "IDs of the devices for which you want to create the new access codes.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -555,7 +555,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "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": "", @@ -667,7 +667,7 @@ "parameters": [ { "name": "access_code_id", - "description": "ID of the access code to delete.", + "description": "ID of the access code that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -681,7 +681,7 @@ }, { "name": "device_id", - "description": "ID of the device for which to delete the access code.", + "description": "ID of the device for which you want to delete the access code.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -720,10 +720,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Generate a Code", "name": "generate_code", "path": "/access_codes/generate_code", - "description": "", + "description": "Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -743,7 +743,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device for which you want to generate a code.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -946,7 +946,7 @@ "title": "Pull a Backup Access Code", "name": "pull_backup_access_code", "path": "/access_codes/pull_backup_access_code", - "description": "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.", + "description": "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -993,7 +993,7 @@ "title": "Report Device Access Code Constraints", "name": "report_device_constraints", "path": "/access_codes/report_device_constraints", - "description": "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.", + "description": "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.\n\nSpecify either `supported_code_lengths` or `min_code_length`/`max_code_length`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -1008,7 +1008,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the device for which to report constraints.", + "description": "ID of the device for which you want to report constraints.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -1291,7 +1291,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "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": "", @@ -1482,7 +1482,7 @@ }, { "name": "name", - "description": "Name of the new access code.", + "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": "", @@ -1649,7 +1649,7 @@ }, { "name": "allow_external_modification", - "description": "Indicates whether external modification of the access code is allowed.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1677,7 +1677,7 @@ }, { "name": "is_external_modification_allowed", - "description": "Indicates whether external modification of the access code is allowed.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1734,7 +1734,7 @@ "parameters": [ { "name": "access_code_id", - "description": "ID of the unmanaged access code to delete.", + "description": "ID of the unmanaged access code that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2026,7 +2026,7 @@ "title": "Add an ACS User to an Access Group", "name": "add_user", "path": "/acs/access_groups/add_user", - "description": "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -2041,7 +2041,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the desired access group.", + "description": "ID of the access group to which you want to add an access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2055,8 +2055,22 @@ }, { "name": "acs_user_id", - "description": "ID of the desired user.", - "isRequired": true, + "description": "ID of the access system user that you want to add to an access group. 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 desired user identity that you want to add to an access group. 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, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -2169,7 +2183,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the desired access group.", + "description": "ID of the access group that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2297,7 +2311,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "ID of the access control system for which you want to retrieve all access groups.", + "description": "ID of the access system for which you want to retrieve all access groups.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -2311,7 +2325,21 @@ }, { "name": "acs_user_id", - "description": "ID of the user for which you want to retrieve all access groups.", + "description": "ID of the access system user for which you want to retrieve all access groups.", + "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 which you want to retrieve all access groups.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -2548,7 +2576,7 @@ "title": "List ACS Users in an Access Group", "name": "list_users", "path": "/acs/access_groups/list_users", - "description": "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -2568,7 +2596,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the access group for which you want to retrieve all users.", + "description": "ID of the access group for which you want to retrieve all access system users.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2686,7 +2714,7 @@ "title": "Remove an ACS User from an Access Group", "name": "remove_user", "path": "/acs/access_groups/remove_user", - "description": "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -2701,7 +2729,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the desired access group.", + "description": "ID of the access group from which you want to remove an access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2715,8 +2743,22 @@ }, { "name": "acs_user_id", - "description": "ID of the desired user.", - "isRequired": true, + "description": "ID of the access system user that you want to remove from an access group.", + "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 associated with the user that you want to remove from an access group.", + "isRequired": false, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -2822,7 +2864,7 @@ }, "endpoints": [ { - "title": "", + "title": "Get an Unmanaged Access Group", "name": "get", "path": "/acs/access_groups/unmanaged/get", "description": "Returns a specified unmanaged [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", @@ -2845,7 +2887,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the desired unmanaged access group.", + "description": "ID of the unmanaged access group that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -2950,7 +2992,7 @@ ] }, { - "title": "", + "title": "List Unmanaged Access Groups", "name": "list", "path": "/acs/access_groups/unmanaged/list", "description": "Returns a list of all unmanaged [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", @@ -2973,7 +3015,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "ID of the access control system for which you want to retrieve all unmanaged access groups.", + "description": "ID of the access system for which you want to retrieve all unmanaged access groups.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -2987,7 +3029,7 @@ }, { "name": "acs_user_id", - "description": "ID of the user for which you want to retrieve all unmanaged access groups.", + "description": "ID of the access system user for which you want to retrieve all unmanaged access groups.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -3111,10 +3153,10 @@ }, "endpoints": [ { - "title": "", + "title": "List Credential Pools", "name": "list", "path": "/acs/credential_pools/list", - "description": "", + "description": "Returns a list of all credential pools.", "isDeprecated": false, "deprecationMessage": "Use `/user_identities/enrollment_automations/list` instead.", "isUndocumented": true, @@ -3134,7 +3176,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "", + "description": "ID of the access system for which you want to list credential pools.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -3170,10 +3212,10 @@ }, "endpoints": [ { - "title": "", + "title": "Launch a Credential Provisioning Automation", "name": "launch", "path": "/acs/credential_provisioning_automations/launch", - "description": "", + "description": "Launches a credential provisioning automation.", "isDeprecated": false, "deprecationMessage": "Use `/user_identities/enrollment_automations/launch` instead.", "isUndocumented": true, @@ -3193,7 +3235,7 @@ "parameters": [ { "name": "acs_credential_pool_id", - "description": "", + "description": "ID of the credential pool for which you want to launch a credential provisioning automation.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -3207,7 +3249,7 @@ }, { "name": "create_credential_manager_user", - "description": "", + "description": "Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -3221,7 +3263,7 @@ }, { "name": "credential_manager_acs_system_id", - "description": "", + "description": "Access system ID of the credential manager for which you want to launch a credential provisioning automation.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -3235,7 +3277,7 @@ }, { "name": "credential_manager_acs_user_id", - "description": "", + "description": "ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -3249,7 +3291,7 @@ }, { "name": "user_identity_id", - "description": "", + "description": "ID of the user identity for which you want to launch a credential provisioning automation.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -3288,7 +3330,7 @@ "title": "Assign a Credential to an ACS User", "name": "assign", "path": "/acs/credentials/assign", - "description": "Assigns a specified [credential](../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Assigns a specified [credential](../capability-guides/access-systems/managing-credentials.md) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -3303,7 +3345,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "ID of the desired credential.", + "description": "ID of the credential that you want to assign to an access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -3317,8 +3359,22 @@ }, { "name": "acs_user_id", - "description": "ID of the desired user.", - "isRequired": true, + "description": "ID of the access system user to whom you want to assign a credential. 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 assign a credential. 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 credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.", + "isRequired": false, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -3489,10 +3545,24 @@ } ] }, + { + "name": "acs_system_id", + "description": "ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_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 ACS user to whom the new credential belongs.", - "isRequired": true, + "description": "ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.", + "isRequired": false, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -3665,7 +3735,7 @@ "parameters": [ { "name": "assign_new_key", - "description": "", + "description": "Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](../device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -3679,7 +3749,7 @@ }, { "name": "update_current_key", - "description": "", + "description": "Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](../device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -3707,6 +3777,20 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "user_identity_id", + "description": "ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, { "name": "visionline_metadata", "description": "Visionline-specific metadata for the new credential.", @@ -3971,7 +4055,7 @@ "title": "Create an Offline Credential for an ACS User", "name": "create_offline_code", "path": "/acs/credentials/create_offline_code", - "description": "Creates a new offline [credential](../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Creates a new offline [credential](../capability-guides/access-systems/managing-credentials.md) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": true, @@ -3991,7 +4075,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the ACS user to whom the new credential belongs.", + "description": "ID of the access system user to whom the new credential belongs.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -4086,7 +4170,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "ID of the desired credential.", + "description": "ID of the credential that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -4199,7 +4283,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "ID of the desired credential.", + "description": "ID of the credential that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -4326,7 +4410,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the ACS user for which you want to retrieve all credentials.", + "description": "ID of the access system user for which you want to retrieve all credentials.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -4340,7 +4424,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access control system for which you want to retrieve all credentials.", + "description": "ID of the access system for which you want to retrieve all credentials.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -4533,7 +4617,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "ID of the credential for which you want to retrieve all entrances to which this credential grants access.", + "description": "ID of the credential for which you want to retrieve all entrances to which the credential grants access.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -4649,7 +4733,7 @@ "title": "Unassign a Credential from an ACS User", "name": "unassign", "path": "/acs/credentials/unassign", - "description": "Unassigns a specified [credential](../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Unassigns a specified [credential](../capability-guides/access-systems/managing-credentials.md) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -4664,7 +4748,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "ID of the desired credential.", + "description": "ID of the credential that you want to unassign from an access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -4678,8 +4762,22 @@ }, { "name": "acs_user_id", - "description": "ID of the desired user.", - "isRequired": true, + "description": "ID of the access system user from which you want to unassign a credential. 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 from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.", + "isRequired": false, "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -4801,7 +4899,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "ID of the desired credential.", + "description": "ID of the credential that you want to update.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -4815,7 +4913,7 @@ }, { "name": "code", - "description": "Replacement access (PIN) code for the credential.", + "description": "Replacement access (PIN) code for the credential that you want to update.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -4959,7 +5057,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "ID of the desired unmanaged credential.", + "description": "ID of the unmanaged credential that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -5002,7 +5100,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the ACS user for which you want to retrieve all credentials.", + "description": "ID of the access system user for which you want to retrieve all credentials.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5016,7 +5114,7 @@ }, { "name": "acs_system_id", - "description": "ID of the access control system for which you want to retrieve all credentials.", + "description": "ID of the access system for which you want to retrieve all credentials.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5205,7 +5303,7 @@ "parameters": [ { "name": "acs_encoder_id", - "description": "ID of the desired encoder.", + "description": "ID of the encoder that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -5248,7 +5346,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.", + "description": "ID of the access system for which you want to retrieve all encoders.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5262,7 +5360,7 @@ }, { "name": "limit", - "description": "Number of `acs_encoders` to return.", + "description": "Number of encoders to return.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5277,7 +5375,7 @@ }, { "name": "acs_system_ids", - "description": "IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.", + "description": "IDs of the access systems for which you want to retrieve all encoders.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5292,7 +5390,7 @@ }, { "name": "acs_encoder_ids", - "description": "IDs of the `acs_encoder`s that you want to retrieve.", + "description": "IDs of the encoders that you want to retrieve.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5337,7 +5435,7 @@ "parameters": [ { "name": "acs_encoder_id", - "description": "ID of the `acs_encoder` to use for the scan.", + "description": "ID of the encoder to use for the scan.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -5761,7 +5859,7 @@ "title": "Get an Entrance", "name": "get", "path": "/acs/entrances/get", - "description": "Returns a specified [ACS entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "description": "Returns a specified [access system entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -5781,7 +5879,7 @@ "parameters": [ { "name": "acs_entrance_id", - "description": "", + "description": "ID of the entrance that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -5883,7 +5981,7 @@ "title": "Grant an ACS User Access to an Entrance", "name": "grant_access", "path": "/acs/entrances/grant_access", - "description": "", + "description": "Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -5898,7 +5996,7 @@ "parameters": [ { "name": "acs_entrance_id", - "description": "", + "description": "ID of the entrance to which you want to grant an access system user access.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -5912,7 +6010,7 @@ }, { "name": "acs_user_id", - "description": "", + "description": "ID of the access system user to whom you want to grant access to an entrance.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -5935,7 +6033,7 @@ "title": "List Entrances", "name": "list", "path": "/acs/entrances/list", - "description": "Returns a list of all [ACS entrances](../capability-guides/access-systems/retrieving-entrance-details.md).", + "description": "Returns a list of all [access system entrances](../capability-guides/access-systems/retrieving-entrance-details.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -5955,7 +6053,7 @@ "parameters": [ { "name": "acs_credential_id", - "description": "", + "description": "ID of the credential for which you want to retrieve all entrances.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5969,7 +6067,7 @@ }, { "name": "acs_system_id", - "description": "", + "description": "ID of the access system for which you want to retrieve all entrances.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -5983,7 +6081,7 @@ }, { "name": "location_id", - "description": "", + "description": "ID of the location for which you want to retrieve all entrances.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6106,7 +6204,7 @@ "parameters": [ { "name": "acs_entrance_id", - "description": "", + "description": "ID of the entrance for which you want to list all credentials that grant access.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -6120,7 +6218,7 @@ }, { "name": "include_if", - "description": "", + "description": "Conditions that credentials must meet to be included in the returned list.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6273,7 +6371,7 @@ "title": "Get an ACS System", "name": "get", "path": "/acs/systems/get", - "description": "Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the desired access control system by including the corresponding `acs_system_id` in the request body.", + "description": "Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -6293,7 +6391,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "ID of the desired access control system.", + "description": "ID of the access system that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -6392,7 +6490,7 @@ "title": "List ACS Systems", "name": "list", "path": "/acs/systems/list", - "description": "Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace.", + "description": "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -6412,7 +6510,7 @@ "parameters": [ { "name": "connected_account_id", - "description": "ID of the connected account by which to filter the list of returned access control systems.", + "description": "ID of the connected account by which you want to filter the list of access systems.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6515,7 +6613,7 @@ "title": "List Compatible Credential Manager ACS Systems", "name": "list_compatible_credential_manager_acs_systems", "path": "/acs/systems/list_compatible_credential_manager_acs_systems", - "description": "Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body.", + "description": "Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -6535,7 +6633,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.", + "description": "ID of the access system for which you want to retrieve all compatible credential manager systems.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -6650,7 +6748,7 @@ "title": "Add an ACS User to an Access Group", "name": "add_to_access_group", "path": "/acs/users/add_to_access_group", - "description": "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "description": "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -6665,7 +6763,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the desired access group.", + "description": "ID of the access group to which you want to add an access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -6679,7 +6777,7 @@ }, { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user that you want to add to an access group.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -6773,7 +6871,7 @@ "title": "Create an ACS User", "name": "create", "path": "/acs/users/create", - "description": "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -6793,7 +6891,7 @@ "parameters": [ { "name": "access_schedule", - "description": "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`.", + "description": "`starts_at` and `ends_at` timestamps for the new 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`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6807,7 +6905,7 @@ "parameters": [ { "name": "ends_at", - "description": "", + "description": "Ending timestamp for the new access system user's access.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6821,7 +6919,7 @@ }, { "name": "starts_at", - "description": "", + "description": "Starting timestamp for the new access system user's access.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6837,7 +6935,7 @@ }, { "name": "acs_access_group_ids", - "description": "Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.", + "description": "Array of access group IDs to indicate the access groups to which you want to add the new access system user.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -6853,7 +6951,7 @@ }, { "name": "acs_system_id", - "description": "ID of the `acs_system` to which to add the new `acs_user`.", + "description": "ID of the access system to which you want to add the new access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -6895,7 +6993,7 @@ }, { "name": "full_name", - "description": "Full name of the new `acs_user`.", + "description": "Full name of the new access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -6923,7 +7021,7 @@ }, { "name": "user_identity_id", - "description": "ID of the user identity with which to associate the new `acs_user`.", + "description": "ID of the user identity with which you want to associate the new access system user.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -7209,7 +7307,7 @@ "title": "Delete an ACS User", "name": "delete", "path": "/acs/users/delete", - "description": "Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../capability-guides/access-systems/managing-credentials.md).", + "description": "Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](../capability-guides/access-systems/managing-credentials.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7224,7 +7322,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -7317,7 +7415,7 @@ "title": "Get an ACS User", "name": "get", "path": "/acs/users/get", - "description": "Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7337,7 +7435,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -7443,7 +7541,7 @@ "title": "List ACS Users", "name": "list", "path": "/acs/users/list", - "description": "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7463,7 +7561,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "ID of the `acs_system` for which you want to retrieve all `acs_user`s.", + "description": "ID of the `acs_system` for which you want to retrieve all access system users.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -7477,7 +7575,7 @@ }, { "name": "created_before", - "description": "", + "description": "Timestamp by which to limit returned access system users. Returns users created before this timestamp.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -7520,7 +7618,7 @@ }, { "name": "search", - "description": "String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.", + "description": "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -7534,7 +7632,7 @@ }, { "name": "user_identity_email_address", - "description": "Email address of the user identity for which you want to retrieve all `acs_user`s.", + "description": "Email address of the user identity for which you want to retrieve all access system users.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -7548,7 +7646,7 @@ }, { "name": "user_identity_id", - "description": "ID of the user identity for which you want to retrieve all `acs_user`s.", + "description": "ID of the user identity for which you want to retrieve all access system users.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -7562,7 +7660,7 @@ }, { "name": "user_identity_phone_number", - "description": "Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).", + "description": "Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -7667,7 +7765,7 @@ "title": "List ACS User-Accessible Entrances", "name": "list_accessible_entrances", "path": "/acs/users/list_accessible_entrances", - "description": "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.", + "description": "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7687,7 +7785,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user for whom you want to list accessible entrances.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -7714,7 +7812,7 @@ "title": "Remove an ACS User from an Access Group", "name": "remove_from_access_group", "path": "/acs/users/remove_from_access_group", - "description": "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "description": "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7729,7 +7827,7 @@ "parameters": [ { "name": "acs_access_group_id", - "description": "ID of the desired access group.", + "description": "ID of the access group from which you want to remove an access system user.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -7743,7 +7841,7 @@ }, { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user that you want to remove from an access group.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -7837,7 +7935,7 @@ "title": "Revoke ACS User Access to All Entrances", "name": "revoke_access_to_all_entrances", "path": "/acs/users/revoke_access_to_all_entrances", - "description": "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7852,7 +7950,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user for whom you want to revoke access.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -7875,7 +7973,7 @@ "title": "Suspend an ACS User", "name": "suspend", "path": "/acs/users/suspend", - "description": "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.", + "description": "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7890,7 +7988,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user that you want to suspend.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -7983,7 +8081,7 @@ "title": "Unsuspend an ACS User", "name": "unsuspend", "path": "/acs/users/unsuspend", - "description": "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.", + "description": "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -7998,7 +8096,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "ID of the desired `acs_user`.", + "description": "ID of the access system user that you want to unsuspend.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -8091,7 +8189,7 @@ "title": "Update an ACS User", "name": "update", "path": "/acs/users/update", - "description": "Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "description": "Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8106,7 +8204,7 @@ "parameters": [ { "name": "access_schedule", - "description": "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.", + "description": "`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`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8120,7 +8218,7 @@ "parameters": [ { "name": "ends_at", - "description": "", + "description": "Ending timestamp for the access system user's access.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8134,7 +8232,7 @@ }, { "name": "starts_at", - "description": "", + "description": "Starting timestamp for the access system user's access.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8327,10 +8425,10 @@ }, "endpoints": [ { - "title": "", + "title": "Get an Unmanaged ACS User", "name": "get", "path": "/acs/users/unmanaged/get", - "description": "", + "description": "Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": true, @@ -8350,7 +8448,7 @@ "parameters": [ { "name": "acs_user_id", - "description": "", + "description": "ID of the unmanaged access system user that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -8370,10 +8468,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Unmanaged ACS Users", "name": "list", "path": "/acs/users/unmanaged/list", - "description": "", + "description": "Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": true, @@ -8393,7 +8491,7 @@ "parameters": [ { "name": "acs_system_id", - "description": "", + "description": "ID of the access system for which you want to retrieve all unmanaged access system users.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8407,7 +8505,7 @@ }, { "name": "limit", - "description": "", + "description": "Number of unmanaged access system users to return.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8422,7 +8520,7 @@ }, { "name": "user_identity_email_address", - "description": "", + "description": "Email address of the user identity for which you want to retrieve all unmanaged access system users.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8436,7 +8534,7 @@ }, { "name": "user_identity_id", - "description": "", + "description": "ID of the user identity for which you want to retrieve all unmanaged access system users.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8450,7 +8548,7 @@ }, { "name": "user_identity_phone_number", - "description": "", + "description": "Phone number of the user identity for which you want to retrieve all unmanaged access system users.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8481,10 +8579,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Get an Action Attempt", "name": "get", "path": "/action_attempts/get", - "description": "", + "description": "Returns a specified [action attempt](../core-concepts/action-attempts.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8504,7 +8602,7 @@ "parameters": [ { "name": "action_attempt_id", - "description": "", + "description": "ID of the action attempt that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -8528,10 +8626,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Action Attempts", "name": "list", "path": "/action_attempts/list", - "description": "", + "description": "Returns a list of the [action attempts](../core-concepts/action-attempts.md) that you specify as an array of `action_attempt_id`s.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8551,7 +8649,7 @@ "parameters": [ { "name": "action_attempt_ids", - "description": "", + "description": "IDs of the action attempts that you want to retrieve.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -8583,14 +8681,14 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Get a Seam Bridge", "name": "get", "path": "/bridges/get", - "description": "", + "description": "Returns a specified [Seam Bridge](../capability-guides/seam-bridge.md).", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Not yet for customer use.", "isDraft": false, "draftMessage": "", "response": { @@ -8606,7 +8704,7 @@ "parameters": [ { "name": "bridge_id", - "description": "", + "description": "ID of the Seam Bridge that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -8626,14 +8724,14 @@ "codeSamples": [] }, { - "title": "", + "title": "List Seam Bridges", "name": "list", "path": "/bridges/list", - "description": "", + "description": "Returns a list of all [Seam Bridges](../capability-guides/seam-bridge.md).", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Not yet for customer use.", "isDraft": false, "draftMessage": "", "response": { @@ -8655,7 +8753,7 @@ } ], "subroutes": [], - "isUndocumented": false, + "isUndocumented": true, "isDeprecated": false, "isDraft": false }, @@ -8665,10 +8763,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Create a Client Session", "name": "create", "path": "/client_sessions/create", - "description": "", + "description": "Creates a new [client session](../core-concepts/authentication/client-session-tokens/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8688,7 +8786,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) for which you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8703,7 +8801,7 @@ }, { "name": "connected_account_ids", - "description": "", + "description": "IDs of the [connected accounts](../core-concepts/connected-accounts/README.md) for which you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8718,7 +8816,7 @@ }, { "name": "expires_at", - "description": "", + "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.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8732,7 +8830,7 @@ }, { "name": "user_identifier_key", - "description": "", + "description": "Your user ID for the user for whom you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8746,7 +8844,7 @@ }, { "name": "user_identity_ids", - "description": "", + "description": "IDs of the [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) for which you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8771,10 +8869,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Delete a Client Session", "name": "delete", "path": "/client_sessions/delete", - "description": "", + "description": "Deletes a [client session](../core-concepts/authentication/client-session-tokens/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8789,7 +8887,7 @@ "parameters": [ { "name": "client_session_id", - "description": "", + "description": "ID of the client session that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -8809,10 +8907,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Get a Client Session", "name": "get", "path": "/client_sessions/get", - "description": "", + "description": "Returns a specified [client session](../core-concepts/authentication/client-session-tokens/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8832,7 +8930,7 @@ "parameters": [ { "name": "client_session_id", - "description": "", + "description": "ID of the client session that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8846,7 +8944,7 @@ }, { "name": "user_identifier_key", - "description": "", + "description": "User identifier key associated with the client session that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8870,10 +8968,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Get or Create a Client Session", "name": "get_or_create", "path": "/client_sessions/get_or_create", - "description": "", + "description": "Returns a [client session](../core-concepts/authentication/client-session-tokens/README.md) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8893,7 +8991,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session (or that are already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8908,7 +9006,7 @@ }, { "name": "connected_account_ids", - "description": "", + "description": "IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8923,7 +9021,7 @@ }, { "name": "expires_at", - "description": "", + "description": "Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8937,7 +9035,7 @@ }, { "name": "user_identifier_key", - "description": "", + "description": "Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8951,7 +9049,7 @@ }, { "name": "user_identity_ids", - "description": "", + "description": "IDs of the [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -8976,10 +9074,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Grant Access to a Client Session", "name": "grant_access", "path": "/client_sessions/grant_access", - "description": "", + "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](../core-concepts/connect-webviews/README.md), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -8994,7 +9092,7 @@ "parameters": [ { "name": "client_session_id", - "description": "", + "description": "ID of the client session to which you want to grant access to resources.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9008,7 +9106,7 @@ }, { "name": "connect_webview_ids", - "description": "", + "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9023,7 +9121,7 @@ }, { "name": "connected_account_ids", - "description": "", + "description": "IDs of the [connected accounts](../core-concepts/connected-accounts/README.md) that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9038,7 +9136,7 @@ }, { "name": "user_identifier_key", - "description": "", + "description": "Your user ID for the user that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9052,7 +9150,7 @@ }, { "name": "user_identity_ids", - "description": "", + "description": "IDs of the [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9073,10 +9171,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Client Sessions", "name": "list", "path": "/client_sessions/list", - "description": "", + "description": "Returns a list of all [client sessions](../core-concepts/authentication/client-session-tokens/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9096,7 +9194,7 @@ "parameters": [ { "name": "client_session_id", - "description": "", + "description": "ID of the client session that you want to retrieve.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9110,7 +9208,7 @@ }, { "name": "connect_webview_id", - "description": "", + "description": "ID of the [Connect Webview](../core-concepts/connect-webviews/README.md) for which you want to retrieve client sessions.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9124,7 +9222,7 @@ }, { "name": "user_identifier_key", - "description": "", + "description": "Your user ID for the user by which you want to filter client sessions.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9138,7 +9236,7 @@ }, { "name": "user_identity_id", - "description": "", + "description": "ID of the [user identity](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) for which you want to retrieve client sessions.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9152,7 +9250,7 @@ }, { "name": "without_user_identifier_key", - "description": "", + "description": "Indicates whether to retrieve only client sessions without associated user identifier keys.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9172,10 +9270,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Revoke a Client Session", "name": "revoke", "path": "/client_sessions/revoke", - "description": "", + "description": "Revokes a [client session](../core-concepts/authentication/client-session-tokens/README.md).\n\nNote that [deleting a client session](https://docs.seam.co/latest/api/client_sessions/delete) is a separate action.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9190,7 +9288,7 @@ "parameters": [ { "name": "client_session_id", - "description": "", + "description": "ID of the client session that you want to revoke.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -9221,10 +9319,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Create a Connect Webview", "name": "create", "path": "/connect_webviews/create", - "description": "", + "description": "Creates a new [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](../core-concepts/connect-webviews/connect-webview-process.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9244,7 +9342,7 @@ "parameters": [ { "name": "accepted_providers", - "description": "", + "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9717,6 +9815,16 @@ "isDraft": false, "draftMessage": "" }, + { + "name": "kwikset2", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, { "name": "yale_access", "description": "", @@ -9751,7 +9859,7 @@ }, { "name": "automatically_manage_new_devices", - "description": "", + "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9766,7 +9874,7 @@ }, { "name": "custom_metadata", - "description": "", + "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9780,7 +9888,7 @@ }, { "name": "custom_redirect_failure_url", - "description": "", + "description": "Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9794,7 +9902,7 @@ }, { "name": "custom_redirect_url", - "description": "", + "description": "URL that you want to redirect the user to after the provider login is complete.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9812,8 +9920,8 @@ "isRequired": false, "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Not supported.", "isDraft": false, "draftMessage": "", "hasDefault": false, @@ -9854,7 +9962,7 @@ }, { "name": "provider_category", - "description": "", + "description": "Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9930,7 +10038,7 @@ }, { "name": "wait_for_device_creation", - "description": "", + "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9955,10 +10063,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Delete a Connect Webview", "name": "delete", "path": "/connect_webviews/delete", - "description": "", + "description": "Deletes a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9973,7 +10081,7 @@ "parameters": [ { "name": "connect_webview_id", - "description": "", + "description": "ID of the Connect Webview that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -9993,10 +10101,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Get a Connect Webview", "name": "get", "path": "/connect_webviews/get", - "description": "", + "description": "Returns a specified [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10016,7 +10124,7 @@ "parameters": [ { "name": "connect_webview_id", - "description": "", + "description": "ID of the Connect Webview that you want to get.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -10040,10 +10148,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Connect Webviews", "name": "list", "path": "/connect_webviews/list", - "description": "", + "description": "Returns a list of all [Connect Webviews](../core-concepts/connect-webviews/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10063,7 +10171,7 @@ "parameters": [ { "name": "custom_metadata_has", - "description": "Returns webviews whose custom_metadata contains all of the provided key/value pairs.", + "description": "Custom metadata pairs by which you want to [filter Connect Webviews](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10077,7 +10185,7 @@ }, { "name": "limit", - "description": "", + "description": "Maximum number of records to return per page.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10092,7 +10200,7 @@ }, { "name": "user_identifier_key", - "description": "Returns webviews that can be accessed by the provided user_identifier_key.", + "description": "Your user ID for the user by which you want to filter Connect Webviews.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10127,10 +10235,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Delete a Connected Account", "name": "delete", "path": "/connected_accounts/delete", - "description": "", + "description": "Deletes a specified [connected account](../core-concepts/connected-accounts/README.md).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10145,7 +10253,7 @@ "parameters": [ { "name": "connected_account_id", - "description": "", + "description": "ID of the connected account that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -10163,8 +10271,8 @@ "isRequired": false, "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", "isDraft": false, "draftMessage": "", "hasDefault": true, @@ -10180,10 +10288,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Get a Connected Account", "name": "get", "path": "/connected_accounts/get", - "description": "", + "description": "Returns a specified [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10203,7 +10311,7 @@ "parameters": [ { "name": "connected_account_id", - "description": "", + "description": "ID of the connected account that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10217,7 +10325,7 @@ }, { "name": "email", - "description": "", + "description": "Email address associated with the connected account that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10241,10 +10349,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Connected Accounts", "name": "list", "path": "/connected_accounts/list", - "description": "", + "description": "Returns a list of all [connected accounts](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10264,7 +10372,7 @@ "parameters": [ { "name": "custom_metadata_has", - "description": "Returns accounts whose custom_metadata contains all of the provided key/value pairs.", + "description": "Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10276,6 +10384,21 @@ "format": "record", "jsonType": "object" }, + { + "name": "customer_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, { "name": "limit", "description": "Maximum number of records to return per page.", @@ -10307,7 +10430,7 @@ }, { "name": "user_identifier_key", - "description": "Returns accounts that can be accessed by the provided user_identifier_key.", + "description": "Your user ID for the user by which you want to filter connected accounts.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10327,10 +10450,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Update a Connected Account", "name": "update", "path": "/connected_accounts/update", - "description": "", + "description": "Updates a [connected account](../core-concepts/connected-accounts/README.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10345,7 +10468,7 @@ "parameters": [ { "name": "automatically_manage_new_devices", - "description": "", + "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10359,7 +10482,7 @@ }, { "name": "connected_account_id", - "description": "", + "description": "ID of the connected account that you want to update.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -10373,7 +10496,7 @@ }, { "name": "custom_metadata", - "description": "", + "description": "Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](../core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account.md) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](../core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10404,10 +10527,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Delete a Device", "name": "delete", "path": "/devices/delete", - "description": "", + "description": "Deletes a specified [device](../core-concepts/devices/README.md).", "isDeprecated": false, "deprecationMessage": "Deleting a device is no longer supported and will be removed.", "isUndocumented": true, @@ -10422,7 +10545,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -10442,10 +10565,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Get a Device", "name": "get", "path": "/devices/get", - "description": "", + "description": "Returns a specified [device](../core-concepts/devices/README.md).\n\nYou must specify either `device_id` or `name`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10465,7 +10588,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10479,7 +10602,7 @@ }, { "name": "name", - "description": "", + "description": "Name of the device that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10526,7 +10649,7 @@ "parameters": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview by which to filter devices.", + "description": "ID of the Connect Webview for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10540,7 +10663,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account by which to filter.", + "description": "ID of the connected account for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10554,7 +10677,7 @@ }, { "name": "connected_account_ids", - "description": "Array of IDs of the connected accounts by which to filter devices.", + "description": "Array of IDs of the connected accounts for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10569,7 +10692,7 @@ }, { "name": "created_before", - "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10583,7 +10706,7 @@ }, { "name": "custom_metadata_has", - "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10595,9 +10718,24 @@ "format": "record", "jsonType": "object" }, + { + "name": "customer_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, { "name": "device_ids", - "description": "Array of device IDs by which to filter devices.", + "description": "Array of device IDs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10612,7 +10750,7 @@ }, { "name": "device_type", - "description": "Device type by which to filter devices.", + "description": "Device type for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10964,6 +11102,16 @@ "isDraft": false, "draftMessage": "" }, + { + "name": "smartthings_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, { "name": "ios_phone", "description": "", @@ -10988,7 +11136,7 @@ }, { "name": "device_types", - "description": "Array of device types by which to filter devices.", + "description": "Array of device types for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -11341,6 +11489,16 @@ "isDraft": false, "draftMessage": "" }, + { + "name": "smartthings_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, { "name": "ios_phone", "description": "", @@ -11634,7 +11792,7 @@ }, { "name": "manufacturer", - "description": "Manufacturer by which to filter devices.", + "description": "Manufacturer for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -11867,7 +12025,7 @@ "draftMessage": "" }, { - "name": "minut", + "name": "two_n", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11877,7 +12035,7 @@ "draftMessage": "" }, { - "name": "two_n", + "name": "ttlock", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11887,7 +12045,7 @@ "draftMessage": "" }, { - "name": "ttlock", + "name": "igloohome", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11897,7 +12055,7 @@ "draftMessage": "" }, { - "name": "nest", + "name": "hubitat", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11907,7 +12065,7 @@ "draftMessage": "" }, { - "name": "igloohome", + "name": "controlbyweb", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11917,7 +12075,7 @@ "draftMessage": "" }, { - "name": "ecobee", + "name": "smartthings", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11927,7 +12085,7 @@ "draftMessage": "" }, { - "name": "hubitat", + "name": "dormakaba_oracode", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11937,7 +12095,7 @@ "draftMessage": "" }, { - "name": "controlbyweb", + "name": "tedee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11947,7 +12105,7 @@ "draftMessage": "" }, { - "name": "smartthings", + "name": "akiles", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11957,7 +12115,7 @@ "draftMessage": "" }, { - "name": "dormakaba_oracode", + "name": "ecobee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11967,7 +12125,7 @@ "draftMessage": "" }, { - "name": "tedee", + "name": "honeywell_resideo", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11977,7 +12135,7 @@ "draftMessage": "" }, { - "name": "honeywell_resideo", + "name": "minut", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -11987,7 +12145,17 @@ "draftMessage": "" }, { - "name": "akiles", + "name": "nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -12034,7 +12202,7 @@ }, { "name": "unstable_location_id", - "description": "", + "description": "ID of the location for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12048,7 +12216,7 @@ }, { "name": "user_identifier_key", - "description": "Your own internal user ID for the user by which to filter devices.", + "description": "Your own internal user ID for the user for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12072,10 +12240,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Device Providers", "name": "list_device_providers", "path": "/devices/list_device_providers", - "description": "", + "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](../core-concepts/connect-webviews/README.md), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -12095,7 +12263,7 @@ "parameters": [ { "name": "provider_category", - "description": "", + "description": "Category for which you want to list providers.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12171,10 +12339,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Update a Device", "name": "update", "path": "/devices/update", - "description": "", + "description": "Updates a specified [device](../core-concepts/devices/README.md).\n\nYou can add or change [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) for a device, change the device's name, or [convert a managed device to unmanaged](../core-concepts/devices/managed-and-unmanaged-devices.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -12189,7 +12357,7 @@ "parameters": [ { "name": "custom_metadata", - "description": "", + "description": "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a 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. Then, you can [filter devices by the desired metadata](../core-concepts/devices/filtering-devices-by-custom-metadata.md).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12203,7 +12371,7 @@ }, { "name": "device_id", - "description": "", + "description": "ID of the device that you want to update.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -12217,7 +12385,7 @@ }, { "name": "is_managed", - "description": "", + "description": "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12232,7 +12400,7 @@ }, { "name": "name", - "description": "", + "description": "Name for the device.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12260,7 +12428,7 @@ "parameters": [ { "name": "name", - "description": "", + "description": "Name for the device.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12297,10 +12465,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Simulate Device Connection", "name": "connect", "path": "/devices/simulate/connect", - "description": "", + "description": "Simulates connecting a device to Seam. Only applicable for [sandbox devices](../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](../core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -12315,7 +12483,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device that you want to simulate connecting to Seam.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -12335,10 +12503,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Simulate Device Disconnection", "name": "disconnect", "path": "/devices/simulate/disconnect", - "description": "", + "description": "Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](../core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -12353,7 +12521,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device that you want to simulate disconnecting from Seam.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -12373,10 +12541,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Simulate Device Removal", "name": "remove", "path": "/devices/simulate/remove", - "description": "", + "description": "Simulates removing a device from Seam. Only applicable for [sandbox devices](../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](../core-concepts/devices/testing-your-app-against-device-disconnection-and-removal.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -12391,7 +12559,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device that you want to simulate removing from Seam.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -12422,10 +12590,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Get an Unmanaged Device", "name": "get", "path": "/devices/unmanaged/get", - "description": "", + "description": "Returns a specified [unmanaged device](../core-concepts/devices/managed-and-unmanaged-devices.md).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](../core-concepts/devices/managed-and-unmanaged-devices.md#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -12445,7 +12613,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the unmanaged device that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12459,7 +12627,7 @@ }, { "name": "name", - "description": "", + "description": "Name of the unmanaged device that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12483,10 +12651,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Unmanaged Devices", "name": "list", "path": "/devices/unmanaged/list", - "description": "", + "description": "Returns a list of all [unmanaged devices](../core-concepts/devices/managed-and-unmanaged-devices.md).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](../core-concepts/devices/managed-and-unmanaged-devices.md#convert-an-unmanaged-device-to-managed).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -12506,7 +12674,7 @@ "parameters": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview by which to filter devices.", + "description": "ID of the Connect Webview for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12520,7 +12688,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account by which to filter.", + "description": "ID of the connected account for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12534,7 +12702,7 @@ }, { "name": "connected_account_ids", - "description": "Array of IDs of the connected accounts by which to filter devices.", + "description": "Array of IDs of the connected accounts for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12549,7 +12717,7 @@ }, { "name": "created_before", - "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12563,7 +12731,7 @@ }, { "name": "custom_metadata_has", - "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12575,9 +12743,24 @@ "format": "record", "jsonType": "object" }, + { + "name": "customer_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, { "name": "device_ids", - "description": "Array of device IDs by which to filter devices.", + "description": "Array of device IDs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12592,7 +12775,7 @@ }, { "name": "device_type", - "description": "Device type by which to filter devices.", + "description": "Device type for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12944,6 +13127,16 @@ "isDraft": false, "draftMessage": "" }, + { + "name": "smartthings_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, { "name": "ios_phone", "description": "", @@ -12968,7 +13161,7 @@ }, { "name": "device_types", - "description": "Array of device types by which to filter devices.", + "description": "Array of device types for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -13322,7 +13515,7 @@ "draftMessage": "" }, { - "name": "ios_phone", + "name": "smartthings_thermostat", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13332,124 +13525,7 @@ "draftMessage": "" }, { - "name": "android_phone", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - } - ] - }, - { - "name": "exclude_if", - "description": "", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Only used internally.", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "list", - "jsonType": "array", - "itemFormat": "enum", - "itemEnumValues": [ - { - "name": "can_remotely_unlock", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_remotely_lock", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_program_offline_access_codes", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_program_online_access_codes", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_hvac_heat", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_hvac_cool", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_hvac_heat_cool", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_turn_off_hvac", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_simulate_removal", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "can_simulate_connection", + "name": "ios_phone", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13459,7 +13535,7 @@ "draftMessage": "" }, { - "name": "can_simulate_disconnection", + "name": "android_phone", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13471,7 +13547,134 @@ ] }, { - "name": "include_if", + "name": "exclude_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "include_if", "description": "", "isRequired": false, "isDeprecated": false, @@ -13614,7 +13817,7 @@ }, { "name": "manufacturer", - "description": "Manufacturer by which to filter devices.", + "description": "Manufacturer for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -13847,7 +14050,7 @@ "draftMessage": "" }, { - "name": "minut", + "name": "two_n", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13857,7 +14060,7 @@ "draftMessage": "" }, { - "name": "two_n", + "name": "ttlock", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13867,7 +14070,7 @@ "draftMessage": "" }, { - "name": "ttlock", + "name": "igloohome", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13877,7 +14080,7 @@ "draftMessage": "" }, { - "name": "nest", + "name": "hubitat", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13887,7 +14090,7 @@ "draftMessage": "" }, { - "name": "igloohome", + "name": "controlbyweb", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13897,7 +14100,7 @@ "draftMessage": "" }, { - "name": "ecobee", + "name": "smartthings", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13907,7 +14110,7 @@ "draftMessage": "" }, { - "name": "hubitat", + "name": "dormakaba_oracode", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13917,7 +14120,7 @@ "draftMessage": "" }, { - "name": "controlbyweb", + "name": "tedee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13927,7 +14130,7 @@ "draftMessage": "" }, { - "name": "smartthings", + "name": "akiles", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13937,7 +14140,7 @@ "draftMessage": "" }, { - "name": "dormakaba_oracode", + "name": "ecobee", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13947,7 +14150,7 @@ "draftMessage": "" }, { - "name": "tedee", + "name": "honeywell_resideo", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13957,7 +14160,7 @@ "draftMessage": "" }, { - "name": "honeywell_resideo", + "name": "minut", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -13967,7 +14170,17 @@ "draftMessage": "" }, { - "name": "akiles", + "name": "nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -14014,7 +14227,7 @@ }, { "name": "unstable_location_id", - "description": "", + "description": "ID of the location for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -14028,7 +14241,7 @@ }, { "name": "user_identifier_key", - "description": "Your own internal user ID for the user by which to filter devices.", + "description": "Your own internal user ID for the user for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -14048,10 +14261,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Update an Unmanaged Device", "name": "update", "path": "/devices/unmanaged/update", - "description": "", + "description": "Updates a specified [unmanaged device](../core-concepts/devices/managed-and-unmanaged-devices.md). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](../core-concepts/devices/managed-and-unmanaged-devices.md#convert-an-unmanaged-device-to-managed).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -14066,7 +14279,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the unmanaged device that you want to update.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -14080,7 +14293,7 @@ }, { "name": "is_managed", - "description": "", + "description": "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -14111,10 +14324,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Get an Event", "name": "get", "path": "/events/get", - "description": "", + "description": "Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to retrieve an event that already took place.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -14186,10 +14399,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Events", "name": "list", "path": "/events/list", - "description": "", + "description": "Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -14309,6 +14522,21 @@ "format": "id", "jsonType": "string" }, + { + "name": "customer_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, { "name": "device_id", "description": "", @@ -16296,7 +16524,7 @@ "parameters": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview by which to filter devices.", + "description": "ID of the Connect Webview for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -16310,7 +16538,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account by which to filter.", + "description": "ID of the connected account for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -16324,7 +16552,7 @@ }, { "name": "connected_account_ids", - "description": "Array of IDs of the connected accounts by which to filter devices.", + "description": "Array of IDs of the connected accounts for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -16339,7 +16567,7 @@ }, { "name": "created_before", - "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -16353,7 +16581,7 @@ }, { "name": "custom_metadata_has", - "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -16365,9 +16593,24 @@ "format": "record", "jsonType": "object" }, + { + "name": "customer_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, { "name": "device_ids", - "description": "Array of device IDs by which to filter devices.", + "description": "Array of device IDs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17524,7 +17767,7 @@ }, { "name": "unstable_location_id", - "description": "", + "description": "ID of the location for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17538,7 +17781,7 @@ }, { "name": "user_identifier_key", - "description": "Your own internal user ID for the user by which to filter devices.", + "description": "Your own internal user ID for the user for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17917,7 +18160,7 @@ "parameters": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview by which to filter devices.", + "description": "ID of the Connect Webview for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17931,7 +18174,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account by which to filter.", + "description": "ID of the connected account for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17945,7 +18188,7 @@ }, { "name": "connected_account_ids", - "description": "Array of IDs of the connected accounts by which to filter devices.", + "description": "Array of IDs of the connected accounts for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17960,7 +18203,7 @@ }, { "name": "created_before", - "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17974,7 +18217,7 @@ }, { "name": "custom_metadata_has", - "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17986,9 +18229,24 @@ "format": "record", "jsonType": "object" }, + { + "name": "customer_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, { "name": "device_ids", - "description": "Array of device IDs by which to filter devices.", + "description": "Array of device IDs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -18358,7 +18616,7 @@ "jsonType": "string", "values": [ { - "name": "noiseaware", + "name": "minut", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -18368,7 +18626,7 @@ "draftMessage": "" }, { - "name": "minut", + "name": "noiseaware", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -18395,7 +18653,7 @@ }, { "name": "unstable_location_id", - "description": "", + "description": "ID of the location for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -18409,7 +18667,7 @@ }, { "name": "user_identifier_key", - "description": "Your own internal user ID for the user by which to filter devices.", + "description": "Your own internal user ID for the user for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -19732,6 +19990,159 @@ "isDeprecated": false, "isDraft": false }, + { + "path": "/seam/mobile_sdk/v1/phone_sessions", + "name": "phone_sessions", + "namespace": { + "path": "/seam/mobile_sdk/v1", + "isDeprecated": false, + "isUndocumented": true, + "isDraft": false + }, + "endpoints": [ + { + "title": "Get or Create a Phone Session", + "name": "get_or_create", + "path": "/seam/mobile_sdk/v1/phone_sessions/get_or_create", + "description": "Get or create a session for a mobile SDK phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Mobile SDK only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "phone_session", + "resourceType": "phone_session", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "custom_sdk_installation_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_device_metadata", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "manufacturer", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "os_version", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "phone_os", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ios", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": ["client_session_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, { "path": "/thermostats", "name": "thermostats", @@ -19762,7 +20173,7 @@ "parameters": [ { "name": "climate_preset_key", - "description": "Climate preset key of the desired climate preset.", + "description": "Climate preset key of the climate preset that you want to activate.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -19776,7 +20187,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want to activate a climate preset.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -19874,200 +20285,6 @@ } ] }, - { - "title": "Activate a Thermostat Weekly Program", - "name": "activate_weekly_program", - "path": "/thermostats/activate_weekly_program", - "description": "Activates a thermostat weekly program.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Unreleased.", - "isDraft": false, - "draftMessage": "", - "response": { - "responseType": "resource", - "responseKey": "action_attempt", - "resourceType": "action_attempt", - "description": "OK", - "actionAttemptType": "PUSH_THERMOSTAT_PROGRAMS" - }, - "request": { - "methods": ["POST"], - "semanticMethod": "POST", - "preferredMethod": "POST", - "parameters": [ - { - "name": "device_id", - "description": "ID of the thermostat device that the weekly program is for.", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "friday_program_id", - "description": "ID of the thermostat daily program to run on Fridays.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "monday_program_id", - "description": "ID of the thermostat daily program to run on Mondays.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "saturday_program_id", - "description": "ID of the thermostat daily program to run on Saturdays.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "sunday_program_id", - "description": "ID of the thermostat daily program to run on Sundays.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "thursday_program_id", - "description": "ID of the thermostat daily program to run on Thursdays.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "tuesday_program_id", - "description": "ID of the thermostat daily program to run on Tuesdays.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - }, - { - "name": "wednesday_program_id", - "description": "ID of the thermostat daily program to run on Wednesdays.", - "isRequired": false, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - } - ] - }, - "hasPagination": false, - "authMethods": [ - "client_session_token", - "personal_access_token", - "api_key" - ], - "workspaceScope": "required", - "codeSamples": [] - }, - { - "title": "Clear a Thermostat Weekly Program", - "name": "clear_weekly_program", - "path": "/thermostats/clear_weekly_program", - "description": "Clears a thermostat weekly program.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Unreleased.", - "isDraft": false, - "draftMessage": "", - "response": { - "responseType": "resource", - "responseKey": "action_attempt", - "resourceType": "action_attempt", - "description": "OK", - "actionAttemptType": "PUSH_THERMOSTAT_PROGRAMS" - }, - "request": { - "methods": ["POST"], - "semanticMethod": "POST", - "preferredMethod": "POST", - "parameters": [ - { - "name": "device_id", - "description": "ID of the thermostat device to clear the weekly program for.", - "isRequired": true, - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "hasDefault": false, - "format": "id", - "jsonType": "string" - } - ] - }, - "hasPagination": false, - "authMethods": [ - "client_session_token", - "personal_access_token", - "api_key" - ], - "workspaceScope": "required", - "codeSamples": [] - }, { "title": "Set to Cool Mode", "name": "cool", @@ -20121,7 +20338,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device that you want to set to cool mode.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -20299,7 +20516,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want create a climate preset.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -20578,7 +20795,7 @@ "parameters": [ { "name": "climate_preset_key", - "description": "Climate preset key of the desired climate preset.", + "description": "Climate preset key of the climate preset that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -20592,7 +20809,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want to delete a climate preset.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -20710,7 +20927,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device that you want to retrieve.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -20724,7 +20941,7 @@ }, { "name": "name", - "description": "User-friendly name of the desired thermostat device.", + "description": "User-friendly name of the thermostat device that you want to retrieve.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -20772,7 +20989,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device that you want to set to heat mode.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -20970,7 +21187,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device that you want to set to heat-cool mode.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -21140,7 +21357,7 @@ "parameters": [ { "name": "connect_webview_id", - "description": "ID of the Connect Webview by which to filter devices.", + "description": "ID of the Connect Webview for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21154,7 +21371,7 @@ }, { "name": "connected_account_id", - "description": "ID of the connected account by which to filter.", + "description": "ID of the connected account for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21168,7 +21385,7 @@ }, { "name": "connected_account_ids", - "description": "Array of IDs of the connected accounts by which to filter devices.", + "description": "Array of IDs of the connected accounts for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21183,7 +21400,7 @@ }, { "name": "created_before", - "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "description": "Timestamp by which to limit returned devices. Returns devices created before this timestamp.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21197,7 +21414,7 @@ }, { "name": "custom_metadata_has", - "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21210,8 +21427,8 @@ "jsonType": "object" }, { - "name": "device_ids", - "description": "Array of device IDs by which to filter devices.", + "name": "customer_ids", + "description": "", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21225,8 +21442,8 @@ "itemFormat": "id" }, { - "name": "device_type", - "description": "Device type by which to filter devices.", + "name": "device_ids", + "description": "Array of device IDs for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21235,64 +21452,13 @@ "isDraft": false, "draftMessage": "", "hasDefault": false, - "format": "enum", - "jsonType": "string", - "values": [ - { - "name": "ecobee_thermostat", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "nest_thermostat", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "honeywell_resideo_thermostat", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "tado_thermostat", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - }, - { - "name": "sensi_thermostat", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "" - } - ] + "format": "list", + "jsonType": "array", + "itemFormat": "id" }, { - "name": "device_types", - "description": "Array of device types by which to filter devices.", + "name": "device_type", + "description": "Device type by which to filter thermostat devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21301,10 +21467,9 @@ "isDraft": false, "draftMessage": "", "hasDefault": false, - "format": "list", - "jsonType": "array", - "itemFormat": "enum", - "itemEnumValues": [ + "format": "enum", + "jsonType": "string", + "values": [ { "name": "ecobee_thermostat", "description": "", @@ -21354,6 +21519,93 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" + }, + { + "name": "smartthings_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "device_types", + "description": "Array of device types by which to filter thermostat devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" } ] }, @@ -21628,7 +21880,7 @@ }, { "name": "manufacturer", - "description": "Manufacturer by which to filter devices.", + "description": "Manufacturer by which to filter thermostat devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21651,7 +21903,7 @@ "draftMessage": "" }, { - "name": "nest", + "name": "honeywell_resideo", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -21661,7 +21913,7 @@ "draftMessage": "" }, { - "name": "honeywell_resideo", + "name": "nest", "description": "", "isDeprecated": false, "deprecationMessage": "", @@ -21679,6 +21931,16 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" + }, + { + "name": "sensi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" } ] }, @@ -21698,7 +21960,7 @@ }, { "name": "unstable_location_id", - "description": "", + "description": "ID of the location for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21712,7 +21974,7 @@ }, { "name": "user_identifier_key", - "description": "Your own internal user ID for the user by which to filter devices.", + "description": "Your own internal user ID for the user for which you want to list devices.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -21857,7 +22119,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device that you want to set to off mode.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -21992,7 +22254,7 @@ "parameters": [ { "name": "climate_preset_key", - "description": "Climate preset key of the desired climate preset.", + "description": "Climate preset key of the climate preset that you want to set as the fallback climate preset.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -22006,7 +22268,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want to set the fallback climate preset.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -22121,7 +22383,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the thermostat device for which you want to set the fan mode.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -22355,7 +22617,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want to set the HVAC mode.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -22590,7 +22852,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want to set a temperature threshold.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -22802,7 +23064,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want to update a climate preset.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -23056,6 +23318,152 @@ } } ] + }, + { + "title": "Update the Thermostat Weekly Program", + "name": "update_weekly_program", + "path": "/thermostats/update_weekly_program", + "description": "Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "PUSH_THERMOSTAT_PROGRAMS" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the thermostat device for which you want to update the weekly program.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "friday_program_id", + "description": "ID of the thermostat daily program to run on Fridays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "monday_program_id", + "description": "ID of the thermostat daily program to run on Mondays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "saturday_program_id", + "description": "ID of the thermostat daily program to run on Saturdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sunday_program_id", + "description": "ID of the thermostat daily program to run on Sundays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "thursday_program_id", + "description": "ID of the thermostat daily program to run on Thursdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "tuesday_program_id", + "description": "ID of the thermostat daily program to run on Tuesdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "wednesday_program_id", + "description": "ID of the thermostat daily program to run on Wednesdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] } ], "subroutes": [], @@ -23072,11 +23480,11 @@ "title": "Create a Thermostat Daily Program", "name": "create", "path": "/thermostats/daily_programs/create", - "description": "Creates a thermostat daily program.", + "description": "Creates a thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Unreleased.", + "isUndocumented": false, + "undocumentedMessage": "", "isDraft": false, "draftMessage": "", "response": { @@ -23092,7 +23500,7 @@ "parameters": [ { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device for which you want to create a daily program.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -23135,7 +23543,7 @@ "itemParameters": [ { "name": "climate_preset_key", - "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the starts_at_time.", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the `starts_at_time`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -23149,7 +23557,7 @@ }, { "name": "starts_at_time", - "description": "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -23181,8 +23589,8 @@ "description": "Deletes a thermostat daily program.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Unreleased.", + "isUndocumented": false, + "undocumentedMessage": "", "isDraft": false, "draftMessage": "", "response": { "responseType": "void", "description": "OK" }, @@ -23193,7 +23601,7 @@ "parameters": [ { "name": "thermostat_daily_program_id", - "description": "ID of the desired thermostat schedule.", + "description": "ID of the thermostat daily program that you want to delete.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -23220,11 +23628,11 @@ "title": "Update a Thermostat Daily Program", "name": "update", "path": "/thermostats/daily_programs/update", - "description": "Updates a specified thermostat daily program.", + "description": "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": true, - "undocumentedMessage": "Unreleased.", + "isUndocumented": false, + "undocumentedMessage": "", "isDraft": false, "draftMessage": "", "response": { @@ -23241,7 +23649,7 @@ "parameters": [ { "name": "name", - "description": "User-friendly name to identify the thermostat daily program.", + "description": "User-friendly name to identify the thermostat daily program that you want to update.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -23255,7 +23663,7 @@ }, { "name": "periods", - "description": "Array of thermostat daily program periods.", + "description": "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -23270,7 +23678,7 @@ "itemParameters": [ { "name": "climate_preset_key", - "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the starts_at_time.", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the `starts_at_time`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -23284,7 +23692,7 @@ }, { "name": "starts_at_time", - "description": "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -23300,7 +23708,7 @@ }, { "name": "thermostat_daily_program_id", - "description": "ID of the desired thermostat daily program.", + "description": "ID of the thermostat daily program that you want to update.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -23325,7 +23733,7 @@ } ], "subroutes": [], - "isUndocumented": true, + "isUndocumented": false, "isDeprecated": false, "isDraft": false }, @@ -25460,6 +25868,229 @@ "isDeprecated": false, "isDraft": false }, + { + "path": "/unstable_partner/resources", + "name": "resources", + "namespace": { + "path": "/unstable_partner", + "isDeprecated": false, + "isUndocumented": true, + "isDraft": false + }, + "endpoints": [ + { + "title": "Push partner resources at Seam", + "name": "push", + "path": "/unstable_partner/resources/push", + "description": "Send Seam some of your resources.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental partner resources.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "custom_metadata", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "customer_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "description", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "email_address", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "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": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "partner_resource_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "partner_resource_type", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, { "path": "/user_identities", "name": "user_identities", @@ -25610,6 +26241,21 @@ "semanticMethod": "POST", "preferredMethod": "POST", "parameters": [ + { + "name": "acs_system_ids", + "description": "List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, { "name": "email_address", "description": "Unique email address for the user identity.", @@ -25763,7 +26409,7 @@ "title": "Delete a User Identity", "name": "delete", "path": "/user_identities/delete", - "description": "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.", + "description": "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -28228,7 +28874,7 @@ "title": "", "name": "reset_sandbox", "path": "/workspaces/reset_sandbox", - "description": "", + "description": "Resets a [sandbox workspace](../core-concepts/workspaces/README.md#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -31437,7 +32083,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.", + "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, @@ -32264,7 +32910,7 @@ ] } ], - "description": "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.", + "description": "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.", "isDeprecated": false, "routePath": "/access_codes", "deprecationMessage": "", @@ -37737,7 +38383,7 @@ "jsonType": "string" } ], - "description": "", + "description": "Represents a [client session](../core-concepts/authentication/client-session-tokens/README.md). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).", "isDeprecated": false, "routePath": "/client_sessions", "deprecationMessage": "", @@ -37756,8 +38402,8 @@ "description": "", "isDeprecated": true, "deprecationMessage": "Unused. Will be removed.", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unused. Will be removed.", "isDraft": false, "draftMessage": "", "propertyGroupKey": null, @@ -37784,8 +38430,8 @@ "description": "", "isDeprecated": true, "deprecationMessage": "Unused. Will be removed.", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unused. Will be removed.", "isDraft": false, "draftMessage": "", "propertyGroupKey": null, @@ -38065,7 +38711,7 @@ "jsonType": "string" } ], - "description": "", + "description": "Represents a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", "isDeprecated": false, "routePath": "/connect_webviews", "deprecationMessage": "", @@ -38934,7 +39580,7 @@ ] } ], - "description": "", + "description": "Represents a [connected account](../core-concepts/connected-accounts/README.md). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.", "isDeprecated": false, "routePath": "/connected_accounts", "deprecationMessage": "", @@ -39572,6 +40218,16 @@ "isDraft": false, "draftMessage": "" }, + { + "name": "smartthings_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, { "name": "ios_phone", "description": "", @@ -41026,7 +41682,7 @@ }, { "name": "manufacturer", - "description": "Manufacturer of the device.", + "description": "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -43960,7 +44616,7 @@ }, { "name": "code_constraints", - "description": "", + "description": "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -44413,6 +45069,19 @@ "propertyGroupKey": null, "format": "id", "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the thermostat schedule.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" } ] }, @@ -45668,7 +46337,7 @@ }, { "name": "device_id", - "description": "ID of the desired thermostat device.", + "description": "ID of the thermostat device on which the thermostat daily program is configured.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45708,7 +46377,7 @@ "itemProperties": [ { "name": "climate_preset_key", - "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the starts_at_time.", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the `starts_at_time`.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45721,7 +46390,7 @@ }, { "name": "starts_at_time", - "description": "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "description": "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -45746,6 +46415,19 @@ "propertyGroupKey": null, "format": "id", "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" } ] }, @@ -45775,19 +46457,6 @@ "format": "datetime", "jsonType": "string" }, - { - "name": "device_id", - "description": "ID of the thermostat device the weekly program is for.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" - }, { "name": "friday_program_id", "description": "ID of the thermostat daily program to run on Fridays.", @@ -46866,7 +47535,7 @@ "jsonType": "string" } ], - "description": "", + "description": "Represents a [device](../core-concepts/devices/README.md) that has been connected to Seam.", "isDeprecated": false, "routePath": "/devices", "deprecationMessage": "", @@ -47495,6 +48164,16 @@ "undocumentedMessage": "", "isDraft": false, "draftMessage": "" + }, + { + "name": "kwikset2", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" } ] }, @@ -49095,8 +49774,1528 @@ "jsonType": "object", "properties": [ { - "name": "endpoints", - "description": "Endpoints associated with the phone.", + "name": "endpoints", + "description": "Endpoints associated with the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "endpoint_id", + "description": "ID of the associated endpoint.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_active", + "description": "Indicated whether the endpoint is active.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "has_active_endpoint", + "description": "Indicates whether the credential service has active endpoints associated with the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_space_credential_service_metadata", + "description": "Salto Space credential service metadata for the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "has_active_phone", + "description": "Indicates whether the credential service has an active associated phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the `phone`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the `phone`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents an app user's mobile phone.", + "isDeprecated": false, + "routePath": "/phones", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "phone_session": { + "resourceType": "phone_session", + "properties": [ + { + "name": "provider_sessions", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "acs_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "access_method", + "description": "Access method for the [credential](../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_credential_id", + "description": "ID of the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_credential_pool_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_entrances", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "acs_entrance_id", + "description": "ID of the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "ASSA ABLOY Vostio-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "door_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "CommonDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "EntranceDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "GuestDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "Elevator", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "pms_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "stand_open", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "created_at", + "description": "Date and time at which the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name for the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "dormakaba_community_metadata", + "description": "dormakaba Community-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "access_point_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "errors", + "description": "Errors associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "latch_metadata", + "description": "Latch-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "accessibility_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_ks_metadata", + "description": "Salto KS-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "battery_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "intrusion_alarm", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "left_open_alarm", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "lock_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "locked_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "online", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_space_metadata", + "description": "Salto Space-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "door_description", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ext_door_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "door_category", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "entrance", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "elevator reader", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "common", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "common (PMS)", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "profiles", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "visionline_door_profile_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_door_profile_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "BLE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "commonDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "touch", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../capability-guides/access-systems/managing-credentials.md) belongs.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "Vostio-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "door_names", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "endpoint_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_issuing_request_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "override_guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + { + "name": "card_number", + "description": "Number of the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "code", + "description": "Access (PIN) code for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name that corresponds to the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_issued", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_latest_desired_state_synced_with_provider", + "description": "Indicates whether the latest state of the [credential](../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_multi_phone_sync_credential", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "issued_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "latest_desired_state_synced_with_provider_at", + "description": "Date and time at which the state of the [credential](../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "parent_acs_credential_id", + "description": "ID of the parent [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "card_function_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "staff", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "card_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "is_valid", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "joiner_acs_credential_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -49109,8 +51308,21 @@ "itemFormat": "object", "itemProperties": [ { - "name": "endpoint_id", - "description": "ID of the associated endpoint.", + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -49122,8 +51334,8 @@ "jsonType": "string" }, { - "name": "is_active", - "description": "Indicated whether the endpoint is active.", + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -49131,14 +51343,76 @@ "isDraft": false, "draftMessage": "", "propertyGroupKey": null, - "format": "boolean", - "jsonType": "boolean" + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "waiting_to_be_issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schedule_externally_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schedule_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown_issue_with_acs_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "needs_to_be_reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] } ] }, { - "name": "has_active_endpoint", - "description": "Indicates whether the credential service has active endpoints associated with the phone.", + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -49146,18 +51420,18 @@ "isDraft": false, "draftMessage": "", "propertyGroupKey": null, - "format": "boolean", - "jsonType": "boolean" + "format": "id", + "jsonType": "string" } ] }, { - "name": "salto_space_credential_service_metadata", - "description": "Salto Space credential service metadata for the phone.", + "name": "phone_registration", + "description": "", "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Mobile SDK only.", "isDraft": false, "draftMessage": "", "propertyGroupKey": null, @@ -49165,8 +51439,8 @@ "jsonType": "object", "properties": [ { - "name": "has_active_phone", - "description": "Indicates whether the credential service has an active associated phone.", + "name": "is_being_activated", + "description": "", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -49176,73 +51450,44 @@ "propertyGroupKey": null, "format": "boolean", "jsonType": "boolean" + }, + { + "name": "phone_registration_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "provider_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" } ] } ] - }, - { - "name": "warnings", - "description": "Warnings associated with the `phone`.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "list", - "jsonType": "array", - "itemFormat": "object", - "itemProperties": [ - { - "name": "message", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "string", - "jsonType": "string" - }, - { - "name": "warning_code", - "description": "", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "string", - "jsonType": "string" - } - ] - }, - { - "name": "workspace_id", - "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the `phone`.", - "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", - "isDraft": false, - "draftMessage": "", - "propertyGroupKey": null, - "format": "id", - "jsonType": "string" } ], - "description": "Represents an app user's mobile phone.", + "description": "", "isDeprecated": false, - "routePath": "/phones", + "routePath": "/seam/mobile_sdk/v1/phone_sessions", "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Mobile SDK only.", "isDraft": false, "draftMessage": "", "propertyGroups": {}, @@ -49409,6 +51654,19 @@ "propertyGroupKey": null, "format": "id", "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the thermostat schedule.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" } ], "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.", @@ -52334,7 +54592,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.", + "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, @@ -53108,7 +55366,7 @@ ] } ], - "description": "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.", + "description": "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.\n\nNot all providers support unmanaged access codes. The following providers do not support unmanaged access codes:\n\n- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)", "isDeprecated": false, "routePath": "/access_codes/unmanaged", "deprecationMessage": "", @@ -56755,6 +59013,16 @@ "isDraft": false, "draftMessage": "" }, + { + "name": "smartthings_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, { "name": "ios_phone", "description": "", @@ -58128,7 +60396,7 @@ }, { "name": "manufacturer", - "description": "Manufacturer of the device.", + "description": "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -59282,7 +61550,7 @@ "jsonType": "string" } ], - "description": "", + "description": "Represents an [unmanaged device](../core-concepts/devices/managed-and-unmanaged-devices.md). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](../core-concepts/devices/managed-and-unmanaged-devices.md#convert-an-unmanaged-device-to-managed).", "isDeprecated": false, "routePath": "/devices/unmanaged", "deprecationMessage": "", @@ -59401,7 +61669,7 @@ "jsonType": "string" } ], - "description": "Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.", + "description": "Represents a [user identity](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) associated with an application user account.", "isDeprecated": false, "routePath": "/user_identities", "deprecationMessage": "", @@ -59664,7 +61932,7 @@ "jsonType": "string" } ], - "description": "", + "description": "Represents a Seam [workspace](../core-concepts/workspaces/README.md). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](../core-concepts/workspaces/README.md#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](../core-concepts/workspaces/README.md#production-workspaces).", "isDeprecated": false, "routePath": "/workspaces", "deprecationMessage": "", diff --git a/docs/api/_report.md b/docs/api/_report.md index 752e7ea79..6b0e40439 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -5,7 +5,6 @@ ### Routes - `/action_attempts` -- `/bridges` - `/client_sessions` - `/connect_webviews` - `/connected_accounts` @@ -18,42 +17,12 @@ - `/noise_sensors` - `/noise_sensors/noise_thresholds` - `/noise_sensors/simulate` +- `/thermostats/daily_programs` - `/webhooks` - `/workspaces` ### Endpoints -- `/access_codes/generate_code` -- `/action_attempts/get` -- `/action_attempts/list` -- `/bridges/get` -- `/bridges/list` -- `/client_sessions/create` -- `/client_sessions/delete` -- `/client_sessions/get` -- `/client_sessions/get_or_create` -- `/client_sessions/grant_access` -- `/client_sessions/list` -- `/client_sessions/revoke` -- `/connect_webviews/create` -- `/connect_webviews/delete` -- `/connect_webviews/get` -- `/connect_webviews/list` -- `/connected_accounts/delete` -- `/connected_accounts/get` -- `/connected_accounts/list` -- `/connected_accounts/update` -- `/devices/get` -- `/devices/list_device_providers` -- `/devices/update` -- `/devices/simulate/connect` -- `/devices/simulate/disconnect` -- `/devices/simulate/remove` -- `/devices/unmanaged/get` -- `/devices/unmanaged/list` -- `/devices/unmanaged/update` -- `/events/get` -- `/events/list` - `/locks/get` - `/locks/list` - `/locks/lock_door` @@ -89,23 +58,28 @@ These items are intentionally undocumented. - `/acs/credential_provisioning_automations`: No undocumented message provided - `/acs/credentials/unmanaged`: No undocumented message provided - `/acs/users/unmanaged`: No undocumented message provided +- `/bridges`: No undocumented message provided - `/locks/simulate`: No undocumented message provided - `/seam/bridge/v1/bridge_client_sessions`: No undocumented message provided - `/seam/bridge/v1/bridge_connected_systems`: No undocumented message provided - `/seam/instant_key/v1/client_sessions`: No undocumented message provided - `/seam/mobile_sdk/v1/acs/credentials`: No undocumented message provided -- `/thermostats/daily_programs`: No undocumented message provided +- `/seam/mobile_sdk/v1/phone_sessions`: No undocumented message provided - `/unstable_access_grants`: No undocumented message provided - `/unstable_access_methods`: No undocumented message provided - `/unstable_locations`: No undocumented message provided +- `/unstable_partner/resources`: No undocumented message provided ### Resources - `instant_key`: Unreleased. +- `phone_session`: Seam Mobile SDK only. ### Resource properties - `acs_user.last_successful_sync_at`: Only used internally. +- `connect_webview.accepted_devices`: Unused. Will be removed. +- `connect_webview.any_device_allowed`: Unused. Will be removed. - `unmanaged_acs_user.last_successful_sync_at`: Only used internally. ### Namespaces @@ -113,6 +87,8 @@ These items are intentionally undocumented. - `/seam/bridge/v1`: No undocumented message provided - `/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 +- `/unstable_partner`: No undocumented message provided ### Endpoints @@ -125,6 +101,8 @@ These items are intentionally undocumented. - `/acs/credentials/unmanaged/list`: No unmanaged credentials are currently implemented. - `/acs/users/unmanaged/get`: No unmanaged users are currently implemented. - `/acs/users/unmanaged/list`: No unmanaged users are currently implemented. +- `/bridges/get`: Not yet for customer use. +- `/bridges/list`: Not yet for customer use. - `/devices/delete`: Deleting a device is no longer supported and will be removed. - `/locks/simulate/keypad_code_entry`: Unreleased. - `/locks/simulate/manual_lock_via_keypad`: Unreleased. @@ -136,12 +114,8 @@ These items are intentionally undocumented. - `/seam/bridge/v1/bridge_connected_systems/list`: Seam Bridge Client only. - `/seam/instant_key/v1/client_sessions/exchange_short_code`: Seam Instant Key only. - `/seam/mobile_sdk/v1/acs/credentials/list`: Mobile SDK only. -- `/thermostats/activate_weekly_program`: Unreleased. -- `/thermostats/clear_weekly_program`: Unreleased. +- `/seam/mobile_sdk/v1/phone_sessions/get_or_create`: Mobile SDK only. - `/thermostats/get`: Will be removed. -- `/thermostats/daily_programs/create`: Unreleased. -- `/thermostats/daily_programs/delete`: Unreleased. -- `/thermostats/daily_programs/update`: Unreleased. - `/unstable_access_grants/create`: Unreleased. - `/unstable_access_grants/get`: Unreleased. - `/unstable_access_grants/list`: Unreleased. @@ -156,6 +130,7 @@ These items are intentionally undocumented. - `/unstable_locations/remove_acs_entrances`: Experimental locations. - `/unstable_locations/remove_devices`: Experimental locations. - `/unstable_locations/update`: Experimental locations. +- `/unstable_partner/resources/push`: Experimental partner resources. ### Endpoint parameters @@ -171,6 +146,10 @@ These items are intentionally undocumented. - `sync`: Only used internally. - `/acs/entrances/list` - `location_id`: Experimental locations. +- `/connect_webviews/create` + - `device_selection_mode`: Not supported. +- `/connected_accounts/delete` + - `sync`: Only used internally. - `/devices/list` - `exclude_if`: Only used internally. - `include_if`: Only used internally. @@ -211,19 +190,14 @@ Items that are intentionally undocumented are not included in this section. - `acs_credential_pool` - `acs_credential_provisioning_automation` -- `client_session` -- `connect_webview` -- `connected_account` -- `device` - `device_provider` - `event` - `instant_key` - `network` - `noise_threshold` +- `phone_session` - `unmanaged_acs_access_group` -- `unmanaged_device` - `webhook` -- `workspace` ### Resource properties @@ -344,6 +318,7 @@ Items that are intentionally undocumented are not included in this section. - `noise_threshold.noise_threshold_id` - `noise_threshold.noise_threshold_nrs` - `noise_threshold.starts_daily_at` +- `phone_session.provider_sessions` - `unmanaged_acs_access_group.access_group_type` - `unmanaged_acs_access_group.access_group_type_display_name` - `unmanaged_acs_access_group.display_name` @@ -381,43 +356,6 @@ Items that are intentionally undocumented are not included in this section. ### Endpoints -- `/access_codes/generate_code` -- `/acs/credential_pools/list` -- `/acs/credential_provisioning_automations/launch` -- `/acs/entrances/grant_access` -- `/acs/users/unmanaged/get` -- `/acs/users/unmanaged/list` -- `/action_attempts/get` -- `/action_attempts/list` -- `/bridges/get` -- `/bridges/list` -- `/client_sessions/create` -- `/client_sessions/delete` -- `/client_sessions/get` -- `/client_sessions/get_or_create` -- `/client_sessions/grant_access` -- `/client_sessions/list` -- `/client_sessions/revoke` -- `/connect_webviews/create` -- `/connect_webviews/delete` -- `/connect_webviews/get` -- `/connect_webviews/list` -- `/connected_accounts/delete` -- `/connected_accounts/get` -- `/connected_accounts/list` -- `/connected_accounts/update` -- `/devices/delete` -- `/devices/get` -- `/devices/list_device_providers` -- `/devices/update` -- `/devices/simulate/connect` -- `/devices/simulate/disconnect` -- `/devices/simulate/remove` -- `/devices/unmanaged/get` -- `/devices/unmanaged/list` -- `/devices/unmanaged/update` -- `/events/get` -- `/events/list` - `/locks/get` - `/locks/list` - `/locks/lock_door` @@ -442,7 +380,6 @@ Items that are intentionally undocumented are not included in this section. - `/workspaces/create` - `/workspaces/get` - `/workspaces/list` -- `/workspaces/reset_sandbox` - `/workspaces/update` ### Endpoint parameters @@ -456,8 +393,6 @@ Items that are intentionally undocumented are not included in this section. - `use_offline_access_code` - `/access_codes/delete` - `sync` -- `/access_codes/generate_code` - - `device_id` - `/access_codes/update` - `attempt_for_offline_device` - `sync` @@ -468,139 +403,30 @@ Items that are intentionally undocumented are not included in this section. - `sync` - `/access_codes/unmanaged/update` - `is_managed` -- `/acs/credential_pools/list` - - `acs_system_id` -- `/acs/credential_provisioning_automations/launch` - - `acs_credential_pool_id` - - `create_credential_manager_user` - - `credential_manager_acs_system_id` - - `credential_manager_acs_user_id` - - `user_identity_id` - `/acs/encoders/simulate/next_credential_scan_will_fail` - `error_code` - `acs_credential_id_on_seam` -- `/acs/entrances/get` - - `acs_entrance_id` -- `/acs/entrances/grant_access` - - `acs_entrance_id` - - `acs_user_id` -- `/acs/entrances/list` - - `acs_credential_id` - - `acs_system_id` - - `location_id` -- `/acs/entrances/list_credentials_with_access` - - `acs_entrance_id` - - `include_if` - `/acs/users/create` - `email` -- `/acs/users/list` - - `created_before` - `/acs/users/update` - `email` - `hid_acs_system_id` -- `/acs/users/unmanaged/get` - - `acs_user_id` -- `/acs/users/unmanaged/list` - - `acs_system_id` - - `limit` - - `user_identity_email_address` - - `user_identity_id` - - `user_identity_phone_number` -- `/action_attempts/get` - - `action_attempt_id` -- `/action_attempts/list` - - `action_attempt_ids` -- `/bridges/get` - - `bridge_id` -- `/client_sessions/create` - - `connect_webview_ids` - - `connected_account_ids` - - `expires_at` - - `user_identifier_key` - - `user_identity_ids` -- `/client_sessions/delete` - - `client_session_id` -- `/client_sessions/get` - - `client_session_id` - - `user_identifier_key` -- `/client_sessions/get_or_create` - - `connect_webview_ids` - - `connected_account_ids` - - `expires_at` - - `user_identifier_key` - - `user_identity_ids` -- `/client_sessions/grant_access` - - `client_session_id` - - `connect_webview_ids` - - `connected_account_ids` - - `user_identifier_key` - - `user_identity_ids` -- `/client_sessions/list` - - `client_session_id` - - `connect_webview_id` - - `user_identifier_key` - - `user_identity_id` - - `without_user_identifier_key` -- `/client_sessions/revoke` - - `client_session_id` - `/connect_webviews/create` - - `accepted_providers` - - `automatically_manage_new_devices` - - `custom_metadata` - - `custom_redirect_failure_url` - - `custom_redirect_url` - `device_selection_mode` - - `provider_category` - - `wait_for_device_creation` -- `/connect_webviews/delete` - - `connect_webview_id` -- `/connect_webviews/get` - - `connect_webview_id` -- `/connect_webviews/list` - - `limit` - `/connected_accounts/delete` - - `connected_account_id` - `sync` -- `/connected_accounts/get` - - `connected_account_id` - - `email` -- `/connected_accounts/update` - - `automatically_manage_new_devices` - - `connected_account_id` - - `custom_metadata` -- `/devices/delete` - - `device_id` -- `/devices/get` - - `device_id` - - `name` +- `/connected_accounts/list` + - `customer_ids` - `/devices/list` + - `customer_ids` - `exclude_if` - `include_if` - - `unstable_location_id` -- `/devices/list_device_providers` - - `provider_category` - `/devices/update` - - `custom_metadata` - - `device_id` - - `is_managed` - - `name` - `properties` -- `/devices/simulate/connect` - - `device_id` -- `/devices/simulate/disconnect` - - `device_id` -- `/devices/simulate/remove` - - `device_id` -- `/devices/unmanaged/get` - - `device_id` - - `name` - `/devices/unmanaged/list` + - `customer_ids` - `exclude_if` - `include_if` - - `unstable_location_id` -- `/devices/unmanaged/update` - - `device_id` - - `is_managed` - `/events/get` - `device_id` - `event_id` @@ -613,6 +439,7 @@ Items that are intentionally undocumented are not included in this section. - `between` - `connect_webview_id` - `connected_account_id` + - `customer_ids` - `device_id` - `device_ids` - `event_ids` @@ -625,9 +452,9 @@ Items that are intentionally undocumented are not included in this section. - `device_id` - `name` - `/locks/list` + - `customer_ids` - `exclude_if` - `include_if` - - `unstable_location_id` - `/locks/lock_door` - `device_id` - `sync` @@ -642,9 +469,9 @@ Items that are intentionally undocumented are not included in this section. - `/networks/get` - `network_id` - `/noise_sensors/list` + - `customer_ids` - `exclude_if` - `include_if` - - `unstable_location_id` - `/noise_sensors/noise_thresholds/create` - `device_id` - `ends_daily_at` @@ -680,6 +507,10 @@ Items that are intentionally undocumented are not included in this section. - `/seam/bridge/v1/bridge_client_sessions/report_status` - `is_tailscale_connected` - `tailscale_ip_v4` +- `/seam/mobile_sdk/v1/phone_sessions/get_or_create` + - `custom_sdk_installation_id` + - `phone_device_metadata` + - `phone_os` - `/thermostats/cool` - `sync` - `/thermostats/heat` @@ -687,13 +518,12 @@ Items that are intentionally undocumented are not included in this section. - `/thermostats/heat_cool` - `sync` - `/thermostats/list` + - `customer_ids` - `exclude_if` - `include_if` - - `unstable_location_id` - `/thermostats/off` - `sync` - `/thermostats/set_fan_mode` - - `device_id` - `fan_mode` - `sync` - `/thermostats/set_hvac_mode` @@ -727,6 +557,20 @@ Items that are intentionally undocumented are not included in this section. - `location_id` - `name` - `time_zone` +- `/unstable_partner/resources/push` + - `custom_metadata` + - `customer_key` + - `description` + - `email_address` + - `ends_at` + - `icon_url` + - `location_keys` + - `name` + - `partner_resource_key` + - `partner_resource_type` + - `phone_number` + - `starts_at` + - `user_identity_key` - `/user_identities/get` - `user_identity_key` - `/user_identities/list` @@ -922,9 +766,9 @@ These items are deprecated. - `/seam/bridge/v1/bridge_connected_systems/list` - `/seam/instant_key/v1/client_sessions/exchange_short_code` - `/seam/mobile_sdk/v1/acs/credentials/list` -- `/thermostats/activate_weekly_program` -- `/thermostats/clear_weekly_program` +- `/seam/mobile_sdk/v1/phone_sessions/get_or_create` - `/thermostats/get` +- `/thermostats/update_weekly_program` - `/thermostats/daily_programs/create` - `/thermostats/daily_programs/delete` - `/thermostats/daily_programs/update` @@ -944,6 +788,7 @@ These items are deprecated. - `/unstable_locations/remove_acs_entrances` - `/unstable_locations/remove_devices` - `/unstable_locations/update` +- `/unstable_partner/resources/push` - `/user_identities/generate_instant_key` - `/user_identities/update` - `/webhooks/create` diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 3bf5b6b8e..6b8a02a8e 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -13,7 +13,7 @@ Represents a smart lock [access code](https://docs.seam.co/latest/capability-gui An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate. -Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. +Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time. In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. @@ -1771,6 +1771,12 @@ 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). @@ -3258,6 +3264,11 @@ Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-l Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). +[**`/access_codes/generate_code`**](./generate_code.md) + +Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID. + + [**`/access_codes/get`**](./get.md) Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 038cabefb..71fda133d 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the device for which to create the new access code. +ID of the device for which you want to create the new access code. --- @@ -88,7 +88,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https **`name`** -Name of the new access code. +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 237687ca7..b96b1a766 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -38,7 +38,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_ids`** *of UUIDs* (Required) -IDs of the devices for which to create the new access codes. +IDs of the devices for which you want to create the new access codes. --- @@ -96,7 +96,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https **`name`** -Name of the new access code. +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/delete.md b/docs/api/access_codes/delete.md index 1292fb058..0c2a78e1e 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -30,13 +30,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`access_code_id`** (Required) -ID of the access code to delete. +ID of the access code that you want to delete. --- **`device_id`** -ID of the device for which to delete the access code. +ID of the device for which you want to delete the access code. --- diff --git a/docs/api/access_codes/generate_code.md b/docs/api/access_codes/generate_code.md new file mode 100644 index 000000000..f2761a806 --- /dev/null +++ b/docs/api/access_codes/generate_code.md @@ -0,0 +1,49 @@ +# Generate a Code + +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + +Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID. + +{% tabs %} +{% tab title="Signature" %} +``` +POST /access_codes/generate_code ⇒ { generated_code } +``` +{% endtab %} +{% endtabs %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## Request Parameters + +**`device_id`** (Required) + +ID of the device for which you want to generate a code. + +--- + + +## Response + +[access\_code](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 7cf759208..0cae6fde1 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -6,9 +6,9 @@ Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). -A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. +A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access. -If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access. +You can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends. You can only pull backup access codes for time-bound access codes. diff --git a/docs/api/access_codes/report_device_constraints.md b/docs/api/access_codes/report_device_constraints.md index 85e9fa6f8..fc758cce3 100644 --- a/docs/api/access_codes/report_device_constraints.md +++ b/docs/api/access_codes/report_device_constraints.md @@ -6,6 +6,8 @@ Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices. +Specify either `supported_code_lengths` or `min_code_length`/`max_code_length`. + {% tabs %} {% tab title="Signature" %} ``` @@ -30,7 +32,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the device for which to report constraints. +ID of the device for which you want to report constraints. --- diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index c79f090ac..c59c504ef 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -17,6 +17,10 @@ When you create an access code on a device in Seam, it is created as a managed a Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. +Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes: + +- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) + {% tabs %} {% tab title="JSON" %} ```json @@ -1690,6 +1694,12 @@ 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). diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 2314f72ea..f85d28c5c 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -40,7 +40,7 @@ ID of the unmanaged access code that you want to convert to a managed access cod **`allow_external_modification`** -Indicates whether external modification of the access code is allowed. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. --- @@ -52,7 +52,7 @@ Indicates whether to force the access code conversion. To switch management of a **`is_external_modification_allowed`** -Indicates whether external modification of the access code is allowed. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. --- diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index a638874c7..511d89024 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`access_code_id`** (Required) -ID of the unmanaged access code to delete. +ID of the unmanaged access code that you want to delete. --- diff --git a/docs/api/access_codes/update-multiple-linked-access-codes.md b/docs/api/access_codes/update-multiple-linked-access-codes.md deleted file mode 100644 index 306c22bc7..000000000 --- a/docs/api/access_codes/update-multiple-linked-access-codes.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -description: >- - Update the starting and ending times for a set of linked access codes across - multiple devices. ---- - -# Update Multiple Linked Access Codes - diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index e6fe40a91..1846c0c54 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`** -Name of the new access code. +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 1f4f7fabc..d7c79722c 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`** -Name of the new access code. +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 b6ca6cb2e..c0a3cfe1b 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -243,7 +243,7 @@ An ACS access group was deleted. [**`/acs/access_groups/add_user`**](./add_user.md) -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). [**`/acs/access_groups/get`**](./get.md) @@ -263,11 +263,11 @@ Returns a list of all accessible entrances for a specified [access group](https: [**`/acs/access_groups/list_users`**](./list_users.md) -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). [**`/acs/access_groups/remove_user`**](./remove_user.md) -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index a66854f77..c4f7dc8d5 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} {% tab title="Signature" %} @@ -29,13 +29,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_access_group_id`** (Required) -ID of the desired access group. +ID of the access group to which you want to add an access system user. --- -**`acs_user_id`** (Required) +**`acs_user_id`** -ID of the desired user. +ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. + +--- + +**`user_identity_id`** + +ID of the desired user identity that you want to add to an access group. 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. --- diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index f5c347664..215105f42 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_access_group_id`** (Required) -ID of the desired access group. +ID of the access group that you want to get. --- diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index ab7ac84c5..03a24e362 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -29,13 +29,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_system_id`** -ID of the access control system for which you want to retrieve all access groups. +ID of the access system for which you want to retrieve all access groups. --- **`acs_user_id`** -ID of the user for which you want to retrieve all access groups. +ID of the access system user for which you want to retrieve all access groups. + +--- + +**`user_identity_id`** + +ID of the user identity for which you want to retrieve all access groups. --- diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 3dbeadb42..dc4ce1182 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} {% tab title="Signature" %} @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_access_group_id`** (Required) -ID of the access group for which you want to retrieve all users. +ID of the access group for which you want to retrieve all access system users. --- diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index bbc51a3e9..d0ecb1eac 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} {% tab title="Signature" %} @@ -29,13 +29,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_access_group_id`** (Required) -ID of the desired access group. +ID of the access group from which you want to remove an access system user. --- -**`acs_user_id`** (Required) +**`acs_user_id`** -ID of the desired user. +ID of the access system user that you want to remove from an access group. + +--- + +**`user_identity_id`** + +ID of the user identity associated with the user that you want to remove from an access group. --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index c230fd6de..4be7db332 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -796,7 +796,7 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia [**`/acs/credentials/assign`**](./assign.md) -Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). [**`/acs/credentials/create`**](./create.md) @@ -826,7 +826,7 @@ Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) [**`/acs/credentials/unassign`**](./unassign.md) -Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). [**`/acs/credentials/update`**](./update.md) diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 247cb2829..3a41950cf 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="Signature" %} @@ -29,13 +29,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_credential_id`** (Required) -ID of the desired credential. +ID of the credential that you want to assign to an access system user. --- -**`acs_user_id`** (Required) +**`acs_user_id`** -ID of the desired user. +ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. + +--- + +**`user_identity_id`** + +ID of the user identity to whom you want to assign a credential. 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 credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. --- diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 5ca7e7b2f..49d3d917e 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -33,9 +33,15 @@ Access method for the new credential. Supported values: `code`, `card`, `mobile_ --- -**`acs_user_id`** (Required) +**`acs_system_id`** -ID of the ACS user to whom the new credential belongs. +ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. + +--- + +**`acs_user_id`** + +ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. --- @@ -87,6 +93,12 @@ Date and time at which the validity of the new credential starts, in [ISO 8601]( --- +**`user_identity_id`** + +ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created. + +--- + **`visionline_metadata`** Visionline-specific metadata for the new credential. diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 8397bf407..89251c393 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_credential_id`** (Required) -ID of the desired credential. +ID of the credential that you want to delete. --- diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 3ee0924b0..67926fe13 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_credential_id`** (Required) -ID of the desired credential. +ID of the credential that you want to get. --- diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index e83062764..673214258 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -30,13 +30,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_system_id`** -ID of the access control system for which you want to retrieve all credentials. +ID of the access system for which you want to retrieve all credentials. --- **`acs_user_id`** -ID of the ACS user for which you want to retrieve all credentials. +ID of the access system user for which you want to retrieve all credentials. --- diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index ba0bccc4d..57cc1de18 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_credential_id`** (Required) -ID of the credential for which you want to retrieve all entrances to which this credential grants access. +ID of the credential for which you want to retrieve all entrances to which the credential grants access. --- diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 75403a0cd..12c9ce700 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="Signature" %} @@ -29,13 +29,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_credential_id`** (Required) -ID of the desired credential. +ID of the credential that you want to unassign from an access system user. --- -**`acs_user_id`** (Required) +**`acs_user_id`** -ID of the desired user. +ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id. + +--- + +**`user_identity_id`** + +ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id. --- diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 172411a3e..37610d1fc 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -29,13 +29,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_credential_id`** (Required) -ID of the desired credential. +ID of the credential that you want to update. --- **`code`** -Replacement access (PIN) code for the credential. +Replacement access (PIN) code for the credential that you want to update. --- diff --git a/docs/api/acs/encoders/get.md b/docs/api/acs/encoders/get.md index 0c56ef974..323e8b2cb 100644 --- a/docs/api/acs/encoders/get.md +++ b/docs/api/acs/encoders/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_encoder_id`** (Required) -ID of the desired encoder. +ID of the encoder that you want to get. --- diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 0e683071c..da1426c23 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -29,25 +29,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_encoder_ids`** *of UUIDs* -IDs of the `acs_encoder`s that you want to retrieve. +IDs of the encoders that you want to retrieve. --- **`acs_system_id`** -ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. +ID of the access system for which you want to retrieve all encoders. --- **`acs_system_ids`** *of UUIDs* -IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. +IDs of the access systems for which you want to retrieve all encoders. --- **`limit`** -Number of `acs_encoders` to return. +Number of encoders to return. --- diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 81a676f88..49da33d96 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_encoder_id`** (Required) -ID of the `acs_encoder` to use for the scan. +ID of the encoder to use for the scan. --- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 41bbb6c1f..6010a7867 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -352,17 +352,17 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra [**`/acs/entrances/get`**](./get.md) -Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +Returns a specified [access system entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). [**`/acs/entrances/grant_access`**](./grant_access.md) - +Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). [**`/acs/entrances/list`**](./list.md) -Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). +Returns a list of all [access system entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). [**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 2d71fe551..45c9535c3 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +Returns a specified [access system entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} {% tab title="Signature" %} @@ -28,6 +28,8 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_entrance_id`** (Required) +ID of the entrance that you want to get. + --- diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index a3dfab766..0dd4d842f 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) - +Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} {% tab title="Signature" %} @@ -29,10 +29,14 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_entrance_id`** (Required) +ID of the entrance to which you want to grant an access system user access. + --- **`acs_user_id`** (Required) +ID of the access system user to whom you want to grant access to an entrance. + --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index df1b08d58..e2fd187cb 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). +Returns a list of all [access system entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} {% tab title="Signature" %} @@ -30,10 +30,14 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_credential_id`** +ID of the credential for which you want to retrieve all entrances. + --- **`acs_system_id`** +ID of the access system for which you want to retrieve all entrances. + --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 2bbf9a386..23b8b4a1a 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -30,9 +30,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_entrance_id`** (Required) +ID of the entrance for which you want to list all credentials that grant access. + --- **`include_if`** *of Enums* + +Conditions that credentials must meet to be included in the returned list.
Enum values diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 815f1d49a..b22d6ddc0 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -940,16 +940,16 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa [**`/acs/systems/get`**](./get.md) -Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems). [**`/acs/systems/list`**](./list.md) -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). +Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems). [**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) -Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index a3514d12e..1f41fff1e 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -4,9 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - -Specify the desired access control system by including the corresponding `acs_system_id` in the request body. +Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems). {% tabs %} {% tab title="Signature" %} @@ -31,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_system_id`** (Required) -ID of the desired access control system. +ID of the access system that you want to get. --- diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 96f315166..0ab985a86 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -4,9 +4,9 @@ - [Response](./#response) - [Examples](./#examples) -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). +Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems). -To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. +To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace. {% tabs %} {% tab title="Signature" %} @@ -32,7 +32,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`connected_account_id`** -ID of the connected account by which to filter the list of returned access control systems. +ID of the connected account by which you want to filter the list of access systems. --- diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index ae5933420..b836953a0 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -4,9 +4,9 @@ - [Response](./#response) - [Examples](./#examples) -Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems). -Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. +Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body. {% tabs %} {% tab title="Signature" %} @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_system_id`** (Required) -ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. +ID of the access system for which you want to retrieve all compatible credential manager systems. --- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 07ff5e68f..c5528a6a8 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -1000,56 +1000,56 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user- [**`/acs/users/add_to_access_group`**](./add_to_access_group.md) -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). [**`/acs/users/create`**](./create.md) -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). [**`/acs/users/delete`**](./delete.md) -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). +Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). [**`/acs/users/get`**](./get.md) -Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). [**`/acs/users/list`**](./list.md) -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). [**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) -Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. +Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. [**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). [**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) -Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). [**`/acs/users/suspend`**](./suspend.md) -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. [**`/acs/users/unsuspend`**](./unsuspend.md) -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. [**`/acs/users/update`**](./update.md) -Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index eee5501c2..7d829ec89 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} {% tab title="Signature" %} @@ -29,13 +29,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_access_group_id`** (Required) -ID of the desired access group. +ID of the access group to which you want to add an access system user. --- **`acs_user_id`** (Required) -ID of the desired `acs_user`. +ID of the access system user that you want to add to an access group. --- diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 64d83c23f..11fa78435 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="Signature" %} @@ -29,25 +29,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_system_id`** (Required) -ID of the `acs_system` to which to add the new `acs_user`. +ID of the access system to which you want to add the new access system user. --- **`full_name`** (Required) -Full name of the new `acs_user`. +Full name of the new access system user. --- **`access_schedule`** -`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. +`starts_at` and `ends_at` timestamps for the new 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_access_group_ids`** *of UUIDs* -Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. +Array of access group IDs to indicate the access groups to which you want to add the new access system user. --- @@ -69,7 +69,7 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc **`user_identity_id`** -ID of the user identity with which to associate the new `acs_user`. +ID of the user identity with which you want to associate the new access system user. --- diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 7207aa613..91deb14d2 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). +Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} {% tab title="Signature" %} @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_user_id`** (Required) -ID of the desired `acs_user`. +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 c990fea87..128ee0515 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="Signature" %} @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_user_id`** (Required) -ID of the desired `acs_user`. +ID of the access system user that you want to get. --- diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 27a37db8f..2bef4ae7b 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="Signature" %} @@ -30,12 +30,14 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_system_id`** -ID of the `acs_system` for which you want to retrieve all `acs_user`s. +ID of the `acs_system` for which you want to retrieve all access system users. --- **`created_before`** +Timestamp by which to limit returned access system users. Returns users created before this timestamp. + --- **`limit`** @@ -52,25 +54,25 @@ Identifies the specific page of results to return, obtained from the previous pa **`search`** -String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. +String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. --- **`user_identity_email_address`** -Email address of the user identity for which you want to retrieve all `acs_user`s. +Email address of the user identity for which you want to retrieve all access system users. --- **`user_identity_id`** -ID of the user identity for which you want to retrieve all `acs_user`s. +ID of the user identity for which you want to retrieve all access system users. --- **`user_identity_phone_number`** -Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). +Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). --- diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index c7e183802..9a87fe071 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. +Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. {% tabs %} {% tab title="Signature" %} @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_user_id`** (Required) -ID of the desired `acs_user`. +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 0d683acda..0af0b5c0d 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} {% tab title="Signature" %} @@ -29,13 +29,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_access_group_id`** (Required) -ID of the desired access group. +ID of the access group from which you want to remove an access system user. --- **`acs_user_id`** (Required) -ID of the desired `acs_user`. +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 9b4e5c40d..819255bea 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="Signature" %} @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_user_id`** (Required) -ID of the desired `acs_user`. +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 af10e9baf..62993ef1c 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. {% tabs %} {% tab title="Signature" %} @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_user_id`** (Required) -ID of the desired `acs_user`. +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 a0f9a4533..af1df0ee9 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. {% tabs %} {% tab title="Signature" %} @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`acs_user_id`** (Required) -ID of the desired `acs_user`. +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 2f2d0d5ac..1ed6ba72d 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="Signature" %} @@ -35,7 +35,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system **`access_schedule`** -`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. +`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`. --- diff --git a/docs/api/devices/device-provider-metadata.md b/docs/api/devices/device-provider-metadata.md deleted file mode 100644 index 6428342fc..000000000 --- a/docs/api/devices/device-provider-metadata.md +++ /dev/null @@ -1,2 +0,0 @@ -# Device Provider Metadata - diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index b4a0bf881..cbaaf314f 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -508,3 +508,8 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-m Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +[**`/thermostats/update_weekly_program`**](./update_weekly_program.md) + +Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat. + + diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index d25d25825..9951b7282 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -29,13 +29,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`climate_preset_key`** (Required) -Climate preset key of the desired climate preset. +Climate preset key of the climate preset that you want to activate. --- **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device for which you want to activate a climate preset. --- diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index e252c3b44..8e950d23a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device that you want to set to cool mode. --- diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 84feed414..046e716be 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -36,7 +36,7 @@ Unique key to identify the [climate preset](../../capability-guides/thermostats/ **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device for which you want create a climate preset. --- diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index c47abea6d..ce56d9c75 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -30,13 +30,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`climate_preset_key`** (Required) -Climate preset key of the desired climate preset. +Climate preset key of the climate preset that you want to delete. --- **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device for which you want to delete a climate preset. --- diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 75ad94fcb..347c5c48d 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device that you want to set to heat mode. --- diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index cb56f47a3..a2879b739 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device that you want to set to heat-cool mode. --- diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index c7c1d38fc..81ff08d3d 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -30,49 +30,53 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`connect_webview_id`** -ID of the Connect Webview by which to filter devices. +ID of the Connect Webview for which you want to list devices. --- **`connected_account_id`** -ID of the connected account by which to filter. +ID of the connected account for which you want to list devices. --- **`connected_account_ids`** *of UUIDs* -Array of IDs of the connected accounts by which to filter devices. +Array of IDs of the connected accounts for which you want to list devices. --- **`created_before`** -Date threshold for devices to return. If specified, returns only devices created before the specified date. +Timestamp by which to limit returned devices. Returns devices created before this timestamp. --- **`custom_metadata_has`** -Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. +Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs for which you want to list devices. + +--- + +**`customer_ids`** *of UUIDs* --- **`device_ids`** *of UUIDs* -Array of device IDs by which to filter devices. +Array of device IDs for which you want to list devices. --- **`device_type`** -Device type by which to filter devices. +Device type by which to filter thermostat devices. --- **`device_types`** *of Enums* -Array of device types by which to filter devices. +Array of device types by which to filter thermostat devices.
Enum values @@ -83,6 +87,7 @@ Possible enum values: - honeywell_resideo_thermostat - tado_thermostat - sensi_thermostat +- smartthings_thermostat
--- @@ -95,7 +100,7 @@ Numerical limit on the number of devices to return. **`manufacturer`** -Manufacturer by which to filter devices. +Manufacturer by which to filter thermostat devices. --- @@ -107,7 +112,7 @@ Identifies the specific page of results to return, obtained from the previous pa **`user_identifier_key`** -Your own internal user ID for the user by which to filter devices. +Your own internal user ID for the user for which you want to list devices. --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 71faea834..53aef0510 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device that you want to set to off mode. --- diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index d8914ac59..c782536ed 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -24,7 +24,8 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati max_override_period_minutes: [example value], name: [example value], starts_at: [example value], - thermostat_schedule_id: [example value] + thermostat_schedule_id: [example value], + workspace_id: [example value] } ``` {% endtab %} @@ -130,6 +131,15 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating- +--- + +**`workspace_id`** *UUID* + +ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the thermostat schedule. + + + + --- ## Endpoints diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 082217834..a11db7fbe 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -29,13 +29,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`climate_preset_key`** (Required) -Climate preset key of the desired climate preset. +Climate preset key of the climate preset that you want to set as the fallback climate preset. --- **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device for which you want to set the fallback climate preset. --- diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index c971e2abf..9f3d30d06 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -30,6 +30,8 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) +ID of the thermostat device for which you want to set the fan mode. + --- **`fan_mode`** diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 6f918d28a..b5b1f7b22 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device for which you want to set the HVAC mode. --- diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 21d4f7c3e..77e9055d8 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device for which you want to set a temperature threshold. --- diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index fbbe11d48..b3a6c10fe 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -36,7 +36,7 @@ Unique key to identify the [climate preset](../../capability-guides/thermostats/ **`device_id`** (Required) -ID of the desired thermostat device. +ID of the thermostat device for which you want to update a climate preset. --- diff --git a/docs/api/thermostats/update_weekly_program.md b/docs/api/thermostats/update_weekly_program.md new file mode 100644 index 000000000..387f47cd1 --- /dev/null +++ b/docs/api/thermostats/update_weekly_program.md @@ -0,0 +1,97 @@ +# Update the Thermostat Weekly Program + +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + +Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat. + +{% tabs %} +{% tab title="Signature" %} +``` +POST /thermostats/update_weekly_program ⇒ { action_attempt } +``` +{% endtab %} +{% endtabs %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication). +
+ +## Request Parameters + +**`device_id`** (Required) + +ID of the thermostat device for which you want to update the weekly program. + +--- + +**`friday_program_id`** + +ID of the thermostat daily program to run on Fridays. + +--- + +**`monday_program_id`** + +ID of the thermostat daily program to run on Mondays. + +--- + +**`saturday_program_id`** + +ID of the thermostat daily program to run on Saturdays. + +--- + +**`sunday_program_id`** + +ID of the thermostat daily program to run on Sundays. + +--- + +**`thursday_program_id`** + +ID of the thermostat daily program to run on Thursdays. + +--- + +**`tuesday_program_id`** + +ID of the thermostat daily program to run on Tuesdays. + +--- + +**`wednesday_program_id`** + +ID of the thermostat daily program to run on Wednesdays. + +--- + + +## Response + +[action\_attempt](./) + +**`PUSH_THERMOSTAT_PROGRAMS`** +{% tabs %} +{% tab title="JSON" %} +```json +{ + action_attempt_id: [example value], + action_type: [example value], + error: [example value], + result: [example value], + status: [example value] +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 4995daccc..35af09e84 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -9,7 +9,7 @@ - [Endpoints](./#endpoints) -Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. +Represents a [user identity](../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity) associated with an application user account. {% tabs %} {% tab title="JSON" %} @@ -116,7 +116,7 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobi [**`/user_identities/delete`**](./delete.md) -Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. +Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. [**`/user_identities/generate_instant_key`**](./generate_instant_key.md) diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index a595e7ca7..2fbf86e67 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -27,6 +27,12 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters +**`acs_system_ids`** *of UUIDs* + +List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity. + +--- + **`email_address`** Unique email address for the user identity. diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index b822a8403..171c6720e 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -4,7 +4,7 @@ - [Response](./#response) - [Examples](./#examples) -Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. +Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. {% tabs %} {% tab title="Signature" %}