@kohost/api-client 3.0.0-beta.7 → 3.0.0-beta.70

package/dist/cjs/schemas/courtesy.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "courtesy.json",
+  "title": "Courtesy",
+  "description": "Any smart courtesy system",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "supportedStates": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "enum": ["privacy", "service", "none"]
+      }
+    },
+    "state": {
+      "type": "string",
+      "$ref": "#/properties/supportedStates/items"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "driver", "supportedStates", "state"]
+}

package/dist/cjs/schemas/credential.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "credential.json",
+  "title": "Credential",
+  "type": "object",
+  "required": ["type", "credential", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["verificationCode", "token", "mobileKey"]
+    },
+    "credential": {
+      "type": "string"
+    },
+    "user": {
+      "type": "string"
+    },
+    "organization": {
+      "type": "string"
+    },
+    "property": {
+      "type": "string"
+    },
+    "userAgent": {
+      "type": "string"
+    },
+    "expires": {
+      "string": "string"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    }
+  }
+}

package/dist/cjs/schemas/definitions.json

@@ -0,0 +1,217 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "definitions.json",
+  "title": "Definitions",
+  "definitions": {
+    "id": {
+      "type": "string",
+      "not": {
+        "enum": ["global", "system"]
+      }
+    },
+    "systemId": {
+      "type": "string"
+    },
+    "systemData": {
+      "type": "object"
+    },
+    "metadata": {
+      "type": "object",
+      "default": {}
+    },
+    "date": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "createdAt": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "updatedAt": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "file": {
+      "type": "object",
+      "required": ["name", "type", "data"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the file."
+        },
+        "type": {
+          "type": "string",
+          "description": "MIME type of the file (e.g. application/pdf)."
+        },
+        "data": {
+          "type": "string",
+          "description": "Base64-encoded data of the file."
+        }
+      }
+    },
+    "address": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "line1": {
+          "type": "string"
+        },
+        "line2": {
+          "type": "string"
+        },
+        "line3": {
+          "type": "string"
+        },
+        "city": {
+          "type": "string"
+        },
+        "state": {
+          "type": "string"
+        },
+        "postalCode": {
+          "type": "string"
+        },
+        "countryCode": {
+          "type": "string",
+          "minLength": 2,
+          "maxLength": 2
+        }
+      }
+    },
+    "driver": {
+      "type": "string",
+      "enum": [
+        "aws-kinesis",
+        "butler",
+        "crestron",
+        "dmp",
+        "dormakaba",
+        "dsc",
+        "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"
+      ]
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "alarm",
+        "dimmer",
+        "switch",
+        "motionSensor",
+        "windowCovering",
+        "camera",
+        "mediaSource",
+        "thermostat",
+        "lock",
+        "courtesy",
+        "gateway",
+        "tv",
+        "dvr",
+        "appleTv",
+        "discPlayer",
+        "mediaPlayer",
+        "uncontrolledDevice"
+      ]
+    },
+    "name": {
+      "type": "string"
+    },
+    "subType": {
+      "type": ["string", "null"]
+    },
+    "supportedNotifications": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "enum": [
+          "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"
+        ]
+      }
+    },
+    "notification": {
+      "type": ["object", "null"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "$ref": "#/definitions/supportedNotifications/items"
+        },
+        "timestamp": {
+          "type": "number",
+          "minimum": 1655907956593
+        },
+        "description": {
+          "type": "string"
+        }
+      }
+    },
+    "batteryLevel": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "watts": {
+      "type": "number",
+      "minimum": 0
+    },
+    "revenue": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "$ref": "definitions.json#/definitions/id"
+          },
+          "name": {
+            "type": "string"
+          },
+          "date": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "price": {
+            "type": "number"
+          }
+        }
+      }
+    }
+  }
+}

package/dist/cjs/schemas/dimmer.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "dimmer.json",
+  "title": "Dimmer",
+  "description": "Any smart dimmer",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "subType": {
+      "$ref": "definitions.json#/definitions/subType"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "level": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "level", "driver"]
+}

package/dist/cjs/schemas/discoveredDevice.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "discoveredDevice.json",
+  "title": "Discovered Device",
+  "description": "A device that has been discovered by Kohost, but not yet added to the Kohost system.",
+  "type": "object",
+  "required": ["name", "deviceId", "deviceData"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "deviceId": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "driver": {
+      "type": "string"
+    },
+    "deviceData": {
+      "type": "object"
+    },
+    "ignore": {
+      "type": "boolean"
+    }
+  }
+}

package/dist/cjs/schemas/emailMessage.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "emailMessage.json",
+  "title": "Email Message",
+  "type": "object",
+  "required": ["to", "from", "status", "subject"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "emailMessage"
+    },
+    "to": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$"
+    },
+    "from": {
+      "type": "string",
+      "pattern": ".*<[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+>.*",
+      "description": "Must be in the format of 'Sender <email@example.com>"
+    },
+    "subject": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "queued",
+        "sending",
+        "sent",
+        "deferred",
+        "delivered",
+        "undelivered",
+        "bounced",
+        "blocked",
+        "receiving",
+        "received",
+        "opened",
+        "clicked",
+        "unsubscribed",
+        "spamReport"
+      ]
+    },
+    "statusMessage": {
+      "type": "string"
+    },
+    "html": {
+      "type": "string"
+    },
+    "text": {
+      "type": "string"
+    },
+    "driver": {
+      "type": "string"
+    },
+    "appData": {
+      "type": "object"
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    }
+  }
+}

package/dist/cjs/schemas/energyReport.json

@@ -0,0 +1,86 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "energyReport.json",
+  "title": "Energy Report Hourly",
+  "description": "Hourly Report for Energy based on energy report shards",
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "roomId",
+    "first",
+    "last",
+    "consumption",
+    "totals",
+    "costPerKw"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["energyReport"],
+      "default": "energyReport"
+    },
+    "reportTime": {
+      "time": "string",
+      "enum": ["hourly", "daily", "monthly"]
+    },
+    "roomId": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "first": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "last": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "consumption": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["id", "type", "kwh"],
+        "properties": {
+          "id": {
+            "$ref": "definitions.json#/definitions/id"
+          },
+          "type": {
+            "$ref": "definitions.json#/definitions/type"
+          },
+          "kwh": {
+            "type": "number",
+            "minimum": 0
+          }
+        }
+      }
+    },
+    "totals": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["lights", "climate", "media"],
+        "properties": {
+          "lights": {
+            "type": "number",
+            "minimum": 0
+          },
+          "climate": {
+            "type": "number",
+            "minimum": 0
+          },
+          "media": {
+            "type": "number",
+            "minimum": 0
+          }
+        }
+      }
+    },
+    "costPerKw": {
+      "type": "number",
+      "minimum": 0
+    }
+  }
+}

package/dist/cjs/schemas/energyReportShard.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "energyReportShard.json",
+  "title": "Energy Report Shard",
+  "description": "Shard used for Energy Reports",
+  "type": "object",
+  "required": [
+    "id",
+    "type",
+    "roomId",
+    "first",
+    "last",
+    "data",
+    "ndata",
+    "expires"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["energyReportShard"],
+      "default": "energyReportShard"
+    },
+    "roomId": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "first": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "last": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "data": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["time", "watts", "id", "type", "value"],
+        "properties": {
+          "time": {
+            "type": ["string", "object"],
+            "format": "date-time"
+          },
+          "watts": {
+            "$ref": "definitions.json#/definitions/watts"
+          },
+          "id": {
+            "$ref": "definitions.json#/definitions/id"
+          },
+          "type": {
+            "$ref": "definitions.json#/definitions/type"
+          },
+          "value": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          }
+        }
+      }
+    },
+    "ndata": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 100000,
+      "default": 0
+    },
+    "expires": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    }
+  }
+}

package/dist/cjs/schemas/gateway.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "iotGateway.json",
+  "title": "IoT Gateway",
+  "description": "Any smart gateway that is an entrypoint for controlling devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "status": {
+      "type": "string"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "status", "driver"]
+}