@kohost/api-client 1.0.0-beta.3 → 1.0.0-beta.5

package/schemas/mediaSource.json

@@ -1,151 +0,0 @@
-{
-  "$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"
-      ]
-    },
-    "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"
-    },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    }
-  },
-  "additionalProperties": false,
-  "required": ["id", "type", "systemData", "audio", "video"]
-}

package/schemas/motionSensor.json

@@ -1,26 +0,0 @@
-{
-  "$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": {
-    "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"
-    },
-    "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-  }
-  },
-  "additionalProperties": false,
-  "required": ["id", "type", "systemData"]
-}

package/schemas/payment.json

@@ -1,40 +0,0 @@
-{
-  "$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",
-        "maestro",
-        "discover",
-        "diners",
-        "jcb",
-        "applePay",
-        "alipay",
-        "chinaUnionPay",
-        "vpay"
-      ]
-    },
-    "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/product.json

@@ -1,36 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/product.json",
-  "title": "Product",
-  "type": "object",
-  "required": ["name", "description", "price", "currency"], 
-  "properties": {
-    "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
-    },
-    "type": {
-      "type": "string" 
-    },
-    "name": {
-      "type": "string"
-    },
-    "description": {
-      "string": "string"
-    },
-    "price": {
-      "type": "number"
-    },
-    "currency": { 
-      "type": "string",
-      "description": "ISO 4217 format",
-      "minLength": 3,
-      "maxLength": 3
-    },
-    "image": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/file"
-    },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
-    }
-  }
-}

package/schemas/reservation.json

@@ -1,71 +0,0 @@
-{
-  "$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"
-      }
-    },
-    "space": {
-      "type": "string"
-    },
-    "status": {
-      "type": "string", 
-      "enum": ["reserved", "checkedIn", "checkedOut", "cancelled", "noShow", "enquired", "requested", "optional"],
-      "description": " reserved - confirmed by both parties, before check-in\n checkedIn - checked in\n checkedOut - checked out\n cancelled - Cancelled\n noShow - No show\n enquired - Confirmed neither by the customer nor enterprise\n requested - Confirmed by the customer but not the enterprise (waitlist)\n optional - Confirmed by the enterprise but not the customer (holding)"
-    },
-    "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"
-    },
-    "metadata": {
-      "ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/metadata"
-    }
-  }
-}
-

package/schemas/room.json

@@ -1,131 +0,0 @@
-{
-  "$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"
-      }
-    },
-    "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

@@ -1,118 +0,0 @@
-{
-  "$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/shortLink.json

@@ -1,30 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/shortLink.json",
-  "title": "Short Link",
-  "type": "object",
-  "required": ["destination", "url"],
-  "properties": {
-    "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
-    },
-    "type": {
-      "type": "string",
-      "default": "shortLink"
-    },
-    "title": {
-      "type": "string"
-    },
-    "destination": {
-      "string": "string",
-      "format": "uri"
-    },
-    "url": {
-      "string": "string",
-      "format": "uri"
-    },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
-    }
-  }
-}