@seamapi/types 1.142.0 → 1.143.0

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

@@ -306,8 +306,8 @@ export declare const routes: {
                 }>;
                 can_remotely_unlock: z.ZodOptional<z.ZodLiteral<true>>;
                 can_remotely_lock: z.ZodOptional<z.ZodLiteral<true>>;
-                can_program_online_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
                 can_program_offline_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
+                can_program_online_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
             }, "strip", z.ZodTypeAny, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -323,8 +323,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -340,8 +340,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }>, z.ZodObject<{
                 main_category: z.ZodLiteral<"sensor">;
                 physical_properties: z.ZodObject<{
@@ -578,8 +578,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }) | ({
                 description: string;
                 display_name: string;
@@ -931,8 +931,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }) | ({
                 description: string;
                 display_name: string;
@@ -1549,8 +1549,8 @@ export declare const routes: {
                 }>;
                 can_remotely_unlock: z.ZodOptional<z.ZodLiteral<true>>;
                 can_remotely_lock: z.ZodOptional<z.ZodLiteral<true>>;
-                can_program_online_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
                 can_program_offline_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
+                can_program_online_access_codes: z.ZodOptional<z.ZodLiteral<true>>;
             }, "strip", z.ZodTypeAny, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -1566,8 +1566,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }, {
                 main_category: "smartlock";
                 physical_properties: {
@@ -1583,8 +1583,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             }>, z.ZodObject<{
                 main_category: z.ZodLiteral<"sensor">;
                 physical_properties: z.ZodObject<{
@@ -1821,8 +1821,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: true | undefined;
+                can_program_online_access_codes?: true | undefined;
             } | {
                 main_category: "sensor";
                 physical_properties: {
@@ -1929,8 +1929,8 @@ export declare const routes: {
                 };
                 can_remotely_unlock?: true | undefined;
                 can_remotely_lock?: true | undefined;
-                can_program_online_access_codes?: true | undefined;
                 can_program_offline_access_codes?: 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.142.0",
+  "version": "1.143.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/{enums.ts → internal/enums.ts}

@@ -3,6 +3,7 @@ export {
   LOCK_DEVICE_TYPE_LIST,
   NOISE_SENSOR_DEVICE_TYPE,
   NOISE_SENSOR_DEVICE_TYPE_LIST,
+  PHONE_DEVICE_TYPE,
   THERMOSTAT_DEVICE_TYPE,
   THERMOSTAT_DEVICE_TYPE_LIST,
-} from './unstable/models/index.js'
+} from '../models/index.js'

package/src/lib/seam/connect/{unstable → internal}/index.ts

@@ -1,5 +1,6 @@
 import * as schemas from './schemas.js'
 
-export * from './model-types.js'
+export * from './enums.js'
 
 export { schemas }
+export * from './model-types.js'

package/src/lib/seam/connect/{unstable → internal}/model-types.ts

@@ -6,6 +6,7 @@ export type {
   AcsCredentialExternalType,
   AcsCredentialPool,
   AcsCredentialPoolExternalType,
+  AcsEntranceLatchMetadata,
   AcsSystem,
   AcsSystemExternalType,
   AcsUser,
@@ -14,7 +15,12 @@ export type {
   BatteryStatus,
   Capabilities,
   ClimateSetting,
+  ConnectWebview,
+  CustomMetadata,
+  ManagedDevice as Device,
   DeviceMetadata,
+  FanModeSetting,
+  HvacModeSetting,
   LockDeviceType,
   ManagedAccessCode,
   ManagedDevice,
@@ -23,4 +29,4 @@ export type {
   ThermostatDeviceType,
   UnmanagedAccessCode,
   UnmanagedDevice,
-} from './models/index.js'
+} from '../models/index.js'

package/src/lib/seam/connect/{unstable → internal}/schemas.ts

@@ -3,12 +3,14 @@ export {
   acs_access_group,
   acs_access_group_external_type,
   acs_credential,
+  acs_credential_access_method_type,
   acs_credential_external_type,
   acs_credential_pool,
   acs_credential_pool_external_type,
   acs_credential_provisioning_automation,
   acs_entrance,
   acs_system,
+  acs_system_capability_flags,
   acs_system_external_type,
   acs_user,
   acs_user_external_type,
@@ -18,6 +20,10 @@ export {
   climate_setting,
   climate_setting_schedule,
   common_device_properties,
+  connect_webview,
+  custom_metadata,
+  device_capability_flags,
+  dormakaba_oracode_time_slot,
   enrollment_automation,
   fan_mode_setting,
   lock_device_type,
@@ -32,4 +38,4 @@ export {
   unmanaged_access_code,
   unmanaged_device,
   user_identity,
-} from './models/index.js'
+} from '../models/index.js'

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

@@ -17,12 +17,16 @@ export const acs_access_group = z.object({
   acs_system_id: z.string().uuid(),
   workspace_id: z.string().uuid(),
   name: z.string(),
-  access_group_type: acs_access_group_external_type.describe(
-    'deprecated: use external_type',
-  ),
-  access_group_type_display_name: z
-    .string()
-    .describe('deprecated: use external_type_display_name'),
+  access_group_type: acs_access_group_external_type.describe(`
+    ---
+    deprecated: use external_type
+    ---
+  `),
+  access_group_type_display_name: z.string().describe(`
+    ---
+    deprecated: use external_type_display_name
+    ---
+    `),
   external_type: acs_access_group_external_type,
   external_type_display_name: z.string(),
   created_at: z.string().datetime(),

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

@@ -34,7 +34,7 @@ export const acs_credential = z.object({
   acs_credential_pool_id: z.string().uuid().optional(),
   acs_system_id: z.string().uuid(),
   parent_acs_credential_id: z.string().uuid().optional(),
-  display_name: z.string().nonempty(),
+  display_name: z.string().min(1),
   code: z.string().optional().nullable(),
   access_method: acs_credential_access_method_type,
   external_type: acs_credential_external_type.optional(),

package/src/lib/seam/connect/{unstable/models → models}/acs/credential_pool.ts

@@ -9,7 +9,7 @@ export type AcsCredentialPoolExternalType = z.infer<
 export const acs_credential_pool = z.object({
   acs_credential_pool_id: z.string().uuid(),
   acs_system_id: z.string().uuid(),
-  display_name: z.string().nonempty(),
+  display_name: z.string().min(1),
   external_type: acs_credential_pool_external_type,
   external_type_display_name: z.string(),
   created_at: z.string().datetime(),

package/src/lib/seam/connect/{unstable/models → models}/acs/system.ts

@@ -11,6 +11,7 @@ export const acs_system_external_type = z.enum([
   'hid_credential_manager_organization',
   'visionline_system',
   'assa_abloy_credential_service',
+  'latch_building',
 ])
 
 export type AcsSystemExternalType = z.infer<typeof acs_system_external_type>
@@ -20,12 +21,16 @@ export const acs_system = z
     acs_system_id: z.string().uuid(),
     external_type: acs_system_external_type,
     external_type_display_name: z.string(),
-    system_type: acs_system_external_type.describe(
-      'deprecated: use external_type',
-    ),
-    system_type_display_name: z
-      .string()
-      .describe('deprecated: use external_type_display_name'),
+    system_type: acs_system_external_type.describe(`
+      ---
+      deprecated: use external_type
+      ---
+      `),
+    system_type_display_name: z.string().describe(`
+      ---
+      deprecated: use external_type_display_name
+      ---
+      `),
     name: z.string(),
     created_at: z.string().datetime(),
     workspace_id: z.string().uuid(),

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

@@ -14,11 +14,11 @@ export type AcsUserExternalType = z.infer<typeof acs_user_external_type>
 
 const user_fields = z.object({
   full_name: z.string().optional(),
-  email: z
-    .string()
-    .email()
-    .optional()
-    .describe('Deprecated: use email_address.'),
+  email: z.string().email().optional().describe(`
+    ---
+    deprecated: use email_address.
+    ---
+    `),
   email_address: z.string().email().optional(),
   phone_number: phone_number.optional(),
 })

package/src/lib/seam/connect/{unstable/models → models}/capability-properties/index.ts

@@ -33,4 +33,8 @@ export const capability_properties = z.intersection(
 )
 
 export type { AccessCodeConstraint } from './access-code.js'
-export type { ClimateSetting, HvacModeSetting } from './thermostat.js'
+export type {
+  ClimateSetting,
+  FanModeSetting,
+  HvacModeSetting,
+} from './thermostat.js'

package/src/lib/seam/connect/{unstable/models → models}/capability-properties/thermostat.ts

@@ -25,7 +25,7 @@ export const climate_setting_schedule = z
   .object({
     climate_setting_schedule_id: z.string().uuid(),
     schedule_type: z.literal('time_bound'),
-    device_id: z.string(),
+    device_id: z.string().uuid(),
     name: z.string().optional(),
     schedule_starts_at: z.string(),
     schedule_ends_at: z.string(),

package/src/lib/seam/connect/{unstable/models → models}/devices/device-metadata.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-export const dormakaba_oracode_time_slot_schema = z.object({
+export const dormakaba_oracode_time_slot = z.object({
   name: z.string(),
   prefix: z.number(),
   // Seam TOD
@@ -192,9 +192,7 @@ export const device_metadata = z
       site_id: z.number(),
       site_name: z.string(),
       iana_timezone: z.string().optional(),
-      predefined_time_slots: z
-        .array(dormakaba_oracode_time_slot_schema)
-        .optional(),
+      predefined_time_slots: z.array(dormakaba_oracode_time_slot).optional(),
     }),
 
     wyze_metadata: z.object({

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

@@ -3,8 +3,8 @@ import { z } from 'zod'
 
 import { schemas as devicedb_schemas } from '@seamapi/types/devicedb'
 
-import { custom_metadata } from '../../../models/custom-metadata.js'
 import { capability_properties } from '../capability-properties/index.js'
+import { custom_metadata } from '../custom-metadata.js'
 import { capabilities } from './capabilities-supported.js'
 import { device_metadata } from './device-metadata.js'
 import { any_device_type } from './device-type.js'
@@ -21,11 +21,12 @@ export type BatteryStatus = z.infer<typeof battery_status>
 
 export const common_device_properties = z.object({
   online: z.boolean().describe('Indicates whether the device is online.'),
-  name: z
-    .string()
-    .describe(
-      'Name of the device. Deprecated - use device.display_name instead',
-    ),
+  name: z.string().describe(`
+      ---
+      deprecated: use device.display_name instead
+      ---
+      Name of the device.
+      `),
   accessory_keypad: z
     .object({
       is_connected: z
@@ -119,11 +120,23 @@ export const common_device_properties = z.object({
   // Deprecated legacy capability support props
   supports_accessory_keypad: z
     .boolean()
-    .describe('Deprecated. Use model.accessory_keypad_supported.')
+    .describe(
+      `
+      ---
+      deprecated: use model.accessory_keypad_supported
+      ---
+      `,
+    )
     .optional(),
   supports_offline_access_codes: z
     .boolean()
-    .describe('Deprecated. Use offline_access_codes_enabled.')
+    .describe(
+      `
+      ---
+      deprecated: use offline_access_codes_enabled
+      ---
+      `,
+    )
     .optional(),
 })
 

package/src/lib/seam/connect/models/index.ts

@@ -1,2 +1,9 @@
+export * from './access-codes/index.js'
+export * from './acs/index.js'
+export * from './capability-properties/index.js'
 export * from './connect-webview.js'
 export * from './custom-metadata.js'
+export * from './devices/index.js'
+export * from './network.js'
+export * from './phone-number.js'
+export * from './user-identity.js'

package/src/lib/seam/connect/{unstable/models → models}/user-identity.ts

@@ -4,11 +4,11 @@ import { phone_number } from './phone-number.js'
 
 export const user_identity = z.object({
   user_identity_id: z.string().uuid(),
-  user_identity_key: z.string().nonempty().nullable(),
+  user_identity_key: z.string().min(1).nullable(),
   email_address: z.string().email().nullable(),
   phone_number: phone_number.nullable(),
-  display_name: z.string().nonempty(),
-  full_name: z.string().nonempty().nullable(),
+  display_name: z.string().min(1),
+  full_name: z.string().min(1).nullable(),
   created_at: z.string().datetime(),
   workspace_id: z.string().uuid(),
 })

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

@@ -140,7 +140,8 @@ export default {
       acs_access_group: {
         properties: {
           access_group_type: {
-            description: 'deprecated: use external_type',
+            description:
+              '\n    ---\n    deprecated: use external_type\n    ---\n  ',
             enum: [
               'pti_unit',
               'pti_access_level',
@@ -150,7 +151,8 @@ export default {
             type: 'string',
           },
           access_group_type_display_name: {
-            description: 'deprecated: use external_type_display_name',
+            description:
+              '\n    ---\n    deprecated: use external_type_display_name\n    ---\n    ',
             type: 'string',
           },
           acs_access_group_id: { format: 'uuid', type: 'string' },
@@ -197,6 +199,7 @@ export default {
               'hid_credential_manager_organization',
               'visionline_system',
               'assa_abloy_credential_service',
+              'latch_building',
             ],
             type: 'string',
           },
@@ -205,7 +208,8 @@ export default {
           image_url: { type: 'string' },
           name: { type: 'string' },
           system_type: {
-            description: 'deprecated: use external_type',
+            description:
+              '\n      ---\n      deprecated: use external_type\n      ---\n      ',
             enum: [
               'pti_site',
               'alta_org',
@@ -214,11 +218,13 @@ export default {
               'hid_credential_manager_organization',
               'visionline_system',
               'assa_abloy_credential_service',
+              'latch_building',
             ],
             type: 'string',
           },
           system_type_display_name: {
-            description: 'deprecated: use external_type_display_name',
+            description:
+              '\n      ---\n      deprecated: use external_type_display_name\n      ---\n      ',
             type: 'string',
           },
           workspace_id: { format: 'uuid', type: 'string' },
@@ -253,7 +259,8 @@ export default {
           created_at: { format: 'date-time', type: 'string' },
           display_name: { type: 'string' },
           email: {
-            description: 'Deprecated: use email_address.',
+            description:
+              '\n    ---\n    deprecated: use email_address.\n    ---\n    ',
             format: 'email',
             type: 'string',
           },
@@ -386,7 +393,7 @@ export default {
           cooling_set_point_celsius: { type: 'number' },
           cooling_set_point_fahrenheit: { type: 'number' },
           created_at: { format: 'date-time', type: 'string' },
-          device_id: { type: 'string' },
+          device_id: { format: 'uuid', type: 'string' },
           errors: {
             description:
               'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
@@ -778,7 +785,7 @@ export default {
                           },
                           name: {
                             description:
-                              'Name of the device. Deprecated - use device.display_name instead',
+                              '\n      ---\n      deprecated: use device.display_name instead\n      ---\n      Name of the device.\n      ',
                             type: 'string',
                           },
                           offline_access_codes_enabled: {
@@ -802,12 +809,12 @@ export default {
                           },
                           supports_accessory_keypad: {
                             description:
-                              'Deprecated. Use model.accessory_keypad_supported.',
+                              '\n      ---\n      deprecated: use model.accessory_keypad_supported\n      ---\n      ',
                             type: 'boolean',
                           },
                           supports_offline_access_codes: {
                             description:
-                              'Deprecated. Use offline_access_codes_enabled.',
+                              '\n      ---\n      deprecated: use offline_access_codes_enabled\n      ---\n      ',
                             type: 'boolean',
                           },
                         },
@@ -1333,7 +1340,7 @@ export default {
                                 format: 'date-time',
                                 type: 'string',
                               },
-                              device_id: { type: 'string' },
+                              device_id: { format: 'uuid', type: 'string' },
                               errors: {
                                 description:
                                   'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
@@ -1476,7 +1483,7 @@ export default {
                                 format: 'date-time',
                                 type: 'string',
                               },
-                              device_id: { type: 'string' },
+                              device_id: { format: 'uuid', type: 'string' },
                               errors: {
                                 description:
                                   'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
@@ -1611,7 +1618,7 @@ export default {
                                 format: 'date-time',
                                 type: 'string',
                               },
-                              device_id: { type: 'string' },
+                              device_id: { format: 'uuid', type: 'string' },
                               errors: {
                                 description:
                                   'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
@@ -2305,7 +2312,7 @@ export default {
               },
               name: {
                 description:
-                  'Name of the device. Deprecated - use device.display_name instead',
+                  '\n      ---\n      deprecated: use device.display_name instead\n      ---\n      Name of the device.\n      ',
                 type: 'string',
               },
               offline_access_codes_enabled: {
@@ -5913,7 +5920,8 @@ export default {
                   },
                   acs_system_id: { format: 'uuid', type: 'string' },
                   email: {
-                    description: 'Deprecated: use email_address.',
+                    description:
+                      '\n    ---\n    deprecated: use email_address.\n    ---\n    ',
                     format: 'email',
                     type: 'string',
                   },
@@ -6400,7 +6408,8 @@ export default {
                   },
                   acs_user_id: { format: 'uuid', type: 'string' },
                   email: {
-                    description: 'Deprecated: use email_address.',
+                    description:
+                      '\n    ---\n    deprecated: use email_address.\n    ---\n    ',
                     format: 'email',
                     type: 'string',
                   },
@@ -6457,7 +6466,8 @@ export default {
                   },
                   acs_user_id: { format: 'uuid', type: 'string' },
                   email: {
-                    description: 'Deprecated: use email_address.',
+                    description:
+                      '\n    ---\n    deprecated: use email_address.\n    ---\n    ',
                     format: 'email',
                     type: 'string',
                   },