@seamapi/types 0.17.0 → 0.19.0

package/lib/seam/connect/unstable/models/capability-properties/thermostat.d.ts

@@ -0,0 +1,302 @@
+import { z } from 'zod';
+export declare const climate_setting: z.ZodObject<{
+    automatic_heating_enabled: z.ZodBoolean;
+    automatic_cooling_enabled: z.ZodBoolean;
+    hvac_mode_setting: z.ZodEnum<["off", "heat", "cool", "heatcool"]>;
+    cooling_set_point_celsius: z.ZodOptional<z.ZodNumber>;
+    heating_set_point_celsius: z.ZodOptional<z.ZodNumber>;
+    cooling_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
+    heating_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
+    manual_override_allowed: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    automatic_heating_enabled: boolean;
+    automatic_cooling_enabled: boolean;
+    hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+    manual_override_allowed: boolean;
+    cooling_set_point_celsius?: number | undefined;
+    heating_set_point_celsius?: number | undefined;
+    cooling_set_point_fahrenheit?: number | undefined;
+    heating_set_point_fahrenheit?: number | undefined;
+}, {
+    automatic_heating_enabled: boolean;
+    automatic_cooling_enabled: boolean;
+    hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+    manual_override_allowed: boolean;
+    cooling_set_point_celsius?: number | undefined;
+    heating_set_point_celsius?: number | undefined;
+    cooling_set_point_fahrenheit?: number | undefined;
+    heating_set_point_fahrenheit?: number | undefined;
+}>;
+export type ClimateSetting = z.infer<typeof climate_setting>;
+export declare const climate_setting_schedule: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    created_at: z.ZodString;
+    climate_setting_schedule_id: z.ZodString;
+    schedule_type: z.ZodLiteral<"time_bound">;
+    device_id: z.ZodString;
+    schedule_starts_at: z.ZodString;
+    schedule_ends_at: z.ZodString;
+    automatic_heating_enabled: z.ZodOptional<z.ZodBoolean>;
+    automatic_cooling_enabled: z.ZodOptional<z.ZodBoolean>;
+    hvac_mode_setting: z.ZodOptional<z.ZodEnum<["off", "heat", "cool", "heatcool"]>>;
+    cooling_set_point_celsius: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    heating_set_point_celsius: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    cooling_set_point_fahrenheit: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    heating_set_point_fahrenheit: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+    manual_override_allowed: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    created_at: string;
+    climate_setting_schedule_id: string;
+    schedule_type: "time_bound";
+    device_id: string;
+    schedule_starts_at: string;
+    schedule_ends_at: string;
+    name?: string | undefined;
+    automatic_heating_enabled?: boolean | undefined;
+    automatic_cooling_enabled?: boolean | undefined;
+    hvac_mode_setting?: "off" | "heat" | "cool" | "heatcool" | undefined;
+    cooling_set_point_celsius?: number | undefined;
+    heating_set_point_celsius?: number | undefined;
+    cooling_set_point_fahrenheit?: number | undefined;
+    heating_set_point_fahrenheit?: number | undefined;
+    manual_override_allowed?: boolean | undefined;
+}, {
+    created_at: string;
+    climate_setting_schedule_id: string;
+    schedule_type: "time_bound";
+    device_id: string;
+    schedule_starts_at: string;
+    schedule_ends_at: string;
+    name?: string | undefined;
+    automatic_heating_enabled?: boolean | undefined;
+    automatic_cooling_enabled?: boolean | undefined;
+    hvac_mode_setting?: "off" | "heat" | "cool" | "heatcool" | undefined;
+    cooling_set_point_celsius?: number | undefined;
+    heating_set_point_celsius?: number | undefined;
+    cooling_set_point_fahrenheit?: number | undefined;
+    heating_set_point_fahrenheit?: number | undefined;
+    manual_override_allowed?: boolean | undefined;
+}>;
+export declare const hvac_mode_setting: z.ZodEnum<["off", "heat", "cool", "heatcool"]>;
+export declare const thermostat_capability_properties: z.ZodObject<{
+    temperature_fahrenheit: z.ZodNumber;
+    temperature_celsius: z.ZodNumber;
+    relative_humidity: z.ZodNumber;
+    can_enable_automatic_heating: z.ZodBoolean;
+    can_enable_automatic_cooling: z.ZodBoolean;
+    available_hvac_mode_settings: z.ZodArray<z.ZodEnum<["off", "heat", "cool", "heatcool"]>, "many">;
+    is_heating: z.ZodBoolean;
+    is_cooling: z.ZodBoolean;
+    is_fan_running: z.ZodBoolean;
+    /**
+     * 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.ZodBoolean;
+    /**
+     * can be derived from `default_climate_setting`, or `active_climate_setting_schedule` if one is active
+     */
+    current_climate_setting: z.ZodObject<{
+        automatic_heating_enabled: z.ZodBoolean;
+        automatic_cooling_enabled: z.ZodBoolean;
+        hvac_mode_setting: z.ZodEnum<["off", "heat", "cool", "heatcool"]>;
+        cooling_set_point_celsius: z.ZodOptional<z.ZodNumber>;
+        heating_set_point_celsius: z.ZodOptional<z.ZodNumber>;
+        cooling_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
+        heating_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
+        manual_override_allowed: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    }, {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    }>;
+    default_climate_setting: z.ZodOptional<z.ZodObject<{
+        automatic_heating_enabled: z.ZodBoolean;
+        automatic_cooling_enabled: z.ZodBoolean;
+        hvac_mode_setting: z.ZodEnum<["off", "heat", "cool", "heatcool"]>;
+        cooling_set_point_celsius: z.ZodOptional<z.ZodNumber>;
+        heating_set_point_celsius: z.ZodOptional<z.ZodNumber>;
+        cooling_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
+        heating_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
+        manual_override_allowed: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    }, {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    }>>;
+    is_climate_setting_schedule_active: z.ZodBoolean;
+    active_climate_setting_schedule: z.ZodOptional<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        created_at: z.ZodString;
+        climate_setting_schedule_id: z.ZodString;
+        schedule_type: z.ZodLiteral<"time_bound">;
+        device_id: z.ZodString;
+        schedule_starts_at: z.ZodString;
+        schedule_ends_at: z.ZodString;
+        automatic_heating_enabled: z.ZodOptional<z.ZodBoolean>;
+        automatic_cooling_enabled: z.ZodOptional<z.ZodBoolean>;
+        hvac_mode_setting: z.ZodOptional<z.ZodEnum<["off", "heat", "cool", "heatcool"]>>;
+        cooling_set_point_celsius: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+        heating_set_point_celsius: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+        cooling_set_point_fahrenheit: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+        heating_set_point_fahrenheit: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
+        manual_override_allowed: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        created_at: string;
+        climate_setting_schedule_id: string;
+        schedule_type: "time_bound";
+        device_id: string;
+        schedule_starts_at: string;
+        schedule_ends_at: string;
+        name?: string | undefined;
+        automatic_heating_enabled?: boolean | undefined;
+        automatic_cooling_enabled?: boolean | undefined;
+        hvac_mode_setting?: "off" | "heat" | "cool" | "heatcool" | undefined;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+        manual_override_allowed?: boolean | undefined;
+    }, {
+        created_at: string;
+        climate_setting_schedule_id: string;
+        schedule_type: "time_bound";
+        device_id: string;
+        schedule_starts_at: string;
+        schedule_ends_at: string;
+        name?: string | undefined;
+        automatic_heating_enabled?: boolean | undefined;
+        automatic_cooling_enabled?: boolean | undefined;
+        hvac_mode_setting?: "off" | "heat" | "cool" | "heatcool" | undefined;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+        manual_override_allowed?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    temperature_fahrenheit: number;
+    temperature_celsius: number;
+    relative_humidity: number;
+    can_enable_automatic_heating: boolean;
+    can_enable_automatic_cooling: boolean;
+    available_hvac_mode_settings: ("off" | "heat" | "cool" | "heatcool")[];
+    is_heating: boolean;
+    is_cooling: boolean;
+    is_fan_running: boolean;
+    is_temporary_manual_override_active: boolean;
+    current_climate_setting: {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    };
+    is_climate_setting_schedule_active: boolean;
+    default_climate_setting?: {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    } | undefined;
+    active_climate_setting_schedule?: {
+        created_at: string;
+        climate_setting_schedule_id: string;
+        schedule_type: "time_bound";
+        device_id: string;
+        schedule_starts_at: string;
+        schedule_ends_at: string;
+        name?: string | undefined;
+        automatic_heating_enabled?: boolean | undefined;
+        automatic_cooling_enabled?: boolean | undefined;
+        hvac_mode_setting?: "off" | "heat" | "cool" | "heatcool" | undefined;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+        manual_override_allowed?: boolean | undefined;
+    } | undefined;
+}, {
+    temperature_fahrenheit: number;
+    temperature_celsius: number;
+    relative_humidity: number;
+    can_enable_automatic_heating: boolean;
+    can_enable_automatic_cooling: boolean;
+    available_hvac_mode_settings: ("off" | "heat" | "cool" | "heatcool")[];
+    is_heating: boolean;
+    is_cooling: boolean;
+    is_fan_running: boolean;
+    is_temporary_manual_override_active: boolean;
+    current_climate_setting: {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    };
+    is_climate_setting_schedule_active: boolean;
+    default_climate_setting?: {
+        automatic_heating_enabled: boolean;
+        automatic_cooling_enabled: boolean;
+        hvac_mode_setting: "off" | "heat" | "cool" | "heatcool";
+        manual_override_allowed: boolean;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+    } | undefined;
+    active_climate_setting_schedule?: {
+        created_at: string;
+        climate_setting_schedule_id: string;
+        schedule_type: "time_bound";
+        device_id: string;
+        schedule_starts_at: string;
+        schedule_ends_at: string;
+        name?: string | undefined;
+        automatic_heating_enabled?: boolean | undefined;
+        automatic_cooling_enabled?: boolean | undefined;
+        hvac_mode_setting?: "off" | "heat" | "cool" | "heatcool" | undefined;
+        cooling_set_point_celsius?: number | undefined;
+        heating_set_point_celsius?: number | undefined;
+        cooling_set_point_fahrenheit?: number | undefined;
+        heating_set_point_fahrenheit?: number | undefined;
+        manual_override_allowed?: boolean | undefined;
+    } | undefined;
+}>;

package/lib/seam/connect/unstable/models/capability-properties/thermostat.js

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+export const climate_setting = z.object({
+    automatic_heating_enabled: z.boolean(),
+    automatic_cooling_enabled: z.boolean(),
+    hvac_mode_setting: z.enum(['off', 'heat', 'cool', 'heatcool']),
+    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(),
+});
+export const climate_setting_schedule = z
+    .object({
+    climate_setting_schedule_id: z.string().uuid(),
+    schedule_type: z.literal('time_bound'),
+    device_id: z.string(),
+    name: z.string().optional(),
+    schedule_starts_at: z.string(),
+    schedule_ends_at: z.string(),
+    created_at: z.string().datetime(),
+})
+    .merge(climate_setting.partial());
+export const hvac_mode_setting = z.enum(['off', 'heat', 'cool', 'heatcool']);
+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(),
+    /**
+     * 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(),
+});
+//# sourceMappingURL=thermostat.js.map

package/lib/seam/connect/unstable/models/capability-properties/thermostat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"thermostat.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/unstable/models/capability-properties/thermostat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,yBAAyB,EAAE,CAAC,CAAC,OAAO,EAAE;IACtC,yBAAyB,EAAE,CAAC,CAAC,OAAO,EAAE;IACtC,iBAAiB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAC9D,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,yBAAyB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,4BAA4B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnD,4BAA4B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnD,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE;CACrC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,2BAA2B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAC9C,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IACtC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC9B,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC;KACD,KAAK,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,CAAA;AAEnC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAA;AAE5E,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE;IAClC,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,4BAA4B,EAAE,CAAC,CAAC,OAAO,EAAE;IACzC,4BAA4B,EAAE,CAAC,CAAC,OAAO,EAAE;IACzC,4BAA4B,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;IACxD,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE;IAE3B;;OAEG;IACH,mCAAmC,EAAE,CAAC,CAAC,OAAO,EAAE;IAEhD;;OAEG;IACH,uBAAuB,EAAE,eAAe;IACxC,uBAAuB,EAAE,eAAe,CAAC,QAAQ,EAAE;IACnD,kCAAkC,EAAE,CAAC,CAAC,OAAO,EAAE;IAC/C,+BAA+B,EAAE,wBAAwB,CAAC,QAAQ,EAAE;CACrE,CAAC,CAAA"}