@seamapi/types 1.138.1 → 1.140.0

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

@@ -8,6 +8,13 @@ export declare const unmanaged_device: z.ZodObject<{
     properties: z.ZodObject<Pick<{
         online: z.ZodBoolean;
         name: z.ZodString;
+        accessory_keypad: z.ZodOptional<z.ZodObject<{
+            is_connected: z.ZodBoolean;
+        }, "strip", z.ZodTypeAny, {
+            is_connected: boolean;
+        }, {
+            is_connected: boolean;
+        }>>;
         appearance: z.ZodObject<{
             name: z.ZodString;
         }, "strip", z.ZodTypeAny, {
@@ -16,20 +23,26 @@ export declare const unmanaged_device: z.ZodObject<{
             name: string;
         }>;
         model: z.ZodObject<{
+            can_connect_accessory_keypad: z.ZodOptional<z.ZodBoolean>;
             display_name: z.ZodString;
             manufacturer_display_name: z.ZodString;
+            has_built_in_keypad: z.ZodOptional<z.ZodBoolean>;
             offline_access_codes_supported: z.ZodOptional<z.ZodBoolean>;
             online_access_codes_supported: z.ZodOptional<z.ZodBoolean>;
             accessory_keypad_supported: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
             display_name: string;
             manufacturer_display_name: string;
+            can_connect_accessory_keypad?: boolean | undefined;
+            has_built_in_keypad?: boolean | undefined;
             offline_access_codes_supported?: boolean | undefined;
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
         }, {
             display_name: string;
             manufacturer_display_name: string;
+            can_connect_accessory_keypad?: boolean | undefined;
+            has_built_in_keypad?: boolean | undefined;
             offline_access_codes_supported?: boolean | undefined;
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
@@ -60,6 +73,8 @@ export declare const unmanaged_device: z.ZodObject<{
         model: {
             display_name: string;
             manufacturer_display_name: string;
+            can_connect_accessory_keypad?: boolean | undefined;
+            has_built_in_keypad?: boolean | undefined;
             offline_access_codes_supported?: boolean | undefined;
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
@@ -80,6 +95,8 @@ export declare const unmanaged_device: z.ZodObject<{
         model: {
             display_name: string;
             manufacturer_display_name: string;
+            can_connect_accessory_keypad?: boolean | undefined;
+            has_built_in_keypad?: boolean | undefined;
             offline_access_codes_supported?: boolean | undefined;
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
@@ -133,6 +150,8 @@ export declare const unmanaged_device: z.ZodObject<{
         model: {
             display_name: string;
             manufacturer_display_name: string;
+            can_connect_accessory_keypad?: boolean | undefined;
+            has_built_in_keypad?: boolean | undefined;
             offline_access_codes_supported?: boolean | undefined;
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
@@ -174,6 +193,8 @@ export declare const unmanaged_device: z.ZodObject<{
         model: {
             display_name: string;
             manufacturer_display_name: string;
+            can_connect_accessory_keypad?: boolean | undefined;
+            has_built_in_keypad?: boolean | undefined;
             offline_access_codes_supported?: boolean | undefined;
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;

package/package.json

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

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

@@ -669,6 +669,19 @@ export default {
                     allOf: [
                       {
                         properties: {
+                          accessory_keypad: {
+                            description:
+                              'Represents the accessory keypad state.',
+                            properties: {
+                              is_connected: {
+                                description:
+                                  'Indicates if the accessory_keypad is connected to the device.',
+                                type: 'boolean',
+                              },
+                            },
+                            required: ['is_connected'],
+                            type: 'object',
+                          },
                           appearance: {
                             properties: {
                               name: {
@@ -725,11 +738,21 @@ export default {
                                   'Indicates whether the device supports an accessory keypad.',
                                 type: 'boolean',
                               },
+                              can_connect_accessory_keypad: {
+                                description:
+                                  'Indicates whether the device can connect a accessory keypad.',
+                                type: 'boolean',
+                              },
                               display_name: {
                                 description:
                                   'Display name of the device model.',
                                 type: 'string',
                               },
+                              has_built_in_keypad: {
+                                description:
+                                  'Indicates whether the device has a built in accessory keypad.',
+                                type: 'boolean',
+                              },
                               manufacturer_display_name: {
                                 description:
                                   'Display name that corresponds to the manufacturer-specific terminology for the device.',
@@ -2244,10 +2267,20 @@ export default {
                       'Indicates whether the device supports an accessory keypad.',
                     type: 'boolean',
                   },
+                  can_connect_accessory_keypad: {
+                    description:
+                      'Indicates whether the device can connect a accessory keypad.',
+                    type: 'boolean',
+                  },
                   display_name: {
                     description: 'Display name of the device model.',
                     type: 'string',
                   },
+                  has_built_in_keypad: {
+                    description:
+                      'Indicates whether the device has a built in accessory keypad.',
+                    type: 'boolean',
+                  },
                   manufacturer_display_name: {
                     description:
                       'Display name that corresponds to the manufacturer-specific terminology for the device.',
@@ -5280,6 +5313,22 @@ export default {
                         acs_system_id: { format: 'uuid', type: 'string' },
                         created_at: { format: 'date-time', type: 'string' },
                         display_name: { type: 'string' },
+                        latch_metadata: {
+                          nullable: true,
+                          properties: {
+                            accessibility_type: { type: 'string' },
+                            is_connected: { type: 'boolean' },
+                            name: { type: 'string' },
+                            type: { type: 'string' },
+                          },
+                          required: [
+                            'accessibility_type',
+                            'name',
+                            'type',
+                            'is_connected',
+                          ],
+                          type: 'object',
+                        },
                         visionline_metadata: {
                           nullable: true,
                           properties: {
@@ -5323,6 +5372,7 @@ export default {
                         'display_name',
                         'acs_system_id',
                         'created_at',
+                        'latch_metadata',
                         'visionline_metadata',
                       ],
                       type: 'object',
@@ -5425,6 +5475,22 @@ export default {
                           acs_system_id: { format: 'uuid', type: 'string' },
                           created_at: { format: 'date-time', type: 'string' },
                           display_name: { type: 'string' },
+                          latch_metadata: {
+                            nullable: true,
+                            properties: {
+                              accessibility_type: { type: 'string' },
+                              is_connected: { type: 'boolean' },
+                              name: { type: 'string' },
+                              type: { type: 'string' },
+                            },
+                            required: [
+                              'accessibility_type',
+                              'name',
+                              'type',
+                              'is_connected',
+                            ],
+                            type: 'object',
+                          },
                           visionline_metadata: {
                             nullable: true,
                             properties: {
@@ -5468,6 +5534,7 @@ export default {
                           'display_name',
                           'acs_system_id',
                           'created_at',
+                          'latch_metadata',
                           'visionline_metadata',
                         ],
                         type: 'object',
@@ -6055,6 +6122,22 @@ export default {
                           acs_system_id: { format: 'uuid', type: 'string' },
                           created_at: { format: 'date-time', type: 'string' },
                           display_name: { type: 'string' },
+                          latch_metadata: {
+                            nullable: true,
+                            properties: {
+                              accessibility_type: { type: 'string' },
+                              is_connected: { type: 'boolean' },
+                              name: { type: 'string' },
+                              type: { type: 'string' },
+                            },
+                            required: [
+                              'accessibility_type',
+                              'name',
+                              'type',
+                              'is_connected',
+                            ],
+                            type: 'object',
+                          },
                           visionline_metadata: {
                             nullable: true,
                             properties: {
@@ -6098,6 +6181,7 @@ export default {
                           'display_name',
                           'acs_system_id',
                           'created_at',
+                          'latch_metadata',
                           'visionline_metadata',
                         ],
                         type: 'object',
@@ -9242,9 +9326,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { access_token: [], seam_workspace: [] },
-          { seam_client_session_token: [] },
-          { client_session_token: [] },
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/locks/lock_door',
         tags: ['/locks'],
@@ -10518,9 +10603,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { api_key: [] },
           { client_session: [] },
           { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/thermostats/cool',
         tags: ['/thermostats'],
@@ -10565,9 +10651,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { api_key: [] },
           { client_session: [] },
           { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/thermostats/get',
         tags: ['/thermostats'],
@@ -10617,9 +10704,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { api_key: [] },
           { client_session: [] },
           { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/thermostats/heat',
         tags: ['/thermostats'],
@@ -10671,9 +10759,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { api_key: [] },
           { client_session: [] },
           { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/thermostats/heat_cool',
         tags: ['/thermostats'],
@@ -10944,9 +11033,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { api_key: [] },
           { client_session: [] },
           { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/thermostats/off',
         tags: ['/thermostats'],
@@ -10996,9 +11086,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { api_key: [] },
           { client_session: [] },
           { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/thermostats/set_fan_mode',
         tags: ['/thermostats'],

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

@@ -1181,6 +1181,12 @@ export interface Routes {
         display_name: string
         acs_system_id: string
         created_at: string
+        latch_metadata: {
+          accessibility_type: string
+          name: string
+          type: string
+          is_connected: boolean
+        } | null
         visionline_metadata: {
           door_name: string
           door_category:
@@ -1227,6 +1233,12 @@ export interface Routes {
         display_name: string
         acs_system_id: string
         created_at: string
+        latch_metadata: {
+          accessibility_type: string
+          name: string
+          type: string
+          is_connected: boolean
+        } | null
         visionline_metadata: {
           door_name: string
           door_category:
@@ -1567,6 +1579,12 @@ export interface Routes {
         display_name: string
         acs_system_id: string
         created_at: string
+        latch_metadata: {
+          accessibility_type: string
+          name: string
+          type: string
+          is_connected: boolean
+        } | null
         visionline_metadata: {
           door_name: string
           door_category:
@@ -2250,15 +2268,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -3077,15 +3106,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -3893,10 +3933,14 @@ export interface Routes {
           /** Indicates whether it is currently possible to use offline access codes for the device. */
           offline_access_codes_enabled?: boolean | undefined
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -4136,10 +4180,14 @@ export interface Routes {
           /** Indicates whether it is currently possible to use offline access codes for the device. */
           offline_access_codes_enabled?: boolean | undefined
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -4491,15 +4539,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -5182,15 +5241,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -6009,15 +6079,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -6700,15 +6781,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -8066,15 +8158,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -8975,15 +9078,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */
@@ -9958,15 +10072,26 @@ export interface Routes {
           online: boolean
           /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          /** Represents the accessory keypad state. */
+          accessory_keypad?:
+            | {
+                /** Indicates if the accessory_keypad is connected to the device. */
+                is_connected: boolean
+              }
+            | undefined
           appearance: {
             /** Name of the device as seen from the provider API and application, not settable through Seam. */
             name: string
           }
           model: {
+            /** Indicates whether the device can connect a accessory keypad. */
+            can_connect_accessory_keypad?: boolean | undefined
             /** Display name of the device model. */
             display_name: string
             /** Display name that corresponds to the manufacturer-specific terminology for the device. */
             manufacturer_display_name: string
+            /** Indicates whether the device has a built in accessory keypad. */
+            has_built_in_keypad?: boolean | undefined
             /** Indicates whether the device supports offline access codes. */
             offline_access_codes_supported?: boolean | undefined
             /** Indicates whether the device supports online access codes. */

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

@@ -1,10 +1,18 @@
 import { z } from 'zod'
 
+export const acs_entrance_latch_metadata = z.object({
+  accessibility_type: z.string(),
+  name: z.string(),
+  type: z.string(),
+  is_connected: z.boolean(),
+})
+
 export const acs_entrance = z.object({
   acs_entrance_id: z.string().uuid(),
   display_name: z.string(),
   acs_system_id: z.string().uuid(),
   created_at: z.string().datetime(),
+  latch_metadata: acs_entrance_latch_metadata.nullable(),
   visionline_metadata: z
     .object({
       door_name: z.string(),
@@ -30,5 +38,8 @@ export const acs_entrance = z.object({
     })
     .nullable(),
 })
+export type AcsEntranceLatchMetadata = z.infer<
+  typeof acs_entrance_latch_metadata
+>
 
 export type AcsEntrance = z.infer<typeof acs_entrance>