@seamapi/types 1.56.1 → 1.57.0

package/src/lib/seam/connect/route-types.ts

@@ -1769,10 +1769,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -2503,10 +2511,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -3149,10 +3165,14 @@ export interface Routes {
           | ('ecobee_thermostat' | 'nest_thermostat')
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Unique identifier for the Seam workspace associated with the device. */
         workspace_id: string
         /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
@@ -3341,10 +3361,14 @@ export interface Routes {
           | ('ecobee_thermostat' | 'nest_thermostat')
         /** Unique identifier for the account associated with the device. */
         connected_account_id: string
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Unique identifier for the Seam workspace associated with the device. */
         workspace_id: string
         /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
@@ -3678,10 +3702,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -4291,10 +4323,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -5025,10 +5065,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -5638,10 +5686,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -6696,10 +6752,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -7460,10 +7524,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */
@@ -8224,10 +8296,18 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
-        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        /** Deprecated. Use enabled_capabilities. */
         capabilities_supported: Array<
           'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
         >
+        /** Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        enabled_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
+        /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
+        supported_capabilities: Array<
+          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+        >
         /** Properties of the device. */
         properties: ({
           /** Indicates whether the device is online. */

package/src/lib/seam/connect/unstable/models/devices/managed-device.ts

@@ -95,7 +95,16 @@ export const common_device_properties = z.object({
 export const managed_device = z.object({
   device_id: z.string().uuid().describe('Unique identifier for the device.'),
   device_type: any_device_type.describe('Type of the device.'),
+  /** @deprecated use enabled_capabilities for same behavior */
   capabilities_supported: z
+    .array(capabilities)
+    .describe('Deprecated. Use enabled_capabilities.'),
+  enabled_capabilities: z
+    .array(capabilities)
+    .describe(
+      'Collection of capabilities that the device has enabled, reflecting its present configuration. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
+    ),
+  supported_capabilities: z
     .array(capabilities)
     .describe(
       'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',

package/src/lib/seam/connect/unstable/models/devices/unmanaged-device.ts

@@ -8,6 +8,7 @@ export const unmanaged_device = managed_device
     device_type: true,
     connected_account_id: true,
     capabilities_supported: true,
+    enabled_capabilities: true,
     workspace_id: true,
     errors: true,
     warnings: true,