@seamapi/types 1.327.0 → 1.329.0

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

@@ -38,266 +38,288 @@ export const lock_method = z
   )
 export type LockMethod = z.infer<typeof lock_method>
 
-export const device_connected_event = device_event
-  .extend({
-    event_type: z.literal('device.connected'),
-  })
-  .describe(
-    'The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`. Note that some devices operate entirely in offline mode, so Seam never emits a `device.connected` event for these devices.',
-  )
+export const device_connected_event = device_event.extend({
+  event_type: z.literal('device.connected'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`. Note that some devices operate entirely in offline mode, so Seam never emits a \`device.connected\` event for these devices.
+`)
 
 export type DeviceConnectedEvent = z.infer<typeof device_connected_event>
 
-export const device_added_event = device_event
-  .extend({
-    event_type: z.literal('device.added'),
-  })
-  .describe(
-    'A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.',
-  )
+export const device_added_event = device_event.extend({
+  event_type: z.literal('device.added'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [device](https://docs.seam.co/latest/core-concepts/devices) was added to Seam or was re-added to Seam after having been removed.
+`)
 
 export type DeviceAddedEvent = z.infer<typeof device_added_event>
 
-export const device_converted_to_unmanaged_event = device_event
-  .extend({
-    event_type: z.literal('device.converted_to_unmanaged'),
-  })
-  .describe(
-    'An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.',
-  )
+export const device_converted_to_unmanaged_event = device_event.extend({
+  event_type: z.literal('device.converted_to_unmanaged'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).
+`)
 
 export type DeviceConvertedToUnmanagedEvent = z.infer<
   typeof device_converted_to_unmanaged_event
 >
 
-export const unmanaged_device_converted_to_managed_event = device_event
-  .extend({
-    event_type: z.literal('device.unmanaged.converted_to_managed'),
-  })
-  .describe(
-    'A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
-  )
+export const unmanaged_device_converted_to_managed_event = device_event.extend({
+  event_type: z.literal('device.unmanaged.converted_to_managed'),
+}).describe(`
+  ---
+  route_path: /devices/unmanaged
+  ---
+  An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.
+`)
 
 export type UnmanagedDeviceConvertedToManagedEvent = z.infer<
   typeof unmanaged_device_converted_to_managed_event
 >
 
-export const unmanaged_device_connected_event = device_event
-  .extend({
-    event_type: z.literal('device.unmanaged.connected'),
-  })
-  .describe(
-    'The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`.',
-  )
+export const unmanaged_device_connected_event = device_event.extend({
+  event_type: z.literal('device.unmanaged.connected'),
+}).describe(`
+  ---
+  route_path: /devices/unmanaged
+  ---
+  The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from offline to online. That is, the \`device.properties.online\` property changed from \`false\` to \`true\`.
+`)
 
 export type UnmanagedDeviceConnectedEvent = z.infer<
   typeof unmanaged_device_connected_event
 >
 
-export const device_disconnected_event = device_event
-  .extend({
-    event_type: z.literal('device.disconnected'),
-    error_code: disconnection_error_code,
-  })
-  .describe(
-    'The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.',
-  )
+export const device_disconnected_event = device_event.extend({
+  event_type: z.literal('device.disconnected'),
+  error_code: disconnection_error_code,
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  The status of a [device](https://docs.seam.co/latest/core-concepts/devices) changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`.
+`)
 
 export type DeviceDisconnectedEvent = z.infer<typeof device_disconnected_event>
 
-export const unmanaged_device_disconnected_event = device_event
-  .extend({
-    event_type: z.literal('device.unmanaged.disconnected'),
-    error_code: disconnection_error_code,
-  })
-  .describe(
-    'The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.',
-  )
+export const unmanaged_device_disconnected_event = device_event.extend({
+  event_type: z.literal('device.unmanaged.disconnected'),
+  error_code: disconnection_error_code,
+}).describe(`
+  ---
+  route_path: /devices/unmanaged
+  ---
+  The status of an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) changed from online to offline. That is, the \`device.properties.online\` property changed from \`true\` to \`false\`.
+`)
 
 export type UnmanagedDeviceDisconnectedEvent = z.infer<
   typeof unmanaged_device_disconnected_event
 >
 
-export const device_tampered_event = device_event
-  .extend({
-    event_type: z.literal('device.tampered'),
-  })
-  .describe(
-    'A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.',
-  )
+export const device_tampered_event = device_event.extend({
+  event_type: z.literal('device.tampered'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [device](https://docs.seam.co/latest/core-concepts/devices) detected that it was tampered with, for example, opened or moved.
+`)
 
 export type DeviceTamperedEvent = z.infer<typeof device_tampered_event>
 
-export const device_low_battery_event = device_event
-  .extend({
-    event_type: z.literal('device.low_battery'),
-    battery_level,
-  })
-  .describe(
-    'A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.',
-  )
+export const device_low_battery_event = device_event.extend({
+  event_type: z.literal('device.low_battery'),
+  battery_level,
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [device](https://docs.seam.co/latest/core-concepts/devices) battery level dropped below the low threshold.
+`)
 
 export type DeviceLowBatteryEvent = z.infer<typeof device_low_battery_event>
 
-export const device_battery_status_changed_event = device_event
-  .extend({
-    event_type: z.literal('device.battery_status_changed'),
-    battery_status: device_battery_status,
-    battery_level,
-  })
-  .describe(
-    'A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last `battery_status_changed` event.',
-  )
+export const device_battery_status_changed_event = device_event.extend({
+  event_type: z.literal('device.battery_status_changed'),
+  battery_status: device_battery_status,
+  battery_level,
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [device](https://docs.seam.co/latest/core-concepts/devices) battery status changed since the last \`battery_status_changed\` event.
+`)
 
 export type DeviceBatteryStatusChangedEvent = z.infer<
   typeof device_battery_status_changed_event
 >
 
-export const device_removed_event = device_event
-  .extend({
-    event_type: z.literal('device.removed'),
-  })
-  .describe(
-    'A [device](https://docs.seam.co/latest/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
-  )
+export const device_removed_event = device_event.extend({
+  event_type: z.literal('device.removed'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [device](https://docs.seam.co/latest/core-concepts/devices) was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).
+`)
 
 export type DeviceRemovedEvent = z.infer<typeof device_removed_event>
 
-export const device_deleted_event = device_event
-  .extend({
-    event_type: z.literal('device.deleted'),
-  })
-  .describe(
-    'A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.',
-  )
+export const device_deleted_event = device_event.extend({
+  event_type: z.literal('device.deleted'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [device](https://docs.seam.co/latest/core-concepts/devices) was deleted.
+`)
 
 export type DeviceDeletedEvent = z.infer<typeof device_deleted_event>
 
-export const device_third_party_integration_detected_event = device_event
-  .extend({
+export const device_third_party_integration_detected_event =
+  device_event.extend({
     event_type: z.literal('device.third_party_integration_detected'),
-  })
-  .describe(
-    'Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is using a third-party integration that will interfere with Seam device management.',
-  )
+  }).describe(`
+    ---
+    route_path: /devices
+    ---
+    Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is using a third-party integration that will interfere with Seam device management.
+  `)
 
 export type DeviceThirdPartyIntegrationDetectedEvent = z.infer<
   typeof device_third_party_integration_detected_event
 >
 
 export const device_third_party_integration_no_longer_detected_event =
-  device_event
-    .extend({
-      event_type: z.literal(
-        'device.third_party_integration_no_longer_detected',
-      ),
-    })
-    .describe(
-      'Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management.',
-    )
+  device_event.extend({
+    event_type: z.literal('device.third_party_integration_no_longer_detected'),
+  }).describe(`
+    ---
+    route_path: /devices
+    ---
+    Seam detected that a [device](https://docs.seam.co/latest/core-concepts/devices) is no longer using a third-party integration that was interfering with Seam device management.
+  `)
 
 export type DeviceThirdPartyIntegrationNoLongerDetectedEvent = z.infer<
   typeof device_third_party_integration_no_longer_detected_event
 >
 
-export const device_salto_privacy_mode_activated_event = device_event
-  .extend({
-    event_type: z.literal('device.salto.privacy_mode_activated'),
-  })
-  .describe(
-    'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.',
-  )
+export const device_salto_privacy_mode_activated_event = device_event.extend({
+  event_type: z.literal('device.salto.privacy_mode_activated'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.
+`)
 
 export type DeviceSaltoPrivacyModeActivatedEvent = z.infer<
   typeof device_salto_privacy_mode_activated_event
 >
 
-export const device_salto_privacy_mode_deactivated_event = device_event
-  .extend({
-    event_type: z.literal('device.salto.privacy_mode_deactivated'),
-  })
-  .describe(
-    'A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.',
-  )
+export const device_salto_privacy_mode_deactivated_event = device_event.extend({
+  event_type: z.literal('device.salto.privacy_mode_deactivated'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.
+`)
 
 export type DeviceSaltoPrivacyModeDeactivatedEvent = z.infer<
   typeof device_salto_privacy_mode_deactivated_event
 >
 
-export const device_connection_became_flaky_event = device_event
-  .extend({
-    event_type: z.literal('device.connection_became_flaky'),
-  })
-  .describe(
-    'Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.',
-  )
+export const device_connection_became_flaky_event = device_event.extend({
+  event_type: z.literal('device.connection_became_flaky'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  Seam detected a flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection.
+`)
 
 export type DeviceConnectionBecameFlakyEvent = z.infer<
   typeof device_connection_became_flaky_event
 >
 
-export const device_connection_stabilized_event = device_event
-  .extend({
-    event_type: z.literal('device.connection_stabilized'),
-  })
-  .describe(
-    'Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.',
-  )
+export const device_connection_stabilized_event = device_event.extend({
+  event_type: z.literal('device.connection_stabilized'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  Seam detected that a previously-flaky [device](https://docs.seam.co/latest/core-concepts/devices) connection stabilized.
+`)
 
 export type DeviceConnectionStabilizedEvent = z.infer<
   typeof device_connection_stabilized_event
 >
 
-export const device_error_subscription_required_event = device_event
-  .extend({
-    event_type: z.literal('device.error.subscription_required'),
-  })
-  .describe(
-    'A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.',
-  )
+export const device_error_subscription_required_event = device_event.extend({
+  event_type: z.literal('device.error.subscription_required'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  A third-party subscription is required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.
+`)
 
 export type DeviceErrorSubscriptionRequiredEvent = z.infer<
   typeof device_error_subscription_required_event
 >
 
-export const device_error_subscription_required_resolved_event = device_event
-  .extend({
+export const device_error_subscription_required_resolved_event =
+  device_event.extend({
     event_type: z.literal('device.error.subscription_required.resolved'),
-  })
-  .describe(
-    'A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.',
-  )
+  }).describe(`
+    ---
+    route_path: /devices
+    ---
+    A third-party subscription is active or no longer required to use all [device](https://docs.seam.co/latest/core-concepts/devices) features.
+  `)
 
 export type DeviceErrorSubscriptionRequiredResolvedEvent = z.infer<
   typeof device_error_subscription_required_resolved_event
 >
 
-export const device_accessory_keypad_connected_event = device_event
-  .extend({
-    event_type: z.literal('device.accessory_keypad_connected'),
-  })
-  .describe(
-    'An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).',
-  )
+export const device_accessory_keypad_connected_event = device_event.extend({
+  event_type: z.literal('device.accessory_keypad_connected'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  An accessory keypad was connected to a [device](https://docs.seam.co/latest/core-concepts/devices).
+`)
 
 export type DeviceAccessoryKeypadConnectedEvent = z.infer<
   typeof device_accessory_keypad_connected_event
 >
 
-export const device_accessory_keypad_disconnected_event = device_event
-  .extend({
-    event_type: z.literal('device.accessory_keypad_disconnected'),
-  })
-  .describe(
-    'An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).',
-  )
+export const device_accessory_keypad_disconnected_event = device_event.extend({
+  event_type: z.literal('device.accessory_keypad_disconnected'),
+}).describe(`
+  ---
+  route_path: /devices
+  ---
+  An accessory keypad was disconnected from a [device](https://docs.seam.co/latest/core-concepts/devices).
+`)
 
 export type DeviceAccessoryKeypadDisconnectedEvent = z.infer<
   typeof device_accessory_keypad_disconnected_event
 >
 
-export const noise_sensor_noise_threshold_triggered_event = device_event
-  .extend({
+export const noise_sensor_noise_threshold_triggered_event = device_event.extend(
+  {
     event_type: z.literal('noise_sensor.noise_threshold_triggered'),
     noise_level_decibels: z
       .number()
@@ -329,110 +351,117 @@ export const noise_sensor_noise_threshold_triggered_event = device_event
       .record(z.unknown())
       .optional()
       .describe('Metadata from Minut.'),
-  })
-  .describe(
-    'Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.',
-  )
+  },
+).describe(`
+    ---
+    route_path: /noise_sensors/noise_thresholds
+    ---
+    Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.
+  `)
 
 export type NoiseSensorNoiseThresholdTriggeredEvent = z.infer<
   typeof noise_sensor_noise_threshold_triggered_event
 >
 
-export const lock_locked_event = device_event
-  .extend({
-    event_type: z.literal('lock.locked'),
-    access_code_id: z
-      .string()
-      .uuid()
-      .optional()
-      .describe(
-        'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.',
-      ),
-    action_attempt_id: z
-      .string()
-      .uuid()
-      .optional()
-      .describe(
-        'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.',
-      ),
-    method: lock_method.describe(
-      'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
+export const lock_locked_event = device_event.extend({
+  event_type: z.literal('lock.locked'),
+  access_code_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.',
     ),
-  })
-  .describe(
-    'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.',
-  )
+  action_attempt_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.',
+    ),
+  method: lock_method.describe(
+    'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
+  ),
+}).describe(`
+  ---
+  route_path: /locks
+  ---
+  A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.
+`)
 
 export type LockLockedEvent = z.infer<typeof lock_locked_event>
 
-export const lock_unlocked_event = device_event
-  .extend({
-    event_type: z.literal('lock.unlocked'),
-    access_code_id: z
-      .string()
-      .uuid()
-      .optional()
-      .describe(
-        'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.',
-      ),
-    action_attempt_id: z
-      .string()
-      .uuid()
-      .optional()
-      .describe(
-        'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.',
-      ),
-    method: lock_method.describe(
-      'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
+export const lock_unlocked_event = device_event.extend({
+  event_type: z.literal('lock.unlocked'),
+  access_code_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.',
     ),
-  })
-  .describe(
-    'A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.',
-  )
+  action_attempt_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.',
+    ),
+  method: lock_method.describe(
+    'Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
+  ),
+}).describe(`
+  ---
+  route_path: /locks
+  ---
+  A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.
+`)
 
 export type LockUnlockedEvent = z.infer<typeof lock_unlocked_event>
 
-export const lock_access_denied_event = device_event
-  .extend({
-    event_type: z.literal('lock.access_denied'),
-    access_code_id: z
-      .string()
-      .uuid()
-      .optional()
-      .describe(
-        'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.',
-      ),
-  })
-  .describe(
-    'The [lock](https://docs.seam.co/latest/capability-guides/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device.',
-  )
+export const lock_access_denied_event = device_event.extend({
+  event_type: z.literal('lock.access_denied'),
+  access_code_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.',
+    ),
+}).describe(`
+  ---
+  route_path: /locks
+  ---
+  The [lock](https://docs.seam.co/latest/capability-guides/smart-locks) denied access to a user after one or more consecutive invalid attempts to unlock the device.
+`)
 
 export type LockAccessDeniedEvent = z.infer<typeof lock_access_denied_event>
 
-export const thermostat_climate_preset_activated_event = device_event
-  .extend({
-    event_type: z.literal('thermostat.climate_preset_activated'),
-    thermostat_schedule_id: z
-      .string()
-      .uuid()
-      .nullable()
-      .describe(
-        'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.',
-      ),
-    climate_preset_key: z
-      .string()
-      .describe(
-        'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.',
-      ),
-    is_fallback_climate_preset: z
-      .boolean()
-      .describe(
-        'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
-      ),
-  })
-  .describe(
-    'A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.',
-  )
+export const thermostat_climate_preset_activated_event = device_event.extend({
+  event_type: z.literal('thermostat.climate_preset_activated'),
+  thermostat_schedule_id: z
+    .string()
+    .uuid()
+    .nullable()
+    .describe(
+      'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.',
+    ),
+  climate_preset_key: z
+    .string()
+    .describe(
+      'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.',
+    ),
+  is_fallback_climate_preset: z
+    .boolean()
+    .describe(
+      'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
+    ),
+}).describe(`
+  ---
+  route_path: /thermostats
+  ---
+  A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.
+`)
 
 export type ThermostatClimatePresetActivatedEvent = z.infer<
   typeof thermostat_climate_preset_activated_event
@@ -458,63 +487,66 @@ export const thermostat_manually_adjusted_event = device_event
       cooling_set_point_fahrenheit: true,
       heating_set_point_fahrenheit: true,
     }),
-  )
-  .describe(
-    'A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.',
-  )
+  ).describe(`
+    ---
+    route_path: /thermostats
+    ---
+    A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.
+  `)
 
 export type ThermostatManuallyAdjustedEvent = z.infer<
   typeof thermostat_manually_adjusted_event
 >
 
-export const temperature_threshold_exceeded_event = device_event
-  .extend({
-    event_type: z.literal('thermostat.temperature_threshold_exceeded'),
-    temperature_celsius: z
-      .number()
-      .describe(
-        'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
-      ),
-    temperature_fahrenheit: z
-      .number()
-      .describe(
-        'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
-      ),
-    upper_limit_celsius: z
-      .number()
-      .nullable()
-      .describe(
-        'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
-      ),
-    upper_limit_fahrenheit: z
-      .number()
-      .nullable()
-      .describe(
-        'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
-      ),
-    lower_limit_celsius: z
-      .number()
-      .nullable()
-      .describe(
-        'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
-      ),
-    lower_limit_fahrenheit: z
-      .number()
-      .nullable()
-      .describe(
-        'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
-      ),
-  })
-  .describe(
-    "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
-  )
+export const temperature_threshold_exceeded_event = device_event.extend({
+  event_type: z.literal('thermostat.temperature_threshold_exceeded'),
+  temperature_celsius: z
+    .number()
+    .describe(
+      'Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
+    ),
+  temperature_fahrenheit: z
+    .number()
+    .describe(
+      'Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
+    ),
+  upper_limit_celsius: z
+    .number()
+    .nullable()
+    .describe(
+      'Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
+    ),
+  upper_limit_fahrenheit: z
+    .number()
+    .nullable()
+    .describe(
+      'Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
+    ),
+  lower_limit_celsius: z
+    .number()
+    .nullable()
+    .describe(
+      'Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
+    ),
+  lower_limit_fahrenheit: z
+    .number()
+    .nullable()
+    .describe(
+      'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
+    ),
+}).describe(`
+  ---
+  route_path: /thermostats
+  ---
+  A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).
+`)
 
 export type TemperatureThresholdExceededEvent = z.infer<
   typeof temperature_threshold_exceeded_event
 >
 
-export const temperature_threshold_no_longer_exceeded_event = device_event
-  .extend({
+export const temperature_threshold_no_longer_exceeded_event =
+  device_event.extend({
     event_type: z.literal(
       'thermostat.temperature_threshold_no_longer_exceeded',
     ),
@@ -552,10 +584,12 @@ export const temperature_threshold_no_longer_exceeded_event = device_event
       .describe(
         'Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).',
       ),
-  })
-  .describe(
-    "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).",
-  )
+  }).describe(`
+    ---
+    route_path: /thermostats
+    ---
+    A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).
+  `)
 
 export type TemperatureThresholdNoLongerExceededEvent = z.infer<
   typeof temperature_threshold_no_longer_exceeded_event
@@ -581,7 +615,11 @@ export const temperature_reached_set_point_event = device_event.extend({
     .describe(
       "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
     ),
-})
+}).describe(`
+  ---
+  route_path: /thermostats
+  ---
+`)
 
 export type TemperatureReachedSetPointEvent = z.infer<
   typeof temperature_reached_set_point_event