diff --git a/codegen/data/paths.yaml b/codegen/data/paths.yaml index 913e352a4..dfd11b176 100644 --- a/codegen/data/paths.yaml +++ b/codegen/data/paths.yaml @@ -75,7 +75,7 @@ Represents a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). - Noise sensors are devices that measure that sound level in a given area. You can use noise sensors to monitor noise levels remotely and receive notifications when the noise volume is too loud. The Seam API enables you to configure the [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) of a noise sensor and receive events when a disturbance is detected. You can also [simulate triggering a noise threshold](https://docs.seam.co/latest/api/noise_sensors/simulate/trigger_noise_threshold.md). + Noise sensors are devices that measure that sound level in a given area. You can use noise sensors to monitor noise levels remotely and receive notifications when the noise volume is too loud. The Seam API enables you to configure the [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) of a noise sensor and receive events when a disturbance is detected. You can also [simulate triggering a noise threshold](https://docs.seam.co/latest/api/noise_sensors/simulate/trigger_noise_threshold). The Seam API represents a noise sensor as a `device` resource that includes both basic device properties and noise sensor-specific properties. @@ -148,7 +148,7 @@ - [Events](./#events) - [Endpoints](./#endpoints) - Represents a [lock](https://docs.seam.co/latest/capability-guides/thermostats). + Represents a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). The Seam API enables you to control connected smart locks from a wide variety of manufacturers, including locks that provide online and offline [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) programming. diff --git a/docs/api-reference/locks/README.md b/docs/api-reference/locks/README.md index a198981ad..269eee4cc 100644 --- a/docs/api-reference/locks/README.md +++ b/docs/api-reference/locks/README.md @@ -9,7 +9,7 @@ - [Events](./#events) - [Endpoints](./#endpoints) -Represents a [lock](https://docs.seam.co/latest/capability-guides/thermostats). +Represents a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). The Seam API enables you to control connected smart locks from a wide variety of manufacturers, including locks that provide online and offline [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) programming. diff --git a/docs/api-reference/noise_sensors/README.md b/docs/api-reference/noise_sensors/README.md index 78707f546..e026e9f7a 100644 --- a/docs/api-reference/noise_sensors/README.md +++ b/docs/api-reference/noise_sensors/README.md @@ -7,7 +7,7 @@ Represents a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). -Noise sensors are devices that measure that sound level in a given area. You can use noise sensors to monitor noise levels remotely and receive notifications when the noise volume is too loud. The Seam API enables you to configure the [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) of a noise sensor and receive events when a disturbance is detected. You can also [simulate triggering a noise threshold](https://docs.seam.co/latest/api/noise_sensors/simulate/trigger_noise_threshold.md). +Noise sensors are devices that measure that sound level in a given area. You can use noise sensors to monitor noise levels remotely and receive notifications when the noise volume is too loud. The Seam API enables you to configure the [noise thresholds](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) of a noise sensor and receive events when a disturbance is detected. You can also [simulate triggering a noise threshold](https://docs.seam.co/latest/api/noise_sensors/simulate/trigger_noise_threshold). The Seam API represents a noise sensor as a `device` resource that includes both basic device properties and noise sensor-specific properties. diff --git a/docs/guides/README.md b/docs/guides/README.md index 31fb44daa..4222538d9 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -34,7 +34,7 @@ With the Seam API, you can grant users access to entrances controlled by a varie Explore our device API guides to start connecting and controlling specific device and system categories. -
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats-cover.pngthermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
+
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats-cover.pngthermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
*** diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index 9d57e5ccc..2b83e702a 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -43,23 +43,23 @@ ## Capability Guides * [Device and System Capabilities](capability-guides/device-and-system-capabilities.md) -* [Smart Locks](products/smart-locks/README.md) - * [Locking and Unlocking Smart Locks](products/smart-locks/lock-and-unlock.md) - * [Creating and Managing Smart Lock Access Codes](products/smart-locks/access-codes/README.md) +* [Smart Locks](capability-guides/smart-locks/README.md) + * [Locking and Unlocking Smart Locks](capability-guides/smart-locks/lock-and-unlock.md) + * [Creating and Managing Smart Lock Access Codes](capability-guides/smart-locks/access-codes/README.md) * [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes/README.md) * [Understanding Code Constraints](capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md) - * [Retrieving Access Codes](products/smart-locks/access-codes/retrieving-access-codes.md) - * [Modifying Access Codes](products/smart-locks/access-codes/modifying-access-codes.md) - * [Deleting Access Codes](products/smart-locks/access-codes/deleting-access-codes.md) - * [Lifecycle of Access Codes](products/smart-locks/access-codes/lifecycle-of-access-codes.md) - * [Access Code Requirements for Door Locks](products/smart-locks/access-codes/access-code-requirements-for-door-locks.md) - * [Streamlining Access Code Management from the Manufacturer App](products/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md) - * [Troubleshooting Access Codes](products/smart-locks/access-codes/troubleshooting-access-code-issues.md) - * [Managing Backup Access Codes](products/smart-locks/access-codes/backup-access-codes.md) - * [Managing Offline Access Codes](products/smart-locks/access-codes/offline-access-codes.md) + * [Retrieving Access Codes](capability-guides/smart-locks/access-codes/retrieving-access-codes.md) + * [Modifying Access Codes](capability-guides/smart-locks/access-codes/modifying-access-codes.md) + * [Deleting Access Codes](capability-guides/smart-locks/access-codes/deleting-access-codes.md) + * [Lifecycle of Access Codes](capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) + * [Access Code Requirements for Door Locks](capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md) + * [Streamlining Access Code Management from the Manufacturer App](capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md) + * [Troubleshooting Access Codes](capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) + * [Managing Backup Access Codes](capability-guides/smart-locks/access-codes/backup-access-codes.md) + * [Managing Offline Access Codes](capability-guides/smart-locks/access-codes/offline-access-codes.md) * [Creating and Updating Multiple Linked Access Codes](capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md) - * [Migrating Existing Unmanaged Access Codes](products/smart-locks/access-codes/migrating-existing-access-codes.md) -* [Access Control Systems](products/access-systems/README.md) + * [Migrating Existing Unmanaged Access Codes](capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md) +* [Access Control Systems](capability-guides/access-systems/README.md) * [Access System Quick Starts](capability-guides/access-systems/acs-quick-starts/README.md) * [PIN Code Quick Start](capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md) * [Encodable Key Card Quick Start](capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md) @@ -68,8 +68,8 @@ * [Retrieving ACS System Details](capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md) * [Access Control System Resources](capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md) * [Understanding Access Control System Differences](capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md) - * [Managing ACS Users](products/access-systems/user-management.md) - * [Suspending and Unsuspending ACS Users](products/access-systems/suspending-and-unsuspending-users.md) + * [Managing ACS Users](capability-guides/access-systems/user-management.md) + * [Suspending and Unsuspending ACS Users](capability-guides/access-systems/suspending-and-unsuspending-users.md) * [Assigning ACS Users to Access Groups](capability-guides/access-systems/user-management/assigning-users-to-access-groups.md) * [Retrieving Entrance Details](capability-guides/access-systems/retrieving-entrance-details.md) * [Managing Credentials](capability-guides/access-systems/managing-credentials.md) @@ -106,21 +106,21 @@ * [Using Access Grants to Issue Instant Keys](capability-guides/instant-keys/using-access-grants-to-issue-instant-keys.md) * [Using Seam Console to Issue Instant Keys](capability-guides/instant-keys/using-seam-console-to-issue-instant-keys.md) * [Delivering Instant Keys](capability-guides/instant-keys/delivering-instant-keys.md) -* [Thermostats](products/thermostats/README.md) +* [Thermostats](capability-guides/thermostats/README.md) * [Understanding Thermostat Concepts](capability-guides/thermostats/understanding-thermostat-concepts/README.md) * [HVAC Mode](capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) * [Set Points](capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) - * [Retrieving Thermostats](products/thermostats/retrieving-thermostats.md) + * [Retrieving Thermostats](capability-guides/thermostats/retrieving-thermostats.md) * [Setting and Monitoring Temperature Thresholds](capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) - * [Setting the Current HVAC and Fan Mode Settings](products/thermostats/configure-current-climate-settings.md) + * [Setting the Current HVAC and Fan Mode Settings](capability-guides/thermostats/configure-current-climate-settings.md) * [Creating and Managing Climate Presets](capability-guides/thermostats/creating-and-managing-climate-presets/README.md) * [Setting the Fallback Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) * [Activating a Climate Preset](capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md) * [Creating and Managing Thermostat Schedules](capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) * [Creating and Managing Thermostat Programs](capability-guides/thermostats/creating-and-managing-thermostat-programs.md) * [Testing Your Thermostat App with Simulate Endpoints](capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md) -* [Noise Sensors](products/noise-sensors/README.md) - * [Configuring Noise Threshold Settings](products/noise-sensors/configure-noise-threshold-settings.md) +* [Noise Sensors](capability-guides/noise-sensors/README.md) + * [Configuring Noise Threshold Settings](capability-guides/noise-sensors/configure-noise-threshold-settings.md) * [Seam Bridge](capability-guides/seam-bridge.md) * [Seam Bridge Setup for Windows](capability-guides/seam-bridge/seam-bridge-setup-for-windows.md) * [Seam Bridge Setup for macOS](capability-guides/seam-bridge/seam-bridge-setup-for-macos.md) @@ -163,7 +163,7 @@ ## Developer Tools -* [Webhooks](core-concepts/webhooks.md) +* [Webhooks](developer-tools/webhooks.md) * [Seam CLI](developer-tools/seam-cli.md) * [Seam MCP Server](developer-tools/seam-mcp.md) * [Sandbox Devices and Systems](device-guides/sandbox-and-sample-data/README.md) diff --git a/docs/guides/products/access-systems/README.md b/docs/guides/capability-guides/access-systems/README.md similarity index 100% rename from docs/guides/products/access-systems/README.md rename to docs/guides/capability-guides/access-systems/README.md diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md b/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md index cb52271fb..1edd7def5 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md +++ b/docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md @@ -21,7 +21,7 @@ This quick start walks you through the following basic steps: 1. [Connect](../../../core-concepts/workspaces/#connecting-virtual-devices) an access control system to Seam. * To get started quickly, use a virtual ACS in a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces). 2. Install a Seam SDK and create an API key. -3. Create an [ACS user](../../../products/access-systems/user-management.md). +3. Create an [ACS user](../../../capability-guides/access-systems/user-management.md). 4. Create an encodable key card [ACS credential](../managing-credentials.md) for the ACS user. This credential contains both the set of entrances to which the user has access and the access schedule for the user.\ @@ -801,7 +801,7 @@ For a deeper dive into ACS concepts and instructions, see the following topics: * [Access Control System Resources](../connect-an-acs-to-seam/access-control-system-resources.md) * [Understanding ACS Differences](../connect-an-acs-to-seam/understanding-access-control-system-differences.md) 2. Create ACS users. - * [Managing ACS Users](../../../products/access-systems/user-management.md) + * [Managing ACS Users](../../../capability-guides/access-systems/user-management.md) 3. For relevant access control systems, assign ACS users to access groups. * [Assigning ACS Users to Access Groups](../user-management/assigning-users-to-access-groups.md) 4. Learn about available entrances. diff --git a/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md b/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md index 55157b51b..c012739e2 100644 --- a/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md +++ b/docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md @@ -19,7 +19,7 @@ This quick start walks you through the following basic steps: 1. [Connect](../../../core-concepts/workspaces/#connecting-virtual-devices) an access control system to Seam. * To get started quickly, use a virtual ACS in a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces). 2. Install a Seam SDK and create an API key. -3. Create an [ACS user](../../../products/access-systems/user-management.md). +3. Create an [ACS user](../../../capability-guides/access-systems/user-management.md). * Also, specify the access schedule for this user. 4. Assign the ACS user to an [access group](../user-management/assigning-users-to-access-groups.md). * Access groups are preconfigured to grant access to specific entrances.\ @@ -656,7 +656,7 @@ For a deeper dive into ACS concepts and instructions, see the following topics: * [Access Control System Resources](../connect-an-acs-to-seam/access-control-system-resources.md) * [Understanding ACS Differences](../connect-an-acs-to-seam/understanding-access-control-system-differences.md) 2. Create ACS users. - * [Managing ACS Users](../../../products/access-systems/user-management.md) + * [Managing ACS Users](../../../capability-guides/access-systems/user-management.md) 3. For relevant access control systems, assign ACS users to access groups. * [Assigning ACS Users to Access Groups](../user-management/assigning-users-to-access-groups.md) 4. Learn about available entrances. diff --git a/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md b/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md index 87eab51fa..c684c825f 100644 --- a/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md +++ b/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md @@ -6,7 +6,7 @@ description: >- # Assigning Credentials to ACS Users -This guide explains how to assign existing [credentials](managing-credentials.md) to [ACS users](../../products/access-systems/user-management.md) and unassign credentials from users. Once you assign credentials to ACS users, these users can use the credentials to access areas and resources according to their permissions. When you unassign credentials from ACS users, these users can no longer use these specific credentials to access areas or resources. +This guide explains how to assign existing [credentials](managing-credentials.md) to [ACS users](../../capability-guides/access-systems/user-management.md) and unassign credentials from users. Once you assign credentials to ACS users, these users can use the credentials to access areas and resources according to their permissions. When you unassign credentials from ACS users, these users can no longer use these specific credentials to access areas or resources. *** diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md index 7502b2857..51d43acfc 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md @@ -12,7 +12,7 @@ The following diagram shows an example of one ACS, including the ACS resources a The following table provides a brief description of each of the Seam ACS resources: -
ACS ResourceDescription

acs_system

The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.
For more information, see Retrieving ACS System Details.

acs_user

The set of users who access the entrances.

If you manage multiple ACSs and need to grant the same user access to entrances in multiple ACSs, you can also use Seam user identities. With user identities, you can link an application user in your own system to one or more Seam ACS users.
For more information, see Managing ACS Users.

acs_access_group

Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.
For more information, see Assigning ACS Users to Access Groups.

acs_credential

A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.
For more information, see Managing Credentials.

acs_entrance

The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.
For more information, see Retrieving Entrance Details.
+
ACS ResourceDescription

acs_system

The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.
For more information, see Retrieving ACS System Details.

acs_user

The set of users who access the entrances.

If you manage multiple ACSs and need to grant the same user access to entrances in multiple ACSs, you can also use Seam user identities. With user identities, you can link an application user in your own system to one or more Seam ACS users.
For more information, see Managing ACS Users.

acs_access_group

Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.
For more information, see Assigning ACS Users to Access Groups.

acs_credential

A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.
For more information, see Managing Credentials.

acs_entrance

The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.
For more information, see Retrieving Entrance Details.
{% hint style="info" %} You configure the access schedules for your ACS users either through access groups or credentials, depending on your specific ACS. There is no separate schedule resource in the Seam API. diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md index c5419c2d6..1ea8e61f6 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/retrieving-acs-system-details.md @@ -4,7 +4,7 @@ description: Learn how to list and get information about your ACS systems. # Retrieving ACS System Details -You can list details for all the ACSs in your [workspace](../../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](https://docs.seam.co/latest/api/acs/systems/) resource. When you want to [create ACS users](../../../products/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users. +You can list details for all the ACSs in your [workspace](../../../core-concepts/workspaces/) or get these details for a specific ACS. Note that Seam represents the ACS as an [`acs_system`](https://docs.seam.co/latest/api/acs/systems/) resource. When you want to [create ACS users](../../../capability-guides/access-systems/user-management.md#create-a-user) for your ACS, you must first obtain the ID of the `acs_system` for which you want to create these users. *** diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md index e475b8d5b..6b9141508 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md @@ -6,7 +6,7 @@ description: >- # Understanding Access Control System Differences -Seam's universal API provides the flexibility to manage a variety of [ACSs](../../../products/access-systems/). Variations among ACSs include the methods that you use to assign access permissions to users. For example, some ACSs grant scheduled access to [entrances](../retrieving-entrance-details.md) through configured [access groups](../user-management/assigning-users-to-access-groups.md), while others specify entrance permissions and schedules as properties of [credentials](../managing-credentials.md). Other variations include the following: +Seam's universal API provides the flexibility to manage a variety of [ACSs](../../../capability-guides/access-systems/). Variations among ACSs include the methods that you use to assign access permissions to users. For example, some ACSs grant scheduled access to [entrances](../retrieving-entrance-details.md) through configured [access groups](../user-management/assigning-users-to-access-groups.md), while others specify entrance permissions and schedules as properties of [credentials](../managing-credentials.md). Other variations include the following: * Whether an ACS is cloud-based or on-premises * The specific licenses, if any, that each ACS manufacturer requires you to purchase @@ -34,7 +34,7 @@ This section describes various ways in which ACSs handle assigning access permis ### Access Group-Based Access Control Systems -Access group-based ACSs use access groups as an efficient way to assign access permissions to [ACS users](../../../products/access-systems/user-management.md). Each access group contains a list of entrances and the corresponding access schedule. Seam syncs all the access group and entrance information from the ACS. +Access group-based ACSs use access groups as an efficient way to assign access permissions to [ACS users](../../../capability-guides/access-systems/user-management.md). Each access group contains a list of entrances and the corresponding access schedule. Seam syncs all the access group and entrance information from the ACS. To assign access permissions in an access group-based ACS, you add ACS users to the access groups. Then, you create credentials to specify the access mechanisms—such as key cards, PIN codes, or mobile keys—and assign these credentials to the ACS users. @@ -58,7 +58,7 @@ The following process describes the configuration steps for your application to Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. -You can also perform other management actions, as needed, such as [adding ACS users to](../user-management/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../user-management/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../products/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../products/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../products/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../products/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). +You can also perform other management actions, as needed, such as [adding ACS users to](../user-management/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../user-management/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). ### Credential-Based Access Control Systems @@ -71,7 +71,7 @@ The following process describes the configuration steps for your application to 1. Connect the ACS system.\ When the ACS connects to Seam, Seam automatically creates the [`acs_system`](https://docs.seam.co/latest/api/acs/systems/). Seam also syncs the entrances from the connected ACS as `acs_entrance` resources. Note that because Seam automatically syncs these entrance resources from the ACS, you cannot create, edit, or delete them using the Seam API. 2. Create ACS users.\ - Your application [creates](../../../products/access-systems/user-management.md#create-a-user) an [`acs_user`](https://docs.seam.co/latest/api/acs/users/) for each user within this ACS. Each `acs_user` is configured with a set of attributes, such their name, email address, and phone number, as applicable.\ + Your application [creates](../../../capability-guides/access-systems/user-management.md#create-a-user) an [`acs_user`](https://docs.seam.co/latest/api/acs/users/) for each user within this ACS. Each `acs_user` is configured with a set of attributes, such their name, email address, and phone number, as applicable.\ If you need to grant a single application user access to multiple ACSs—for example, if an application user needs access to multiple buildings, each of which uses a separate ACS—you can use Seam [user identities](https://docs.seam.co/latest/api/user_identities/) to link `acs_user`s in different `acs_system`s. 3. Create credentials.\ Your application [creates](../managing-credentials.md#create-a-credential-for-a-user) `acs_credential`s with the following attributes: @@ -83,7 +83,7 @@ The following process describes the configuration steps for your application to Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. -You can also perform other management actions, as needed, such as [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../products/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../products/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../products/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../products/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). +You can also perform other management actions, as needed, such as [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). *** diff --git a/docs/guides/capability-guides/access-systems/managing-credentials.md b/docs/guides/capability-guides/access-systems/managing-credentials.md index ca2c51454..2cdece4fb 100644 --- a/docs/guides/capability-guides/access-systems/managing-credentials.md +++ b/docs/guides/capability-guides/access-systems/managing-credentials.md @@ -4,7 +4,7 @@ description: Learn how to manage credentials and assign them to users. # Managing Credentials -An ACS generally uses digital means of access to authorize an [ACS user](../../products/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs. +An ACS generally uses digital means of access to authorize an [ACS user](../../capability-guides/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
Examples of ACS user credentials

Examples of ACS user credentials

@@ -579,11 +579,11 @@ This response contains manufacturer-specific metadata that may vary by [manufact ## List Credentials -You can [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../products/access-systems/user-management.md) or [user identity](../mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). You can also [list all credentials for an ACS system](https://docs.seam.co/latest/api/acs/credentials/list). +You can [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../capability-guides/access-systems/user-management.md) or [user identity](../mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). You can also [list all credentials for an ACS system](https://docs.seam.co/latest/api/acs/credentials/list). ### List Credentials by ACS User -To [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../products/access-systems/user-management.md), provide the `acs_user_id`. +To [list all ACS credentials](https://docs.seam.co/latest/api/acs/credentials/list) for a specific [ACS user](../../capability-guides/access-systems/user-management.md), provide the `acs_user_id`. {% tabs %} {% tab title="Python" %} diff --git a/docs/guides/products/access-systems/suspending-and-unsuspending-users.md b/docs/guides/capability-guides/access-systems/suspending-and-unsuspending-users.md similarity index 100% rename from docs/guides/products/access-systems/suspending-and-unsuspending-users.md rename to docs/guides/capability-guides/access-systems/suspending-and-unsuspending-users.md diff --git a/docs/guides/products/access-systems/user-management.md b/docs/guides/capability-guides/access-systems/user-management.md similarity index 100% rename from docs/guides/products/access-systems/user-management.md rename to docs/guides/capability-guides/access-systems/user-management.md diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md index ba4d2b089..00aafd333 100644 --- a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md +++ b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md @@ -19,7 +19,7 @@ Some access control systems require credentials to be [encoded onto plastic key Separately, the Seam API also supports [card scanning](scanning-encoded-cards.md), which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with ACS records or diagnose discrepancies if needed. -To verify if your ACS requires a card encoder, see the [system integration guide](../../../products/access-systems/) for your ACS. +To verify if your ACS requires a card encoder, see the [system integration guide](../../../capability-guides/access-systems/) for your ACS. *** diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md index 155ea19c0..20bee4358 100644 --- a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md +++ b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md @@ -23,7 +23,7 @@ This process consists of the following basic steps: See [Retrieve Encoders](creating-and-encoding-card-access-methods.md#id-2.-retrieve-encoders). 3. Use the `/access_methods/encode` endpoint to encode the access method onto the card, using the encoder that you have chosen.\ See [Encode the Card](creating-and-encoding-card-access-methods.md#id-3.-encode-the-card). -4. Confirm that the card was encoded successfully using polling or a [webhook](../../../core-concepts/webhooks.md).\ +4. Confirm that the card was encoded successfully using polling or a [webhook](../../../developer-tools/webhooks.md).\ See [Confirm Successful Encoding](creating-and-encoding-card-access-methods.md#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](creating-and-encoding-card-access-methods.md#common-encoding-errors). Once you have written an access method to a card, you cannot reuse the access method for another card. That is, you must create a separate access method for each card. However, you can reuse a card by re-encoding the card with a new access method. @@ -648,7 +648,7 @@ $encoding_action_attempt = $seam->access_methods->encode( ## 4. Confirm Successful Encoding -Once you issue a request to encode the access method onto the card, it is important to confirm that the encoding process completes successfully. You can use polling or a [webhook](../../../core-concepts/webhooks.md). +Once you issue a request to encode the access method onto the card, it is important to confirm that the encoding process completes successfully. You can use polling or a [webhook](../../../developer-tools/webhooks.md). ### Confirm Successful Encoding by Polling @@ -951,7 +951,7 @@ $seam->access_methods->get( ### Confirm Successful Encoding by Using a Webhook -To confirm successful encoding, you can use a [webhook](../../../core-concepts/webhooks.md) to listen for an `access_method.issued` event that contains the `access_method_id` in the payload. If you are re-encoding a card, listen for `access_method.reissued` instead of `access_method.issued`. +To confirm successful encoding, you can use a [webhook](../../../developer-tools/webhooks.md) to listen for an `access_method.issued` event that contains the `access_method_id` in the payload. If you are re-encoding a card, listen for `access_method.reissued` instead of `access_method.issued`. ```json { diff --git a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md index 4fdda448c..e60b6126d 100644 --- a/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md +++ b/docs/guides/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md @@ -12,14 +12,14 @@ Some access control systems require encoding a plastic card with the data necess This process consists of the following basic steps: -1. Set up an [access system user](../../../products/access-systems/user-management.md) and create a [credential](../managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card`.\ +1. Set up an [access system user](../../../capability-guides/access-systems/user-management.md) and create a [credential](../managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card`.\ See the [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems) for your access system provider to learn specific requirements, such as configuring entrances and access schedules.\ See [Set Up an Access System User and Card Credential](creating-and-encoding-card-based-credentials.md#id-1.-set-up-an-access-syseuser-and-card-credential). 2. Use the `/acs/encoders/list` endpoint to retrieve a list of available encoders. Then, choose the encoder that you want to use to write the credential onto the card.\ See [Retrieve Encoders](creating-and-encoding-card-based-credentials.md#id-2.-retrieve-encoders). 3. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ See [Encode the Card](creating-and-encoding-card-based-credentials.md#id-3.-encode-the-card). -4. Confirm that the card was encoded successfully using polling or a [webhook](../../../core-concepts/webhooks.md).\ +4. Confirm that the card was encoded successfully using polling or a [webhook](../../../developer-tools/webhooks.md).\ See [Confirm Successful Encoding](creating-and-encoding-card-based-credentials.md#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](creating-and-encoding-card-based-credentials.md#common-encoding-errors). Once you have written a credential to a card, you cannot reuse the credential for another card. That is, you must create a separate credential for each card. However, you can reuse a card by re-encoding the card with a new credential. @@ -619,7 +619,7 @@ actionAttempt encodingActionAttempt = seam.EncodersAcs.EncodeCredential( ## 4. Confirm Successful Encoding -Once you issue a request to encode the credential onto the card, it is important to confirm that the encoding process completes successfully. You can use polling or a [webhook](../../../core-concepts/webhooks.md). +Once you issue a request to encode the credential onto the card, it is important to confirm that the encoding process completes successfully. You can use polling or a [webhook](../../../developer-tools/webhooks.md). ### Confirm Successful Encoding by Polling @@ -979,7 +979,7 @@ seam.CredentialsAcs.Get( ### Confirm Successful Encoding by Using a Webhook -To confirm successful encoding, you can use a [webhook](../../../core-concepts/webhooks.md) to listen for an `acs_credential.issued` event that contains the `acs_credential_id` in the payload. If you are re-encoding a card, listen for `acs_credential.reissued` instead of `acs_credential.issued`. +To confirm successful encoding, you can use a [webhook](../../../developer-tools/webhooks.md) to listen for an `acs_credential.issued` event that contains the `acs_credential_id` in the payload. If you are re-encoding a card, listen for `acs_credential.reissued` instead of `acs_credential.issued`. ```json { diff --git a/docs/guides/capability-guides/device-and-system-capabilities.md b/docs/guides/capability-guides/device-and-system-capabilities.md index 03774d36a..e892f6df2 100644 --- a/docs/guides/capability-guides/device-and-system-capabilities.md +++ b/docs/guides/capability-guides/device-and-system-capabilities.md @@ -6,7 +6,7 @@ description: Learn about device and system capabilities, as well as capability f
In the Seam API, capability flags inform your application about what features and behaviors each device supports.
-Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For example, some devices support [remote unlock actions](../products/smart-locks/lock-and-unlock.md), while others support [programming access codes](../products/smart-locks/access-codes/). Some devices support both of these capabilities. When developing your application, it is imperative to be able to identify the capabilities of each device. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For example, some devices support [remote unlock actions](../capability-guides/smart-locks/lock-and-unlock.md), while others support [programming access codes](../capability-guides/smart-locks/access-codes/). Some devices support both of these capabilities. When developing your application, it is imperative to be able to identify the capabilities of each device. For example, if a device supports programming online access codes, your app can present the [`CreateAccessCodeForm` Seam Component](../seam-components/react-components/create-access-code-form.md) to your user. On the other hand, if a connected device does not support the remote unlock action, you'll likely want to disable or not display the unlock functionality for your app user. @@ -26,17 +26,17 @@ All capability flags share the following behavior: Reasons why a capability flag might be `false` could include that a required hardware accessory is not connected to the device. For example, if a lock needs a Wi-Fi bridge for connectivity and is currently not connected to a bridge, the lock cannot be remotely unlocked. If a lock is missing an accessory keypad, access codes cannot be programmed on the lock. -With respect to the ability to program online access codes, as long as a lock has the required hardware, Seam assumes that any offline status is temporary and will be resolved before [it's time to set the access code on the device](../products/smart-locks/access-codes/lifecycle-of-access-codes.md). Consequently, in this case, Seam maintains `can_program_online_access_codes` as `true`. +With respect to the ability to program online access codes, as long as a lock has the required hardware, Seam assumes that any offline status is temporary and will be resolved before [it's time to set the access code on the device](../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md). Consequently, in this case, Seam maintains `can_program_online_access_codes` as `true`.
Capability flags help you to understand why a device cannot currently perform an action.

Capability flags help you to understand why a device cannot currently perform an action.

-Seam recommends adding capability checks before performing specific actions in your app. For example, before performing a [remote unlock](../products/smart-locks/lock-and-unlock.md#unlocking-a-door) operation, you can check to make sure that the target device supports remote unlocking. For details and code samples, see the corresponding capability guides. +Seam recommends adding capability checks before performing specific actions in your app. For example, before performing a [remote unlock](../capability-guides/smart-locks/lock-and-unlock.md#unlocking-a-door) operation, you can check to make sure that the target device supports remote unlocking. For details and code samples, see the corresponding capability guides. {% hint style="info" %} In addition to viewing the capabilities for a specific device, you can also view the capabilities for a provider using [List Device Providers](https://docs.seam.co/latest/api/devices/list_device_providers). If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. {% endhint %} -
PropertyTypeDescription
device.can_remotely_unlockBoolean
Optional
Indicates whether the device can perform a remote unlock operation.
device.can_remotely_lockBoolean
Optional
Indicates whether the device can perform a remote lock operation.
device.can_program_online_access_codesBoolean
Optional
Indicates whether the device can program online access codes.
If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online.
device.can_program_offline_access_codesBoolean
Optional
Indicates whether the device can program offline access codes.
When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device.
device.can_hvac_heatBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode.
When this flag is true, you can set the thermostat to heat mode.
device.can_hvac_coolBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode.
When this flag is true, you can set the thermostat to cool mode.
device.can_hvac_heat_coolBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode.
When this flag is true, you can set the thermostat to heat-cool mode.
device.can_turn_off_hvacBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode.
When this flag is true, you can set the thermostat to "off" mode, which turns off both the heating and cooling systems for the space.
+
PropertyTypeDescription
device.can_remotely_unlockBoolean
Optional
Indicates whether the device can perform a remote unlock operation.
device.can_remotely_lockBoolean
Optional
Indicates whether the device can perform a remote lock operation.
device.can_program_online_access_codesBoolean
Optional
Indicates whether the device can program online access codes.
If true, it is currently possible to create new online access codes for the device, and Seam programs the device the next time it's online.
device.can_program_offline_access_codesBoolean
Optional
Indicates whether the device can program offline access codes.
When this flag is true, Seam can generate an offline code for this device, regardless of the current online status of the device.
device.can_hvac_heatBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode.
When this flag is true, you can set the thermostat to heat mode.
device.can_hvac_coolBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode.
When this flag is true, you can set the thermostat to cool mode.
device.can_hvac_heat_coolBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode.
When this flag is true, you can set the thermostat to heat-cool mode.
device.can_turn_off_hvacBoolean
Optional
Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode.
When this flag is true, you can set the thermostat to "off" mode, which turns off both the heating and cooling systems for the space.
{% hint style="info" %} Seam is actively developing additional capability flags to provide you with even more robust capability checking abilities for your app. If you would like us to add a specific capability flag, contact [support@seam.co](mailto:support@seam.co). @@ -48,9 +48,9 @@ Seam is actively developing additional capability flags to provide you with even To learn about the actions that you can perform using the Seam API, see the Seam capability guides. These guides provide helpful tutorials and code samples, categorized by capability types. -* [Smart locks](../products/smart-locks/), including [locking/unlocking](../products/smart-locks/lock-and-unlock.md) and [managing access codes](../products/smart-locks/access-codes/) -* [Access control systems](../products/access-systems/) -* [Thermostats](../products/thermostats/) -* [Noise sensors](../products/noise-sensors/) +* [Smart locks](../capability-guides/smart-locks/), including [locking/unlocking](../capability-guides/smart-locks/lock-and-unlock.md) and [managing access codes](../capability-guides/smart-locks/access-codes/) +* [Access control systems](../capability-guides/access-systems/) +* [Thermostats](../capability-guides/thermostats/) +* [Noise sensors](../capability-guides/noise-sensors/) * [Mobile access](mobile-access/) * [Seam Bridge](seam-bridge.md) diff --git a/docs/guides/capability-guides/mobile-access/README.md b/docs/guides/capability-guides/mobile-access/README.md index 836391722..d46b76b19 100644 --- a/docs/guides/capability-guides/mobile-access/README.md +++ b/docs/guides/capability-guides/mobile-access/README.md @@ -10,7 +10,7 @@ description: >- ## Managing Mobile Credentials -Mobile access is the use of a mobile device, such as a smartphone, tablet, or wearable, to gain access to secured doors, gates, services, and more. This functionality is incorporated in [access control systems](../../products/access-systems/) (ACSs) of diverse types and levels of complexity. +Mobile access is the use of a mobile device, such as a smartphone, tablet, or wearable, to gain access to secured doors, gates, services, and more. This functionality is incorporated in [access control systems](../../capability-guides/access-systems/) (ACSs) of diverse types and levels of complexity. The Seam mobile access solution makes it easy to issue and retrieve mobile credentials across a wide variety of access control systems. This guide provides an overview of these basic operations and introduces the basic terminology related to mobile access. @@ -19,7 +19,7 @@ The Seam mobile access solution makes it easy to issue and retrieve mobile crede ## Applicable Lock and Access Platforms The Seam mobile access solution is primarily focused on electronic locks and access hardware that support Bluetooth® or near-field communication (NFC) wireless technology. These groups of devices include a vast array of modern electronic door locks, turnstiles, and gate systems. Before implementation, it is important to verify that the existing hardware can communicate with smartphones through one of these wireless technologies.\ -If you aim to enable mobile access with Wi-Fi or Z-Wave locks, see [Smart Locks](../../products/smart-locks/). This section describes API endpoints that you can use directly in your mobile application. +If you aim to enable mobile access with Wi-Fi or Z-Wave locks, see [Smart Locks](../../capability-guides/smart-locks/). This section describes API endpoints that you can use directly in your mobile application. *** diff --git a/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md b/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md index 65857af2d..80ca0371c 100644 --- a/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md +++ b/docs/guides/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md @@ -12,7 +12,7 @@ Seam user identities are a feature for tracking and managing user accounts in yo ### User Identities Can Be Connected to Users in Multiple Access Control Systems -User identities can be linked to one [ACS user](../../products/access-systems/#what-is-a-user) in each access control system. Any mobile credentials issued to these ACS users are consolidated under the user identity. Consequently, a user's mobile app account has access to these credentials through the user identity. +User identities can be linked to one [ACS user](../../capability-guides/access-systems/#what-is-a-user) in each access control system. Any mobile credentials issued to these ACS users are consolidated under the user identity. Consequently, a user's mobile app account has access to these credentials through the user identity.
A user identity can be connected to an ACS user in each ACS.
diff --git a/docs/guides/products/noise-sensors/README.md b/docs/guides/capability-guides/noise-sensors/README.md similarity index 100% rename from docs/guides/products/noise-sensors/README.md rename to docs/guides/capability-guides/noise-sensors/README.md diff --git a/docs/guides/products/noise-sensors/configure-noise-threshold-settings.md b/docs/guides/capability-guides/noise-sensors/configure-noise-threshold-settings.md similarity index 100% rename from docs/guides/products/noise-sensors/configure-noise-threshold-settings.md rename to docs/guides/capability-guides/noise-sensors/configure-noise-threshold-settings.md diff --git a/docs/guides/products/smart-locks/README.md b/docs/guides/capability-guides/smart-locks/README.md similarity index 100% rename from docs/guides/products/smart-locks/README.md rename to docs/guides/capability-guides/smart-locks/README.md diff --git a/docs/guides/products/smart-locks/access-codes/README.md b/docs/guides/capability-guides/smart-locks/access-codes/README.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/README.md rename to docs/guides/capability-guides/smart-locks/access-codes/README.md diff --git a/docs/guides/products/smart-locks/access-codes/access-code-requirements-for-door-locks.md b/docs/guides/capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/access-code-requirements-for-door-locks.md rename to docs/guides/capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md diff --git a/docs/guides/products/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md b/docs/guides/capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md rename to docs/guides/capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md diff --git a/docs/guides/products/smart-locks/access-codes/backup-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/backup-access-codes.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/backup-access-codes.md rename to docs/guides/capability-guides/smart-locks/access-codes/backup-access-codes.md diff --git a/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/README.md b/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/README.md index e48d3bba0..5615bf69a 100644 --- a/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/README.md +++ b/docs/guides/capability-guides/smart-locks/access-codes/creating-access-codes/README.md @@ -16,14 +16,14 @@ Seam supports programming two types of online access codes for online door locks 2. **Time Bound**: Suitable for temporary access like guest visits or service appointments. These codes operate between a designated `starts_at` and `ends_at` time window, granting access only during that period. {% hint style="info" %} -For more information about creating offline access codes, see [Managing Offline Access Codes](../../../../products/smart-locks/access-codes/offline-access-codes.md). +For more information about creating offline access codes, see [Managing Offline Access Codes](../../../../capability-guides/smart-locks/access-codes/offline-access-codes.md). {% endhint %} *** ## Before You Begin: Confirm Capabilities -Before you attempt to create an [online](../../../../products/smart-locks/access-codes/#what-is-an-access-code) or [offline](../../../../products/smart-locks/access-codes/#offline-access-codes) access code, be sure to confirm that your device has the capability to perform these operations. You can inspect the capabilities of a device by checking the following [capability flags](../../../device-and-system-capabilities.md#capability-flags) for the device: +Before you attempt to create an [online](../../../../capability-guides/smart-locks/access-codes/#what-is-an-access-code) or [offline](../../../../capability-guides/smart-locks/access-codes/#offline-access-codes) access code, be sure to confirm that your device has the capability to perform these operations. You can inspect the capabilities of a device by checking the following [capability flags](../../../device-and-system-capabilities.md#capability-flags) for the device: * `device.can_program_online_access_codes` * `device.can_program_offline_access_codes` @@ -178,7 +178,7 @@ Ongoing online access codes are ideal for long-term users that wish to keep the Set an ongoing online access code by providing the `device_id` of the smart lock on which you want to [create an access code](https://docs.seam.co/latest/api/access_codes/create). Assign an optional `name` to the access code for easier identification within the [Seam Console](https://console.seam.co) and smart lock app. -To customize the PIN code, specify a desired PIN for the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See [Access Code Requirements for Door Locks](../../../../products/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock. +To customize the PIN code, specify a desired PIN for the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See [Access Code Requirements for Door Locks](../../../../capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock. {% tabs %} {% tab title="Python" %} @@ -414,7 +414,7 @@ There are two methods to verify that an ongoing access code has been set on the Use the `access_code` reference returned by the create function to call the [Get Access Code](https://docs.seam.co/latest/api/access_codes/get) function. A basic implementation would involve polling this endpoint until the `status` of the access code updates to `set`. -If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [the guide on "Troubleshooting Access Code Issues"](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for further guidance. +If the `status` remains `setting` for a very long time, or if the `access_code` object contains any `warnings` or `errors` properties, consult [the guide on "Troubleshooting Access Code Issues"](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for further guidance.

Illustration of the polling verification step for an ongoing access code

@@ -425,7 +425,7 @@ To avoid polling, monitor for incoming Seam webhook events related to the code s * The `access_code.set_on_device` event indicates the successful setting of the access code on the device. * The `access_code.failed_to_set_on_device` or `access_code.delay_in_setting_on_device` events indicate a delay or failure. -In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies. +In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies.

Illustration of the webhook verification method for an ongoing access code

@@ -443,7 +443,7 @@ To set a time-bound online access code, provide the `device_id` of the smart loc As with ongoing codes, you can assign an optional `name` to the access code. A clear name helps users to identify the access code quickly within their smart lock app. -Similarly, to customize the PIN code, specify a desired PIN in the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See the [Access Code Requirements for Door Locks](../../../../products/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock brand. +Similarly, to customize the PIN code, specify a desired PIN in the `code` property. If you do not specify a `code`, you can set the `preferred_code_length`, and Seam generates a code of this length if the affected device supports the specified preferred code length. See the [Access Code Requirements for Door Locks](../../../../capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md) to understand any requirements specific to the door lock brand. {% tabs %} {% tab title="Python" %} @@ -691,7 +691,7 @@ if (device.CanProgramOnlineAccessCodes == true) { ### 2. Verify Successful Time-Bound Code Programming -The [lifecycle of a time-bound access code](../../../../products/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](../../../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the access code remains in an `unset` state, indicating it has not yet been programmed onto the door lock due to its future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of programming the code onto the lock, transitioning the code's `status` to `setting`. @@ -699,7 +699,7 @@ The [lifecycle of a time-bound access code](../../../../products/smart-locks/acc

Life-cycle of a time-bound access code

-On door locks that support [natively scheduled](../../../../products/smart-locks/access-codes/#native-scheduling) access codes, Seam will preload the access code into the device's internal memory bank **72 hours ahead** of the `starts_at` time. Even if preloaded in memory, the access code will remain in an `unset` state ahead of the `starts_at` time and await the precise activation moment to toggle its status. When the `starts_at` time arrives, the access code becomes active and transition to a `set` status, granting the designated user the ability to utilize it for entry. If there's an issue programming the natively-scheduled code by its `starts_at` time, the code's status will display as `setting`. For more information on the lifecycle of access codes, [please refer to this guide](../../../../products/smart-locks/access-codes/lifecycle-of-access-codes.md). +On door locks that support [natively scheduled](../../../../capability-guides/smart-locks/access-codes/#native-scheduling) access codes, Seam will preload the access code into the device's internal memory bank **72 hours ahead** of the `starts_at` time. Even if preloaded in memory, the access code will remain in an `unset` state ahead of the `starts_at` time and await the precise activation moment to toggle its status. When the `starts_at` time arrives, the access code becomes active and transition to a `set` status, granting the designated user the ability to utilize it for entry. If there's an issue programming the natively-scheduled code by its `starts_at` time, the code's status will display as `setting`. For more information on the lifecycle of access codes, [please refer to this guide](../../../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md). There are two methods to verify that an time-bound access code has been set on the device: @@ -710,7 +710,7 @@ There are two methods to verify that an time-bound access code has been set on t Use the `access_code` reference returned by the create function to call the [Get Access Code](https://docs.seam.co/latest/api/access_codes/get) function. In a basic implementation, you would poll this endpoint at the `starts_at` time to check if the access code's status is updated to `set`. -If the `status` remains `setting`, or if the `access_code` object displays any `warnings` or `errors`, refer to [the "Troubleshooting Access Code Issues" guide](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance. +If the `status` remains `setting`, or if the `access_code` object displays any `warnings` or `errors`, refer to [the "Troubleshooting Access Code Issues" guide](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance.
@@ -721,6 +721,6 @@ To avoid polling, monitor for incoming Seam webhook events related to the code s * The `access_code.set_on_device` event indicates the successful setting of the access code on the device. * The `access_code.failed_to_set_on_device` or `access_code.delay_in_setting_on_device` events indicate a delay or failure. -In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../products/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies. +In the event of delay or failure, refer to [the "Troubleshooting access code issues" guide](../../../../capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md) for assistance and mitigation strategies.
diff --git a/docs/guides/products/smart-locks/access-codes/deleting-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/deleting-access-codes.md similarity index 82% rename from docs/guides/products/smart-locks/access-codes/deleting-access-codes.md rename to docs/guides/capability-guides/smart-locks/access-codes/deleting-access-codes.md index ca28c79d5..45336365d 100644 --- a/docs/guides/products/smart-locks/access-codes/deleting-access-codes.md +++ b/docs/guides/capability-guides/smart-locks/access-codes/deleting-access-codes.md @@ -122,6 +122,6 @@ void ## 2. Verify that the access code has been removed -Poll for or configure a [webhook](../../../core-concepts/webhooks.md) to listen for an `access_code.deleted` or `access_code.removed_from_device` event containing the `access_code_id` of the access code that you've deleted. Note that if you delete an access code that was never programmed onto a device, Seam does not emit an `access_code.removed_from_device` event for this access code. +Poll for or configure a [webhook](../../../developer-tools/webhooks.md) to listen for an `access_code.deleted` or `access_code.removed_from_device` event containing the `access_code_id` of the access code that you've deleted. Note that if you delete an access code that was never programmed onto a device, Seam does not emit an `access_code.removed_from_device` event for this access code. If you receive `access_code.failed_to_remove_from_device` or `access_code.delay_in_removing_from_device` events, see [Troubleshooting Access Code Issues](troubleshooting-access-code-issues.md). diff --git a/docs/guides/products/smart-locks/access-codes/lifecycle-of-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/lifecycle-of-access-codes.md rename to docs/guides/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md diff --git a/docs/guides/products/smart-locks/access-codes/migrating-existing-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/migrating-existing-access-codes.md rename to docs/guides/capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md diff --git a/docs/guides/products/smart-locks/access-codes/modifying-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/modifying-access-codes.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/modifying-access-codes.md rename to docs/guides/capability-guides/smart-locks/access-codes/modifying-access-codes.md diff --git a/docs/guides/products/smart-locks/access-codes/offline-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/offline-access-codes.md rename to docs/guides/capability-guides/smart-locks/access-codes/offline-access-codes.md diff --git a/docs/guides/products/smart-locks/access-codes/retrieving-access-codes.md b/docs/guides/capability-guides/smart-locks/access-codes/retrieving-access-codes.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/retrieving-access-codes.md rename to docs/guides/capability-guides/smart-locks/access-codes/retrieving-access-codes.md diff --git a/docs/guides/products/smart-locks/access-codes/troubleshooting-access-code-issues.md b/docs/guides/capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md similarity index 100% rename from docs/guides/products/smart-locks/access-codes/troubleshooting-access-code-issues.md rename to docs/guides/capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md diff --git a/docs/guides/products/smart-locks/lock-and-unlock.md b/docs/guides/capability-guides/smart-locks/lock-and-unlock.md similarity index 99% rename from docs/guides/products/smart-locks/lock-and-unlock.md rename to docs/guides/capability-guides/smart-locks/lock-and-unlock.md index 9def106aa..1e63e3cc1 100644 --- a/docs/guides/products/smart-locks/lock-and-unlock.md +++ b/docs/guides/capability-guides/smart-locks/lock-and-unlock.md @@ -989,7 +989,7 @@ seam.Devices.Get("11111111-1111-1111-1111-444444444444"); ## Lock and Unlock Events -Whenever a lock is locked or unlocked, Seam emits a `lock.locked` or `lock.unlocked` event. You can see these events by making a [List Events request](https://docs.seam.co/latest/api/events/list) or by setting up a webhook. For more information on how to set up webhooks, see the [Webhooks guide](../../core-concepts/webhooks.md). +Whenever a lock is locked or unlocked, Seam emits a `lock.locked` or `lock.unlocked` event. You can see these events by making a [List Events request](https://docs.seam.co/latest/api/events/list) or by setting up a webhook. For more information on how to set up webhooks, see the [Webhooks guide](../../developer-tools/webhooks.md). A lock or unlock event looks like the following: diff --git a/docs/guides/products/thermostats/README.md b/docs/guides/capability-guides/thermostats/README.md similarity index 100% rename from docs/guides/products/thermostats/README.md rename to docs/guides/capability-guides/thermostats/README.md diff --git a/docs/guides/products/thermostats/configure-current-climate-settings.md b/docs/guides/capability-guides/thermostats/configure-current-climate-settings.md similarity index 99% rename from docs/guides/products/thermostats/configure-current-climate-settings.md rename to docs/guides/capability-guides/thermostats/configure-current-climate-settings.md index 2a93c0f73..0ef45af7f 100644 --- a/docs/guides/products/thermostats/configure-current-climate-settings.md +++ b/docs/guides/capability-guides/thermostats/configure-current-climate-settings.md @@ -57,7 +57,7 @@ To configure and then verify a climate setting on a thermostat, perform the foll 3. Poll the action attempt.\ See [Poll the Action Attempt](configure-current-climate-settings.md#poll-the-action-attempt). 4. If desired, configure a webhook to watch for a `thermostat.temperature_reached_set_point` event that indicates that the thermostat has reported a temperature within 1° Celsius of the heating or cooling [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) that you requested.\ - See [Webhooks](../../core-concepts/webhooks.md). + See [Webhooks](../../developer-tools/webhooks.md). *** diff --git a/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/README.md b/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/README.md index b6dde49d3..08df231d8 100644 --- a/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/README.md +++ b/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/README.md @@ -12,7 +12,7 @@ Once you create climate presets, you can [activate them](https://docs.seam.co/la ## Climate Preset Properties -Each climate preset can contain the following properties, depending on the [capabilities](../../../products/thermostats/#thermostat-capabilities) of the thermostat: +Each climate preset can contain the following properties, depending on the [capabilities](../../../capability-guides/thermostats/#thermostat-capabilities) of the thermostat:
PropertyDescription
climate_preset_key(Required) Key to identify the climate preset.
name(Optional) User-friendly name to identify the climate preset.
fan_mode_settingDesired fan mode setting, such as on, auto, or circulate.
hvac_mode_settingDesired HVAC mode setting, such as heat, cool, heat_cool, or off.
cooling_set_point_celsiusTemperature to which the thermostat should cool (in °C). See also Set Points.
cooling_set_point_fahrenheitTemperature to which the thermostat should cool (in °F).
heating_set_point_celsiusTemperature to which the thermostat should heat (in °C).
heating_set_point_fahrenheitTemperature to which the thermostat should heat (in °F).
manual_override_allowed(Optional) Indicates whether a person at the thermostat or using the API can change the thermostat's settings.

Deprecated. Use thermostat_schedule.is_override_allowed instead.
can_editIndicates whether the climate preset can be edited. There are some cases in which Seam syncs in climate presets (from the device) that cannot be modified.
can_deleteIndicates whether the climate preset can be deleted. There are some cases in which Seam syncs in climate presets (from the device) that cannot be deleted.
diff --git a/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md b/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md index 10475b147..0f91f349b 100644 --- a/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md +++ b/docs/guides/capability-guides/thermostats/creating-and-managing-climate-presets/activating-a-climate-preset.md @@ -8,7 +8,7 @@ In addition to [scheduling](../creating-and-managing-thermostat-schedules.md) cl Activating a climate preset returns an [action attempt](../../../core-concepts/action-attempts.md) that enables you to track the progress of the action. Poll this action attempt, until the action completes. -Further, Seam emits a [`thermostat.temperature_reached_set_point` event](https://docs.seam.co/latest/api/events/) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points.md) specified in the climate preset that you've activated. You can configure a [webhook](../../../core-concepts/webhooks.md) to watch for this event. +Further, Seam emits a [`thermostat.temperature_reached_set_point` event](https://docs.seam.co/latest/api/events/) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](../understanding-thermostat-concepts/set-points.md) specified in the climate preset that you've activated. You can configure a [webhook](../../../developer-tools/webhooks.md) to watch for this event. *** diff --git a/docs/guides/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md b/docs/guides/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md index f8d2d6e68..f25de878c 100644 --- a/docs/guides/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md +++ b/docs/guides/capability-guides/thermostats/creating-and-managing-thermostat-schedules.md @@ -24,7 +24,7 @@ In the Seam API, use the `starts_at` and `ends_at` parameters to define the time `starts_at` is required and must be unique within all the schedules for the thermostat. However, if you want to schedule a climate preset that starts immediately, set `start_at` to a time in the past. Alternately, you can [activate a climate preset](creating-and-managing-climate-presets/activating-a-climate-preset.md) immediately. -After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](https://docs.seam.co/latest/api/events/) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](understanding-thermostat-concepts/set-points.md) specified in this climate preset. You can configure a [webhook](../../core-concepts/webhooks.md) to watch for this event. +After a scheduled climate preset starts, Seam emits a [`thermostat.temperature_reached_set_point` event](https://docs.seam.co/latest/api/events/) when the thermostat reports a temperature within 1° Celsius of the heating or cooling [set point](understanding-thermostat-concepts/set-points.md) specified in this climate preset. You can configure a [webhook](../../developer-tools/webhooks.md) to watch for this event. *** diff --git a/docs/guides/products/thermostats/retrieving-thermostats.md b/docs/guides/capability-guides/thermostats/retrieving-thermostats.md similarity index 100% rename from docs/guides/products/thermostats/retrieving-thermostats.md rename to docs/guides/capability-guides/thermostats/retrieving-thermostats.md diff --git a/docs/guides/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md b/docs/guides/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md index e502db768..8a83ff8d2 100644 --- a/docs/guides/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md +++ b/docs/guides/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md @@ -8,7 +8,7 @@ description: >- You can configure Seam to emit a [`thermostat.temperature_threshold_exceeded` event](https://docs.seam.co/latest/api/events/) if a thermostat reports a temperature outside a specific threshold range. This capability helps you to monitor your thermostats proactively, alerting you to potential HVAC system misuse or malfunctioning. -Use the [`/thermostats/set_temperature_threshold`](https://docs.seam.co/latest/api/thermostats/set\_temperature\_threshold) endpoint to set upper and lower acceptable temperature bounds. Then, you can use a [webhook](../../core-concepts/webhooks.md) to monitor for `thermostat.temperature_threshold_exceeded` events. +Use the [`/thermostats/set_temperature_threshold`](https://docs.seam.co/latest/api/thermostats/set\_temperature\_threshold) endpoint to set upper and lower acceptable temperature bounds. Then, you can use a [webhook](../../developer-tools/webhooks.md) to monitor for `thermostat.temperature_threshold_exceeded` events. When the thermostat reports a temperature outside the threshold range, Seam also adds a warning on the thermostat. You can use the [`/devices/get`](https://docs.seam.co/latest/api/devices/get) endpoint to get the thermostat and then inspect its `device.warnings` property. @@ -291,7 +291,7 @@ To change the temperature threshold range for a thermostat, issue a new [`/therm ## Monitor a Temperature Threshold -To monitor a thermostat for temperatures outside the bounds of the configured threshold range, you can configure a [webhook](../../core-concepts/webhooks.md) to receive `thermostat.temperature_threshold_exceeded` events. This event includes the `device_id` of the affected thermostat, as well as the configured threshold values and the reported temperature that exceeded this threshold range. +To monitor a thermostat for temperatures outside the bounds of the configured threshold range, you can configure a [webhook](../../developer-tools/webhooks.md) to receive `thermostat.temperature_threshold_exceeded` events. This event includes the `device_id` of the affected thermostat, as well as the configured threshold values and the reported temperature that exceeded this threshold range. When the reported temperature for a thermostat returns to within the configured threshold range, Seam emits a `thermostat.temperature_threshold_no_longer_exceeded` event. diff --git a/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md b/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md index e3c8a0e5a..146da62a6 100644 --- a/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md +++ b/docs/guides/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md @@ -30,7 +30,7 @@ The following device properties show the relevant capabilities of a thermostat: * `device.can_hvac_heat_cool` * `device.can_turn_off_hvac` -For more information, see [Thermostat Capabilities](../../products/thermostats/#thermostat-capabilities). +For more information, see [Thermostat Capabilities](../../capability-guides/thermostats/#thermostat-capabilities). *** diff --git a/docs/guides/core-concepts/connect-webviews/connect-webview-process.md b/docs/guides/core-concepts/connect-webviews/connect-webview-process.md index b5cdb9e62..6030aa06a 100644 --- a/docs/guides/core-concepts/connect-webviews/connect-webview-process.md +++ b/docs/guides/core-concepts/connect-webviews/connect-webview-process.md @@ -311,8 +311,8 @@ Continue using the Seam API to control your users' connected devices or ACS. For To learn about the actions that you can perform using the Seam API, see the Seam [capability guides](../../capability-guides/device-and-system-capabilities.md). These guides provide helpful tutorials and code samples, categorized by capability types. -* [Smart locks](../../products/smart-locks/), including [locking/unlocking](../../products/smart-locks/lock-and-unlock.md) and [managing access codes](../../products/smart-locks/access-codes/) -* [Access control systems](../../products/access-systems/) -* [Thermostats](../../products/thermostats/) -* [Noise sensors](../../products/noise-sensors/) +* [Smart locks](../../capability-guides/smart-locks/), including [locking/unlocking](../../capability-guides/smart-locks/lock-and-unlock.md) and [managing access codes](../../capability-guides/smart-locks/access-codes/) +* [Access control systems](../../capability-guides/access-systems/) +* [Thermostats](../../capability-guides/thermostats/) +* [Noise sensors](../../capability-guides/noise-sensors/) * [Mobile access](../../capability-guides/mobile-access/) diff --git a/docs/guides/core-concepts/providers/README.md b/docs/guides/core-concepts/providers/README.md index 7089d83b8..af14b3de4 100644 --- a/docs/guides/core-concepts/providers/README.md +++ b/docs/guides/core-concepts/providers/README.md @@ -6,7 +6,7 @@ description: Learn how to find out information about the providers that Seam sup Seam maintains a list of supported providers that you can access using the [List Device Providers](https://docs.seam.co/latest/api/devices/list_device_providers) endpoint. For a provider, this endpoint returns a subset of the following information, depending on the capabilities of the provider's devices: -
PropertyTypeDescription
device_provider_nameString

Name of the device provider.

For example: august

display_nameString

Formatted version of the device_provider_name.

For example: August

image_urlStringImage URL for the provider logo.
provider_categoriesArray

Array of associated categories for the provider.

Supported categories:

  • stable
  • consumer_smartlocks
  • thermostats
  • noise_sensors
can_remotely_unlockBooleanIndicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.
can_remotely_lockBooleanIndicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesBooleanIndicates whether at least one supported device from the provider can program online access codes. See Capability Flags.
can_program_offline_access_codesBooleanIndicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.
can_simulate_connectionBooleanIndicates whether at least one supported device from the provider can simulate device connection. See Capability Flags.
can_simulate_disconnectionBooleanIndicates whether at least one supported device from the provider can simulate device disconnection. See Capability Flags.
can_simulate_removalBooleanIndicates whether at least one supported device from the provider can simulate device removal. See Capability Flags.
can_hvac_coolBooleanIndicates whether at least one supported device from the provider can be set to cool mode. See Capability Flags.
can_hvac_heatBooleanIndicates whether at least one supported device from the provider can be set to heat mode. See Capability Flags.
can_hvac_heat_coolBooleanIndicates whether at least one supported device from the provider can be set to heat-cool mode. See Capability Flags.
can_turn_off_hvacBooleanIndicates whether at least one supported device from the provider can be set to off mode. See Capability Flags.
+
PropertyTypeDescription
device_provider_nameString

Name of the device provider.

For example: august

display_nameString

Formatted version of the device_provider_name.

For example: August

image_urlStringImage URL for the provider logo.
provider_categoriesArray

Array of associated categories for the provider.

Supported categories:

  • stable
  • consumer_smartlocks
  • thermostats
  • noise_sensors
can_remotely_unlockBooleanIndicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags.
can_remotely_lockBooleanIndicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesBooleanIndicates whether at least one supported device from the provider can program online access codes. See Capability Flags.
can_program_offline_access_codesBooleanIndicates whether at least one supported device from the provider can program offline access codes. See Capability Flags.
can_simulate_connectionBooleanIndicates whether at least one supported device from the provider can simulate device connection. See Capability Flags.
can_simulate_disconnectionBooleanIndicates whether at least one supported device from the provider can simulate device disconnection. See Capability Flags.
can_simulate_removalBooleanIndicates whether at least one supported device from the provider can simulate device removal. See Capability Flags.
can_hvac_coolBooleanIndicates whether at least one supported device from the provider can be set to cool mode. See Capability Flags.
can_hvac_heatBooleanIndicates whether at least one supported device from the provider can be set to heat mode. See Capability Flags.
can_hvac_heat_coolBooleanIndicates whether at least one supported device from the provider can be set to heat-cool mode. See Capability Flags.
can_turn_off_hvacBooleanIndicates whether at least one supported device from the provider can be set to off mode. See Capability Flags.
The following example shows a `device_provider`: diff --git a/docs/guides/core-concepts/seam-console/README.md b/docs/guides/core-concepts/seam-console/README.md index 40d838e96..e2fa14f9d 100644 --- a/docs/guides/core-concepts/seam-console/README.md +++ b/docs/guides/core-concepts/seam-console/README.md @@ -12,7 +12,7 @@ Seam Console enables you to manage all resources associated with your Seam accou * Create and manage [workspaces](../workspaces/). * Create and manage [API keys](../authentication/api-keys.md). * Add and manage [devices](../devices/). -* Add and manage [access control systems](../../products/access-systems/). +* Add and manage [access control systems](../../capability-guides/access-systems/). * Create, customize, and manage [Connect Webviews](../connect-webviews/). * Add and manage [webhooks](../webhooks.md). * Use the [Seam Online CLI](seam-online-cli.md). diff --git a/docs/guides/core-concepts/seam-console/seam-online-cli.md b/docs/guides/core-concepts/seam-console/seam-online-cli.md index 8f9ecc5b2..f85c9b8d6 100644 --- a/docs/guides/core-concepts/seam-console/seam-online-cli.md +++ b/docs/guides/core-concepts/seam-console/seam-online-cli.md @@ -72,7 +72,7 @@ Interact with the Seam CLI using any combination of interactive and typed comman The Seam CLI supports the following command stubs: -
Command StubDescription
seamAccess all Seam CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
+
Command StubDescription
seamAccess all Seam CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
## Copying and Pasting in the Seam CLI diff --git a/docs/guides/core-concepts/webhooks.md b/docs/guides/developer-tools/webhooks.md similarity index 100% rename from docs/guides/core-concepts/webhooks.md rename to docs/guides/developer-tools/webhooks.md diff --git a/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md b/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md index 84181a6fe..f4355f439 100644 --- a/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md +++ b/docs/guides/device-and-system-integration-guides/33-lock-devices/README.md @@ -24,8 +24,8 @@ For detailed information about the 33 Lock devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../products/smart-locks/access-codes/) +* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../../capability-guides/smart-locks/access-codes/) *** diff --git a/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md b/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md index a1a04d8a5..ec2139358 100644 --- a/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md +++ b/docs/guides/device-and-system-integration-guides/33-lock-devices/get-started-with-33-lock-devices.md @@ -697,7 +697,7 @@ True Next, you can use the Seam API to control your lock. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../../products/smart-locks/lock-and-unlock.md), [programming access codes](../../products/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Try out the following actions on your 33 Lock device: @@ -1014,9 +1014,9 @@ Now that you have successfully unlocked your lock, you can use the [Lock Door](h ### Program access codes on your lock -You can use the Seam API to program [online access codes](../../products/smart-locks/access-codes/) on 33 Lock devices. These devices have an integrated keypad. Lock users can then enter these access codes using the keypad to unlock the lock. +You can use the Seam API to program [online access codes](../../capability-guides/smart-locks/access-codes/) on 33 Lock devices. These devices have an integrated keypad. Lock users can then enter these access codes using the keypad to unlock the lock. -The Seam API makes it easy to program both [ongoing](../../products/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../../products/smart-locks/access-codes/#time-bound-access-codes) online access codes. +The Seam API makes it easy to program both [ongoing](../../capability-guides/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../../capability-guides/smart-locks/access-codes/#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1404,9 +1404,9 @@ Now that you've completed this getting started guide for 33 Lock devices, you ca * [ ] **Use Seam Components**\ Find out about [Seam Components](../../seam-components/overview/), which are prebuilt UI components for building your device management flow. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [access control systems](../../products/access-systems/), [thermostats](../../products/thermostats/), and [noise sensors](../../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [access control systems](../../capability-guides/access-systems/), [thermostats](../../capability-guides/thermostats/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). diff --git a/docs/guides/device-and-system-integration-guides/4suites-locks/README.md b/docs/guides/device-and-system-integration-guides/4suites-locks/README.md index 88e053d0a..e359a73b3 100644 --- a/docs/guides/device-and-system-integration-guides/4suites-locks/README.md +++ b/docs/guides/device-and-system-integration-guides/4suites-locks/README.md @@ -22,8 +22,8 @@ For detailed information about the 4SUITES devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../products/smart-locks/access-codes/) +* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../../capability-guides/smart-locks/access-codes/) *** diff --git a/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md b/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md index 410cf2c2f..666a60fe7 100644 --- a/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md +++ b/docs/guides/device-and-system-integration-guides/4suites-locks/get-started-with-4suites-locks.md @@ -679,7 +679,7 @@ True Next, you can use the Seam API to control your lock. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../../products/smart-locks/lock-and-unlock.md), [programming access codes](../../products/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Try out the following actions on your 4SUITES lock: @@ -1022,9 +1022,9 @@ Now that you've completed this getting started guide for 4SUITES devices, you ca * [ ] **Use Seam Components**\ Find out about [Seam Components](../../seam-components/overview/), which are prebuilt UI components for building your device management flow. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [access control systems](../../products/access-systems/), [thermostats](../../products/thermostats/), and [noise sensors](../../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [access control systems](../../capability-guides/access-systems/), [thermostats](../../capability-guides/thermostats/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). diff --git a/docs/guides/device-and-system-integration-guides/akiles-locks/README.md b/docs/guides/device-and-system-integration-guides/akiles-locks/README.md index 03c075e3b..8b4fb448d 100644 --- a/docs/guides/device-and-system-integration-guides/akiles-locks/README.md +++ b/docs/guides/device-and-system-integration-guides/akiles-locks/README.md @@ -28,8 +28,8 @@ For detailed information about the Akiles devices that Seam supports, see our [A We support the following features: -* [Triggering web unlock actions](../../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../products/smart-locks/access-codes/) on devices that have an integrated keypad or Akiles Pinpad +* [Triggering web unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../../capability-guides/smart-locks/access-codes/) on devices that have an integrated keypad or Akiles Pinpad *** diff --git a/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md b/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md index 2648ed6a5..0df5c1221 100644 --- a/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md +++ b/docs/guides/device-and-system-integration-guides/akiles-locks/get-started-with-akiles-locks.md @@ -679,7 +679,7 @@ True Next, you can use the Seam API to control your lock. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../../products/smart-locks/lock-and-unlock.md), [programming access codes](../../products/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Try out the following actions on your Akiles lock: @@ -991,9 +991,9 @@ False ### Program access codes on your lock -You can use the Seam API to program [online access codes](../../products/smart-locks/access-codes/) on Akiles locks that have an integrated keypad or an Akiles Pinpad. Lock users can then enter these access codes using the keypad or Pinpad to unlock the lock. +You can use the Seam API to program [online access codes](../../capability-guides/smart-locks/access-codes/) on Akiles locks that have an integrated keypad or an Akiles Pinpad. Lock users can then enter these access codes using the keypad or Pinpad to unlock the lock. -The Seam API makes it easy to program both [ongoing](../../products/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../../products/smart-locks/access-codes/#time-bound-access-codes) online access codes. +The Seam API makes it easy to program both [ongoing](../../capability-guides/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../../capability-guides/smart-locks/access-codes/#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1381,9 +1381,9 @@ Now that you've completed this getting started guide for Akiles devices, you can * [ ] **Use Seam Components**\ Find out about [Seam Components](../../seam-components/overview/), which are prebuilt UI components for building your device management flow. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [access control systems](../../products/access-systems/), [thermostats](../../products/thermostats/), and [noise sensors](../../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [access control systems](../../capability-guides/access-systems/), [thermostats](../../capability-guides/thermostats/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md b/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md index 1fa9a3e41..ea72ee15c 100644 --- a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md +++ b/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md @@ -22,7 +22,7 @@ For detailed information about the ASSA ABLOY Visionline devices that Seam suppo We support the following features: -* [Managing access systems](../../products/access-systems/) +* [Managing access systems](../../capability-guides/access-systems/) * [Issuing plastic card credentials](../../capability-guides/access-systems/managing-credentials.md#create-a-key-card-based-credential) * [Issuing mobile access credentials](../../capability-guides/mobile-access/) diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md b/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md index 74bd2bcdd..4d3d3de84 100644 --- a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md +++ b/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/configuring-visionline-mobile-credentials/README.md @@ -31,7 +31,7 @@ Seam currently only supports issuing guest mobile credentials and plastic cards. Use the following basic process to grant access in a Visionline ACS: 1. Set up the mobile user account by creating a [user identity](../../../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity). -2. Associate the user identity with an [ACS user](../../../products/access-systems/#what-is-a-user). +2. Associate the user identity with an [ACS user](../../../capability-guides/access-systems/#what-is-a-user). 3. Gather the entrances to which the credential should have access. 4. Create the [guest](./#issuing-guest-mobile-credentials) mobile credential. diff --git a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md b/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md index e17538222..ffe71f844 100644 --- a/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md +++ b/docs/guides/device-and-system-integration-guides/assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md @@ -6,7 +6,7 @@ description: Learn how to create a card-based credential for Visionline. To create a credential to encode onto a plastic key card for a Visionline ACS: -1. Set up an [ACS user](../../products/access-systems/user-management.md). +1. Set up an [ACS user](../../capability-guides/access-systems/user-management.md). 2. Create a [credential](../../capability-guides/access-systems/managing-credentials.md#create-a-card-based-credential) with the `access_method` set to `card` and the appropriate [`visionline_metadata`](mobile-credential-related-properties.md#acs_credential.visionline_metadata-properties), such as the card format. * To issue the first credential for a reservation—that is, an "override" credential—make sure to set `visionline_metadata.override` to `true`. @@ -18,7 +18,7 @@ To create a credential to encode onto a plastic key card for a Visionline ACS: See [Retrieve Encoders](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-2.-retrieve-encoders). 2. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ See [Encode the Card](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-3.-encode-the-card). - 3. Confirm that the card was encoded successfully using polling or a [webhook](../../core-concepts/webhooks.md).\ + 3. Confirm that the card was encoded successfully using polling or a [webhook](../../developer-tools/webhooks.md).\ See [Confirm Successful Encoding](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#common-encoding-errors). The following example shows how to create a card-based override credential for Visionline and encode it onto a plastic card: diff --git a/docs/guides/device-and-system-integration-guides/brivo-access/README.md b/docs/guides/device-and-system-integration-guides/brivo-access/README.md index 63d68cca9..89064cdcf 100644 --- a/docs/guides/device-and-system-integration-guides/brivo-access/README.md +++ b/docs/guides/device-and-system-integration-guides/brivo-access/README.md @@ -12,7 +12,7 @@ Seam integrates with Brivo, which produces an access control platform for applic ## Supported Devices -This integration supports all [readers](https://www.brivo.com/products/smart-readers/), [control panels](https://www.brivo.com/products/control-panels/), and [wireless smart locks](https://www.brivo.com/products/smart-locks/) connected to the Brivo Access platform. Brivo control panels also integrate with any Wiegand or Open Supervised Device Protocol (OSDP) readers. +This integration supports all [readers](https://www.brivo.com/products/smart-readers/), [control panels](https://www.brivo.com/products/control-panels/), and [wireless smart locks](https://www.brivo.com/capability-guides/smart-locks/) connected to the Brivo Access platform. Brivo control panels also integrate with any Wiegand or Open Supervised Device Protocol (OSDP) readers. The Brivo Access platform supports the following wireless locks: @@ -26,9 +26,9 @@ For detailed information about the Brivo-connected devices that Seam supports, s We support the following features: -* [Triggering web lock and unlock actions](../../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../products/smart-locks/access-codes/) for readers and locks that have a keypad -* [Managing access systems](../../products/access-systems/) +* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../../capability-guides/smart-locks/access-codes/) for readers and locks that have a keypad +* [Managing access systems](../../capability-guides/access-systems/) *** diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md index 73dae31aa..7eb88dbd1 100644 --- a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md +++ b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md @@ -7,15 +7,15 @@ hidden: true # Creating dormakaba Oracode Offline Access Codes -The Seam integration for dormakaba Oracode enables you to manage [offline access codes](../../products/smart-locks/access-codes/offline-access-codes.md) for dormakaba Oracode locks. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +The Seam integration for dormakaba Oracode enables you to manage [offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) for dormakaba Oracode locks. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -To learn about the special requirements regarding offline access codes for dormakaba Oracode locks, see [Offline Access Code Requirements](creating-dormakaba-oracode-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](../../products/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../products/smart-locks/access-codes/offline-access-codes.md). +To learn about the special requirements regarding offline access codes for dormakaba Oracode locks, see [Offline Access Code Requirements](creating-dormakaba-oracode-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](../../capability-guides/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md). *** ## Offline Access Code Requirements -Seam supports daily-bound and hourly-bound [offline access codes](../../products/smart-locks/access-codes/offline-access-codes.md) for dormakaba Oracode locks. Note the following dormakaba Oracode-specific restrictions and requirements for offline access codes: +Seam supports daily-bound and hourly-bound [offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) for dormakaba Oracode locks. Note the following dormakaba Oracode-specific restrictions and requirements for offline access codes: ### Duration @@ -93,7 +93,7 @@ You can create hourly- and daily-bound offline access codes for dormakaba Oracod ### Hourly-Bound Offline Access Codes -To [create an hourly-bound offline access code](../../products/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. +To [create an hourly-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. #### 1. Create an Hourly-Bound Offline Access Code @@ -364,7 +364,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../products/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -379,7 +379,7 @@ There are two methods to verify that an time-bound offline access code has been ### Daily-Bound Offline Access Codes -To [create a daily-bound offline access code](../../products/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. +To [create a daily-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the dormakaba Oracode offline access code server. #### 1. Create a Daily-Bound Access Code @@ -658,7 +658,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../products/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. diff --git a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md index 1cece6c70..bbb2a6985 100644 --- a/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md +++ b/docs/guides/device-and-system-integration-guides/dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md @@ -4,7 +4,7 @@ Dormakaba Oracode locks use offline access codes (PIN codes) that are generated ### Understanding Oracode offline access codes -[**Offline access codes**](../../products/smart-locks/access-codes/offline-access-codes.md) are PIN codes generated by Seam that work on the lock without an internet connection. Dormakaba maintains a server-based registry of synchronized encryption keys that enable these codes to work offline. +[**Offline access codes**](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) are PIN codes generated by Seam that work on the lock without an internet connection. Dormakaba maintains a server-based registry of synchronized encryption keys that enable these codes to work offline. Once generated, you can share these codes with guests through messaging or your property management system—guests don't need to install any special app to unlock the door. diff --git a/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md b/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md index 91e2a0c08..b6bce66c2 100644 --- a/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md @@ -722,7 +722,7 @@ Fan running: false Next, you can use the Seam API to control your Google Nest thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../products/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -1863,11 +1863,11 @@ Now that you've completed this getting started guide for Google Nest thermostats * [ ] **Learn**\ Read about Seam [concepts](../../core-concepts/overview.md) and the [device and system capabilities ](../../capability-guides/device-and-system-capabilities.md)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../products/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../products/smart-locks/), [access control systems](../../products/access-systems/), and [noise sensors](../../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). diff --git a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/README.md b/docs/guides/device-and-system-integration-guides/honeywell-thermostats/README.md index 5d3d5773d..744c94685 100644 --- a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/README.md +++ b/docs/guides/device-and-system-integration-guides/honeywell-thermostats/README.md @@ -24,7 +24,7 @@ For detailed information about the Honeywell devices that Seam supports, see our We support the following features: -* [Configuring current thermostat settings](../../products/thermostats/configure-current-climate-settings.md) +* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) * [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) * [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) * [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) diff --git a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md b/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md index 619c310f6..f60fe56e2 100644 --- a/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md @@ -722,7 +722,7 @@ Fan running: false Next, you can use the Seam API to control your Honeywell Resideo thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../products/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -1863,11 +1863,11 @@ Now that you've completed this getting started guide for Honeywell Resideo devic * [ ] **Learn**\ Read about Seam [concepts](../../core-concepts/overview.md) and the [device and system capabilities ](../../capability-guides/device-and-system-capabilities.md)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../products/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../products/smart-locks/), [access control systems](../../products/access-systems/), and [noise sensors](../../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). diff --git a/docs/guides/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md b/docs/guides/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md index f8bbe79ba..75d444c7a 100644 --- a/docs/guides/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md +++ b/docs/guides/device-and-system-integration-guides/igloohome-locks/creating-igloohome-offline-access-codes.md @@ -6,15 +6,15 @@ description: >- # Creating igloohome Offline Access Codes -In addition to supporting [online access codes](../../products/smart-locks/access-codes/), the Seam integration for igloohome supports the generation of offline access codes (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for all igloohome lock models, without the need for a bridge. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +In addition to supporting [online access codes](../../capability-guides/smart-locks/access-codes/), the Seam integration for igloohome supports the generation of offline access codes (that is, igloohome [algoPIN™](https://www.igloohome.co/en-US/how-it-works) codes) for all igloohome lock models, without the need for a bridge. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -To learn about the special requirements regarding offline access codes for igloohome locks, see [Offline Access Code Requirements](creating-igloohome-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](../../products/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../products/smart-locks/access-codes/offline-access-codes.md). +To learn about the special requirements regarding offline access codes for igloohome locks, see [Offline Access Code Requirements](creating-igloohome-offline-access-codes.md#offline-access-code-requirements). For more information about using offline access codes, see [Offline Access Codes](../../capability-guides/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md). *** ## Offline Access Code Requirements -Seam supports the following types of [offline access codes](../../products/smart-locks/access-codes/offline-access-codes.md) for igloohome locks: +Seam supports the following types of [offline access codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md) for igloohome locks: * [Hourly-bound](creating-igloohome-offline-access-codes.md#hourly-bound-offline-access-codes) * [Daily-bound](creating-igloohome-offline-access-codes.md#daily-bound-offline-access-codes) @@ -63,7 +63,7 @@ You can create hourly-bound, daily-bound, and one-time-use offline access codes ### Hourly-Bound Offline Access Codes -To [create an hourly-bound offline access code](../../products/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. +To [create an hourly-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), issue an access code creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. #### 1. Create an Hourly-Bound Offline Access Code @@ -319,7 +319,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../products/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -334,7 +334,7 @@ There are two methods to verify that an time-bound offline access code has been ### Daily-Bound Offline Access Codes -To [create a daily-bound offline access code](../../products/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. +To [create a daily-bound offline access code](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes), first issue a creation request. Then, poll or use a webhook to confirm that the code was registered successfully in the igloohome offline access code server. #### 1. Create a Daily-Bound Access Code @@ -600,7 +600,7 @@ if (device.CanProgramOfflineAccessCodes == true) { #### 2. Verify Successful Time-Bound Code Registration -The [lifecycle of a time-bound access code](../../products/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: +The [lifecycle of a time-bound access code](../../capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md) is marked by distinct phases: 1. `Unset`: When initially created on Seam, the offline access code remains in an `unset` state, indicating that it is not yet available for use on the lock due to a configured future activation time. 2. `Setting`: As the scheduled `starts_at` time approaches, Seam initiates the process of readying the code for use on the lock, transitioning the `status` of the offline code to `setting`. @@ -615,4 +615,4 @@ There are two methods to verify that an time-bound offline access code has been ### One-Time-Use Offline Access Codes -igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. These codes expire after a single use. For detailed instructions, see [Creating One-Time-Use Offline Access Codes](../../products/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes). +igloohome one-time-use offline access codes are valid for 24 hours from the `starts_at` timestamp that you configure. These codes expire after a single use. For detailed instructions, see [Creating One-Time-Use Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes). diff --git a/docs/guides/device-and-system-integration-guides/latch-access-control-system/README.md b/docs/guides/device-and-system-integration-guides/latch-access-control-system/README.md index 86938c11d..a47e33040 100644 --- a/docs/guides/device-and-system-integration-guides/latch-access-control-system/README.md +++ b/docs/guides/device-and-system-integration-guides/latch-access-control-system/README.md @@ -8,7 +8,7 @@ description: Guide for using the Latch Access Control System with Seam ## Overview -Seam integrates seamlessly with the [Latch](https://www.latch.com/) management platform. Property managers and owners use the Latch [access control system](../../products/access-systems/) (ACS) to control access across their properties. Latch enables them to manage who has access to which spaces and when, view access history, and set up and manage multiple users and guests. +Seam integrates seamlessly with the [Latch](https://www.latch.com/) management platform. Property managers and owners use the Latch [access control system](../../capability-guides/access-systems/) (ACS) to control access across their properties. Latch enables them to manage who has access to which spaces and when, view access history, and set up and manage multiple users and guests. The Seam integration for Latch enables you to automate the creation of residents and the issuing of credentials to these residents. Within these credentials, you specify the entrances to which the residents have access and the access schedules. @@ -18,7 +18,7 @@ Latch enables you to install wireless door locks and intercom systems in your bu ## Latch ACS Resources -The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Latch ACS in a logical, efficient manner. Latch is a [credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems), so you [create ACS users](../../products/access-systems/user-management.md#create-an-acs-user) and then grant them access permissions using credentials. When you create a credential, you specify the ACS user to which to assign the credential, as well as the allowed entrances and the start and end times for the access schedule. +The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Latch ACS in a logical, efficient manner. Latch is a [credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-access-control-systems), so you [create ACS users](../../capability-guides/access-systems/user-management.md#create-an-acs-user) and then grant them access permissions using credentials. When you create a credential, you specify the ACS user to which to assign the credential, as well as the allowed entrances and the start and end times for the access schedule. The following diagram shows the Seam resources for a Latch ACS and the relationships between these resources: @@ -33,7 +33,7 @@ For more information about managing your Latch ACS through Seam, see the followi * [Programming Code-Based Latch Credentials](programming-code-based-latch-credentials.md) * [Programming Latch ACS Mobile Credentials](programming-latch-acs-mobile-credentials.md) * [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Access Control Systems](../../products/access-systems/) +* [Access Control Systems](../../capability-guides/access-systems/) * [Mobile Access](../../capability-guides/mobile-access/) *** @@ -48,7 +48,7 @@ This integration supports all wireless locks and readers connected to the Latch We support the following features: -* [Managing access systems](../../products/access-systems/) +* [Managing access systems](../../capability-guides/access-systems/) * [Issuing mobile access credentials](../../capability-guides/mobile-access/) *** diff --git a/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-code-based-latch-credentials.md b/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-code-based-latch-credentials.md index 4de650a35..e056ac355 100644 --- a/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-code-based-latch-credentials.md +++ b/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-code-based-latch-credentials.md @@ -16,7 +16,7 @@ Alternately, you can update entrances manually using the [Latch Manager App](htt To use the Seam API to program codes for users in a [Latch ACS](./): -1. Create an [ACS user](../../products/access-systems/user-management.md). +1. Create an [ACS user](../../capability-guides/access-systems/user-management.md). * Specify the `acs_system_id` of the Latch ACS in the building to which you want to grant the new user access. * Specify the details of the new ACS user, such as their `full_name`, `email_address`, and so on. 2. Create an [ACS credential](../../capability-guides/access-systems/managing-credentials.md). @@ -394,9 +394,9 @@ foreach (AcsEntrance entrance in entrances) To learn more about using the Seam API with your Latch ACS, see the following topics: * [Programming Latch ACS Mobile Keys for App Users](programming-latch-acs-mobile-credentials.md) -* [Access Control Systems](../../products/access-systems/) +* [Access Control Systems](../../capability-guides/access-systems/) * [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Managing ACS Users](../../products/access-systems/user-management.md) +* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) * [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) * [Mobile Access](../../capability-guides/mobile-access/) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md b/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md index 8236f44be..00239cecd 100644 --- a/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md +++ b/docs/guides/device-and-system-integration-guides/latch-access-control-system/programming-latch-acs-mobile-credentials.md @@ -11,7 +11,7 @@ To use the Seam API to create mobile credentials for mobile app users in a Latch 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/) that corresponds to your user's app account. Seam [user identities](https://docs.seam.co/latest/api/user_identities/) enable you to match your own mobile app users to ACS users that you create using the Seam API. -2. Create an [access system user](../../products/access-systems/user-management.md) on the Latch access system or assign an existing access system user to the user identity.\ +2. Create an [access system user](../../capability-guides/access-systems/user-management.md) on the Latch access system or assign an existing access system user to the user identity.\ The resources that you create for the access system user are available under the associated user identity. * In the access system user creation command, set the `user_identity_id` property for a new access system user. Alternately, use the `add_acs_user` command for user identities to assign an existing access system user to a user identity. * If you choose to create a new access system user, specify the `acs_system_id` of the Latch access system in the building to which you want to grant the new user access. @@ -460,9 +460,9 @@ seam.CredentialsAcs.ListAccessibleEntrances( To learn more about using the Seam API with your Latch ACS, see the following topics: * [Programming PIN Codes for Latch ACS Users](programming-code-based-latch-credentials.md) -* [Access Control Systems](../../products/access-systems/) +* [Access Control Systems](../../capability-guides/access-systems/) * [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Managing ACS Users](../../products/access-systems/user-management.md) +* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) * [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) * [Mobile Access](../../capability-guides/mobile-access/) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/guides/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md b/docs/guides/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md index 5d5064d39..f317e46cd 100644 --- a/docs/guides/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md +++ b/docs/guides/device-and-system-integration-guides/lockly-locks/creating-lockly-offline-access-codes.md @@ -6,20 +6,20 @@ description: >- # Creating Lockly Offline Access Codes -In addition to supporting [online access codes](../../products/smart-locks/access-codes/), the Seam integration for Lockly supports the generation of offline access codes for all Lockly lock models that have a keypad. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. +In addition to supporting [online access codes](../../capability-guides/smart-locks/access-codes/), the Seam integration for Lockly supports the generation of offline access codes for all Lockly lock models that have a keypad. You generate offline access (PIN) codes remotely, and the manufacturer maintains a server-based registry of synchronized encryption keys (tokens) to enable these offline codes. Then, owners or managers can share these codes with users through messaging or other similar applications, and the users do not need to install a special application to unlock the device. -For Lockly locks with keypads, you can program [time-bound](../../products/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes) and [one-time-use](../../products/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes) offline access codes. To define the validity period for each Lockly offline access code, specify the desired `starts_at` and `ends_at` timestamp. You can create as many offline access codes as you'd like, up to the limits of your device memory capacity and your Lockly subscription. You can verify your Lockly subscription in the [Lockly Access Portal](https://lap.lockly.com/lap/index.html#/login). +For Lockly locks with keypads, you can program [time-bound](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes) and [one-time-use](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes) offline access codes. To define the validity period for each Lockly offline access code, specify the desired `starts_at` and `ends_at` timestamp. You can create as many offline access codes as you'd like, up to the limits of your device memory capacity and your Lockly subscription. You can verify your Lockly subscription in the [Lockly Access Portal](https://lap.lockly.com/lap/index.html#/login). {% hint style="info" %} It is important to inform your Lockly lock users that the mechanism for entering offline access codes on Lockly devices is different from the mechanism for entering online access codes on these devices. For instructions, see [https://www.support.lockly.com/faq/how-to-use-oac/](https://www.support.lockly.com/faq/how-to-use-oac/). {% endhint %} -For more information about using offline access codes, see [Offline Access Codes](../../products/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../products/smart-locks/access-codes/offline-access-codes.md). +For more information about using offline access codes, see [Offline Access Codes](../../capability-guides/smart-locks/access-codes/#offline-access-codes) and [Managing Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md). *** ## Programming Lockly Offline Access Codes -For detailed instructions for creating time-bound offline access codes for Lockly locks, see [Creating Time-Bound Offline Access Codes](../../products/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes). +For detailed instructions for creating time-bound offline access codes for Lockly locks, see [Creating Time-Bound Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-time-bound-offline-access-codes). -For detailed instructions for creating one-time-use offline access codes for Lockly locks, see [Creating One-Time-Use Offline Access Codes](../../products/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes). +For detailed instructions for creating one-time-use offline access codes for Lockly locks, see [Creating One-Time-Use Offline Access Codes](../../capability-guides/smart-locks/access-codes/offline-access-codes.md#creating-one-time-use-offline-access-codes). diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/README.md b/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/README.md index 3828bd240..497039f60 100644 --- a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/README.md +++ b/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/README.md @@ -16,7 +16,7 @@ The Seam integration for Salto KS enables you to create ACS users and assign acc ## Salto KS Resources -The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto KS ACS in a logical, efficient manner. Salto KS is an [access group-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems), so you [create ACS users](../../products/access-systems/user-management.md#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. You can also configure access schedules for ACS users. +The Seam ACS schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto KS ACS in a logical, efficient manner. Salto KS is an [access group-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems), so you [create ACS users](../../capability-guides/access-systems/user-management.md#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. You can also configure access schedules for ACS users. The following diagram shows the Seam resources for a Salto KS ACS and the relationships between these resources: @@ -31,7 +31,7 @@ For more information about managing your Salto KS ACS through Seam, see the foll * [Programming Salto KS PIN Code Credentials](programming-code-based-salto-ks-credentials.md) * [Programming Salto KS Mobile Credentials](programming-salto-ks-mobile-credentials.md) * [Access Group-Based Access Control Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Access Control Systems](../../products/access-systems/) +* [Access Control Systems](../../capability-guides/access-systems/) * [Mobile Access](../../capability-guides/mobile-access/) *** @@ -46,7 +46,7 @@ This integration supports all Salto locks connected to the Salto KS ACS. We support the following features: -* [Managing access systems](../../products/access-systems/) +* [Managing access systems](../../capability-guides/access-systems/) * [Issuing code-based credentials](programming-code-based-salto-ks-credentials.md) * [Issuing mobile access credentials](../../capability-guides/mobile-access/) diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md b/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md index 0424c164a..a4929c1b6 100644 --- a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md +++ b/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md @@ -6,7 +6,7 @@ description: Learn how to create Salto KS PIN codes. To use the Seam API to program codes for users in a [Salto KS ACS](./): -1. Create an [ACS user](../../products/access-systems/user-management.md). +1. Create an [ACS user](../../capability-guides/access-systems/user-management.md). * For Salto KS, you can specify the `access_schedule` for the new ACS user. An `access_schedule` consists of `starts_at` and `ends_at` times. In this case, a Salto KS ACS user appears as "unsubscribed" in the ACS until the `starts_at` time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access. 2. Assign access permissions to the ACS user by assigning them to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). * Each access group is preconfigured with specific entrances and schedules. @@ -317,9 +317,9 @@ echo json_encode($pin_code, JSON_PRETTY_PRINT); To learn more about using the Seam API with your Salto KS ACS, see the following topics: -* [Access Control Systems](../../products/access-systems/) +* [Access Control Systems](../../capability-guides/access-systems/) * [Access Group-Based Access Control Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Managing ACS Users](../../products/access-systems/user-management.md) +* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) * [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) * [Mobile Access](../../capability-guides/mobile-access/) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md b/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md index 72657ae7b..6673e2c88 100644 --- a/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md +++ b/docs/guides/device-and-system-integration-guides/salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md @@ -11,7 +11,7 @@ To use the Seam API to create mobile credentials for mobile app users in a Salto 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/). Seam user identities enable you to match your own mobile app users to ACS users that you create using the Seam API. -2. Create an [ACS user](../../products/access-systems/user-management.md) on the Salto KS ACS or assign an existing ACS user to the user identity.\ +2. Create an [ACS user](../../capability-guides/access-systems/user-management.md) on the Salto KS ACS or assign an existing ACS user to the user identity.\ The resources that you create for the ACS user are available under the associated user identity. * For Salto KS, you can specify the `access_schedule` for the ACS user. The `access_schedule` consists of `starts_at` and `ends_at` times. In this case, a Salto KS ACS user appears as "unsubscribed" in the ACS until the `starts_at` time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access. 3. Assign the ACS user to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). @@ -472,9 +472,9 @@ echo json_encode($reservation_mobile_key, JSON_PRETTY_PRINT); To learn more about using the Seam API with your Salto KS ACS, see the following topics: * [Programming Code-Based Salto KS Credentials](programming-code-based-salto-ks-credentials.md) -* [Access Control Systems](../../products/access-systems/) +* [Access Control Systems](../../capability-guides/access-systems/) * [Credential-based ACS](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#credential-based-acs) -* [Managing ACS Users](../../products/access-systems/user-management.md) +* [Managing ACS Users](../../capability-guides/access-systems/user-management.md) * [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) * [Mobile Access](../../capability-guides/mobile-access/) * [Access Control Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/README.md b/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/README.md index 29d14c2bf..0149c1955 100644 --- a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/README.md +++ b/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/README.md @@ -18,7 +18,7 @@ This integration requires [Seam Bridge](../../capability-guides/seam-bridge.md) ## Salto Space Resources -The Seam access system schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto Space access system in a logical, efficient manner. Salto Space is an [access group-based access system](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems), so you [create access system users](../../products/access-systems/user-management.md#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. +The Seam access system schema consists of a series of resources that interact intuitively, enabling you to use the Seam API to manage your Salto Space access system in a logical, efficient manner. Salto Space is an [access group-based access system](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems), so you [create access system users](../../capability-guides/access-systems/user-management.md#create-an-acs-user) and then assign them to access groups to specify the entrances to which these users have access. The following diagram shows the Seam resources for a Salto Space access system and the relationships between these resources: @@ -33,7 +33,7 @@ For more information about managing your Salto Space access system through Seam, * [Programming Salto Space Card-based Credentials](programming-salto-space-card-based-credentials.md) * [Programming Salto Space Mobile Credentials](programming-salto-space-mobile-credentials.md) * [Access Group-Based Access Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Access Systems](../../products/access-systems/) +* [Access Systems](../../capability-guides/access-systems/) * [Mobile Access](../../capability-guides/mobile-access/) *** @@ -48,7 +48,7 @@ This integration supports all Salto locks connected to the Salto Space ACS. We support the following features: -* [Managing access systems](../../products/access-systems/) +* [Managing access systems](../../capability-guides/access-systems/) * [Issuing card-based credentials](programming-salto-space-card-based-credentials.md) * [Issuing mobile access credentials](../../capability-guides/mobile-access/) diff --git a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md b/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md index 0396f8fd3..04f1aa478 100644 --- a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md +++ b/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md @@ -8,7 +8,7 @@ For each access system user in a [Salto Space access system](./), you can create To use the Seam API to create card credentials for a Salto Space access system: -1. Create an [access system user](../../products/access-systems/user-management.md). +1. Create an [access system user](../../capability-guides/access-systems/user-management.md). 2. Assign access permissions to the user by assigning them to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). * Each access group is preconfigured with specific entrances. 3. Create a [credential](../../capability-guides/access-systems/managing-credentials.md). @@ -29,7 +29,7 @@ To use the Seam API to create card credentials for a Salto Space access system: See [Retrieve Encoders](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-2.-retrieve-encoders). 2. Use the `/acs/encoders/encode_credential` endpoint to encode the credential onto the card, using the encoder that you have chosen.\ See [Encode the Card](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-3.-encode-the-card). - 3. Confirm that the card was encoded successfully using polling or a [webhook](../../core-concepts/webhooks.md).\ + 3. Confirm that the card was encoded successfully using polling or a [webhook](../../developer-tools/webhooks.md).\ See [Confirm Successful Encoding](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#id-4.-confirm-successful-encoding). Also, see a list of [common encoding errors](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md#common-encoding-errors). The following example walks you through this process: @@ -550,9 +550,9 @@ You can use an encoder to scan a plastic key card to read its encoded parameters To find out more about using the Seam API with your Salto Space access system, see the following topics: -* [Access Systems](../../products/access-systems/) +* [Access Systems](../../capability-guides/access-systems/) * [Access Group-Based Access Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Managing Access System Users](../../products/access-systems/user-management.md) +* [Managing Access System Users](../../capability-guides/access-systems/user-management.md) * [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) * [Working with Card Encoders and Scanners](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/) * [Access Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md b/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md index d8b5adcdc..8655a3824 100644 --- a/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md +++ b/docs/guides/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-mobile-credentials.md @@ -11,7 +11,7 @@ To use the Seam API to create mobile credentials for mobile app users in a Salto 1. Create a [user identity](https://docs.seam.co/latest/api/user_identities/). Seam user identities enable you to match your own mobile app users to access system users that you create using the Seam API. -2. Create an [access system user](../../products/access-systems/user-management.md) on the Salto Space access system or assign an existing access system user to the user identity.\ +2. Create an [access system user](../../capability-guides/access-systems/user-management.md) on the Salto Space access system or assign an existing access system user to the user identity.\ The resources that you create for the access system user are available under the associated user identity. 3. Assign the access system user to one or more [access groups](../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). * Each access group is preconfigured with the allowed entrances. @@ -359,9 +359,9 @@ $mobile_key = $seam->acs->credentials->create( To find out more about using the Seam API with your Salto Space access system, see the following topics: * [Programming Salto Space Card-based Credentials](programming-salto-space-card-based-credentials.md) -* [Access Systems](../../products/access-systems/) +* [Access Systems](../../capability-guides/access-systems/) * [Access Group-Based Access Systems](../../capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-group-based-access-control-systems) -* [Managing Access System Users](../../products/access-systems/user-management.md) +* [Managing Access System Users](../../capability-guides/access-systems/user-management.md) * [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md) * [Mobile Access](../../capability-guides/mobile-access/) * [Access Systems](https://docs.seam.co/latest/api/acs/) in the Seam API reference diff --git a/docs/guides/device-and-system-integration-guides/schlage-locks/README.md b/docs/guides/device-and-system-integration-guides/schlage-locks/README.md index d60d64ad1..8afe27e7c 100644 --- a/docs/guides/device-and-system-integration-guides/schlage-locks/README.md +++ b/docs/guides/device-and-system-integration-guides/schlage-locks/README.md @@ -28,8 +28,8 @@ For detailed information about the Schlage devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../../products/smart-locks/lock-and-unlock.md) -* [Programming online access codes](../../products/smart-locks/access-codes/) on locks that have a connected keypad +* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming online access codes](../../capability-guides/smart-locks/access-codes/) on locks that have a connected keypad *** diff --git a/docs/guides/device-and-system-integration-guides/sensi-thermostats/README.md b/docs/guides/device-and-system-integration-guides/sensi-thermostats/README.md index fd33328bf..33ad7fd27 100644 --- a/docs/guides/device-and-system-integration-guides/sensi-thermostats/README.md +++ b/docs/guides/device-and-system-integration-guides/sensi-thermostats/README.md @@ -24,7 +24,7 @@ For detailed information about the Sensi devices that Seam supports, see our [Se We support the following features: -* [Configuring current thermostat settings](../../products/thermostats/configure-current-climate-settings.md) +* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) * [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) * [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) * [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) @@ -64,7 +64,7 @@ The Sensi API does not communicate the battery state of Sensi devices, so Seam c ### Heat-Cool Mode -Some Sensi models do not support heat-cool mode, such as the Sensi Classic and Sensi One Touch thermostats. To check whether a thermostat supports heat-cool mode, [get the device](../../products/thermostats/retrieving-thermostats.md) and look for a `device.can_hvac_heat_cool` capability flag. For more information about thermostat-related capability flags, see [Thermostat Capabilities](../../products/thermostats/#thermostat-capabilities). +Some Sensi models do not support heat-cool mode, such as the Sensi Classic and Sensi One Touch thermostats. To check whether a thermostat supports heat-cool mode, [get the device](../../capability-guides/thermostats/retrieving-thermostats.md) and look for a `device.can_hvac_heat_cool` capability flag. For more information about thermostat-related capability flags, see [Thermostat Capabilities](../../capability-guides/thermostats/#thermostat-capabilities). *** diff --git a/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md b/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md index 60ff1ca79..204792e36 100644 --- a/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/sensi-thermostats/get-started-with-sensi-thermostats.md @@ -715,7 +715,7 @@ Fan running: false Next, you can use the Seam API to control your Sensi thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../products/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -1846,11 +1846,11 @@ Now that you've completed this getting started guide for Sensi devices, you can * [ ] **Learn**\ Read about Seam [concepts](../../core-concepts/overview.md) and the [device and system capabilities ](../../capability-guides/device-and-system-capabilities.md)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../products/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../products/smart-locks/), [access control systems](../../products/access-systems/), and [noise sensors](../../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/README.md b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/README.md index bf92eb418..2a2ab8efe 100644 --- a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/README.md +++ b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/README.md @@ -24,9 +24,9 @@ For detailed information about the SmartThings devices that Seam supports, see o We support the following features: -* [Triggering web lock and unlock actions](../../products/smart-locks/lock-and-unlock.md) on smart locks -* [Programming online access codes](../../products/smart-locks/access-codes/) on smart locks that have a connected keypad -* [Configuring current thermostat settings](../../products/thermostats/configure-current-climate-settings.md) on thermostats +* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) on smart locks +* [Programming online access codes](../../capability-guides/smart-locks/access-codes/) on smart locks that have a connected keypad +* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) on thermostats * [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) on thermostats * [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) on thermostats * [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) on thermostats diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md index 0766ec25a..9d3b3f75b 100644 --- a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md +++ b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md @@ -725,7 +725,7 @@ Fan running: false Next, you can use the Seam API to control your SmartThings-connected thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../products/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -1856,11 +1856,11 @@ Now that you've completed this getting started guide for SmartThings-connected d * [ ] **Learn**\ Read about Seam [concepts](../../core-concepts/overview.md) and the [device and system capabilities ](../../capability-guides/device-and-system-capabilities.md)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../../products/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](../../capability-guides/thermostats/) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../products/smart-locks/), [access control systems](../../products/access-systems/), and [noise sensors](../../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](../../capability-guides/smart-locks/), [access control systems](../../capability-guides/access-systems/), and [noise sensors](../../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../../capability-guides/mobile-access/). diff --git a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md index 6e1b884e8..ef6185278 100644 --- a/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md +++ b/docs/guides/device-and-system-integration-guides/smartthings-hubs-+-smart-locks.md @@ -22,8 +22,8 @@ For detailed information about the SmartThings hubs that Seam supports, see our We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) on paired smart locks that support this feature -* [Programming access codes](../products/smart-locks/access-codes/) on paired smart locks that support this feature +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) on paired smart locks that support this feature +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on paired smart locks that support this feature *** diff --git a/docs/guides/device-and-system-integration-guides/tedee-locks/README.md b/docs/guides/device-and-system-integration-guides/tedee-locks/README.md index 93b6c006b..efb488db4 100644 --- a/docs/guides/device-and-system-integration-guides/tedee-locks/README.md +++ b/docs/guides/device-and-system-integration-guides/tedee-locks/README.md @@ -28,8 +28,8 @@ For detailed information about the Tedee devices that Seam supports, see our [Te We support the following features: -* [Triggering web lock and unlock actions](../../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../../products/smart-locks/access-codes/) on locks and openers that have an installed Tedee keypad +* [Triggering web lock and unlock actions](../../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../../capability-guides/smart-locks/access-codes/) on locks and openers that have an installed Tedee keypad *** diff --git a/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md b/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md index 8a2762413..2c1981fed 100644 --- a/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md +++ b/docs/guides/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md @@ -375,7 +375,7 @@ $seam->locks->lock_door($lock->device_id); Some Tedee locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Tedee lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Tedee lock. You can find out more about Tedee lock access code in our [core concept section on access codes.](../../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Tedee lock. You can find out more about Tedee lock access code in our [core concept section on access codes.](../../capability-guides/smart-locks/access-codes/) {% hint style="info" %} For Tedee-specific access code restrictions, see [Access (PIN) Code Requirements](./#access-pin-code-requirements). @@ -480,7 +480,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Schlage Getting Started Guide](../../device-guides/get-started-with-schlage-locks.md) * [Yale Getting Started Guide](../../device-guides/get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](../../device-guides/get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-and-system-integration-guides/ultraloq-locks/creating-ultraloq-access-codes.md b/docs/guides/device-and-system-integration-guides/ultraloq-locks/creating-ultraloq-access-codes.md index 9f9fedf9a..5c973c42b 100644 --- a/docs/guides/device-and-system-integration-guides/ultraloq-locks/creating-ultraloq-access-codes.md +++ b/docs/guides/device-and-system-integration-guides/ultraloq-locks/creating-ultraloq-access-codes.md @@ -853,6 +853,6 @@ For complete API documentation, see: * **Learn about timezone configuration:** See [Configuring Ultraloq Device Timezones](configuring-ultraloq-device-timezones.md) * **Understand code constraints:** See [Understanding Code Constraints](../../capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md) * **Review the setup guide:** See [Ultraloq Setup Guide](ultraloq-setup-guide.md) -* **Explore access code webhooks:** See [Webhooks](../../core-concepts/webhooks.md) +* **Explore access code webhooks:** See [Webhooks](../../developer-tools/webhooks.md) *** diff --git a/docs/guides/device-and-system-integration-guides/ultraloq-locks/ultraloq-setup-guide.md b/docs/guides/device-and-system-integration-guides/ultraloq-locks/ultraloq-setup-guide.md index 31075bd63..9258f2eeb 100644 --- a/docs/guides/device-and-system-integration-guides/ultraloq-locks/ultraloq-setup-guide.md +++ b/docs/guides/device-and-system-integration-guides/ultraloq-locks/ultraloq-setup-guide.md @@ -151,7 +151,7 @@ After authorization, the user is redirected to your `custom_redirect_url` with t ## Step 3: Verify Connection -Wait for the Connect Webview status to change to `authorized`, indicating that the connection was successful. You can either poll the Connect Webview or use [webhooks](../../core-concepts/webhooks.md) to be notified when the status changes. +Wait for the Connect Webview status to change to `authorized`, indicating that the connection was successful. You can either poll the Connect Webview or use [webhooks](../../developer-tools/webhooks.md) to be notified when the status changes. {% tabs %} {% tab title="Python" %} @@ -1436,8 +1436,8 @@ echo $device | jq '.device.warnings' * **[Creating Ultraloq Access Codes](creating-ultraloq-access-codes.md)** - Detailed guide on permanent and time-bound access codes * **[Configuring Ultraloq Device Timezones](configuring-ultraloq-device-timezones.md)** - Complete timezone configuration reference -* **[Lock and Unlock Operations](../../products/smart-locks/lock-and-unlock.md)** - General smart lock control documentation -* **[Access Codes Overview](../../products/smart-locks/access-codes/)** - Understanding access code management +* **[Lock and Unlock Operations](../../capability-guides/smart-locks/lock-and-unlock.md)** - General smart lock control documentation +* **[Access Codes Overview](../../capability-guides/smart-locks/access-codes/)** - Understanding access code management *** diff --git a/docs/guides/device-guides/august-locks.md b/docs/guides/device-guides/august-locks.md index e61be2a6b..05621e7bd 100644 --- a/docs/guides/device-guides/august-locks.md +++ b/docs/guides/device-guides/august-locks.md @@ -32,8 +32,8 @@ For detailed information about the August devices that Seam supports, see our [A We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../products/smart-locks/access-codes/) on locks that have an installed August Smart Keypad +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on locks that have an installed August Smart Keypad *** diff --git a/docs/guides/device-guides/avigilon-alta-access-system.md b/docs/guides/device-guides/avigilon-alta-access-system.md index 3528f22b9..97d74f17d 100644 --- a/docs/guides/device-guides/avigilon-alta-access-system.md +++ b/docs/guides/device-guides/avigilon-alta-access-system.md @@ -24,7 +24,7 @@ For detailed information about the Avigilon Alta-connected devices that Seam sup We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) *** diff --git a/docs/guides/device-guides/dormakaba-oracode-locks.md b/docs/guides/device-guides/dormakaba-oracode-locks.md index 4e7bd9efc..0c2533d49 100644 --- a/docs/guides/device-guides/dormakaba-oracode-locks.md +++ b/docs/guides/device-guides/dormakaba-oracode-locks.md @@ -26,7 +26,7 @@ For detailed information about the dormakaba Oracode devices that Seam supports, We support the following features: -* [Programming offline access codes](../products/smart-locks/access-codes/offline-access-codes.md) +* [Programming offline access codes](../capability-guides/smart-locks/access-codes/offline-access-codes.md) *** diff --git a/docs/guides/device-guides/ecobee-thermostats.md b/docs/guides/device-guides/ecobee-thermostats.md index a9df18cb8..a7794c43e 100644 --- a/docs/guides/device-guides/ecobee-thermostats.md +++ b/docs/guides/device-guides/ecobee-thermostats.md @@ -24,7 +24,7 @@ For detailed information about the ecobee devices that Seam supports, see our [e We support the following features: -* [Configuring current thermostat settings](../products/thermostats/configure-current-climate-settings.md) +* [Configuring current thermostat settings](../capability-guides/thermostats/configure-current-climate-settings.md) * [Creating and managing climate presets](../capability-guides/thermostats/creating-and-managing-climate-presets/) * [Creating and managing thermostat schedules](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) * [Creating and managing thermostat weekly programs](../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) diff --git a/docs/guides/device-guides/get-started-with-2n-intercoms.md b/docs/guides/device-guides/get-started-with-2n-intercoms.md index cf547dac5..b2530c070 100644 --- a/docs/guides/device-guides/get-started-with-2n-intercoms.md +++ b/docs/guides/device-guides/get-started-with-2n-intercoms.md @@ -381,7 +381,7 @@ $seam->locks->lock_door($lock->device_id); 2N devices have a directory with residents. These residents can be assigned PIN codes to unlock the door. -Seam maps these residents to [access codes](../products/smart-locks/access-codes/) and allows you to create and manage them through the Seam API. +Seam maps these residents to [access codes](../capability-guides/smart-locks/access-codes/) and allows you to create and manage them through the Seam API. \{% tabs %\} \{% tab title="Python" %\} @@ -556,7 +556,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) * [Minut Getting Started Guide](get-started-with-minut-sensors.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-guides/get-started-with-august-locks.md b/docs/guides/device-guides/get-started-with-august-locks.md index 951b51f2b..4ceff1a3b 100644 --- a/docs/guides/device-guides/get-started-with-august-locks.md +++ b/docs/guides/device-guides/get-started-with-august-locks.md @@ -700,7 +700,7 @@ True Next, you can use the Seam API to control your lock. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../products/smart-locks/lock-and-unlock.md), [programming access codes](../products/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Try out the following actions on your August lock: @@ -1016,9 +1016,9 @@ Now that you have successfully unlocked your lock, you can use the [Lock Door](h ### Program access codes on your lock -You can use the Seam API to program [online access codes](../products/smart-locks/access-codes/) on August locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. +You can use the Seam API to program [online access codes](../capability-guides/smart-locks/access-codes/) on August locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. -The Seam API makes it easy to program both [ongoing](../products/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../products/smart-locks/access-codes/#time-bound-access-codes) online access codes. +The Seam API makes it easy to program both [ongoing](../capability-guides/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../capability-guides/smart-locks/access-codes/#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1406,9 +1406,9 @@ Now that you've completed this getting started guide for August devices, you can * [ ] **Use Seam Components**\ Find out about [Seam Components](../seam-components/overview/), which are prebuilt UI components for building your device management flow. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [access control systems](../products/access-systems/), [thermostats](../products/thermostats/), and [noise sensors](../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [access control systems](../capability-guides/access-systems/), [thermostats](../capability-guides/thermostats/), and [noise sensors](../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../capability-guides/mobile-access/). diff --git a/docs/guides/device-guides/get-started-with-controlbyweb-devices.md b/docs/guides/device-guides/get-started-with-controlbyweb-devices.md index 731ea8415..bb589f838 100644 --- a/docs/guides/device-guides/get-started-with-controlbyweb-devices.md +++ b/docs/guides/device-guides/get-started-with-controlbyweb-devices.md @@ -306,7 +306,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) * [Minut Getting Started Guide](get-started-with-minut-sensors.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-guides/get-started-with-dormakaba-oracode-locks.md b/docs/guides/device-guides/get-started-with-dormakaba-oracode-locks.md index d9d8eb44f..c6ecabb83 100644 --- a/docs/guides/device-guides/get-started-with-dormakaba-oracode-locks.md +++ b/docs/guides/device-guides/get-started-with-dormakaba-oracode-locks.md @@ -258,7 +258,7 @@ In addition, if you'd like to explore other aspects of Seam, check out the follo * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Configuring webhooks](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Configuring webhooks](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at [support@seam.co](mailto:support@seam.co). diff --git a/docs/guides/device-guides/get-started-with-ecobee-thermostats.md b/docs/guides/device-guides/get-started-with-ecobee-thermostats.md index 48e6f9a66..80e66a8ce 100644 --- a/docs/guides/device-guides/get-started-with-ecobee-thermostats.md +++ b/docs/guides/device-guides/get-started-with-ecobee-thermostats.md @@ -720,7 +720,7 @@ Fan running: false Next, you can use the Seam API to control your ecobee thermostat. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../products/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use. For thermostats, device-specific capabilities include whether you can [set the HVAC mode](../capability-guides/thermostats/configure-current-climate-settings.md) to `heat`, `cool`, or `heat_cool`. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Seam provides additional actions for thermostats, such as setting the fan mode, creating and scheduling climate presets, setting temperature thresholds, and configuring weekly thermostat programs. You can also monitor for Seam thermostat-related events, such as reported temperatures outside your set thresholds. @@ -1861,11 +1861,11 @@ Now that you've completed this getting started guide for ecobee devices, you can * [ ] **Learn**\ Read about Seam [concepts](../core-concepts/overview.md) and the [device and system capabilities ](../capability-guides/device-and-system-capabilities.md)that Seam supports. * [ ] **Expand your abilities**\ - Find out what other [thermostat actions](../products/thermostats/) you can perform using the Seam API. + Find out what other [thermostat actions](../capability-guides/thermostats/) you can perform using the Seam API. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [smart locks](../products/smart-locks/), [access control systems](../products/access-systems/), and [noise sensors](../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [smart locks](../capability-guides/smart-locks/), [access control systems](../capability-guides/access-systems/), and [noise sensors](../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../capability-guides/mobile-access/). diff --git a/docs/guides/device-guides/get-started-with-igloo-locks.md b/docs/guides/device-guides/get-started-with-igloo-locks.md index 32c1221a7..c52fb3db8 100644 --- a/docs/guides/device-guides/get-started-with-igloo-locks.md +++ b/docs/guides/device-guides/get-started-with-igloo-locks.md @@ -350,7 +350,7 @@ $seam->locks->lock_door($lock->device_id); Most Igloohome locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Igloohome lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Igloohome lock. You can find out more about Igloohome lock access code in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Igloohome lock. You can find out more about Igloohome lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) {% hint style="info" %} Igloohome pins have to be 4-6 digits long, and for time bound access codes, start date can't be on the past. @@ -459,7 +459,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-guides/get-started-with-kwikset-wifi-locks.md b/docs/guides/device-guides/get-started-with-kwikset-wifi-locks.md index 91c47f542..1435712e8 100644 --- a/docs/guides/device-guides/get-started-with-kwikset-wifi-locks.md +++ b/docs/guides/device-guides/get-started-with-kwikset-wifi-locks.md @@ -367,7 +367,7 @@ If you're connected through Wi-Fi and not Bluetooth, the Kwikset app _only_ show Some Kwikset locks have a keypad paired to them to program access codes. These codes can then be entered to unlock a Kwikset lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Kwikset lock. You can find out more about Kwikset lock access code in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Kwikset lock. You can find out more about Kwikset lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) **Access Code Constraints** @@ -550,7 +550,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [August Getting Started Guide](get-started-with-august-locks.md) * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-guides/get-started-with-minut-sensors.md b/docs/guides/device-guides/get-started-with-minut-sensors.md index fa9fe3418..dcb9c5866 100644 --- a/docs/guides/device-guides/get-started-with-minut-sensors.md +++ b/docs/guides/device-guides/get-started-with-minut-sensors.md @@ -139,7 +139,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](../core-concepts/webhooks.md). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](../developer-tools/webhooks.md). Otherwise you can just poll for the webview until it's status changes, as shown below: {% tabs %} {% tab title="Python" %} @@ -498,7 +498,7 @@ echo json_encode($device[0]); Minut users can define noise thresholds at which noise alerts are sent. -You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](../core-concepts/webhooks.md). You can also [poll for events](https://docs.seam.co/latest/api/events/list). +You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](../developer-tools/webhooks.md). You can also [poll for events](https://docs.seam.co/latest/api/events/list). {% hint style="info" %} Minut has a builtin threshold that can be triggered multiple times. Each Minut notice will trigger a `noise_threshold_triggered` event with the `minut_metadata.event_name` containing the Minut event name, which can be any of the following: diff --git a/docs/guides/device-guides/get-started-with-noiseaware-sensors.md b/docs/guides/device-guides/get-started-with-noiseaware-sensors.md index 00b195d54..231eefd85 100644 --- a/docs/guides/device-guides/get-started-with-noiseaware-sensors.md +++ b/docs/guides/device-guides/get-started-with-noiseaware-sensors.md @@ -148,7 +148,7 @@ Navigate to the URL returned by the Webview object. Since you are using a sandbo ### Get the New Webview -After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](../core-concepts/webhooks.md). Otherwise you can just poll for the webview until it's status changes, as shown below: +After you complete the login above, you'll get an event for [`connected_account.created`](https://docs.seam.co/latest/api/events/)if you set up a [webhook handler](../developer-tools/webhooks.md). Otherwise you can just poll for the webview until it's status changes, as shown below: {% tabs %} {% tab title="Python" %} @@ -327,7 +327,7 @@ echo json_encode($device[0]); NoiseAware users can define noise thresholds at which noise alerts are sent. -You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](../core-concepts/webhooks.md). You can also [poll for events](https://docs.seam.co/latest/api/events/list). +You'll get an event for `noise_threshold.noise_threshold_triggered` when you set up a [webhook handler](../developer-tools/webhooks.md). You can also [poll for events](https://docs.seam.co/latest/api/events/list). {% hint style="info" %} NoiseAware has three distinct noise alerts: `newNoise`, `continuedNoise`, and `resolvedNoise`. It is essential to keep in mind that Seam will solely trigger the `noise_threshold.noise_threshold_triggered` event for `newNoise`. diff --git a/docs/guides/device-guides/get-started-with-nuki-locks.md b/docs/guides/device-guides/get-started-with-nuki-locks.md index 406d33bf4..d996797be 100644 --- a/docs/guides/device-guides/get-started-with-nuki-locks.md +++ b/docs/guides/device-guides/get-started-with-nuki-locks.md @@ -344,7 +344,7 @@ $seam->locks->lock_door($lock->device_id); Some Nuki locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock a Nuki lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Nuki lock. You can find out more about Nuki lock access code in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Nuki lock. You can find out more about Nuki lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) {% hint style="info" %} Nuki does not let you create a code starting with the digits "12". Codes cannot contain the digit 0. @@ -451,7 +451,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at [support@seam.co](mailto:support@seam.co). diff --git a/docs/guides/device-guides/get-started-with-salto-locks.md b/docs/guides/device-guides/get-started-with-salto-locks.md index 1be0b0ec7..f03b4a007 100644 --- a/docs/guides/device-guides/get-started-with-salto-locks.md +++ b/docs/guides/device-guides/get-started-with-salto-locks.md @@ -466,7 +466,7 @@ $seam->locks->lock_door($lock->device_id); Some Salto locks and access points will have a keypad available to program access codes. These codes can then be entered to unlock the door. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Salto lock. You can find out more about Salto lock access code in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on an Salto lock. You can find out more about Salto lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) {% hint style="info" %} Salto does not let you specify a code for an access code. Instead Salto generates a 6-digit code, which the Seam API returns. @@ -625,7 +625,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at [support@seam.co](mailto:support@seam.co). diff --git a/docs/guides/device-guides/get-started-with-schlage-locks.md b/docs/guides/device-guides/get-started-with-schlage-locks.md index 686fa0428..1b59ff4cc 100644 --- a/docs/guides/device-guides/get-started-with-schlage-locks.md +++ b/docs/guides/device-guides/get-started-with-schlage-locks.md @@ -323,7 +323,7 @@ puts updated_lock.properties.locked # false All Schlage wifi locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Schlage lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Schlage lock. You can find out more about Schlage lock access code in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Schlage lock. You can find out more about Schlage lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/)
@@ -474,7 +474,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Yale Getting Started Guide](get-started-with-yale-locks.md) * [August Getting Started Guide](get-started-with-august-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. If you would like help diff --git a/docs/guides/device-guides/get-started-with-smartlocks-api.md b/docs/guides/device-guides/get-started-with-smartlocks-api.md index 780898dbc..5595660ef 100644 --- a/docs/guides/device-guides/get-started-with-smartlocks-api.md +++ b/docs/guides/device-guides/get-started-with-smartlocks-api.md @@ -325,7 +325,7 @@ Many smartlocks have a built-in keypad or an external one that can be paired ove ![](<../.gitbook/assets/code_unlock (1).gif>) -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a smartlock. An `ongoing` code is a code that will be permanently programmed onto the device until you tell the Seam API you wish to remove it. A `timebound` code is, as the time implies, time bound by a set of ISO8601 timestamp that you provide the Seam API. You can find out more about access code in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a smartlock. An `ongoing` code is a code that will be permanently programmed onto the device until you tell the Seam API you wish to remove it. A `timebound` code is, as the time implies, time bound by a set of ISO8601 timestamp that you provide the Seam API. You can find out more about access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) {% tabs %} {% tab title="Python" %} @@ -487,5 +487,5 @@ Now that you've completed this guide, you can try to build a real application to * [August Getting Started Guide](get-started-with-august-locks.md) * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) diff --git a/docs/guides/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/guides/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md index ab3784c36..4b8bc389d 100644 --- a/docs/guides/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md +++ b/docs/guides/device-guides/get-started-with-smartthings-hubs-+-smart-locks.md @@ -701,7 +701,7 @@ True Next, you can use the Seam API to control your lock. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../products/smart-locks/lock-and-unlock.md), [programming access codes](../products/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Try out the following actions on your SmartThings-connected lock: @@ -1017,9 +1017,9 @@ Now that you have successfully unlocked your lock, you can use the [Lock Door](h ### Program access codes on your lock -You can use the Seam API to program [online access codes](../products/smart-locks/access-codes/) on SmartThings-connected locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. +You can use the Seam API to program [online access codes](../capability-guides/smart-locks/access-codes/) on SmartThings-connected locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. -The Seam API makes it easy to program both [ongoing](../products/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../products/smart-locks/access-codes/#time-bound-access-codes) online access codes. +The Seam API makes it easy to program both [ongoing](../capability-guides/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../capability-guides/smart-locks/access-codes/#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1407,9 +1407,9 @@ Now that you've completed this getting started guide for SmartThings-connected d * [ ] **Use Seam Components**\ Find out about [Seam Components](../seam-components/overview/), which are prebuilt UI components for building your device management flow. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [access control systems](../products/access-systems/), [thermostats](../products/thermostats/), and [noise sensors](../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [access control systems](../capability-guides/access-systems/), [thermostats](../capability-guides/thermostats/), and [noise sensors](../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../capability-guides/mobile-access/). diff --git a/docs/guides/device-guides/get-started-with-ttlock-devices.md b/docs/guides/device-guides/get-started-with-ttlock-devices.md index a2410b8df..4df559894 100644 --- a/docs/guides/device-guides/get-started-with-ttlock-devices.md +++ b/docs/guides/device-guides/get-started-with-ttlock-devices.md @@ -697,7 +697,7 @@ True Next, you can use the Seam API to control your lock. -Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../products/smart-locks/lock-and-unlock.md), [programming access codes](../products/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. +Each device that you connect to Seam has a specific set of capabilities. These capabilities define the Seam API actions that you can use, such as [remote unlock actions](../capability-guides/smart-locks/lock-and-unlock.md), [programming access codes](../capability-guides/smart-locks/access-codes/), and so on. Seam's intuitive and granular [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags) inform your application about what features and behaviors each device supports. Notice the capability flags within the code samples in this guide. Try out the following actions on your TTLock lock: @@ -1014,9 +1014,9 @@ Now that you have successfully unlocked your lock, you can use the [Lock Door](h ### Program access codes on your lock -You can use the Seam API to program [online access codes](../products/smart-locks/access-codes/) on TTLock locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. +You can use the Seam API to program [online access codes](../capability-guides/smart-locks/access-codes/) on TTLock locks that have an integrated or accessory keypad. Lock users can then enter these access codes using the keypad to unlock the lock. -The Seam API makes it easy to program both [ongoing](../products/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../products/smart-locks/access-codes/#time-bound-access-codes) online access codes. +The Seam API makes it easy to program both [ongoing](../capability-guides/smart-locks/access-codes/#ongoing-access-codes) and [time-bound](../capability-guides/smart-locks/access-codes/#time-bound-access-codes) online access codes. {% tabs %} {% tab title="Python" %} @@ -1404,9 +1404,9 @@ Now that you've completed this getting started guide for TTLock devices, you can * [ ] **Use Seam Components**\ Find out about [Seam Components](../seam-components/overview/), which are prebuilt UI components for building your device management flow. * [ ] **Use webhooks**\ - Learn how to use [webhooks](../core-concepts/webhooks.md) as an efficient way to receive device events. + Learn how to use [webhooks](../developer-tools/webhooks.md) as an efficient way to receive device events. * [ ] **Find out more**\ - Explore the other types of devices and systems that you can control with Seam, including [access control systems](../products/access-systems/), [thermostats](../products/thermostats/), and [noise sensors](../products/noise-sensors/). + Explore the other types of devices and systems that you can control with Seam, including [access control systems](../capability-guides/access-systems/), [thermostats](../capability-guides/thermostats/), and [noise sensors](../capability-guides/noise-sensors/). * [ ] **Develop for mobile access**\ Learn about Seam's [mobile access solution](../capability-guides/mobile-access/). diff --git a/docs/guides/device-guides/get-started-with-wyze-locks.md b/docs/guides/device-guides/get-started-with-wyze-locks.md index 8fba52032..22ef15c4d 100644 --- a/docs/guides/device-guides/get-started-with-wyze-locks.md +++ b/docs/guides/device-guides/get-started-with-wyze-locks.md @@ -330,7 +330,7 @@ $seam->locks->lock_door($lock->device_id); ## 5 — Programming Access Code on a Wyze Lock -The Seam API lets you create access codes on Wyze locks with a gateway. These codes can then be entered to unlock the door. You can find out more info about how Seam access codes in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API lets you create access codes on Wyze locks with a gateway. These codes can then be entered to unlock the door. You can find out more info about how Seam access codes in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) {% hint style="info" %} Wyze does not allow pin code values to be seen after the code is created. If you create a code through Seam, avoid changing the pin code through the app and instead use Seam to change any information about the code! @@ -490,7 +490,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [August Getting Started Guide](get-started-with-august-locks.md) * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at support@seam.co. diff --git a/docs/guides/device-guides/get-started-with-yale-locks.md b/docs/guides/device-guides/get-started-with-yale-locks.md index 60769ed0d..d1df3ab43 100644 --- a/docs/guides/device-guides/get-started-with-yale-locks.md +++ b/docs/guides/device-guides/get-started-with-yale-locks.md @@ -314,7 +314,7 @@ puts updated_lock.properties.locked # false Most Yale locks come with a keypad built-in to program access codes. These codes can then be entered to unlock a Yale lock. -The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Yale lock. You can find out more about Yale lock access code in our [core concept section on access codes.](../products/smart-locks/access-codes/) +The Seam API makes it easy to program both `ongoing` codes and `timebound` codes on a Yale lock. You can find out more about Yale lock access code in our [core concept section on access codes.](../capability-guides/smart-locks/access-codes/) {% tabs %} {% tab title="Python" %} @@ -457,7 +457,7 @@ In addition, if you'd like to explore other aspects of Seam, here is a list of h * [Schlage Getting Started Guide](get-started-with-schlage-locks.md) * [August Getting Started Guide](get-started-with-august-locks.md) * [SmartThings Getting Started Guide](get-started-with-smartthings-hubs-+-smart-locks.md) -* [Receiving webhook](../core-concepts/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) +* [Receiving webhook](../developer-tools/webhooks.md) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](../core-concepts/overview.md) If you have any questions or want to report an issue, email us at [support@seam.co](mailto:support@seam.co). diff --git a/docs/guides/device-guides/google-nest-thermostats/README.md b/docs/guides/device-guides/google-nest-thermostats/README.md index 57d853591..08d458098 100644 --- a/docs/guides/device-guides/google-nest-thermostats/README.md +++ b/docs/guides/device-guides/google-nest-thermostats/README.md @@ -24,7 +24,7 @@ For detailed information about the Google Nest devices that Seam supports, see o We support the following features: -* [Configuring current thermostat settings](../../products/thermostats/configure-current-climate-settings.md) +* [Configuring current thermostat settings](../../capability-guides/thermostats/configure-current-climate-settings.md) * [Creating and managing climate presets](../../capability-guides/thermostats/creating-and-managing-climate-presets/) * [Creating and managing thermostat schedules](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) * [Creating and managing thermostat weekly programs](../../capability-guides/thermostats/creating-and-managing-thermostat-programs.md) @@ -70,7 +70,7 @@ Once you have set up Google Device Access, prompt the owners of these Google Nes ## Brand-Specific Features -Google Nest thermostats support an eco HVAC mode. To set a Google Nest thermostat to eco mode, use the [`/thermostats/set_hvac_mode`](https://docs.seam.co/latest/api/thermostats/set_hvac_mode) endpoint. For details, see [HVAC Mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) and [Setting the Current HVAC and Fan Mode Settings](../../products/thermostats/configure-current-climate-settings.md). +Google Nest thermostats support an eco HVAC mode. To set a Google Nest thermostat to eco mode, use the [`/thermostats/set_hvac_mode`](https://docs.seam.co/latest/api/thermostats/set_hvac_mode) endpoint. For details, see [HVAC Mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) and [Setting the Current HVAC and Fan Mode Settings](../../capability-guides/thermostats/configure-current-climate-settings.md). *** diff --git a/docs/guides/device-guides/hubitat-elevation-hub.md b/docs/guides/device-guides/hubitat-elevation-hub.md index a58d6a1e8..c8f205aa5 100644 --- a/docs/guides/device-guides/hubitat-elevation-hub.md +++ b/docs/guides/device-guides/hubitat-elevation-hub.md @@ -16,8 +16,8 @@ For detailed information about the Hubitat-connected devices that Seam supports, We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) for devices with this capability -* [Programming access codes](../products/smart-locks/access-codes/) on devices with this capability +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) for devices with this capability +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on devices with this capability *** diff --git a/docs/guides/device-guides/igloohome-locks.md b/docs/guides/device-guides/igloohome-locks.md index f6fa21605..52005e6f9 100644 --- a/docs/guides/device-guides/igloohome-locks.md +++ b/docs/guides/device-guides/igloohome-locks.md @@ -32,9 +32,9 @@ Each igloohome Bridge supports up to five compatible igloohome locks. We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) for igloohome smart locks connected through the igloohome Bridge -* [Programming online access codes](../products/smart-locks/access-codes/) -* [Programming offline access codes](../products/smart-locks/access-codes/offline-access-codes.md) +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) for igloohome smart locks connected through the igloohome Bridge +* [Programming online access codes](../capability-guides/smart-locks/access-codes/) +* [Programming offline access codes](../capability-guides/smart-locks/access-codes/offline-access-codes.md) {% hint style="info" %} We support customizable access codes for igloohome locks connected through the igloohome Bridge. We support offline algoPIN codes for all igloohome locks, without the need for a bridge. diff --git a/docs/guides/device-guides/kwikset-locks.md b/docs/guides/device-guides/kwikset-locks.md index 123141a11..9a3599c8f 100644 --- a/docs/guides/device-guides/kwikset-locks.md +++ b/docs/guides/device-guides/kwikset-locks.md @@ -22,11 +22,11 @@ For detailed information about the Kwikset devices that Seam supports, see our [ We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../products/smart-locks/access-codes/) +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../capability-guides/smart-locks/access-codes/) {% hint style="info" %} -Seam does not support [unmanaged access codes](../products/smart-locks/access-codes/migrating-existing-access-codes.md) for Kwikset. +Seam does not support [unmanaged access codes](../capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md) for Kwikset. {% endhint %} *** diff --git a/docs/guides/device-guides/minut-sensors.md b/docs/guides/device-guides/minut-sensors.md index 4daf324d3..672e53174 100644 --- a/docs/guides/device-guides/minut-sensors.md +++ b/docs/guides/device-guides/minut-sensors.md @@ -22,7 +22,7 @@ For detailed information about the Minut devices that Seam supports, see our [Mi We support the following features: -* [Configuring noise threshold settings](../products/noise-sensors/configure-noise-threshold-settings.md)\ +* [Configuring noise threshold settings](../capability-guides/noise-sensors/configure-noise-threshold-settings.md)\ You can configure a maximum of two noise thresholds per Minut sensor. The first threshold is required and represents the regular threshold for the whole day. The second threshold is optional and represents the threshold for the quiet hours timeframe. * [Receiving noise sensor events when noise events occur](https://docs.seam.co/latest/api/events/)\ For more information, see the [`noise_sensor.noise_threshold_triggered` event](https://docs.seam.co/latest/api/events/). diff --git a/docs/guides/device-guides/noiseaware-sensors.md b/docs/guides/device-guides/noiseaware-sensors.md index b037f14f2..ecbeb7153 100644 --- a/docs/guides/device-guides/noiseaware-sensors.md +++ b/docs/guides/device-guides/noiseaware-sensors.md @@ -22,7 +22,7 @@ For detailed information about the NoiseAware devices that Seam supports, see ou We support the following features: -* [Configuring noise threshold settings](../products/noise-sensors/configure-noise-threshold-settings.md)\ +* [Configuring noise threshold settings](../capability-guides/noise-sensors/configure-noise-threshold-settings.md)\ You can configure a maximum of one noise threshold per hour per Noiseaware sensor. You cannot configure thresholds with time periods that overlap. * [Receiving noise sensor events when noise events occur](https://docs.seam.co/latest/api/events/)\ For more information, see the [`noise_sensor.noise_threshold_triggered` event](https://docs.seam.co/latest/api/events/). diff --git a/docs/guides/device-guides/nuki-locks.md b/docs/guides/device-guides/nuki-locks.md index 05e76e7f5..d72921885 100644 --- a/docs/guides/device-guides/nuki-locks.md +++ b/docs/guides/device-guides/nuki-locks.md @@ -34,8 +34,8 @@ For detailed information about the Nuki devices that Seam supports, see our [Nuk We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../products/smart-locks/access-codes/) on locks and openers that have an installed Nuki Keypad +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on locks and openers that have an installed Nuki Keypad {% hint style="info" %} Nuki does not allow the use of zeros in PIN codes. diff --git a/docs/guides/device-guides/pti-storlogix-cloud.md b/docs/guides/device-guides/pti-storlogix-cloud.md index 4a49ee661..c176c40dc 100644 --- a/docs/guides/device-guides/pti-storlogix-cloud.md +++ b/docs/guides/device-guides/pti-storlogix-cloud.md @@ -6,7 +6,7 @@ description: Guide for using the PTI Storlogix Cloud with Seam ## Overview -This integration uses [Storlogix Cloud](https://ptisecurity.com/products/storlogixcloudplatform/) to create [users](../products/access-systems/#what-is-a-user), [generate PIN codes](../capability-guides/access-systems/managing-credentials.md#create-a-pin-code-based-credential), and [grant users access](../products/access-systems/#what-is-an-access-group) to different access areas within storage rental unit facilities. +This integration uses [Storlogix Cloud](https://ptisecurity.com/products/storlogixcloudplatform/) to create [users](../capability-guides/access-systems/#what-is-a-user), [generate PIN codes](../capability-guides/access-systems/managing-credentials.md#create-a-pin-code-based-credential), and [grant users access](../capability-guides/access-systems/#what-is-an-access-group) to different access areas within storage rental unit facilities. *** @@ -22,9 +22,9 @@ For detailed information about the PTI devices that Seam supports, see our [PTI We support the following features: -* [**User Management**](../products/access-systems/user-management.md) +* [**User Management**](../capability-guides/access-systems/user-management.md) - You can administer individual [users](../products/access-systems/#what-is-a-user) and add them to [access groups](../products/access-systems/#what-is-an-access-group) as needed. + You can administer individual [users](../capability-guides/access-systems/#what-is-a-user) and add them to [access groups](../capability-guides/access-systems/#what-is-an-access-group) as needed. To authorize a user, [add the user to a `pti_access_level` access group](../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). If you wish to document that a user has rented a specific unit, include them in a `pti_unit` access group using the same endpoint. Note that certain access levels mandate a user be part of a `pti_unit` linked to that access area before they can enter those zones. * [**Manage ACS Credentials**](../capability-guides/access-systems/managing-credentials.md) @@ -79,7 +79,7 @@ The PIN code value must be an integer in the range 1-4294967296. ## Assigning Access Permissions to Users -For PTI Storlogix Cloud, you must add the [users](../products/access-systems/#what-is-a-user) to `pti_access_level` and `pti_unit` [access groups](../products/access-systems/#what-is-an-access-group) to give them access to their storage unit. +For PTI Storlogix Cloud, you must add the [users](../capability-guides/access-systems/#what-is-a-user) to `pti_access_level` and `pti_unit` [access groups](../capability-guides/access-systems/#what-is-an-access-group) to give them access to their storage unit. For example, you could assign them to the "Building A - 3/F" access level and give them access to the "A301" unit. For details, see [Assigning Users to Access Groups](../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). diff --git a/docs/guides/device-guides/salto-locks.md b/docs/guides/device-guides/salto-locks.md index 92c036db9..9549c35ef 100644 --- a/docs/guides/device-guides/salto-locks.md +++ b/docs/guides/device-guides/salto-locks.md @@ -29,7 +29,7 @@ For detailed information about the Salto devices that Seam supports, see our [Sa We support the following features: * [Triggering web unlock actions](https://docs.seam.co/latest/api/locks/unlock_door) -* [Programming access codes](../products/smart-locks/access-codes/) on door locks and card readers that have a PIN pad +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on door locks and card readers that have a PIN pad *** diff --git a/docs/guides/device-guides/test.md b/docs/guides/device-guides/test.md index ed0d5e302..ba8c67be9 100644 --- a/docs/guides/device-guides/test.md +++ b/docs/guides/device-guides/test.md @@ -76,8 +76,8 @@ Working Seam supported device table copied from above in Markdown file, pasted i We support the following features: -- [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) -- [Programming access codes](../products/smart-locks/access-codes/) on locks that have an installed August Smart Keypad +- [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) +- [Programming access codes](../capability-guides/smart-locks/access-codes/) on locks that have an installed August Smart Keypad --- diff --git a/docs/guides/device-guides/ttlock-locks.md b/docs/guides/device-guides/ttlock-locks.md index fb6275a7f..980eef271 100644 --- a/docs/guides/device-guides/ttlock-locks.md +++ b/docs/guides/device-guides/ttlock-locks.md @@ -18,8 +18,8 @@ For detailed information about the TTLock devices that Seam supports, see our [T We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../products/smart-locks/access-codes/) on door locks and card readers that have a PIN pad +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on door locks and card readers that have a PIN pad *** diff --git a/docs/guides/device-guides/wyze-locks.md b/docs/guides/device-guides/wyze-locks.md index 502fbe26e..761227199 100644 --- a/docs/guides/device-guides/wyze-locks.md +++ b/docs/guides/device-guides/wyze-locks.md @@ -30,8 +30,8 @@ For detailed information about the Wyze devices that Seam supports, see our [Wyz We support the following features: -* [Triggering web lock and unlock actions](../products/smart-locks/lock-and-unlock.md) -* [Programming access codes](../products/smart-locks/access-codes/) on locks that have an installed Wyze Lock Keypad +* [Triggering web lock and unlock actions](../capability-guides/smart-locks/lock-and-unlock.md) +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on locks that have an installed Wyze Lock Keypad {% hint style="info" %} The Seam platform cannot determine the PIN codes for access codes that were created outside of the Seam platform. diff --git a/docs/guides/device-guides/yale-locks.md b/docs/guides/device-guides/yale-locks.md index c1568e426..dd7c4c163 100644 --- a/docs/guides/device-guides/yale-locks.md +++ b/docs/guides/device-guides/yale-locks.md @@ -37,7 +37,7 @@ For detailed information about the Yale devices that Seam supports, see our [Yal We support the following features: * [Triggering web unlock actions](https://docs.seam.co/latest/api/locks/unlock_door) -* [Programming access codes](../products/smart-locks/access-codes/) on door locks that have a keypad +* [Programming access codes](../capability-guides/smart-locks/access-codes/) on door locks that have a keypad *** diff --git a/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md b/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md index 47c876e9e..6bbf62bff 100644 --- a/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md +++ b/docs/guides/industry-guides/hospitality-industry-guide/seam-api-overview.md @@ -10,7 +10,7 @@ If you want the easiest, most efficient way to grant access, use the [Access Gra This unified approach means that you can build access workflows once and rely on them to work everywhere. -If you need more granular control, the Seam API provides lower-level API resources and endpoints as well. In this case, use the Seam [access control system](../../products/access-systems/) (ACS) API. +If you need more granular control, the Seam API provides lower-level API resources and endpoints as well. In this case, use the Seam [access control system](../../capability-guides/access-systems/) (ACS) API. *** diff --git a/docs/guides/quickstart.md b/docs/guides/quickstart.md index 78948214a..bd761fd4e 100644 --- a/docs/guides/quickstart.md +++ b/docs/guides/quickstart.md @@ -361,4 +361,4 @@ If you are creating an app to control your users' devices, see [Connect Webviews Seam supports many device categories. Each device can be broken down into [device capabilities](capability-guides/device-and-system-capabilities.md). A capability indicates what the device can do, what properties it has, and what events it emits. To learn more about specific capabilities, such as access codes or thermostats, see the following guides: -
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
+
Door Locks APIGet started →smart-locks-16-9.pngsmart-locks
Thermostats APIGet started →thermostats
Noise Sensors APIGet started →sensors-16-9.pngnoise-sensors
Access Control Systems APIGet started →acs-cover.pngaccess-systems
diff --git a/docs/guides/ui-components/seam-mobile-components/seam-mobile-components-for-ios/README.md b/docs/guides/ui-components/seam-mobile-components/seam-mobile-components-for-ios/README.md index 391a988d1..e606ca906 100644 --- a/docs/guides/ui-components/seam-mobile-components/seam-mobile-components-for-ios/README.md +++ b/docs/guides/ui-components/seam-mobile-components/seam-mobile-components-for-ios/README.md @@ -12,7 +12,7 @@ description: >- * Xcode 15+ * iOS 16+ target -You should already have a Seam workspace and API key set up. If you’re new to Seam, start with the [Seam Mobile SDK](https://docs.seam.co/latest/mobile/ios/quickstart). +You should already have a Seam workspace and API key set up. If you’re new to Seam, start with the [Seam Mobile SDK](https://docs.seam.co/latest/developer-tools/mobile-sdks/ios-sdk). *** @@ -92,4 +92,4 @@ By default, components are styled with Seam’s design system, but theming lets ### See Also -* Explore [Seam Mobile SDK](https://docs.seam.co/latest/mobile/ios/quickstart) +* Explore [Seam Mobile SDK](https://docs.seam.co/latest/developer-tools/mobile-sdks/ios-sdk)