@seamapi/types 1.147.0 → 1.148.0

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;
             };
         };
@@ -2045,6 +2045,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -2513,7 +2517,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 +2542,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;
         };
@@ -2570,6 +2574,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -3038,7 +3046,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;
@@ -3183,7 +3191,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;
         };
@@ -3461,6 +3469,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -3929,7 +3941,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;
@@ -3961,6 +3973,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -4429,7 +4445,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;
@@ -4454,7 +4470,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;
         };
@@ -4486,6 +4502,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -4954,7 +4974,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;
@@ -4986,6 +5006,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -5454,7 +5478,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;
@@ -5809,7 +5833,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;
@@ -5884,7 +5908,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;
@@ -6127,6 +6151,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -6595,7 +6623,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;
@@ -6696,7 +6724,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;
         };
@@ -6728,6 +6756,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -7196,7 +7228,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;
@@ -7512,6 +7544,10 @@ export interface Routes {
                     accessory_keypad?: {
                         /** Indicates if the accessory_keypad is connected to the device. */
                         is_connected: boolean;
+                        /** Indicates if the keypad battery properties. */
+                        battery?: {
+                            level: number;
+                        } | undefined;
                     } | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
@@ -7980,7 +8016,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.147.0",
+  "version": "1.148.0",
   "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

@@ -34,6 +34,12 @@ export const common_device_properties = z.object({
         .describe(
           'Indicates if the accessory_keypad is connected to the device.',
         ),
+      battery: z
+        .object({
+          level: z.number().min(0).max(1),
+        })
+        .optional()
+        .describe('Indicates if the keypad battery properties.'),
     })
     .optional()
     .describe('Represents the accessory keypad state.'),
@@ -218,7 +224,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/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',
           },
@@ -681,6 +667,19 @@ export default {
                             description:
                               'Represents the accessory keypad state.',
                             properties: {
+                              battery: {
+                                description:
+                                  'Indicates if the keypad battery properties.',
+                                properties: {
+                                  level: {
+                                    maximum: 1,
+                                    minimum: 0,
+                                    type: 'number',
+                                  },
+                                },
+                                required: ['level'],
+                                type: 'object',
+                              },
                               is_connected: {
                                 description:
                                   'Indicates if the accessory_keypad is connected to the device.',
@@ -1778,6 +1777,7 @@ export default {
           'warnings',
           'created_at',
           'is_managed',
+          'custom_metadata',
         ],
         type: 'object',
       },
@@ -1934,12 +1934,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 +2042,7 @@ export default {
           'warnings',
           'created_at',
           'is_managed',
+          'custom_metadata',
         ],
         type: 'object',
       },
@@ -7399,12 +7395,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.",
@@ -7591,12 +7582,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.",
@@ -7818,12 +7804,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',
                   },
@@ -8212,12 +8193,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',
                   },
@@ -9174,12 +9150,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',
                   },
@@ -10909,12 +10880,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',
                   },