@seamapi/types 1.146.0 → 1.147.1

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

@@ -1794,7 +1794,7 @@ export interface Routes {
                 status: 'pending' | 'failed' | 'authorized';
                 custom_redirect_url: string | null;
                 custom_redirect_failure_url: string | null;
-                custom_metadata: Record<string, string | boolean | null>;
+                custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
                 wait_for_device_creation: boolean;
                 authorized_at: string | null;
@@ -1838,7 +1838,7 @@ export interface Routes {
                 status: 'pending' | 'failed' | 'authorized';
                 custom_redirect_url: string | null;
                 custom_redirect_failure_url: string | null;
-                custom_metadata: Record<string, string | boolean | null>;
+                custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
                 wait_for_device_creation: boolean;
                 authorized_at: string | null;
@@ -1854,7 +1854,7 @@ export interface Routes {
         commonParams: {
             user_identifier_key?: string | undefined;
             /** Returns devices where the webview's custom_metadata contains all of the provided key/value pairs. */
-            custom_metadata_has?: Record<string, string | boolean | null> | undefined;
+            custom_metadata_has?: Record<string, string | boolean> | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -1873,7 +1873,7 @@ export interface Routes {
                 status: 'pending' | 'failed' | 'authorized';
                 custom_redirect_url: string | null;
                 custom_redirect_failure_url: string | null;
-                custom_metadata: Record<string, string | boolean | null>;
+                custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
                 wait_for_device_creation: boolean;
                 authorized_at: string | null;
@@ -1931,7 +1931,7 @@ export interface Routes {
                 account_type_display_name: string;
                 errors?: any;
                 warnings?: any;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
             };
         };
@@ -1943,7 +1943,7 @@ export interface Routes {
         jsonBody: {};
         commonParams: {
             /** Returns devices where the account's custom_metadata contains all of the provided key/value pairs. */
-            custom_metadata_has?: Record<string, string | boolean | null> | undefined;
+            custom_metadata_has?: Record<string, string | boolean> | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -1961,7 +1961,7 @@ export interface Routes {
                 account_type_display_name: string;
                 errors?: any;
                 warnings?: any;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
             }>;
         };
@@ -1992,7 +1992,7 @@ export interface Routes {
                 account_type_display_name: string;
                 errors?: any;
                 warnings?: any;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 automatically_manage_new_devices: boolean;
             };
         };
@@ -2513,7 +2513,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -2538,7 +2538,7 @@ export interface Routes {
             limit?: number;
             created_before?: Date | undefined;
             user_identifier_key?: string | undefined;
-            custom_metadata_has?: Record<string, string | boolean | null> | undefined;
+            custom_metadata_has?: Record<string, string | boolean> | undefined;
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
         };
@@ -3038,7 +3038,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -3111,6 +3111,11 @@ export interface Routes {
                 created_at: string;
                 is_managed: false;
                 properties: {
+                    /** Represents the accessory keypad state. */
+                    accessory_keypad?: {
+                        /** Indicates if the accessory_keypad is connected to the device. */
+                        is_connected: boolean;
+                    } | undefined;
                     /**
                             ---
                             deprecated: use device.display_name instead
@@ -3178,7 +3183,7 @@ export interface Routes {
             limit?: number;
             created_before?: Date | undefined;
             user_identifier_key?: string | undefined;
-            custom_metadata_has?: Record<string, string | boolean | null> | undefined;
+            custom_metadata_has?: Record<string, string | boolean> | undefined;
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
         };
@@ -3209,6 +3214,11 @@ export interface Routes {
                 created_at: string;
                 is_managed: false;
                 properties: {
+                    /** Represents the accessory keypad state. */
+                    accessory_keypad?: {
+                        /** Indicates if the accessory_keypad is connected to the device. */
+                        is_connected: boolean;
+                    } | undefined;
                     /**
                             ---
                             deprecated: use device.display_name instead
@@ -3919,7 +3929,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -4419,7 +4429,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -4444,7 +4454,7 @@ export interface Routes {
             limit?: number;
             created_before?: Date | undefined;
             user_identifier_key?: string | undefined;
-            custom_metadata_has?: Record<string, string | boolean | null> | undefined;
+            custom_metadata_has?: Record<string, string | boolean> | undefined;
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
         };
@@ -4944,7 +4954,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -5444,7 +5454,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -5799,7 +5809,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -5874,7 +5884,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -6585,7 +6595,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -6686,7 +6696,7 @@ export interface Routes {
             limit?: number;
             created_before?: Date | undefined;
             user_identifier_key?: string | undefined;
-            custom_metadata_has?: Record<string, string | boolean | null> | undefined;
+            custom_metadata_has?: Record<string, string | boolean> | undefined;
             include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
             exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_online_access_codes' | 'can_simulate_removal'> | undefined;
         };
@@ -7186,7 +7196,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;
@@ -7970,7 +7980,7 @@ export interface Routes {
                 created_at: string;
                 /** Indicates whether Seam manages the device. */
                 is_managed: true;
-                custom_metadata?: Record<string, string | boolean | null> | undefined;
+                custom_metadata: Record<string, string | boolean>;
                 can_remotely_unlock?: boolean | undefined;
                 can_remotely_lock?: boolean | undefined;
                 can_program_online_access_codes?: boolean | undefined;

package/package.json

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

package/src/lib/seam/connect/internal/model-types.ts

@@ -1,32 +1,2 @@
-export type {
-  AccessCodeConstraint,
-  AcsAccessGroup,
-  AcsAccessGroupExternalType,
-  AcsCredential,
-  AcsCredentialExternalType,
-  AcsCredentialPool,
-  AcsCredentialPoolExternalType,
-  AcsEntranceLatchMetadata,
-  AcsSystem,
-  AcsSystemExternalType,
-  AcsUser,
-  AcsUserExternalType,
-  AnyDeviceType,
-  BatteryStatus,
-  Capabilities,
-  ClimateSetting,
-  ConnectWebview,
-  CustomMetadata,
-  ManagedDevice as Device,
-  DeviceMetadata,
-  FanModeSetting,
-  HvacModeSetting,
-  LockDeviceType,
-  ManagedAccessCode,
-  ManagedDevice,
-  ManagedDeviceWithBackendMetadata,
-  NoiseSensorDeviceType,
-  ThermostatDeviceType,
-  UnmanagedAccessCode,
-  UnmanagedDevice,
-} from '../models/index.js'
+export type { ManagedDevice as Device } from '../models/index.js'
+export * from '../models/index.js'

package/src/lib/seam/connect/internal/schemas.ts

@@ -20,8 +20,7 @@ export {
   climate_setting,
   climate_setting_schedule,
   common_device_properties,
-  connect_webview,
-  custom_metadata,
+  custom_metadata_input,
   device_capability_flags,
   dormakaba_oracode_time_slot,
   enrollment_automation,
@@ -39,3 +38,4 @@ export {
   unmanaged_device,
   user_identity,
 } from '../models/index.js'
+export * from '../schemas.js'

package/src/lib/seam/connect/models/custom-metadata.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-export const custom_metadata = z
+export const custom_metadata_input = z
   .record(
     z.string().max(40),
     z.union([z.string().max(500), z.boolean(), z.null()]),
@@ -9,4 +9,11 @@ export const custom_metadata = z
     message: 'Custom metadata is limited to a maximum of 50 keys',
   })
 
-export type CustomMetadata = z.infer<typeof custom_metadata>
+export const custom_metadata = z.record(
+  z.string(),
+  z.union([z.string(), z.boolean()]),
+)
+
+export type CustomMetadata = z.output<typeof custom_metadata>
+
+export type CustomMetadataInput = z.input<typeof custom_metadata_input>

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

@@ -218,7 +218,7 @@ export const managed_device = z
     is_managed: z
       .literal(true)
       .describe('Indicates whether Seam manages the device.'),
-    custom_metadata: custom_metadata.optional(),
+    custom_metadata,
   })
   .merge(device_capability_flags)
 

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

@@ -20,6 +20,7 @@ export const unmanaged_device = managed_device
   .extend({
     is_managed: z.literal(false),
     properties: common_device_properties.pick({
+      accessory_keypad: true,
       name: true,
       online: true,
       manufacturer: true,

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

@@ -438,12 +438,7 @@ export default {
           created_at: { format: 'date-time', type: 'string' },
           custom_metadata: {
             additionalProperties: {
-              nullable: true,
-              oneOf: [
-                { maxLength: 500, type: 'string' },
-                { type: 'boolean' },
-                { format: 'null', nullable: true, type: 'string' },
-              ],
+              oneOf: [{ type: 'string' }, { type: 'boolean' }],
             },
             type: 'object',
           },
@@ -499,12 +494,7 @@ export default {
           created_at: { format: 'date-time', type: 'string' },
           custom_metadata: {
             additionalProperties: {
-              nullable: true,
-              oneOf: [
-                { maxLength: 500, type: 'string' },
-                { type: 'boolean' },
-                { format: 'null', nullable: true, type: 'string' },
-              ],
+              oneOf: [{ type: 'string' }, { type: 'boolean' }],
             },
             type: 'object',
           },
@@ -523,6 +513,7 @@ export default {
         },
         required: [
           'account_type_display_name',
+          'custom_metadata',
           'automatically_manage_new_devices',
         ],
         type: 'object',
@@ -563,12 +554,7 @@ export default {
           },
           custom_metadata: {
             additionalProperties: {
-              nullable: true,
-              oneOf: [
-                { maxLength: 500, type: 'string' },
-                { type: 'boolean' },
-                { format: 'null', nullable: true, type: 'string' },
-              ],
+              oneOf: [{ type: 'string' }, { type: 'boolean' }],
             },
             type: 'object',
           },
@@ -1778,6 +1764,7 @@ export default {
           'warnings',
           'created_at',
           'is_managed',
+          'custom_metadata',
         ],
         type: 'object',
       },
@@ -1934,12 +1921,7 @@ export default {
           },
           custom_metadata: {
             additionalProperties: {
-              nullable: true,
-              oneOf: [
-                { maxLength: 500, type: 'string' },
-                { type: 'boolean' },
-                { format: 'null', nullable: true, type: 'string' },
-              ],
+              oneOf: [{ type: 'string' }, { type: 'boolean' }],
             },
             type: 'object',
           },
@@ -2047,6 +2029,7 @@ export default {
           'warnings',
           'created_at',
           'is_managed',
+          'custom_metadata',
         ],
         type: 'object',
       },
@@ -2238,6 +2221,18 @@ export default {
           is_managed: { enum: [false], type: 'boolean' },
           properties: {
             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',
+              },
               battery: {
                 description:
                   'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
@@ -7387,12 +7382,7 @@ export default {
                 properties: {
                   custom_metadata_has: {
                     additionalProperties: {
-                      nullable: true,
-                      oneOf: [
-                        { maxLength: 500, type: 'string' },
-                        { type: 'boolean' },
-                        { format: 'null', nullable: true, type: 'string' },
-                      ],
+                      oneOf: [{ type: 'string' }, { type: 'boolean' }],
                     },
                     description:
                       "Returns devices where the webview's custom_metadata contains all of the provided key/value pairs.",
@@ -7579,12 +7569,7 @@ export default {
                 properties: {
                   custom_metadata_has: {
                     additionalProperties: {
-                      nullable: true,
-                      oneOf: [
-                        { maxLength: 500, type: 'string' },
-                        { type: 'boolean' },
-                        { format: 'null', nullable: true, type: 'string' },
-                      ],
+                      oneOf: [{ type: 'string' }, { type: 'boolean' }],
                     },
                     description:
                       "Returns devices where the account's custom_metadata contains all of the provided key/value pairs.",
@@ -7806,12 +7791,7 @@ export default {
                   },
                   custom_metadata_has: {
                     additionalProperties: {
-                      nullable: true,
-                      oneOf: [
-                        { maxLength: 500, type: 'string' },
-                        { type: 'boolean' },
-                        { format: 'null', nullable: true, type: 'string' },
-                      ],
+                      oneOf: [{ type: 'string' }, { type: 'boolean' }],
                     },
                     type: 'object',
                   },
@@ -8200,12 +8180,7 @@ export default {
                   },
                   custom_metadata_has: {
                     additionalProperties: {
-                      nullable: true,
-                      oneOf: [
-                        { maxLength: 500, type: 'string' },
-                        { type: 'boolean' },
-                        { format: 'null', nullable: true, type: 'string' },
-                      ],
+                      oneOf: [{ type: 'string' }, { type: 'boolean' }],
                     },
                     type: 'object',
                   },
@@ -9162,12 +9137,7 @@ export default {
                   },
                   custom_metadata_has: {
                     additionalProperties: {
-                      nullable: true,
-                      oneOf: [
-                        { maxLength: 500, type: 'string' },
-                        { type: 'boolean' },
-                        { format: 'null', nullable: true, type: 'string' },
-                      ],
+                      oneOf: [{ type: 'string' }, { type: 'boolean' }],
                     },
                     type: 'object',
                   },
@@ -10897,12 +10867,7 @@ export default {
                   },
                   custom_metadata_has: {
                     additionalProperties: {
-                      nullable: true,
-                      oneOf: [
-                        { maxLength: 500, type: 'string' },
-                        { type: 'boolean' },
-                        { format: 'null', nullable: true, type: 'string' },
-                      ],
+                      oneOf: [{ type: 'string' }, { type: 'boolean' }],
                     },
                     type: 'object',
                   },