@kohost/api-client 3.0.0-beta.53 → 3.0.0-beta.55

package/dist/cjs/schemas/RoomSchema.d.ts

@@ -0,0 +1,1035 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export type SupportedNotifications = (
+  | "button 1"
+  | "button 2"
+  | "button 3"
+  | "button 4"
+  | "button 5"
+  | "idle"
+  | "powerHasBeedApplied"
+  | "acMainsDisconnected"
+  | "acMainsReconnected"
+  | "replaceBatterySoon"
+  | "replaceBatteryNow"
+  | "hardwareFailure"
+  | "softwareFailure"
+  | "hardwareFailureWithCode"
+  | "softwareFailureWithCode"
+  | "motionDetection"
+  | "airFilterNeedsCleaned"
+  | "smokeDetected"
+  | "outsideSafeTemperatureRange"
+  | "outsideSafeHumidityRange"
+)[];
+export type Notification = {
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} & ({
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} | null);
+export type CreatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+export type UpdatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+
+/**
+ * A room represents a physical space of controllable IoT devices
+ */
+export interface Room {
+  id?: string;
+  name?: string;
+  floor?: string;
+  dimmers?: Dimmer[];
+  switches?: Switch[];
+  thermostats?: Thermostat[];
+  locks?: Lock[];
+  windowCoverings?: WindowCovering[];
+  courtesy?: Courtesy[];
+  cameras?: Camera[];
+  mediaSources?: MediaSource[];
+  motionSensors?: MotionSensor[];
+  alarms?: Alarm[];
+  occupiedAt?: CreatedAt;
+  createdAt?: CreatedAt;
+  updatedAt?: UpdatedAt;
+}
+/**
+ * Any smart dimmer
+ */
+export interface Dimmer {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  subType?: string | null;
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  level: number;
+  systemData: SystemData;
+  watts?: number;
+}
+export interface SystemData {
+  [k: string]: unknown;
+}
+/**
+ * Any smart switch
+ */
+export interface Switch {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  subType?: string | null;
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  state: "on" | "off";
+  systemData: SystemData;
+  watts?: number;
+}
+/**
+ * Any smart thermostat
+ */
+export interface Thermostat {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  currentTemperature?: number;
+  currentHumidity?: number;
+  hvacMode: "cool" | "heat" | "auto" | "off";
+  hvacState: "cooling" | "heating" | "off" | null;
+  fanMode: "auto" | "low" | "medium" | "high" | "off" | "on";
+  fanState: "off" | "low" | "medium" | "high" | "on" | null;
+  temperatureScale: "celsius" | "fahrenheit";
+  humidityScale?: "absolute" | "relative" | null;
+  /**
+   * @minItems 2
+   */
+  supportedHvacModes: [
+    "cool" | "heat" | "auto" | "off",
+    "cool" | "heat" | "auto" | "off",
+    ...("cool" | "heat" | "auto" | "off")[]
+  ];
+  supportedFanModes: ("auto" | "low" | "medium" | "high" | "off" | "on")[];
+  setpoints: {
+    cool?: Setpoint;
+    heat?: Setpoint;
+    auto?: Setpoint;
+  };
+  minAutoDelta?: number;
+  cycleRate?: number;
+  batteryLevel?: number;
+  systemData: SystemData1;
+  watts?: number;
+}
+export interface Setpoint {
+  value?: number;
+  min?: number | null;
+  max?: number | null;
+}
+export interface SystemData1 {
+  [k: string]: unknown;
+}
+/**
+ * Any smart lock
+ */
+export interface Lock {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  offline?: boolean;
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  state: "locked" | "unlocked" | null;
+  batteryLevel?: number;
+  systemData: SystemData;
+  watts?: number;
+}
+/**
+ * Any smart window covering
+ */
+export interface WindowCovering {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  position: number;
+  systemData: SystemData;
+  watts?: number;
+}
+/**
+ * Any smart courtesy system
+ */
+export interface Courtesy {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  supportedStates: ("privacy" | "service" | "none")[];
+  state: "privacy" | "service" | "none";
+  systemData?: SystemData;
+  watts?: number;
+}
+/**
+ * Any smart camera
+ */
+export interface Camera {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  liveStreams?: {
+    iframe?: string | null;
+    hls?: string | null;
+    webRTC?: string | null;
+  };
+  systemData: SystemData;
+  watts?: number;
+}
+/**
+ * Any media source
+ */
+export interface MediaSource {
+  id: string;
+  type: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "uncontrolledDevice";
+  name?: string;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  audio: boolean;
+  video: boolean;
+  powerFeedback?: boolean;
+  volumeFeedback?: boolean;
+  muted?: boolean;
+  volume?: number;
+  power?: "on" | "off";
+  input?: string;
+  supportedInputs?: string[];
+  command?:
+    | (
+        | "mute"
+        | "volumeUp"
+        | "volumeDown"
+        | "channelUp"
+        | "channelDown"
+        | "number0"
+        | "number1"
+        | "number2"
+        | "number3"
+        | "number4"
+        | "number5"
+        | "number6"
+        | "number7"
+        | "number8"
+        | "number9"
+        | "lastChannel"
+        | "display"
+        | "favoriteChannel"
+        | "play"
+        | "stop"
+        | "pause"
+        | "fastForward"
+        | "rewind"
+        | "instantReplay"
+        | "record"
+        | "ac3"
+        | "pvrMenu"
+        | "guide"
+        | "menu"
+        | "menuUp"
+        | "menuDown"
+        | "menuLeft"
+        | "menuRight"
+        | "pageUp"
+        | "pageDown"
+        | "select"
+        | "exit"
+        | "input"
+        | "power"
+        | "enterChannel"
+        | "enterVolume"
+        | "number10"
+        | "number11"
+        | "number12"
+        | "number13"
+        | "number14"
+        | "number15"
+        | "number16"
+        | "number10Plus"
+        | "number20Plus"
+        | "number100"
+        | "dash"
+        | "threeChan"
+        | "threeD"
+        | "sixChan"
+        | "a"
+        | "add"
+        | "alarm"
+        | "am"
+        | "analog"
+        | "angle"
+        | "antenna"
+        | "antennaEast"
+        | "antennaWest"
+        | "aspect"
+        | "audio1"
+        | "audio2"
+        | "audio3"
+        | "audioDumming"
+        | "audioLevelDown"
+        | "audioLevelUp"
+        | "b"
+        | "back"
+        | "c"
+        | "component1"
+        | "component2"
+        | "component3"
+        | "d"
+        | "home"
+        | "list"
+        | "liveTv"
+        | "discreteInputCable"
+        | "powerOff"
+        | "powerOn"
+        | "setupMenu"
+        | "skipForward"
+        | "skipReverse"
+        | "video1"
+        | "video2"
+        | "video3"
+        | "video4"
+        | "video5"
+        | "details"
+        | "hdmi1"
+        | "hdmi2"
+        | "hdmi3"
+        | "cecDeviceList"
+        | "mtsSap"
+        | "red"
+        | "green"
+        | "yellow"
+        | "blue"
+        | "alert"
+      )
+    | null;
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  systemData: SystemData;
+  watts?: number;
+}
+/**
+ * Any smart motion sensor
+ */
+export interface MotionSensor {
+  id: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  systemData: SystemData;
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  watts?: number;
+}
+/**
+ * Any smart alarm system
+ */
+export interface Alarm {
+  id: string;
+  name?: string;
+  offline?: boolean;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  systemData: SystemData;
+  supportedNotifications?: SupportedNotifications;
+  notification?: {
+    name?:
+      | "button 1"
+      | "button 2"
+      | "button 3"
+      | "button 4"
+      | "button 5"
+      | "idle"
+      | "powerHasBeedApplied"
+      | "acMainsDisconnected"
+      | "acMainsReconnected"
+      | "replaceBatterySoon"
+      | "replaceBatteryNow"
+      | "hardwareFailure"
+      | "softwareFailure"
+      | "hardwareFailureWithCode"
+      | "softwareFailureWithCode"
+      | "motionDetection"
+      | "airFilterNeedsCleaned"
+      | "smokeDetected"
+      | "outsideSafeTemperatureRange"
+      | "outsideSafeHumidityRange";
+    timestamp?: number;
+    description?: string;
+    [k: string]: unknown;
+  } | null;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  areas: {
+    number?: number;
+    name?: string;
+    securityMode?: "arming" | "disarming" | "armed" | "disarmed" | "alarm" | null;
+    readyToArm?: boolean | null;
+  }[];
+  zones: {
+    number?: number;
+    name?: string;
+    secure?: boolean;
+    bypassed?: boolean | null;
+  }[];
+  watts?: number;
+}