@seamapi/types 1.65.0 → 1.67.0

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

@@ -19,7 +19,7 @@ export interface Routes {
       use_offline_access_code?: boolean | undefined
       is_offline_access_code?: boolean | undefined
       is_one_time_use?: boolean | undefined
-      max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined
+      max_time_rounding?: '1hour' | '1day' | '1h' | '1d'
     }
     commonParams: {}
     formData: {}
@@ -116,7 +116,7 @@ export interface Routes {
       use_offline_access_code?: boolean | undefined
       is_offline_access_code?: boolean | undefined
       is_one_time_use?: boolean | undefined
-      max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined
+      max_time_rounding?: '1hour' | '1day' | '1h' | '1d'
     }
     commonParams: {}
     formData: {}
@@ -733,13 +733,14 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type:
-          | 'pti_user'
-          | 'brivo_user'
-          | 'hid_cm_user'
-          | 'salto_site_user'
-        external_type_display_name: string
+        external_type?:
+          | ('pti_user' | 'brivo_user' | 'hid_cm_user' | 'salto_site_user')
+          | undefined
+        external_type_display_name?: string | undefined
         is_suspended: boolean
+        starts_at?: string | undefined
+        ends_at?: string | undefined
+        is_virtual: boolean
         full_name?: string | undefined
         /** Deprecated: use email_address. */
         email?: string | undefined
@@ -1123,6 +1124,12 @@ export interface Routes {
     jsonBody: {
       acs_system_id: string
       acs_access_group_ids?: string[]
+      access_schedule?:
+        | {
+            starts_at: string
+            ends_at: string
+          }
+        | undefined
       full_name?: string | undefined
       /** Deprecated: use email_address. */
       email?: string | undefined
@@ -1139,13 +1146,14 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type:
-          | 'pti_user'
-          | 'brivo_user'
-          | 'hid_cm_user'
-          | 'salto_site_user'
-        external_type_display_name: string
+        external_type?:
+          | ('pti_user' | 'brivo_user' | 'hid_cm_user' | 'salto_site_user')
+          | undefined
+        external_type_display_name?: string | undefined
         is_suspended: boolean
+        starts_at?: string | undefined
+        ends_at?: string | undefined
+        is_virtual: boolean
         full_name?: string | undefined
         /** Deprecated: use email_address. */
         email?: string | undefined
@@ -1182,13 +1190,14 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type:
-          | 'pti_user'
-          | 'brivo_user'
-          | 'hid_cm_user'
-          | 'salto_site_user'
-        external_type_display_name: string
+        external_type?:
+          | ('pti_user' | 'brivo_user' | 'hid_cm_user' | 'salto_site_user')
+          | undefined
+        external_type_display_name?: string | undefined
         is_suspended: boolean
+        starts_at?: string | undefined
+        ends_at?: string | undefined
+        is_virtual: boolean
         full_name?: string | undefined
         /** Deprecated: use email_address. */
         email?: string | undefined
@@ -1214,13 +1223,14 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type:
-          | 'pti_user'
-          | 'brivo_user'
-          | 'hid_cm_user'
-          | 'salto_site_user'
-        external_type_display_name: string
+        external_type?:
+          | ('pti_user' | 'brivo_user' | 'hid_cm_user' | 'salto_site_user')
+          | undefined
+        external_type_display_name?: string | undefined
         is_suspended: boolean
+        starts_at?: string | undefined
+        ends_at?: string | undefined
+        is_virtual: boolean
         full_name?: string | undefined
         /** Deprecated: use email_address. */
         email?: string | undefined
@@ -1542,6 +1552,7 @@ export interface Routes {
             | 'seam_passport'
             | 'visionline'
             | 'assa_abloy_credential_service'
+            | 'seam_bridge'
             | 'yale_access'
             | 'hid_cm'
           >
@@ -1840,9 +1851,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -2483,6 +2500,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           )
         | undefined
       device_types?:
@@ -2516,6 +2534,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           >
         | undefined
       manufacturer?:
@@ -2595,9 +2614,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -3260,11 +3285,17 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Unique identifier for the Seam workspace associated with the device. */
         workspace_id: string
@@ -3362,6 +3393,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           )
         | undefined
       device_types?:
@@ -3395,6 +3427,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           >
         | undefined
       manufacturer?:
@@ -3474,11 +3507,17 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Unique identifier for the Seam workspace associated with the device. */
         workspace_id: string
@@ -3835,9 +3874,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -4469,9 +4514,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -5112,6 +5163,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           )
         | undefined
       device_types?:
@@ -5145,6 +5197,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           >
         | undefined
       manufacturer?:
@@ -5224,9 +5277,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -5858,9 +5917,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -6945,9 +7010,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -7618,6 +7689,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           )
         | undefined
       device_types?:
@@ -7651,6 +7723,7 @@ export interface Routes {
               )
             | ('noiseaware_activity_zone' | 'minut_sensor')
             | ('ecobee_thermostat' | 'nest_thermostat')
+            | ('ios_phone' | 'android_phone')
           >
         | undefined
       manufacturer?:
@@ -7730,9 +7803,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -8515,9 +8594,15 @@ export interface Routes {
             )
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat')
+          | ('ios_phone' | 'android_phone')
         /** 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. */
         capabilities_supported: Array<
-          'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
+          | 'access_code'
+          | 'lock'
+          | 'noise_detection'
+          | 'thermostat'
+          | 'battery'
+          | 'phone'
         >
         /** Properties of the device. */
         properties: ({
@@ -9134,13 +9219,14 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type:
-          | 'pti_user'
-          | 'brivo_user'
-          | 'hid_cm_user'
-          | 'salto_site_user'
-        external_type_display_name: string
+        external_type?:
+          | ('pti_user' | 'brivo_user' | 'hid_cm_user' | 'salto_site_user')
+          | undefined
+        external_type_display_name?: string | undefined
         is_suspended: boolean
+        starts_at?: string | undefined
+        ends_at?: string | undefined
+        is_virtual: boolean
         full_name?: string | undefined
         /** Deprecated: use email_address. */
         email?: string | undefined

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

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-// If changed, update seam.acs_access_group.access_group_type check constraint
+// If changed, update seam.acs_access_group.external_type generated column
 export const acs_access_group_external_type = z.enum([
   'pti_unit',
   'pti_access_level',

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

@@ -41,9 +41,12 @@ export const acs_user = z
     workspace_id: z.string().uuid(),
     created_at: z.string().datetime(),
     display_name: z.string(),
-    external_type: acs_user_external_type,
-    external_type_display_name: z.string(),
+    external_type: acs_user_external_type.optional(),
+    external_type_display_name: z.string().optional(),
     is_suspended: z.boolean(),
+    starts_at: z.string().datetime().optional(),
+    ends_at: z.string().datetime().optional(),
+    is_virtual: z.boolean(),
   })
   .merge(user_fields)
 

package/src/lib/seam/connect/unstable/models/devices/capabilities-supported.ts

@@ -6,6 +6,7 @@ export const capabilities = z.enum([
   'noise_detection',
   'thermostat',
   'battery',
+  'phone',
 ])
 
 export type Capabilities = z.infer<typeof capabilities>

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

@@ -80,10 +80,30 @@ export const thermostat_device_type = z.enum(
 
 export type ThermostatDeviceType = z.infer<typeof thermostat_device_type>
 
+/** Phones */
+export const PHONE_DEVICE_TYPE = {
+  IOS_PHONE: 'ios_phone',
+  ANDROID_PHONE: 'android_phone',
+} as const
+
+type PhoneDeviceTypeFromMapping =
+  (typeof PHONE_DEVICE_TYPE)[keyof typeof PHONE_DEVICE_TYPE]
+
+export const PHONE_DEVICE_TYPE_LIST = Object.values(
+  PHONE_DEVICE_TYPE,
+) as PhoneDeviceTypeFromMapping[]
+
+export const phone_device_type = z.enum(
+  Object.values(PHONE_DEVICE_TYPE_LIST) as [PhoneDeviceTypeFromMapping],
+)
+
+export type PhoneDeviceType = z.infer<typeof phone_device_type>
+
 export const any_device_type = z.union([
   lock_device_type,
   noise_sensor_device_type,
   thermostat_device_type,
+  phone_device_type,
 ])
 
 export type AnyDeviceType = z.infer<typeof any_device_type>