@seamapi/types 1.222.0 → 1.224.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.222.0",
+  "version": "1.224.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -92,7 +92,7 @@
     "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^0.12.0",
+    "@seamapi/blueprint": "^0.13.0",
     "@types/node": "^20.8.10",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",

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

@@ -73,8 +73,20 @@ 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_site_user_limit_reached = common_acs_system_error.extend({
+  error_code: z
+    .literal('salto_site_user_limit_reached')
+    .describe(
+      'You have reached the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
+    ),
+})
+
 const acs_system_error = z
-  .union([seam_bridge_disconnected, visionline_instance_unreachable])
+  .union([
+    seam_bridge_disconnected,
+    visionline_instance_unreachable,
+    salto_site_user_limit_reached,
+  ])
   .describe('Error associated with the `acs_system`.')
 
 const acs_system_error_map = z.object({
@@ -82,13 +94,44 @@ const acs_system_error_map = z.object({
   visionline_instance_unreachable: visionline_instance_unreachable
     .optional()
     .nullable(),
+  salto_site_user_limit_reached: salto_site_user_limit_reached
+    .optional()
+    .nullable(),
 })
 
 export type AcsSystemErrorMap = z.infer<typeof acs_system_error_map>
 
-const acs_system_warning = z.object({})
+const common_acs_system_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.',
+    ),
+})
+
+const salto_site_user_limit_almost_reached = common_acs_system_warning.extend({
+  warning_code: z
+    .literal('salto_site_user_limit_almost_reached')
+    .describe(
+      'You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
+    ),
+})
+
+const acs_system_warning =
+  // z.union([
+  salto_site_user_limit_almost_reached
+    // ])
+    .describe('Warning associated with the `acs_system`.')
 
-const acs_system_warning_map = z.object({})
+const acs_system_warning_map = z.object({
+  salto_site_user_limit_almost_reached: salto_site_user_limit_almost_reached
+    .optional()
+    .nullable(),
+})
 
 export type AcsSystemWarningMap = z.infer<typeof acs_system_warning_map>
 
@@ -150,13 +193,9 @@ export const acs_system = z
     errors: z
       .array(acs_system_error)
       .describe('Errors associated with the `acs_system`.'),
-    warnings: z.array(acs_system_warning).describe(
-      `
-          ---
-          undocumented: Currently, no warnings defined for \`acs_system\`s.
-          ---
-          `,
-    ),
+    warnings: z
+      .array(acs_system_warning)
+      .describe('Warnings associated with the `acs_system`.'),
   })
   .merge(acs_system_capability_flags)
   .describe(

package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts

@@ -7,70 +7,40 @@ import {
   hvac_mode_setting,
 } from '../../thermostats/index.js'
 
-const base_thermostat_capability_properties = z.object({
-  temperature_fahrenheit: z.number(),
-  temperature_celsius: z.number(),
-  relative_humidity: z.number().min(0).max(1),
-  can_enable_automatic_heating: z.boolean(),
-  can_enable_automatic_cooling: z.boolean(),
-  available_hvac_mode_settings: z.array(hvac_mode_setting),
-  is_heating_available: z.literal(false),
-  is_cooling_available: z.literal(false),
-  is_heating: z.boolean(),
-  is_cooling: z.boolean(),
-  is_fan_running: z.boolean(),
-  fan_mode_setting,
-
-  /**
-   * this is true if the current thermostat settings differ that what is on seam, and `current_climate_setting.manual_override_allowed: true`
-   */
-  is_temporary_manual_override_active: z.boolean(),
-
-  /**
-   * can be derived from `default_climate_setting`, or `active_climate_setting_schedule` if one is active
-   */
-  current_climate_setting: climate_setting,
-  default_climate_setting: climate_setting.optional(),
-  is_climate_setting_schedule_active: z.boolean(),
-  active_climate_setting_schedule: climate_setting_schedule.optional(),
-})
-
-export const cooling_thermostat_capability_properties =
-  base_thermostat_capability_properties.merge(
-    z.object({
-      min_cooling_set_point_celsius: z.number(),
-      min_cooling_set_point_fahrenheit: z.number(),
-      max_cooling_set_point_celsius: z.number(),
-      max_cooling_set_point_fahrenheit: z.number(),
-      is_cooling_available: z.literal(true),
-    }),
-  )
-
-export const heating_thermostat_capability_properties =
-  base_thermostat_capability_properties.merge(
-    z.object({
-      min_heating_set_point_celsius: z.number(),
-      min_heating_set_point_fahrenheit: z.number(),
-      max_heating_set_point_celsius: z.number(),
-      max_heating_set_point_fahrenheit: z.number(),
-      is_heating_available: z.literal(true),
-    }),
-  )
-
-export const heating_cooling_thermostat_capability_properties =
-  cooling_thermostat_capability_properties
-    .merge(heating_thermostat_capability_properties)
-    .merge(
-      z.object({
-        is_cooling_available: z.literal(true),
-        is_heating_available: z.literal(true),
-        min_heating_cooling_delta_celsius: z.number(),
-        min_heating_cooling_delta_fahrenheit: z.number(),
-      }),
-    )
-
-export const thermostat_capability_properties = z.union([
-  heating_cooling_thermostat_capability_properties.partial(),
-  heating_thermostat_capability_properties.partial(),
-  cooling_thermostat_capability_properties.partial(),
-])
+export const thermostat_capability_properties = z
+  .object({
+    temperature_fahrenheit: z.number(),
+    temperature_celsius: z.number(),
+    relative_humidity: z.number().min(0).max(1),
+    can_enable_automatic_heating: z.boolean(),
+    can_enable_automatic_cooling: z.boolean(),
+    available_hvac_mode_settings: z.array(hvac_mode_setting),
+    is_heating: z.boolean(),
+    is_cooling: z.boolean(),
+    is_fan_running: z.boolean(),
+    fan_mode_setting,
+
+    /**
+     * this is true if the current thermostat settings differ that what is on seam, and `current_climate_setting.manual_override_allowed: true`
+     */
+    is_temporary_manual_override_active: z.boolean(),
+
+    /**
+     * can be derived from `default_climate_setting`, or `active_climate_setting_schedule` if one is active
+     */
+    current_climate_setting: climate_setting,
+    default_climate_setting: climate_setting,
+    is_climate_setting_schedule_active: z.boolean(),
+    active_climate_setting_schedule: climate_setting_schedule,
+    min_cooling_set_point_celsius: z.number(),
+    min_cooling_set_point_fahrenheit: z.number(),
+    max_cooling_set_point_celsius: z.number(),
+    max_cooling_set_point_fahrenheit: z.number(),
+    min_heating_set_point_celsius: z.number(),
+    min_heating_set_point_fahrenheit: z.number(),
+    max_heating_set_point_celsius: z.number(),
+    max_heating_set_point_fahrenheit: z.number(),
+    min_heating_cooling_delta_celsius: z.number(),
+    min_heating_cooling_delta_fahrenheit: z.number(),
+  })
+  .partial()