@seamapi/types 1.360.0 → 1.361.0

package/lib/seam/connect/models/thermostats/climate-preset.js

@@ -3,23 +3,25 @@ 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`.'),
+        .describe('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()
         .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`.'),
@@ -30,20 +32,20 @@ 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).`),
 });
 export const climate_setting = climate_preset.partial();
 //# sourceMappingURL=climate-preset.js.map

package/lib/seam/connect/models/thermostats/climate-preset.js.map

@@ -1 +1 @@
-{"version":3,"file":"climate-preset.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/thermostats/climate-preset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEhE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,QAAQ,CAAC,4CAA4C,CAAC;IACzD,QAAQ,EAAE,CAAC;SACR,OAAO,EAAE;SACT,QAAQ,CAAC,0DAA0D,CAAC;IACvE,UAAU,EAAE,CAAC;SACV,OAAO,EAAE;SACT,QAAQ,CAAC,2DAA2D,CAAC;IACxE,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,EAAE;SACV,QAAQ,CAAC,oDAAoD,CAAC;IACjE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IACzE,gBAAgB,EAAE,gBAAgB;SAC/B,QAAQ,EAAE;SACV,QAAQ,CACP,iEAAiE,CAClE;IACH,iBAAiB,EAAE,iBAAiB;SACjC,QAAQ,EAAE;SACV,QAAQ,CACP,oLAAoL,CACrL;IACH,yBAAyB,EAAE,CAAC;SACzB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yLAAyL,CAC1L;IACH,yBAAyB,EAAE,CAAC;SACzB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,4BAA4B,EAAE,CAAC;SAC5B,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,4BAA4B,EAAE,CAAC;SAC5B,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAC3C;;;;yFAIqF,CACtF;CACF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,EAAE,CAAA"}
+{"version":3,"file":"climate-preset.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/thermostats/climate-preset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEhE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,QAAQ,CACP,+IAA+I,CAChJ;IACH,QAAQ,EAAE,CAAC;SACR,OAAO,EAAE;SACT,QAAQ,CACP,4JAA4J,CAC7J;IACH,UAAU,EAAE,CAAC;SACV,OAAO,EAAE;SACT,QAAQ,CACP,6JAA6J,CAC9J;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,EAAE;SACV,QAAQ,CACP,uJAAuJ,CACxJ;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,CACP,yIAAyI,CAC1I;IACH,gBAAgB,EAAE,gBAAgB;SAC/B,QAAQ,EAAE;SACV,QAAQ,CACP,mLAAmL,CACpL;IACH,iBAAiB,EAAE,iBAAiB;SACjC,QAAQ,EAAE;SACV,QAAQ,CACP,oLAAoL,CACrL;IACH,yBAAyB,EAAE,CAAC;SACzB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yLAAyL,CAC1L;IACH,yBAAyB,EAAE,CAAC;SACzB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yLAAyL,CAC1L;IACH,4BAA4B,EAAE,CAAC;SAC5B,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yLAAyL,CAC1L;IACH,4BAA4B,EAAE,CAAC;SAC5B,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,yLAAyL,CAC1L;IACH,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAC3C;;;;oRAIgR,CACjR;CACF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,EAAE,CAAA"}

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

@@ -20,31 +20,31 @@ export declare const thermostat_schedule: z.ZodObject<{
         error_code: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
-    created_at: string;
-    errors: {
-        message: string;
-        error_code: string;
-    }[];
     climate_preset_key: string;
     thermostat_schedule_id: string;
     device_id: string;
     max_override_period_minutes: number;
     starts_at: string;
     ends_at: string;
-    name?: string | undefined;
-    unstable_is_override_allowed?: boolean | undefined;
-}, {
     created_at: string;
     errors: {
         message: string;
         error_code: string;
     }[];
+    name?: string | undefined;
+    unstable_is_override_allowed?: boolean | undefined;
+}, {
     climate_preset_key: string;
     thermostat_schedule_id: string;
     device_id: string;
     max_override_period_minutes: number;
     starts_at: string;
     ends_at: string;
+    created_at: string;
+    errors: {
+        message: string;
+        error_code: string;
+    }[];
     name?: string | undefined;
     unstable_is_override_allowed?: boolean | undefined;
 }>;

package/lib/seam/connect/models/thermostats/thermostat-schedule.js

@@ -3,24 +3,27 @@ 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.'),
+        .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](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)."),
+        .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](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.'),
+        .describe('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()
         .optional()
@@ -28,21 +31,25 @@ 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.'),
+        .describe('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.'),
+        .describe('Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).'),
 }).describe(`
   ---
   route_path: /thermostats/schedules

package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map

@@ -1 +1 @@
-{"version":3,"file":"thermostat-schedule.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/thermostats/thermostat-schedule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,sBAAsB,EAAE,CAAC;SACtB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CAAC,gCAAgC,CAAC;IAC7C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IAC7E,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,QAAQ,CACP,kKAAkK,CACnK;IACH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,WAAW,EAAE;SACb,QAAQ,CACP,mVAAmV,CACpV;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,sIAAsI,CACvI;IACH,4BAA4B,EAAE,CAAC;SAC5B,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP;;;;2FAIqF,CACtF;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,oIAAoI,CACrI;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CACP,gZAAgZ,CACjZ;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}
+{"version":3,"file":"thermostat-schedule.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/thermostats/thermostat-schedule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,sBAAsB,EAAE,CAAC;SACtB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,wIAAwI,CACzI;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,mGAAmG,CACpG;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,iKAAiK,CAClK;IACH,kBAAkB,EAAE,CAAC;SAClB,MAAM,EAAE;SACR,QAAQ,CACP,0QAA0Q,CAC3Q;IACH,2BAA2B,EAAE,CAAC;SAC3B,MAAM,EAAE;SACR,GAAG,EAAE;SACL,WAAW,EAAE;SACb,QAAQ,CACP,sbAAsb,CACvb;IACH,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,8OAA8O,CAC/O;IACH,4BAA4B,EAAE,CAAC;SAC5B,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP;;;;wOAIkO,CACnO;IACH,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,4OAA4O,CAC7O;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,qKAAqK,CACtK;IACH,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC;aACV,MAAM,EAAE;aACR,QAAQ,CACP,oGAAoG,CACrG;QACH,OAAO,EAAE,CAAC;aACP,MAAM,EAAE;aACR,QAAQ,CACP,wGAAwG,CACzG;KACJ,CAAC,CACH;SACA,QAAQ,CACP,yJAAyJ,CAC1J;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;CAKX,CAAC,CAAA"}

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

@@ -9,8 +9,8 @@ export declare const user_identity: z.ZodObject<{
     created_at: z.ZodString;
     workspace_id: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    created_at: string;
     display_name: string;
+    created_at: string;
     workspace_id: string;
     user_identity_id: string;
     full_name: string | null;
@@ -18,8 +18,8 @@ export declare const user_identity: z.ZodObject<{
     phone_number: string | null;
     user_identity_key: string | null;
 }, {
-    created_at: string;
     display_name: string;
+    created_at: string;
     workspace_id: string;
     user_identity_id: string;
     full_name: string | null;