@seamapi/types 1.916.0 → 1.918.0

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -134,7 +134,7 @@ const common_acs_access_group = z.object({
     deprecated: Use \`external_type_display_name\`.
     ---
     `),
-  display_name: z.string(),
+  display_name: z.string().describe('Display name for the access group.'),
   external_type: acs_access_group_external_type.describe(
     'Brand-specific terminology for the access group type.',
   ),
@@ -166,7 +166,9 @@ const common_acs_access_group = z.object({
 })
 
 export const acs_access_group = common_acs_access_group.extend({
-  is_managed: z.literal(true),
+  is_managed: z
+    .literal(true)
+    .describe('Indicates whether Seam manages the access group.'),
 }).describe(`
     ---
     route_path: /acs/access_groups

package/src/lib/seam/connect/models/acs/acs-credential.ts

@@ -162,7 +162,11 @@ const common_acs_credential = z.object({
     .describe(
       'ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.',
     ),
-  acs_credential_pool_id: z.string().uuid().optional(),
+  acs_credential_pool_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe('ID of the credential pool to which the credential belongs.'),
   acs_system_id: z
     .string()
     .uuid()
@@ -304,7 +308,9 @@ const common_acs_credential = z.object({
 
 export const acs_credential = common_acs_credential.merge(
   z.object({
-    is_managed: z.literal(true),
+    is_managed: z
+      .literal(true)
+      .describe('Indicates whether Seam manages the credential.'),
   }),
 ).describe(`
   ---
@@ -340,7 +346,12 @@ export const acs_credential_on_encoder = z.object({
       'Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.',
     ),
 
-  is_issued: z.boolean().nullable(),
+  is_issued: z
+    .boolean()
+    .nullable()
+    .describe(
+      'Indicates whether the credential has been issued (encoded onto a card).',
+    ),
 
   starts_at: z
     .string()

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -63,7 +63,12 @@ const seam_bridge_disconnected = common_acs_system_error.extend({
 
 const bridge_disconnected = common_acs_system_error.extend({
   error_code: z.literal('bridge_disconnected').describe(error_code_description),
-  is_bridge_error: z.boolean().optional(),
+  is_bridge_error: z
+    .boolean()
+    .optional()
+    .describe(
+      'Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
+    ),
 })
   .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
     See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`)
@@ -251,8 +256,18 @@ export const acs_system = z
       .describe(
         'ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
       ),
-    acs_user_count: z.number().optional(),
-    acs_access_group_count: z.number().optional(),
+    acs_user_count: z
+      .number()
+      .optional()
+      .describe(
+        'Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
+      ),
+    acs_access_group_count: z
+      .number()
+      .optional()
+      .describe(
+        'Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
+      ),
     external_type: acs_system_external_type
       .describe(
         'Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type.',
@@ -285,7 +300,10 @@ export const acs_system = z
             'IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network.',
           ),
       })
-      .optional(),
+      .optional()
+      .describe(
+        'Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
+      ),
     system_type: acs_system_external_type
       .describe(
         `
@@ -300,7 +318,9 @@ export const acs_system = z
       deprecated: Use \`external_type_display_name\`.
       ---
       `),
-    location: acs_location,
+    location: acs_location.describe(
+      'Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems).',
+    ),
     name: z
       .string()
       .describe(

package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts

@@ -221,7 +221,13 @@ const common_acs_user = z
       .describe(
         'ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).',
       ),
-    hid_acs_system_id: z.string().uuid().optional(),
+    hid_acs_system_id: z
+      .string()
+      .uuid()
+      .optional()
+      .describe(
+        'ID of the HID access control system associated with the user.',
+      ),
     workspace_id: z
       .string()
       .uuid()
@@ -323,7 +329,9 @@ const common_acs_user = z
 
 export const acs_user = common_acs_user.merge(
   z.object({
-    is_managed: z.literal(true),
+    is_managed: z
+      .literal(true)
+      .describe('Indicates whether Seam manages the access system user.'),
   }),
 ).describe(`
   ---

package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts

@@ -32,7 +32,9 @@ export const connect_webview = z.object({
     .describe(
       'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.',
     ),
-  device_selection_mode: connect_webview_device_selection_mode,
+  device_selection_mode: connect_webview_device_selection_mode.describe(
+    'Device selection mode of the Connect Webview. Supported values: `none`, `single`, `multiple`.',
+  ),
 
   // TODO: Use enum value.
   accepted_providers: z

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

@@ -175,10 +175,16 @@ export const PUBLIC_PROVIDER_CATEGORIES: typeof PROVIDER_CATEGORIES =
 
 export const device_provider = z
   .object({
-    device_provider_name: z.enum(ALL_DEVICE_PROVIDERS),
-    display_name: z.string(),
-    image_url: z.string(),
-    provider_categories: z.array(z.enum(PUBLIC_PROVIDER_CATEGORIES)),
+    device_provider_name: z
+      .enum(ALL_DEVICE_PROVIDERS)
+      .describe('Name of the device provider.'),
+    display_name: z.string().describe('Display name for the device provider.'),
+    image_url: z.string().describe('Image URL for the device provider.'),
+    provider_categories: z
+      .array(z.enum(PUBLIC_PROVIDER_CATEGORIES))
+      .describe(
+        'List of provider categories to which the device provider belongs, such as `stable`, `consumer_smartlocks`, `thermostats`, and so on.',
+      ),
   })
   .extend(device_capability_flags.shape).describe(`
     ---

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

@@ -10,26 +10,96 @@ import { phone_specific_properties } from './phone-properties.js'
 
 export const device_capability_flags = z
   .object({
-    can_remotely_unlock: z.boolean(),
-    can_remotely_lock: z.boolean(),
-    can_program_offline_access_codes: z.boolean(),
-    can_program_online_access_codes: z.boolean(),
-    can_hvac_heat: z.boolean(),
-    can_hvac_cool: z.boolean(),
-    can_hvac_heat_cool: z.boolean(),
-    can_turn_off_hvac: z.boolean(),
-    can_simulate_removal: z.boolean(),
-    can_simulate_connection: z.boolean(),
-    can_simulate_disconnection: z.boolean(),
-    can_unlock_with_code: z.boolean(),
-    can_run_thermostat_programs: z.boolean(),
-    can_program_thermostat_programs_as_weekday_weekend: z.boolean(),
-    can_program_thermostat_programs_as_different_each_day: z.boolean(),
-    can_program_thermostat_programs_as_same_each_day: z.boolean(),
-    can_simulate_hub_connection: z.boolean(),
-    can_simulate_hub_disconnection: z.boolean(),
-    can_simulate_paid_subscription: z.boolean(),
-    can_configure_auto_lock: z.boolean(),
+    can_remotely_unlock: z
+      .boolean()
+      .describe('Indicates whether the device supports remote unlocking.'),
+    can_remotely_lock: z
+      .boolean()
+      .describe('Indicates whether the device supports remote locking.'),
+    can_program_offline_access_codes: z
+      .boolean()
+      .describe(
+        'Indicates whether the device supports programming offline access codes.',
+      ),
+    can_program_online_access_codes: z
+      .boolean()
+      .describe(
+        'Indicates whether the device supports programming online access codes.',
+      ),
+    can_hvac_heat: z
+      .boolean()
+      .describe('Indicates whether the thermostat supports heating.'),
+    can_hvac_cool: z
+      .boolean()
+      .describe('Indicates whether the thermostat supports cooling.'),
+    can_hvac_heat_cool: z
+      .boolean()
+      .describe(
+        'Indicates whether the thermostat supports simultaneous heating and cooling.',
+      ),
+    can_turn_off_hvac: z
+      .boolean()
+      .describe('Indicates whether the thermostat can be turned off.'),
+    can_simulate_removal: z
+      .boolean()
+      .describe(
+        'Indicates whether the device supports simulating removal in a sandbox.',
+      ),
+    can_simulate_connection: z
+      .boolean()
+      .describe(
+        'Indicates whether the device supports simulating connection in a sandbox.',
+      ),
+    can_simulate_disconnection: z
+      .boolean()
+      .describe(
+        'Indicates whether the device supports simulating disconnection in a sandbox.',
+      ),
+    can_unlock_with_code: z
+      .boolean()
+      .describe(
+        'Indicates whether the lock supports unlocking with an access code.',
+      ),
+    can_run_thermostat_programs: z
+      .boolean()
+      .describe(
+        'Indicates whether the thermostat supports running climate programs.',
+      ),
+    can_program_thermostat_programs_as_weekday_weekend: z
+      .boolean()
+      .describe(
+        'Indicates whether the thermostat supports weekday/weekend climate programs.',
+      ),
+    can_program_thermostat_programs_as_different_each_day: z
+      .boolean()
+      .describe(
+        'Indicates whether the thermostat supports different climate programs for each day of the week.',
+      ),
+    can_program_thermostat_programs_as_same_each_day: z
+      .boolean()
+      .describe(
+        'Indicates whether the thermostat supports a single climate program applied to every day.',
+      ),
+    can_simulate_hub_connection: z
+      .boolean()
+      .describe(
+        'Indicates whether the hub supports simulating connection in a sandbox.',
+      ),
+    can_simulate_hub_disconnection: z
+      .boolean()
+      .describe(
+        'Indicates whether the hub supports simulating disconnection in a sandbox.',
+      ),
+    can_simulate_paid_subscription: z
+      .boolean()
+      .describe(
+        'Indicates whether the device supports simulating a paid subscription in a sandbox.',
+      ),
+    can_configure_auto_lock: z
+      .boolean()
+      .describe(
+        'Indicates whether the lock supports configuring automatic locking.',
+      ),
   })
   .partial()
 

package/src/lib/seam/connect/models/devices/phone.ts

@@ -37,21 +37,27 @@ export const phone = z.object({
   errors: z
     .array(
       z.object({
-        error_code: z.string(),
-        message: z.string(),
+        error_code: z
+          .string()
+          .describe('Unique identifier of the type of error.'),
+        message: z.string().describe('Detailed description of the error.'),
       }),
     )
     .describe('Errors associated with the phone.'),
   warnings: z
     .array(
       z.object({
-        warning_code: z.string(),
-        message: z.string(),
+        warning_code: z
+          .string()
+          .describe('Unique identifier of the type of warning.'),
+        message: z.string().describe('Detailed description of the warning.'),
       }),
     )
     .describe('Warnings associated with the phone.'),
-  device_type: phone_device_type,
-  properties: phone_specific_properties,
+  device_type: phone_device_type.describe(
+    'Type of the phone device, such as `ios_phone` or `android_phone`.',
+  ),
+  properties: phone_specific_properties.describe('Properties of the phone.'),
 }).describe(`
   ---
   route_path: /phones

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

@@ -20,7 +20,9 @@ export const unmanaged_device = device
     custom_metadata: true,
   })
   .extend({
-    is_managed: z.literal(false),
+    is_managed: z
+      .literal(false)
+      .describe('Indicates that Seam does not manage the device.'),
     properties: common_device_properties.pick({
       accessory_keypad: true,
       name: true,

package/src/lib/seam/connect/models/events/access-codes.ts

@@ -69,19 +69,21 @@ export const access_code_changed_event = access_code_event.extend({
   event_type: z.literal('access_code.changed'),
   changed_properties: z
     .array(
-      z.object({
-        property: z
-          .string()
-          .describe('Name of the property that changed (e.g. `code`).'),
-        from: z
-          .string()
-          .nullable()
-          .describe('Previous value of the property, or null if not set.'),
-        to: z
-          .string()
-          .nullable()
-          .describe('New value of the property, or null if cleared.'),
-      }),
+      z
+        .object({
+          property: z
+            .string()
+            .describe('Name of the property that changed (e.g. `code`).'),
+          from: z
+            .string()
+            .nullable()
+            .describe('Previous value of the property, or null if not set.'),
+          to: z
+            .string()
+            .nullable()
+            .describe('New value of the property, or null if cleared.'),
+        })
+        .describe('Record describing a single changed property.'),
     )
     .optional()
     .describe('List of properties that changed on the access code.'),
@@ -324,7 +326,9 @@ export type AccessCodeDeletedExternalToSeamEvent = z.infer<
 export const access_code_backup_access_code_pulled_event =
   access_code_event.extend({
     event_type: z.literal('access_code.backup_access_code_pulled'),
-    backup_access_code_id: z.string(),
+    backup_access_code_id: z
+      .string()
+      .describe('ID of the backup access code that was pulled from the pool.'),
   }).describe(`
     ---
     route_path: /access_codes

package/src/lib/seam/connect/models/events/acs/entrances.ts

@@ -2,11 +2,9 @@ import { z } from 'zod'
 
 import { common_acs_event } from './common.js'
 
-const acs_entrance_event = common_acs_event
-  .extend({
-    acs_entrance_id: z.string().uuid(),
-  })
-  .describe('ID of the affected entrance.')
+const acs_entrance_event = common_acs_event.extend({
+  acs_entrance_id: z.string().uuid().describe('ID of the affected entrance.'),
+})
 
 export const acs_entrance_added_event = acs_entrance_event.extend({
   event_type: z.literal('acs_entrance.added'),

package/src/lib/seam/connect/models/events/acs/users.ts

@@ -2,11 +2,12 @@ import { z } from 'zod'
 
 import { common_acs_event } from './common.js'
 
-const acs_user_event = common_acs_event
-  .extend({
-    acs_user_id: z.string().uuid(),
-  })
-  .describe('ID of the affected access system user.')
+const acs_user_event = common_acs_event.extend({
+  acs_user_id: z
+    .string()
+    .uuid()
+    .describe('ID of the affected access system user.'),
+})
 
 export const acs_user_deleted_event = acs_user_event.extend({
   event_type: z.literal('acs_user.deleted'),

package/src/lib/seam/connect/models/events/common.ts

@@ -21,28 +21,36 @@ const error_code_description =
 const warning_code_description =
   'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
 
-export const common_event_error = z.object({
-  created_at: z
-    .string()
-    .datetime()
-    .describe('Date and time at which Seam created the error.'),
-  message: z
-    .string()
-    .describe(
-      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
-    ),
-  error_code: z.string().describe(error_code_description),
-})
+export const common_event_error = z
+  .object({
+    created_at: z
+      .string()
+      .datetime()
+      .describe('Date and time at which Seam created the error.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+      ),
+    error_code: z.string().describe(error_code_description),
+  })
+  .describe(
+    'Error associated with the resource, including the error code, message, and creation timestamp.',
+  )
 
-export const common_event_warning = z.object({
-  created_at: z
-    .string()
-    .datetime()
-    .describe('Date and time at which Seam created the warning.'),
-  message: z
-    .string()
-    .describe(
-      'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
-    ),
-  warning_code: z.string().describe(warning_code_description),
-})
+export const common_event_warning = z
+  .object({
+    created_at: z
+      .string()
+      .datetime()
+      .describe('Date and time at which Seam created the warning.'),
+    message: z
+      .string()
+      .describe(
+        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+      ),
+    warning_code: z.string().describe(warning_code_description),
+  })
+  .describe(
+    'Warning associated with the resource, including the warning code, message, and creation timestamp.',
+  )

package/src/lib/seam/connect/models/events/devices.ts

@@ -518,6 +518,31 @@ export const lock_access_denied_event = device_event.extend({
     .uuid()
     .optional()
     .describe('ID of the access code that was used in the unlock attempts.'),
+  user_identity_id: z.string().uuid().optional().describe(`
+      undocumented: Unreleased.
+      ---
+      ID of the user identity associated with the access-denied event.
+    `),
+  acs_system_id: z.string().uuid().optional().describe(`
+      undocumented: Unreleased.
+      ---
+      ID of the ACS system associated with the access-denied event.
+    `),
+  acs_user_id: z.string().uuid().optional().describe(`
+      undocumented: Unreleased.
+      ---
+      ID of the ACS user associated with the access-denied event.
+    `),
+  acs_entrance_id: z.string().uuid().optional().describe(`
+      undocumented: Unreleased.
+      ---
+      ID of the ACS entrance associated with the access-denied event.
+    `),
+  device_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe('ID of the affected device.'),
 }).describe(`
   ---
   route_path: /locks

package/src/lib/seam/connect/models/thermostats/modes.ts

@@ -1,16 +1,18 @@
 import { z } from 'zod'
 
-export const hvac_mode_setting = z.enum([
-  'off',
-  'heat',
-  'cool',
-  'heat_cool',
-  'eco',
-])
+export const hvac_mode_setting = z
+  .enum(['off', 'heat', 'cool', 'heat_cool', 'eco'])
+  .describe(
+    'HVAC mode setting for the thermostat, such as `heat`, `cool`, `heat_cool`, `eco`, or `off`.',
+  )
 
 export type HvacModeSetting = z.infer<typeof hvac_mode_setting>
 
-export const fan_mode_setting = z.enum(['auto', 'on', 'circulate'])
+export const fan_mode_setting = z
+  .enum(['auto', 'on', 'circulate'])
+  .describe(
+    'Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.',
+  )
 
 export type FanModeSetting = z.infer<typeof fan_mode_setting>
 
@@ -20,13 +22,10 @@ export type AvailableFanModeSettings = z.infer<
   typeof available_fan_mode_settings
 >
 
-export const climate_preset_mode = z.enum([
-  'home',
-  'away',
-  'wake',
-  'sleep',
-  'occupied',
-  'unoccupied',
-])
+export const climate_preset_mode = z
+  .enum(['home', 'away', 'wake', 'sleep', 'occupied', 'unoccupied'])
+  .describe(
+    'Climate preset mode for the thermostat, such as `home`, `away`, `wake`, `sleep`, `occupied`, or `unoccupied`.',
+  )
 
 export type ClimatePresetMode = z.infer<typeof climate_preset_mode>

package/src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -119,8 +119,15 @@ export const user_identity = z.object({
     .describe(
       'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
     ),
-  display_name: z.string().min(1),
-  full_name: z.string().min(1).nullable(),
+  display_name: z
+    .string()
+    .min(1)
+    .describe('Display name for the user identity.'),
+  full_name: z
+    .string()
+    .min(1)
+    .nullable()
+    .describe('Full name of the user associated with the user identity.'),
   created_at: z
     .string()
     .datetime()