@kohost/api-client 1.0.0-alpha.1 → 1.0.0-alpha.3

package/schemas/application.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/application.json",
+  "title": "Application",
+  "type": "object",
+  "required": ["id", "active", "name", "publicKey", "hashedPrivateKey"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "active": {
+      "type": "boolean"
+    },
+    "name": {
+      "type": "string"
+    },
+    "publicKey": {
+      "type": "string"
+    },
+    "hashedPrivateKey": {
+      "type": "string"
+    }
+  }
+}

package/schemas/camera.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/camera.json",
+  "title": "Camera",
+  "description": "Any smart camera",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
+    },
+    "type": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
+    },
+    "supportedNotifications": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
+    },
+    "streams": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "origin": {
+          "type": ["string", "null"]
+        },
+        "local": {
+          "type": ["string", "null"]
+        },
+        "remote": {
+          "type": ["string", "null"]
+        }
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "streams"]
+}

package/schemas/courtesy.json

@@ -4,22 +4,21 @@
   "title": "Courtesy",
   "description": "Any smart courtesy system",
   "type": "object",
-  "allOf": [{ "$ref": "https://api.kohost.app/schemas/v3/device.json" }],
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "supportedStates": {
       "type": "array",

package/schemas/definitions/common.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/definitions/common.json",
+  "definitions": {
+    "id": {
+      "type": "string"
+    },
+    "systemData": {
+      "type": "object",
+      "default": {}
+    },
+    "createdAt": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "updatedAt": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    }
+  }
+}

package/schemas/{device.json → definitions/device.json}

@@ -1,16 +1,34 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/device.json",
+  "$id": "https://api.kohost.app/schemas/v3/definitions/device.json",
   "definitions": {
     "id": {
-      "type": "string"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
     },
     "systemData": {
-      "type": "object"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
     },
     "type": {
+      "type": "string",
+      "enum": [
+        "dimmer",
+        "switch",
+        "motionSensor",
+        "windowCovering",
+        "camera",
+        "mediaSource",
+        "thermostat",
+        "lock",
+        "courtesy",
+        "sceneController"
+      ]
+    },
+    "name": {
       "type": "string"
     },
+    "subType": {
+      "type": ["string", "null"]
+    },
     "supportedNotifications": {
       "type": "array",
       "uniqueItems": true,
@@ -31,7 +49,7 @@
       }
     },
     "notification": {
-      "type": "object",
+      "type": ["object", "null"],
       "properties": {
         "name": {
           "type": "string",

package/schemas/dimmer.json

@@ -6,19 +6,22 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
+    },
+    "subType": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "level": {
       "type": "number",

package/schemas/discoveredDevice.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/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", "driver", "deviceData"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "deviceId": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "dimmer",
+        "switch",
+        "motionSensor",
+        "thermostat",
+        "lock",
+        "camera",
+        "courtesy",
+        "source",
+        "alarm",
+        "windowCovering"
+      ]
+    },
+    "driver": {
+      "type": "string"
+    },
+    "integrationId": {
+      "type": "string"
+    },
+    "deviceData": {
+      "type": "object"
+    }
+  }
+}

package/schemas/gateway.json

@@ -2,28 +2,60 @@
   "$schema": "http://json-schema.org/draft-07/schema",
   "$id": "https://api.kohost.app/schemas/v3/gateway.json",
   "title": "Gateway",
-  "description": "Any smart gateway",
+  "description": "Any Kohost gateway",
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
     },
-    "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+    "name": {
+      "type": "string"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+    "hashedAuthKey": {
+      "type": "string"
     },
-    "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+    "integrations": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "$ref": "https://api.kohost.app/schemas/v3/integration.json"
+          },
+          {
+            "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+          }
+        ]
+      },
+      "default": []
     },
-    "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+    "health": {
+      "type": "object",
+      "properties": {
+        "upSince": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "lastSeen": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "additionalProperties": false
     },
-    "status": {
-      "type": "string"
+    "roles": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": ["Gateway"]
+    },
+    "createdAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/updatedAt"
     }
   },
   "additionalProperties": false,
-  "required": ["id", "type", "systemData", "status"]
+  "required": ["id", "name", "hashedAuthKey", "integrations", "health"]
 }

package/schemas/identification.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/identification.json",
+  "title": "Identification",
+  "type": "object",
+  "required": ["type", "number", "expires", "issuingCountry"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["driversLicense", "passport", "identityCard"]
+    },
+    "number": {
+      "string": "string"
+    },
+    "issued": {
+      "string": "string",
+      "format": "date-time"
+    },
+    "expires": {
+      "string": "string",
+      "format": "date-time"
+    },
+    "issuingCountry": {
+      "string": "string",
+      "minLength": 2,
+      "maxLength": 2
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  }
+}

package/schemas/integration.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/integration.json",
+  "title": "Integration",
+  "description": "Integration configuration",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "driver": {
+      "type": "string",
+      "description": "Driver to use for this integration",
+      "enum": [
+        "aws-kinesis",
+        "crestron",
+        "igor",
+        "lirc",
+        "pelican-wireless",
+        "salto",
+        "se",
+        "mews",
+        "operaCloud",
+        "stay-n-touch"
+      ]
+    },
+    "driverVersion": {
+      "type": "string",
+      "description": "Version of the driver to use for this integration",
+      "default": "latest"
+    },
+    "config": {
+      "type": "object",
+      "default": {}
+    },
+    "data": {
+      "type": "object",
+      "default": {},
+      "description": "Data to be used by the driver",
+      "additionalProperties": true,
+      "properties": {
+        "deviceMap": {
+          "type": "object",
+          "description": "Map of kohost device IDs to device names",
+          "additionalProperties": false,
+          "patternProperties": {
+            "^[a-zA-Z0-9]{8}$": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["id", "type", "roomId"],
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Driver device id"
+                },
+                "type": {
+                  "type": "string",
+                  "description": "Driver device type"
+                },
+                "roomId": {
+                  "type": "string",
+                  "description": "Kohost room id"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "health": {
+      "type": "object",
+      "properties": {
+        "upSince": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "lastSeen": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "default": {},
+      "additionalProperties": false
+    },
+    "createdAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/updatedAt"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "driver", "driverVersion", "config", "health", "data"]
+}

package/schemas/iotGateway.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/iotGateway.json",
+  "title": "IoT Gateway",
+  "description": "Any smart gateway that is an entrypoint for controlling devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
+    },
+    "type": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
+    },
+    "supportedNotifications": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
+    },
+    "status": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "status"]
+}

package/schemas/lock.json

@@ -6,19 +6,22 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
+    },
+    "subType": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "state": {
       "type": "string",

package/schemas/mediaSource.json

@@ -0,0 +1,151 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/mediaSource.json",
+  "title": "Media Source",
+  "description": "Any media source",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
+    },
+    "type": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
+    },
+    "subType": {
+      "type": "string",
+      "enum": [
+        "tv",
+        "dvr",
+        "appleTv",
+        "discPlayer",
+        "mediaPlayer",
+        "uncontrolledDevice"
+      ]
+    },
+    "audio": {
+      "type": "boolean"
+    },
+    "video": {
+      "type": "boolean"
+    },
+    "powerFeedback": {
+      "type": "boolean"
+    },
+    "volumeFeedback": {
+      "type": "boolean"
+    },
+    "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",
+        "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"
+      ]
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
+    },
+    "supportedNotifications": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "audio", "video"]
+}