@kohost/api-client 3.0.0-beta.5 → 3.0.0-beta.51

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"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "status", "driver"]
+}

package/dist/cjs/schemas/identification.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "identification.json",
+  "title": "Identification",
+  "type": "object",
+  "required": ["type"],
+  "oneOf": [
+    {
+      "required": ["number"]
+    },
+    {
+      "required": ["encryptedNumber"]
+    }
+  ],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["driversLicense", "passport", "identityCard", "visa"]
+    },
+    "number": {
+      "string": "string"
+    },
+    "maskedNumber": {
+      "string": "string"
+    },
+    "encryptedNumber": {
+      "string": "string"
+    },
+    "issued": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "expires": {
+      "type": ["string", "object", "null"],
+      "format": "date-time"
+    },
+    "verified": {
+      "type": "boolean"
+    },
+    "matched": {
+      "type": "boolean"
+    },
+    "firstName": {
+      "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
+    "issuingCountry": {
+      "string": "string",
+      "minLength": 2,
+      "maxLength": 2
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}

package/dist/cjs/schemas/lock.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "lock.json",
+  "title": "Lock",
+  "description": "Any smart lock",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "state": {
+      "type": ["string", "null"],
+      "enum": ["locked", "unlocked", null]
+    },
+    "batteryLevel": {
+      "$ref": "definitions.json#/definitions/batteryLevel"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "state", "driver"]
+}

package/dist/cjs/schemas/mediaFile.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "mediaFile.json",
+  "title": "Media File",
+  "description": "Any media file",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "mediaFile"
+    },
+    "fileHash": {
+      "type": "string"
+    },
+    "mimeType": {
+      "type": "string",
+      "enum": [
+        "image/*",
+        "image/jpeg",
+        "image/png",
+        "image/gif",
+        "image/webp",
+        "image/avif",
+        "image/svg+xml",
+        "application/pdf"
+      ]
+    },
+    "data": {
+      "type": "string"
+    },
+    "url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "width": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "height": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "size": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Size in bytes"
+    },
+    "uploadUrl": {
+      "type": "string",
+      "format": "uri"
+    },
+    "uploadUrlExpires": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "createdBy": {
+      "type": "string"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type"]
+}

package/dist/cjs/schemas/mediaSource.json

@@ -0,0 +1,184 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "mediaSource.json",
+  "title": "Media Source",
+  "description": "Any media source",
+  "type": "object",
+  "required": ["id", "type", "systemData", "audio", "video", "driver"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "tv",
+        "dvr",
+        "appleTv",
+        "discPlayer",
+        "mediaPlayer",
+        "uncontrolledDevice"
+      ]
+    },
+    "name": {
+      "$ref": "definitions.json#/definitions/name"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "audio": {
+      "type": "boolean"
+    },
+    "video": {
+      "type": "boolean"
+    },
+    "powerFeedback": {
+      "type": "boolean"
+    },
+    "volumeFeedback": {
+      "type": "boolean"
+    },
+    "muted": {
+      "type": "boolean"
+    },
+    "volume": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "power": {
+      "type": "string",
+      "enum": ["on", "off"]
+    },
+    "input": {
+      "type": "string"
+    },
+    "supportedInputs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "command": {
+      "type": ["string", "null"],
+      "enum": [
+        "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"
+      ]
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false
+}

package/dist/cjs/schemas/motionSensor.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "motionSensor.json",
+  "title": "Motion Sensor",
+  "description": "Any smart motion sensor",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "driver"]
+}

package/dist/cjs/schemas/organization.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "organization.json",
+  "title": "Organization",
+  "type": "object",
+  "description": "An organization is a group or entity that subscribes to Kohost software.",
+  "required": ["accountNumber", "name"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "accountNumber": {
+      "type": "number",
+      "minimum": 10000
+    },
+    "name": {
+      "type": "string"
+    },
+    "properties": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "credentials": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/updatedAt"
+    }
+  }
+}

package/dist/cjs/schemas/payment.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "payment.json",
+  "title": "Payment",
+  "type": "object",
+  "required": ["type", "maskedNumber", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "amex",
+        "visa",
+        "masterCard",
+        "maestro",
+        "discover",
+        "diners",
+        "jcb",
+        "applePay",
+        "alipay",
+        "chinaUnionPay",
+        "vpay"
+      ]
+    },
+    "enabled": {
+      "type": "boolean",
+      "default": true
+    },
+    "storageData": {
+      "type": ["string", "null"]
+    },
+    "maskedNumber": {
+      "string": "string"
+    },
+    "issued": {
+      "type": ["string", "null"]
+    },
+    "expires": {
+      "string": "string"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}