@seamapi/types 1.103.0 → 1.105.0

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

@@ -82,6 +82,13 @@ export declare const routes: {
                 description: z.ZodString;
                 product_url: z.ZodOptional<z.ZodString>;
                 main_connection_type: z.ZodEnum<["wifi", "zwave", "zigbee", "unknown"]>;
+                hardware: z.ZodObject<{
+                    has_physical_key: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    has_physical_key?: boolean | undefined;
+                }, {
+                    has_physical_key?: boolean | undefined;
+                }>;
                 aesthetic_variants: z.ZodArray<z.ZodObject<{
                     slug: z.ZodString;
                     display_name: z.ZodString;
@@ -191,6 +198,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -237,6 +247,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -291,6 +304,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 }>;
+                can_remotely_unlock: z.ZodOptional<z.ZodLiteral<true>>;
+                can_program_online_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
             }, "strip", z.ZodTypeAny, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -304,6 +319,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -317,6 +334,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }>, z.ZodObject<{
                 main_category: z.ZodLiteral<"sensor">;
                 physical_properties: z.ZodObject<{
@@ -512,6 +531,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -548,6 +570,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }) | ({
                 description: string;
                 display_name: string;
@@ -571,6 +595,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -625,6 +652,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -685,6 +715,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -733,6 +766,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -793,6 +829,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -843,6 +882,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -879,6 +921,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }) | ({
                 description: string;
                 display_name: string;
@@ -902,6 +946,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -956,6 +1003,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1016,6 +1066,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1064,6 +1117,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1124,6 +1180,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1256,6 +1315,13 @@ export declare const routes: {
                 description: z.ZodString;
                 product_url: z.ZodOptional<z.ZodString>;
                 main_connection_type: z.ZodEnum<["wifi", "zwave", "zigbee", "unknown"]>;
+                hardware: z.ZodObject<{
+                    has_physical_key: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    has_physical_key?: boolean | undefined;
+                }, {
+                    has_physical_key?: boolean | undefined;
+                }>;
                 aesthetic_variants: z.ZodArray<z.ZodObject<{
                     slug: z.ZodString;
                     display_name: z.ZodString;
@@ -1365,6 +1431,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1411,6 +1480,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1465,6 +1537,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 }>;
+                can_remotely_unlock: z.ZodOptional<z.ZodLiteral<true>>;
+                can_program_online_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
             }, "strip", z.ZodTypeAny, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -1478,6 +1552,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -1491,6 +1567,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }>, z.ZodObject<{
                 main_category: z.ZodLiteral<"sensor">;
                 physical_properties: z.ZodObject<{
@@ -1686,6 +1764,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1722,6 +1803,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             } | {
                 main_category: "sensor";
                 physical_properties: {
@@ -1787,6 +1870,9 @@ export declare const routes: {
                 };
                 is_device_supported: boolean;
                 main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: {
                     display_name: string;
                     slug: string;
@@ -1823,6 +1909,8 @@ export declare const routes: {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             } | {
                 main_category: "sensor";
                 physical_properties: {

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

@@ -33,6 +33,9 @@ export interface Routes {
                 description: string;
                 product_url?: string | undefined;
                 main_connection_type: 'wifi' | 'zwave' | 'zigbee' | 'unknown';
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: Array<{
                     slug: string;
                     display_name: string;
@@ -68,6 +71,8 @@ export interface Routes {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             } | {
                 main_category: 'sensor';
                 physical_properties: {
@@ -152,6 +157,9 @@ export interface Routes {
                 description: string;
                 product_url?: string | undefined;
                 main_connection_type: 'wifi' | 'zwave' | 'zigbee' | 'unknown';
+                hardware: {
+                    has_physical_key?: boolean | undefined;
+                };
                 aesthetic_variants: Array<{
                     slug: string;
                     display_name: string;
@@ -187,6 +195,8 @@ export interface Routes {
                     can_program_access_schedules: boolean;
                     can_program_access_codes_offline: boolean;
                 };
+                can_remotely_unlock?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             } | {
                 main_category: 'sensor';
                 physical_properties: {

package/package.json

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

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

@@ -3903,6 +3903,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -4000,6 +4008,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -4134,6 +4150,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -4276,6 +4300,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -4402,6 +4434,14 @@ export default {
                           starts_at: { type: 'string' },
                           visionline_metadata: {
                             properties: {
+                              common_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                              guest_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
                               joiner_acs_credential_ids: {
                                 items: { format: 'uuid', type: 'string' },
                                 type: 'array',
@@ -4505,6 +4545,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -4602,6 +4650,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -4702,6 +4758,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -4799,6 +4863,14 @@ export default {
                         starts_at: { type: 'string' },
                         visionline_metadata: {
                           properties: {
+                            common_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
+                            guest_acs_entrance_ids: {
+                              items: { format: 'uuid', type: 'string' },
+                              type: 'array',
+                            },
                             joiner_acs_credential_ids: {
                               items: { format: 'uuid', type: 'string' },
                               type: 'array',
@@ -5132,6 +5204,14 @@ export default {
                           starts_at: { type: 'string' },
                           visionline_metadata: {
                             properties: {
+                              common_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
+                              guest_acs_entrance_ids: {
+                                items: { format: 'uuid', type: 'string' },
+                                type: 'array',
+                              },
                               joiner_acs_credential_ids: {
                                 items: { format: 'uuid', type: 'string' },
                                 type: 'array',

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

@@ -854,6 +854,8 @@ export interface Routes {
         visionline_metadata?:
           | {
               joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
             }
           | undefined
       }
@@ -918,6 +920,8 @@ export interface Routes {
         visionline_metadata?:
           | {
               joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
             }
           | undefined
       }
@@ -970,6 +974,8 @@ export interface Routes {
         visionline_metadata?:
           | {
               joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
             }
           | undefined
       }
@@ -1022,6 +1028,8 @@ export interface Routes {
         visionline_metadata?:
           | {
               joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
             }
           | undefined
       }>
@@ -1064,6 +1072,8 @@ export interface Routes {
         visionline_metadata?:
           | {
               joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
             }
           | undefined
       }
@@ -1106,6 +1116,8 @@ export interface Routes {
         visionline_metadata?:
           | {
               joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
             }
           | undefined
       }
@@ -1215,6 +1227,8 @@ export interface Routes {
         visionline_metadata?:
           | {
               joiner_acs_credential_ids?: string[] | undefined
+              guest_acs_entrance_ids?: string[] | undefined
+              common_acs_entrance_ids?: string[] | undefined
             }
           | undefined
       }>

package/src/lib/seam/connect/unstable/models/acs/credential.ts

@@ -20,6 +20,8 @@ export type AcsCredentialExternalType = z.infer<
 
 export const acs_credential_visionline_metadata = z.object({
   joiner_acs_credential_ids: z.array(z.string().uuid()).optional(),
+  guest_acs_entrance_ids: z.array(z.string().uuid()).optional(),
+  common_acs_entrance_ids: z.array(z.string().uuid()).optional(),
 })
 
 export type AcsCredentialVisionlineMetadata = z.infer<

package/src/lib/seam/devicedb/public-models/device-capability.ts

@@ -0,0 +1,20 @@
+import { z, type ZodLiteral } from 'zod'
+
+export const device_capability_flags = z
+  .object({
+    can_remotely_unlock: z.boolean(),
+    can_program_online_access_codes: z.boolean(),
+  })
+  .partial()
+
+const device_model_capability_flags_map: Record<
+  keyof z.infer<typeof device_capability_flags>,
+  ZodLiteral<true>
+> = {
+  can_remotely_unlock: z.literal(true),
+  can_program_online_access_codes: z.literal(true),
+}
+
+export const device_model_capability_flags = z
+  .object(device_model_capability_flags_map)
+  .partial()

package/src/lib/seam/devicedb/public-models/device-model-v1.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { device_model_capability_flags } from './device-capability.js'
+import { hardware } from './hardware.js'
 import { image_reference } from './image-reference.js'
 import { manufacturer } from './manufacturer.js'
 
@@ -23,29 +25,36 @@ export const device_connection_type = z.enum([
 
 export type DeviceConnectionType = z.infer<typeof device_connection_type>
 
-const smartlock = z.object({
-  main_category: z.literal(device_category.enum.smartlock),
-  physical_properties: z.object({
-    lock_type: z.enum([
-      'deadbolt',
-      'lever',
-      'mortise',
-      'lockbox',
-      'cylinder',
-      'padlock',
-      'locker',
-      'unknown',
-    ]),
-    has_physical_key: z.boolean(),
-    has_camera: z.boolean(),
-  }),
-  software_features: z.object({
-    can_remotely_unlock: z.boolean(),
-    can_program_access_codes: z.boolean(),
-    can_program_access_schedules: z.boolean(),
-    can_program_access_codes_offline: z.boolean(),
-  }),
-})
+const smartlock = z
+  .object({
+    main_category: z.literal(device_category.enum.smartlock),
+    physical_properties: z.object({
+      lock_type: z.enum([
+        'deadbolt',
+        'lever',
+        'mortise',
+        'lockbox',
+        'cylinder',
+        'padlock',
+        'locker',
+        'unknown',
+      ]),
+      has_physical_key: z.boolean(),
+      has_camera: z.boolean(),
+    }),
+    software_features: z.object({
+      can_remotely_unlock: z.boolean(),
+      can_program_access_codes: z.boolean(),
+      can_program_access_schedules: z.boolean(),
+      can_program_access_codes_offline: z.boolean(),
+    }),
+  })
+  .merge(
+    device_model_capability_flags.pick({
+      can_remotely_unlock: true,
+      can_program_online_access_codes: true,
+    }),
+  )
 
 const sensor = z.object({
   main_category: z.literal(device_category.enum.sensor),
@@ -114,6 +123,7 @@ export const base_device_model_v1 = z.object({
   description: z.string(),
   product_url: z.string().optional(),
   main_connection_type: device_connection_type,
+  hardware,
   aesthetic_variants: z
     .object({
       slug: z.string(),

package/src/lib/seam/devicedb/public-models/hardware.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod'
+
+export const hardware = z
+  .object({
+    has_physical_key: z.boolean(),
+  })
+  .partial()

package/src/lib/seam/devicedb/public-models/index.ts

@@ -1,3 +1,4 @@
+export { device_capability_flags } from './device-capability.js'
 export * from './device-model-v0.js'
 export * from './device-model-v1.js'
 export * from './image-reference.js'