@seamapi/types 1.457.0 → 1.458.0

package/lib/seam/devicedb/route-specs.d.ts

@@ -212,7 +212,6 @@ export declare const routes: {
             }, "strip", z.ZodTypeAny, {
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -241,11 +240,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -272,7 +272,6 @@ export declare const routes: {
             }, {
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -301,11 +300,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -336,12 +336,12 @@ export declare const routes: {
                     has_physical_key: z.ZodBoolean;
                     has_camera: z.ZodBoolean;
                 }, "strip", z.ZodTypeAny, {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 }, {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 }>;
                 software_features: z.ZodObject<{
@@ -372,8 +372,8 @@ export declare const routes: {
             }, "can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes">, "strip", z.ZodTypeAny, {
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {
@@ -389,8 +389,8 @@ export declare const routes: {
             }, {
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {
@@ -595,7 +595,6 @@ export declare const routes: {
             device_model: {
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -624,11 +623,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -655,8 +655,8 @@ export declare const routes: {
             } & ({
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {
@@ -718,7 +718,6 @@ export declare const routes: {
             device_model: {
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -747,11 +746,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -778,8 +778,8 @@ export declare const routes: {
             } & ({
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {
@@ -853,23 +853,23 @@ export declare const routes: {
             include_if: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
             exclude_if: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         }, "strip", z.ZodTypeAny, {
+            include_if?: string[] | undefined;
+            exclude_if?: string[] | undefined;
             manufacturer_id?: string | undefined;
-            main_category?: "relay" | "thermostat" | "smartlock" | "sensor" | "intercom" | "accessory" | undefined;
+            main_category?: "relay" | "thermostat" | "sensor" | "smartlock" | "intercom" | "accessory" | undefined;
             manufacturer_ids?: string[] | undefined;
             integration_status?: "beta" | "stable" | "planned" | "unsupported" | "inquire" | undefined;
             integration_support_levels?: ("beta" | "stable" | "planned" | "unsupported" | "inquire")[] | undefined;
             text_search?: string | undefined;
+        }, {
             include_if?: string[] | undefined;
             exclude_if?: string[] | undefined;
-        }, {
             manufacturer_id?: string | undefined;
-            main_category?: "relay" | "thermostat" | "smartlock" | "sensor" | "intercom" | "accessory" | undefined;
+            main_category?: "relay" | "thermostat" | "sensor" | "smartlock" | "intercom" | "accessory" | undefined;
             manufacturer_ids?: string[] | undefined;
             integration_status?: "beta" | "stable" | "planned" | "unsupported" | "inquire" | undefined;
             integration_support_levels?: ("beta" | "stable" | "planned" | "unsupported" | "inquire")[] | undefined;
             text_search?: string | undefined;
-            include_if?: string[] | undefined;
-            exclude_if?: string[] | undefined;
         }>;
         readonly jsonResponse: z.ZodObject<{
             device_models: z.ZodArray<z.ZodIntersection<z.ZodObject<{
@@ -1073,7 +1073,6 @@ export declare const routes: {
             }, "strip", z.ZodTypeAny, {
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1102,11 +1101,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1133,7 +1133,6 @@ export declare const routes: {
             }, {
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1162,11 +1161,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1197,12 +1197,12 @@ export declare const routes: {
                     has_physical_key: z.ZodBoolean;
                     has_camera: z.ZodBoolean;
                 }, "strip", z.ZodTypeAny, {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 }, {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 }>;
                 software_features: z.ZodObject<{
@@ -1233,8 +1233,8 @@ export declare const routes: {
             }, "can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes">, "strip", z.ZodTypeAny, {
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {
@@ -1250,8 +1250,8 @@ export declare const routes: {
             }, {
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {
@@ -1456,7 +1456,6 @@ export declare const routes: {
             device_models: ({
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1485,11 +1484,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1516,8 +1516,8 @@ export declare const routes: {
             } & ({
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {
@@ -1579,7 +1579,6 @@ export declare const routes: {
             device_models: ({
                 description: string;
                 display_name: string;
-                device_model_id: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1608,11 +1607,12 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                is_device_supported: boolean;
-                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
+                device_model_id: string;
+                is_device_supported: boolean;
+                main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1639,8 +1639,8 @@ export declare const routes: {
             } & ({
                 main_category: "smartlock";
                 physical_properties: {
-                    has_physical_key: boolean;
                     lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
+                    has_physical_key: boolean;
                     has_camera: boolean;
                 };
                 software_features: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.457.0",
+  "version": "1.458.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/acs/metadata/salto-space.ts

@@ -2,17 +2,26 @@ import { z } from 'zod'
 
 export const acs_entrance_salto_space_metadata = z
   .object({
+    ext_door_id: z.string().describe(`
+    ---
+    deprecated: use door_id.
+    ---
+    `),
+    door_id: z.string().describe('Door ID in the Salto Space access system.'),
     door_name: z
       .string()
       .describe('Name of the door in the Salto Space access system.'),
-    ext_door_id: z
-      .string()
-      .describe('External door ID in the Salto Space access system.'),
     door_description: z
       .string()
-      .optional()
       .describe('Description of the door in the Salto Space access system.'),
+    room_name: z
+      .string()
+      .describe('Name of the room in the Salto Space access system.'),
+    room_description: z
+      .string()
+      .describe('Description of the room in the Salto Space access system.'),
   })
+  .partial()
   .describe('Salto Space-specific metadata associated with the entrance.')
 
 export type AcsEntranceSaltoSpaceMetadata = z.infer<

package/src/lib/seam/connect/models/devices/device.ts

@@ -1,7 +1,5 @@
 import { z } from 'zod'
 
-import { schemas as devicedb_schemas } from '@seamapi/types/devicedb'
-
 import { connected_account_error } from '../connected-accounts/index.js'
 import { custom_metadata } from '../custom-metadata.js'
 import { capabilities } from './capabilities-supported.js'
@@ -10,13 +8,22 @@ import { device_metadata } from './device-metadata.js'
 import { any_device_type } from './device-type.js'
 import { phone_specific_properties } from './phone-properties.js'
 
-export const device_capability_flags =
-  devicedb_schemas.device_capability_flags.extend({
-    can_simulate_removal: z.boolean().optional(),
-    can_simulate_connection: z.boolean().optional(),
-    can_simulate_disconnection: z.boolean().optional(),
-    can_unlock_with_code: z.boolean().optional(),
+export const device_capability_flags = z
+  .object({
+    can_remotely_unlock: z.boolean(),
+    can_remotely_lock: z.boolean(),
+    can_program_offline_access_codes: z.boolean(),
+    can_program_online_access_codes: z.boolean(),
+    can_hvac_heat: z.boolean(),
+    can_hvac_cool: z.boolean(),
+    can_hvac_heat_cool: z.boolean(),
+    can_turn_off_hvac: z.boolean(),
+    can_simulate_removal: z.boolean(),
+    can_simulate_connection: z.boolean(),
+    can_simulate_disconnection: z.boolean(),
+    can_unlock_with_code: z.boolean(),
   })
+  .partial()
 
 export const battery_status = z.enum(['critical', 'low', 'good', 'full'])
   .describe(`Represents the current status of the battery charge level. Values are \`critical\`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; \`low\`, which signifies that the battery is under the preferred threshold and should be charged soon; \`good\`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and \`full\`, which represents a battery that is fully charged, providing the maximum duration of usage.

package/src/lib/seam/connect/openapi.ts

@@ -2892,18 +2892,31 @@ export default {
                   'Description of the door in the Salto Space access system.',
                 type: 'string',
               },
+              door_id: {
+                description: 'Door ID in the Salto Space access system.',
+                type: 'string',
+              },
               door_name: {
                 description:
                   'Name of the door in the Salto Space access system.',
                 type: 'string',
               },
               ext_door_id: {
+                deprecated: true,
+                type: 'string',
+                'x-deprecated': 'use door_id.',
+              },
+              room_description: {
+                description:
+                  'Description of the room in the Salto Space access system.',
+                type: 'string',
+              },
+              room_name: {
                 description:
-                  'External door ID in the Salto Space access system.',
+                  'Name of the room in the Salto Space access system.',
                 type: 'string',
               },
             },
-            required: ['door_name', 'ext_door_id'],
             type: 'object',
           },
           visionline_metadata: {
@@ -19505,18 +19518,32 @@ export default {
                                     'Description of the door in the Salto Space access system.',
                                   type: 'string',
                                 },
+                                door_id: {
+                                  description:
+                                    'Door ID in the Salto Space access system.',
+                                  type: 'string',
+                                },
                                 door_name: {
                                   description:
                                     'Name of the door in the Salto Space access system.',
                                   type: 'string',
                                 },
                                 ext_door_id: {
+                                  deprecated: true,
+                                  type: 'string',
+                                  'x-deprecated': 'use door_id.',
+                                },
+                                room_description: {
+                                  description:
+                                    'Description of the room in the Salto Space access system.',
+                                  type: 'string',
+                                },
+                                room_name: {
                                   description:
-                                    'External door ID in the Salto Space access system.',
+                                    'Name of the room in the Salto Space access system.',
                                   type: 'string',
                                 },
                               },
-                              required: ['door_name', 'ext_door_id'],
                               type: 'object',
                             },
                             visionline_metadata: {
@@ -40355,7 +40382,7 @@ export default {
     '/devices/simulate/connect_to_hub': {
       post: {
         description:
-          'Simulates bringing the Wi-Fi hub (bridge) back online for a device.  \nOnly applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) and August locks today, but designed so we can extend to other providers later.  \nThis will clear the `hub_disconnected` error on the device.',
+          'Simulates bringing the Wi‑Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.',
         operationId: 'devicesSimulateConnectToHubPost',
         requestBody: {
           content: {