@seamapi/types 1.290.0 → 1.292.0

package/package.json

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

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

@@ -1,5 +1,42 @@
 import { z } from 'zod'
 
+const common_acs_encoder_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.',
+    ),
+})
+
+const error_code_description =
+  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+
+const acs_encoder_removed = common_acs_encoder_error.extend({
+  error_code: z.literal('acs_encoder_removed').describe(error_code_description),
+  _event_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the event that was created when the `acs_encoder` was removed.',
+    ),
+})
+
+const acs_encoder_error =
+  // z.union([
+  acs_encoder_removed
+    // ])
+    .describe('Error associated with the `acs_encoder`.')
+
+export const acs_encoder_error_map = z.object({
+  acs_encoder_removed: acs_encoder_removed.optional().nullable(),
+})
+
+export type AcsEncoderErrorMap = z.infer<typeof acs_encoder_error_map>
+
 export const acs_encoder = z.object({
   acs_encoder_id: z.string().uuid().describe('ID of the `acs_encoder`.'),
   acs_system_id: z
@@ -14,12 +51,9 @@ export const acs_encoder = z.object({
     .describe(
       'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
     ),
-  errors: z.array(
-    z.object({
-      error_code: z.string(),
-      message: z.string(),
-    }),
-  ),
+  errors: z
+    .array(acs_encoder_error)
+    .describe('Errors associated with the `acs_encoder`.'),
   created_at: z
     .string()
     .datetime()

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

@@ -75,6 +75,7 @@ const seam_bridge_disconnected = common_acs_system_error.extend({
   .describe(`Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
   This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
   See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`)
+
 const visionline_instance_unreachable = common_acs_system_error.extend({
   error_code: z
     .literal('visionline_instance_unreachable')
@@ -84,29 +85,36 @@ const visionline_instance_unreachable = common_acs_system_error.extend({
   For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
   See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`)
 
-const salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
-  error_code: z
-    .literal('salto_ks_subscription_limit_exceeded')
-    .describe(
-      'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
-    ),
-})
+const salto_ks_subscription_limit_exceeded = common_acs_system_error
+  .extend({
+    error_code: z
+      .literal('salto_ks_subscription_limit_exceeded')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
+  )
 
-const acs_system_disconnected = common_acs_system_error.extend({
-  error_code: z
-    .literal('acs_system_disconnected')
-    .describe(
-      'Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
-    ),
-})
+const acs_system_disconnected = common_acs_system_error
+  .extend({
+    error_code: z
+      .literal('acs_system_disconnected')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
+  )
+
+const account_disconnected = common_acs_system_error
+  .extend({
+    error_code: z
+      .literal('account_disconnected')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access.',
+  )
 
-const account_disconnected = common_acs_system_error.extend({
-  error_code: z
-    .literal('account_disconnected')
-    .describe(
-      'Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access.',
-    ),
-})
 const acs_system_error = z
   .union([
     seam_bridge_disconnected,

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

@@ -0,0 +1,28 @@
+import { z } from 'zod'
+
+import { common_acs_event } from './common.js'
+
+const acs_encoder_event = common_acs_event.extend({
+  acs_encoder_id: z.string().uuid().describe('ID of the ACS encoder.'),
+})
+
+export const acs_encoder_added_event = acs_encoder_event
+  .extend({
+    event_type: z.literal('acs_encoder.added'),
+  })
+  .describe('An ACS encoder was added.')
+
+export type AcsEncoderAddedEvent = z.infer<typeof acs_encoder_added_event>
+
+export const acs_encoder_removed_event = acs_encoder_event
+  .extend({
+    event_type: z.literal('acs_encoder.removed'),
+  })
+  .describe('An ACS encoder was removed.')
+
+export type AcsEncoderRemovedEvent = z.infer<typeof acs_encoder_removed_event>
+
+export const acs_encoder_events = [
+  acs_encoder_added_event,
+  acs_encoder_removed_event,
+] as const

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

@@ -1,4 +1,5 @@
 import { acs_credential_events } from './credentials.js'
+import { acs_encoder_events } from './encoders.js'
 import { acs_system_events } from './systems.js'
 import { acs_user_events } from './users.js'
 
@@ -6,4 +7,5 @@ export const acs_events = [
   ...acs_system_events,
   ...acs_credential_events,
   ...acs_user_events,
+  ...acs_encoder_events,
 ] as const

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

@@ -3,18 +3,55 @@ import { z } from 'zod'
 import { fan_mode_setting, hvac_mode_setting } from './modes.js'
 
 export const climate_preset = z.object({
-  climate_preset_key: z.string(),
-  can_edit: z.boolean(),
-  can_delete: z.boolean(),
-  name: z.string().nullable().default(null).optional(),
-  display_name: z.string(),
-  fan_mode_setting: fan_mode_setting.optional(),
-  hvac_mode_setting: hvac_mode_setting.optional(),
-  cooling_set_point_celsius: z.number().optional(),
-  heating_set_point_celsius: z.number().optional(),
-  cooling_set_point_fahrenheit: z.number().optional(),
-  heating_set_point_fahrenheit: z.number().optional(),
-  manual_override_allowed: z.boolean(),
+  climate_preset_key: z
+    .string()
+    .describe('Unique key to identify the climate preset.'),
+  can_edit: z
+    .boolean()
+    .describe('Indicates whether this climate preset key can be edited.'),
+  can_delete: z
+    .boolean()
+    .describe('Indicates whether this climate preset 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.'),
+  fan_mode_setting: fan_mode_setting
+    .optional()
+    .describe(
+      'Desired fan mode setting, such as `on`, `auto`, or `circulate`.',
+    ),
+  hvac_mode_setting: hvac_mode_setting
+    .optional()
+    .describe(
+      'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.',
+    ),
+  cooling_set_point_celsius: z
+    .number()
+    .optional()
+    .describe(
+      'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
+    ),
+  heating_set_point_celsius: z
+    .number()
+    .optional()
+    .describe('Temperature to which the thermostat should heat (in °C).'),
+  cooling_set_point_fahrenheit: z
+    .number()
+    .optional()
+    .describe('Temperature to which the thermostat should cool (in °F).'),
+  heating_set_point_fahrenheit: z
+    .number()
+    .optional()
+    .describe('Temperature to which the thermostat should heat (in °F).'),
+  manual_override_allowed: z
+    .boolean()
+    .describe(
+      "Indicates whether a person at the thermostat can change the thermostat's settings.",
+    ),
 })
 
 export type ClimatePreset = z.infer<typeof climate_preset>

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

@@ -1,18 +1,47 @@
 import { z } from 'zod'
 
 export const thermostat_schedule = z.object({
-  thermostat_schedule_id: z.string().uuid(),
-  device_id: z.string().uuid(),
-  name: z.string().optional(),
-  climate_preset_key: z.string(),
-  max_override_period_minutes: z.number().int().nonnegative(),
-  starts_at: z.string().datetime(),
-  ends_at: z.string().datetime(),
-  created_at: z.string().datetime(),
+  thermostat_schedule_id: z
+    .string()
+    .uuid()
+    .describe('ID of the climate schedule.'),
+  device_id: z.string().uuid().describe('ID of the desired thermostat device.'),
+  name: z
+    .string()
+    .optional()
+    .describe('User-friendly name to identify the climate schedule.'),
+  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 climate schedule.',
+    ),
+  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-climate-schedules#specifying-manual-override-permissions).",
+    ),
+  starts_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+    ),
+  ends_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the climate schedule 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 climate schedule was created.'),
   errors: z
     .any()
     .describe(
-      'Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
+      'Array of errors associated with the climate 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.',
     ),
 })