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 API | Get started → | smart-locks-16-9.png | smart-locks | |
| Thermostats API | Get started → | thermostats-cover.png | thermostats | |
| Noise Sensors API | Get started → | sensors-16-9.png | noise-sensors | |
| Access Control Systems API | Get started → | acs-cover.png | access-systems |
| Door Locks API | Get started → | smart-locks-16-9.png | smart-locks | |
| Thermostats API | Get started → | thermostats-cover.png | thermostats | |
| Noise Sensors API | Get started → | sensors-16-9.png | noise-sensors | |
| Access Control Systems API | Get started → | acs-cover.png | access-systems |
| ACS Resource | Description |
|---|---|
| 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. |
| 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. |
| 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. |
| 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. |
| 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 Resource | Description |
|---|---|
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |

Examples of ACS user credentials


Capability flags help you to understand why a device cannot currently perform an action.
| Property | Type | Description |
|---|---|---|
device.can_remotely_unlock | Boolean Optional | Indicates whether the device can perform a remote unlock operation. |
device.can_remotely_lock | Boolean Optional | Indicates whether the device can perform a remote lock operation. |
device.can_program_online_access_codes | Boolean 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_codes | Boolean 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_heat | Boolean 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_cool | Boolean 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_cool | Boolean 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_hvac | Boolean 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. |
| Property | Type | Description |
|---|---|---|
device.can_remotely_unlock | Boolean Optional | Indicates whether the device can perform a remote unlock operation. |
device.can_remotely_lock | Boolean Optional | Indicates whether the device can perform a remote lock operation. |
device.can_program_online_access_codes | Boolean 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_codes | Boolean 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_heat | Boolean 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_cool | Boolean 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_cool | Boolean 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_hvac | Boolean 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. |


Illustration of the polling verification step for an ongoing access code

Illustration of the webhook verification method for an ongoing access code

Life-cycle of a time-bound access code


| Property | Description |
|---|---|
climate_preset_key | (Required) Key to identify the climate preset. |
name | (Optional) User-friendly name to identify the climate preset. |
fan_mode_setting | Desired fan mode setting, such as on, auto, or circulate. |
hvac_mode_setting | Desired HVAC mode setting, such as heat, cool, heat_cool, or off. |
cooling_set_point_celsius | Temperature to which the thermostat should cool (in °C). See also Set Points. |
cooling_set_point_fahrenheit | Temperature to which the thermostat should cool (in °F). |
heating_set_point_celsius | Temperature to which the thermostat should heat (in °C). |
heating_set_point_fahrenheit | Temperature 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_edit | Indicates 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_delete | Indicates 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. |
| Property | Type | Description |
|---|---|---|
device_provider_name | String | Name of the device provider. For example: |
display_name | String | Formatted version of the For example: |
image_url | String | Image URL for the provider logo. |
provider_categories | Array | Array of associated categories for the provider. Supported categories:
|
can_remotely_unlock | Boolean | Indicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags. |
can_remotely_lock | Boolean | Indicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags. |
can_program_online_access_codes | Boolean | Indicates whether at least one supported device from the provider can program online access codes. See Capability Flags. |
can_program_offline_access_codes | Boolean | Indicates whether at least one supported device from the provider can program offline access codes. See Capability Flags. |
can_simulate_connection | Boolean | Indicates whether at least one supported device from the provider can simulate device connection. See Capability Flags. |
can_simulate_disconnection | Boolean | Indicates whether at least one supported device from the provider can simulate device disconnection. See Capability Flags. |
can_simulate_removal | Boolean | Indicates whether at least one supported device from the provider can simulate device removal. See Capability Flags. |
can_hvac_cool | Boolean | Indicates whether at least one supported device from the provider can be set to cool mode. See Capability Flags. |
can_hvac_heat | Boolean | Indicates whether at least one supported device from the provider can be set to heat mode. See Capability Flags. |
can_hvac_heat_cool | Boolean | Indicates whether at least one supported device from the provider can be set to heat-cool mode. See Capability Flags. |
can_turn_off_hvac | Boolean | Indicates whether at least one supported device from the provider can be set to off mode. See Capability Flags. |
| Property | Type | Description |
|---|---|---|
device_provider_name | String | Name of the device provider. For example: |
display_name | String | Formatted version of the For example: |
image_url | String | Image URL for the provider logo. |
provider_categories | Array | Array of associated categories for the provider. Supported categories:
|
can_remotely_unlock | Boolean | Indicates whether at least one supported device from the provider can perform a remote unlock operation. See Capability Flags. |
can_remotely_lock | Boolean | Indicates whether at least one supported device from the provider can perform a remote lock operation. See Capability Flags. |
can_program_online_access_codes | Boolean | Indicates whether at least one supported device from the provider can program online access codes. See Capability Flags. |
can_program_offline_access_codes | Boolean | Indicates whether at least one supported device from the provider can program offline access codes. See Capability Flags. |
can_simulate_connection | Boolean | Indicates whether at least one supported device from the provider can simulate device connection. See Capability Flags. |
can_simulate_disconnection | Boolean | Indicates whether at least one supported device from the provider can simulate device disconnection. See Capability Flags. |
can_simulate_removal | Boolean | Indicates whether at least one supported device from the provider can simulate device removal. See Capability Flags. |
can_hvac_cool | Boolean | Indicates whether at least one supported device from the provider can be set to cool mode. See Capability Flags. |
can_hvac_heat | Boolean | Indicates whether at least one supported device from the provider can be set to heat mode. See Capability Flags. |
can_hvac_heat_cool | Boolean | Indicates whether at least one supported device from the provider can be set to heat-cool mode. See Capability Flags. |
can_turn_off_hvac | Boolean | Indicates whether at least one supported device from the provider can be set to off mode. See Capability Flags. |
| Command Stub | Description |
|---|---|
seam | Access all Seam CLI commands in an interactive manner. |
seam access-codes | Manage access codes. |
seam acs | Manage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials. |
seam action-attempts | List and get action attempts to poll the status of attempted actions, such as unlock and create access code. |
seam client-sessions | Manage client sessions that enable you to restrict users' interactions to include only the devices that they own. |
seam connect-webviews | Manage Connect Webviews that enable users to connect their devices to Seam. |
seam connected-accounts | Manage connected accounts that represent external, third-party accounts to which users have authorized Seam to access. |
seam devices | Manage devices, including both "managed" and "unmanaged" devices. |
seam events | Retrieve events. |
seam locks | Retrieve, lock, and unlock smart locks. |
seam login | Log back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token. |
seam logout | Log out of the Seam CLI. |
seam noise-sensors | Manage noise thresholds for noise sensors and simulate triggering noise threshold alerts. |
seam select | Select the desired workspace or server. |
seam thermostats | Manage thermostats, including current climate settings. |
seam user-identities | Manage user identities that enable you to issue and manage mobile credentials and access permissions for users. |
seam webhooks | Manage webhook endpoints that enable you to receive notifications of Seam-related events. |
seam workspaces | Manage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces. |
| Command Stub | Description |
|---|---|
seam | Access all Seam CLI commands in an interactive manner. |
seam access-codes | Manage access codes. |
seam acs | Manage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials. |
seam action-attempts | List and get action attempts to poll the status of attempted actions, such as unlock and create access code. |
seam client-sessions | Manage client sessions that enable you to restrict users' interactions to include only the devices that they own. |
seam connect-webviews | Manage Connect Webviews that enable users to connect their devices to Seam. |
seam connected-accounts | Manage connected accounts that represent external, third-party accounts to which users have authorized Seam to access. |
seam devices | Manage devices, including both "managed" and "unmanaged" devices. |
seam events | Retrieve events. |
seam locks | Retrieve, lock, and unlock smart locks. |
seam login | Log back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token. |
seam logout | Log out of the Seam CLI. |
seam noise-sensors | Manage noise thresholds for noise sensors and simulate triggering noise threshold alerts. |
seam select | Select the desired workspace or server. |
seam thermostats | Manage thermostats, including current climate settings. |
seam user-identities | Manage user identities that enable you to issue and manage mobile credentials and access permissions for users. |
seam webhooks | Manage webhook endpoints that enable you to receive notifications of Seam-related events. |
seam workspaces | Manage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces. |
| Door Locks API | Get started → | smart-locks-16-9.png | smart-locks | |
| Thermostats API | Get started → | thermostats | ||
| Noise Sensors API | Get started → | sensors-16-9.png | noise-sensors | |
| Access Control Systems API | Get started → | acs-cover.png | access-systems |
| Door Locks API | Get started → | smart-locks-16-9.png | smart-locks | |
| Thermostats API | Get started → | thermostats | ||
| Noise Sensors API | Get started → | sensors-16-9.png | noise-sensors | |
| Access Control Systems API | Get started → | acs-cover.png | access-systems |