@kohost/api-client 1.0.0-alpha.2 → 1.0.0-alpha.4

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"]
+}

package/schemas/motionSensor.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/motionSensor.json",
+  "title": "Motion Sensor",
+  "description": "Any smart motion sensor",
+  "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"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData"]
+}

package/schemas/payment.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/payment.json",
+  "title": "Payment",
+  "type": "object",
+  "required": ["type", "maskedNumber", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "amex",
+        "visa",
+        "masterCard",
+        "discover",
+        "diners",
+        "jcb",
+        "applePay",
+        "alipay",
+        "chinaUnionPay"
+      ]
+    },
+    "maskedNumber": {
+      "string": "string"
+    },
+    "issued": {
+      "type": ["string", "null"]
+    },
+    "expires": {
+      "string": "string"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  }
+}

package/schemas/reservation.json

@@ -0,0 +1,66 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/reservation.json",
+  "title": "Reservation",
+  "type": "object",
+  "required": ["type", "status", "checkInDateTime", "checkOutDateTime"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "primaryGuest": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string"
+    },
+    "sharedGuests": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "group": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["reserved", "checkedIn", "checkedOut", "cancelled", "noShow"]
+    },
+    "confirmationNumber": {
+      "type": "string"
+    },
+    "checkInDateTime": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "checkOutDateTime": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "adultCount": {
+      "type": "number",
+      "default": 1,
+      "minimum": 1
+    },
+    "childCount": {
+      "type": "number",
+      "default": 0
+    },
+    "rateSuppressed": {
+      "type": "boolean"
+    },
+    "payment": {
+      "type": "string"
+    },
+    "company": {
+      "type": "string"
+    },
+    "travelAgent": {
+      "type": "string"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  }
+}

package/schemas/room.json

@@ -0,0 +1,138 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/room.json",
+  "title": "Room",
+  "description": "A room represents a physical space of controllable IoT devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "floor": {
+      "type": "string"
+    },
+    "dimmers": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/dimmer.json"
+      }
+    },
+    "switches": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/switch.json"
+      }
+    },
+    "thermostats": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/thermostat.json"
+      }
+    },
+    "locks": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/lock.json"
+      }
+    },
+    "windowCoverings": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/windowCovering.json"
+      }
+    },
+    "courtesy": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/courtesy.json"
+      }
+    },
+    "sceneControllers": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/sceneController.json"
+      }
+    },
+    "cameras": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/camera.json"
+      }
+    },
+    "sources": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/mediaSource.json"
+      }
+    },
+    "motionSensors": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/motionSensor.json"
+      }
+    },
+    "alarms": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/alarm.json"
+      }
+    },
+    "media": {
+      "type": "object",
+      "additionalProperties": false,
+      "default": {
+        "volume": 0,
+        "currentSource": null
+      },
+      "properties": {
+        "volume": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "currentSource": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "scenes": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "A list of scene IDs for later population, or entire scene objects",
+        "oneOf": [
+          {
+            "$ref": "https://api.kohost.app/schemas/v3/scene.json"
+          },
+          {
+            "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+          }
+        ]
+      }
+    },
+    "occupiedAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    },
+    "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
+}

package/schemas/scene.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/scene.json",
+  "title": "Scene",
+  "description": "A room represents a physical space of controllable IoT devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "devices": {
+      "type": "object",
+      "properties": {
+        "switches": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "state": {
+                "$ref": "https://api.kohost.app/schemas/v3/switch.json#/properties/state"
+              }
+            },
+            "default": []
+          }
+        },
+        "dimmers": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "level": {
+                "$ref": "https://api.kohost.app/schemas/v3/dimmer.json#/properties/level"
+              }
+            }
+          },
+          "default": []
+        },
+        "windowCoverings": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "position": {
+                "$ref": "https://api.kohost.app/schemas/v3/windowCovering.json#/properties/position"
+              }
+            }
+          },
+          "default": []
+        },
+        "thermostats": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "hvacMode": {
+                "$ref": "https://api.kohost.app/schemas/v3/thermostat.json#/properties/hvacMode"
+              },
+              "setpoints": {
+                "$ref": "https://api.kohost.app/schemas/v3/thermostat.json#/properties/setpoints"
+              },
+              "fanMode": {
+                "$ref": "https://api.kohost.app/schemas/v3/thermostat.json#/properties/fanMode"
+              }
+            }
+          },
+          "default": []
+        },
+        "media": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "volume": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 100
+              },
+              "commands": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "isDefault": {
+      "type": "boolean",
+      "default": false
+    },
+    "showOnUi": {
+      "type": "boolean",
+      "default": true
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/sceneController.json

@@ -6,22 +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"
-    },
-    "subType": {
-      "type": ["string", "null"]
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "supportedScenes": {
       "type": "array",
@@ -53,6 +53,6 @@
       "enum": ["on", "off"]
     }
   },
-  "additionalProperties": true,
+  "additionalProperties": false,
   "required": ["id", "type", "systemData", "supportedScenes", "scene"]
 }