@seamapi/types 1.360.0 → 1.361.0

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

@@ -24,6 +24,7 @@ export type BatteryStatus = z.infer<typeof battery_status>
 const common_device_error = z.object({
   message: z.string(),
   is_device_error: z.literal(true),
+  created_at: z.string().datetime(),
 })
 
 const error_code_description =
@@ -55,6 +56,16 @@ const device_disconnected = common_device_error
   })
   .describe('Device is disconnected')
 
+const account_disconnected = common_device_error
+  .extend({
+    error_code: z
+      .literal('account_disconnected')
+      .describe(error_code_description),
+    is_connected_account_error: z.literal(true),
+    is_device_error: z.literal(false),
+  })
+  .describe('Account is disconnected')
+
 const empty_backup_access_code_pool = common_device_error
   .extend({
     error_code: z
@@ -79,11 +90,13 @@ const august_lock_missing_bridge = common_device_error
   })
   .describe('Lock is not connected to the Seam Bridge.')
 
-const salto_site_user_limit_reached = common_device_error
+const salto_ks_subscription_limit_exceeded = common_device_error
   .extend({
     error_code: z
-      .literal('salto_site_user_limit_reached')
+      .literal('salto_ks_subscription_limit_exceeded')
       .describe(error_code_description),
+    is_connected_account_error: z.literal(true),
+    is_device_error: z.literal(false),
   })
   .describe('Salto site user limit reached.')
 
@@ -121,6 +134,8 @@ const subscription_required = common_device_error
 
 export const device_error = z
   .discriminatedUnion('error_code', [
+    account_disconnected,
+    salto_ks_subscription_limit_exceeded,
     device_offline,
     device_removed,
     hub_disconnected,
@@ -128,7 +143,6 @@ export const device_error = z
     empty_backup_access_code_pool,
     august_lock_not_authorized,
     august_lock_missing_bridge,
-    salto_site_user_limit_reached,
     ttlock_lock_not_paired_to_gateway,
     missing_device_credentials,
     auxiliary_heat_running,
@@ -138,11 +152,36 @@ export const device_error = z
 
 export type DeviceError = z.infer<typeof device_error>
 
+const device_error_map = z.object({
+  device_offline: device_offline.optional().nullable(),
+  device_removed: device_removed.optional().nullable(),
+  hub_disconnected: hub_disconnected.optional().nullable(),
+  device_disconnected: device_disconnected.optional().nullable(),
+  account_disconnected: account_disconnected.optional().nullable(),
+  empty_backup_access_code_pool: empty_backup_access_code_pool
+    .optional()
+    .nullable(),
+  august_lock_not_authorized: august_lock_not_authorized.optional().nullable(),
+  august_lock_missing_bridge: august_lock_missing_bridge.optional().nullable(),
+  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded
+    .optional()
+    .nullable(),
+  ttlock_lock_not_paired_to_gateway: ttlock_lock_not_paired_to_gateway
+    .optional()
+    .nullable(),
+  missing_device_credentials: missing_device_credentials.optional().nullable(),
+  auxiliary_heat_running: auxiliary_heat_running.optional().nullable(),
+  subscription_required: subscription_required.optional().nullable(),
+})
+
+export type DeviceErrorMap = z.infer<typeof device_error_map>
+
 const warning_code_description =
   'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
 
 const common_device_warning = z.object({
   message: z.string(),
+  created_at: z.string().datetime(),
 })
 
 const partial_backup_access_code_pool = common_device_warning
@@ -297,6 +336,47 @@ const device_warning = z.discriminatedUnion('warning_code', [
 
 export type DeviceWarning = z.infer<typeof device_warning>
 
+export const device_warning_map = z.object({
+  partial_backup_access_code_pool: partial_backup_access_code_pool
+    .optional()
+    .nullable(),
+  many_active_backup_codes: many_active_backup_codes.optional().nullable(),
+  salto_unknown_device_type: salto_unknown_device_type.optional().nullable(),
+  wyze_device_missing_gateway: wyze_device_missing_gateway
+    .optional()
+    .nullable(),
+  functional_offline_device: functional_offline_device.optional().nullable(),
+  third_party_integration_detected: third_party_integration_detected
+    .optional()
+    .nullable(),
+  nest_thermostat_in_manual_eco_mode: nest_thermostat_in_manual_eco_mode
+    .optional()
+    .nullable(),
+  ttlock_lock_gateway_unlocking_not_enabled:
+    ttlock_lock_gateway_unlocking_not_enabled.optional().nullable(),
+  ttlock_weak_gateway_signal: ttlock_weak_gateway_signal.optional().nullable(),
+  temperature_threshold_exceeded: temperature_threshold_exceeded
+    .optional()
+    .nullable(),
+  device_communication_degraded: device_communication_degraded
+    .optional()
+    .nullable(),
+  scheduled_maintenance_window: scheduled_maintenance_window
+    .optional()
+    .nullable(),
+  device_has_flaky_connection: device_has_flaky_connection
+    .extend({
+      _event_id: z.string().uuid().optional(),
+    })
+    .optional()
+    .nullable(),
+  salto_office_mode: salto_office_mode.optional().nullable(),
+  salto_privacy_mode: salto_privacy_mode.optional().nullable(),
+  unknown_issue_with_phone: unknown_issue_with_phone.optional().nullable(),
+})
+
+export type DeviceWarningMap = z.infer<typeof device_warning_map>
+
 export const common_device_properties = z.object({
   online: z.boolean().describe('Indicates whether the device is online.'),
   name: z.string().describe(`
@@ -440,6 +520,18 @@ export const common_device_properties = z.object({
     .optional(),
 })
 
+export const device_and_connected_account_error_options = [
+  ...device_error.options,
+  ...connected_account_error.options.filter(
+    (_connected_account_error) =>
+      !device_error.options.some(
+        (_device_error) =>
+          _device_error.shape.error_code.value ===
+          _connected_account_error.shape.error_code.value,
+      ),
+  ),
+]
+
 export const device = z
   .object({
     device_id: z.string().uuid().describe('Unique identifier for the device.'),
@@ -495,7 +587,14 @@ export const device = z
       .array(
         z.discriminatedUnion('error_code', [
           ...device_error.options,
-          ...connected_account_error.options,
+          ...connected_account_error.options.filter(
+            (_connected_account_error) =>
+              !device_error.options.some(
+                (_device_error) =>
+                  _device_error.shape.error_code.value ===
+                  _connected_account_error.shape.error_code.value,
+              ),
+          ),
         ]),
       )
       .describe(

package/src/lib/seam/connect/models/thermostats/climate-preset.ts

@@ -5,24 +5,36 @@ import { fan_mode_setting, hvac_mode_setting } from './modes.js'
 export const climate_preset = z.object({
   climate_preset_key: z
     .string()
-    .describe('Unique key to identify the climate preset.'),
+    .describe(
+      'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
   can_edit: z
     .boolean()
-    .describe('Indicates whether this climate preset key can be edited.'),
+    .describe(
+      'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.',
+    ),
   can_delete: z
     .boolean()
-    .describe('Indicates whether this climate preset key can be deleted.'),
+    .describe(
+      'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
+    ),
   name: z
     .string()
     .nullable()
     .default(null)
     .optional()
-    .describe('User-friendly name to identify the climate preset.'),
-  display_name: z.string().describe('Display name for the climate preset.'),
+    .describe(
+      'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
+  display_name: z
+    .string()
+    .describe(
+      'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
+    ),
   fan_mode_setting: fan_mode_setting
     .optional()
     .describe(
-      'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
+      'Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.',
     ),
   hvac_mode_setting: hvac_mode_setting
     .optional()
@@ -38,21 +50,27 @@ export const climate_preset = z.object({
   heating_set_point_celsius: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should heat (in °C).'),
+    .describe(
+      'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   cooling_set_point_fahrenheit: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should cool (in °F).'),
+    .describe(
+      'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   heating_set_point_fahrenheit: z
     .number()
     .optional()
-    .describe('Temperature to which the thermostat should heat (in °F).'),
+    .describe(
+      'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
   manual_override_allowed: z.boolean().describe(
     `
       ---
       deprecated: Use 'thermostat_schedule.is_override_allowed'
       ---
-      Indicates whether a person at the thermostat can change the thermostat's settings.`,
+      Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).`,
   ),
 })
 

package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts

@@ -4,29 +4,38 @@ export const thermostat_schedule = z.object({
   thermostat_schedule_id: z
     .string()
     .uuid()
-    .describe('ID of the thermostat schedule.'),
-  device_id: z.string().uuid().describe('ID of the desired thermostat device.'),
+    .describe(
+      'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
+    ),
+  device_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.',
+    ),
   name: z
     .string()
     .optional()
-    .describe('User-friendly name to identify the thermostat schedule.'),
+    .describe(
+      'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
+    ),
   climate_preset_key: z
     .string()
     .describe(
-      'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
+      'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
     ),
   max_override_period_minutes: z
     .number()
     .int()
     .nonnegative()
     .describe(
-      "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
+      "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
     ),
   starts_at: z
     .string()
     .datetime()
     .describe(
-      'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+      'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
     ),
   unstable_is_override_allowed: z
     .boolean()
@@ -36,27 +45,37 @@ export const thermostat_schedule = z.object({
         ---
         undocumented: Unstable
         ---
-        Indicates whether a person at the thermostat can change the thermostat's settings.`,
+        Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.`,
     ),
   ends_at: z
     .string()
     .datetime()
     .describe(
-      'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+      'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
     ),
   created_at: z
     .string()
     .datetime()
-    .describe('Date and time at which the thermostat schedule was created.'),
+    .describe(
+      'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.',
+    ),
   errors: z
     .array(
       z.object({
-        error_code: z.string(),
-        message: z.string(),
+        error_code: z
+          .string()
+          .describe(
+            'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
+          ),
+        message: z
+          .string()
+          .describe(
+            'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+          ),
       }),
     )
     .describe(
-      'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
+      'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
     ),
 }).describe(`
   ---