@kohost/api-client 3.0.0-beta.9 → 3.0.0-beta.91

package/dist/cjs/schemas/scene.json

@@ -0,0 +1,121 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "scene.json",
+  "title": "Scene",
+  "description": "A room represents a physical space of controllable IoT devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "devices": {
+      "type": "object",
+      "properties": {
+        "switches": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "state": {
+                "$ref": "switch.json#/properties/state"
+              }
+            },
+            "default": []
+          }
+        },
+        "dimmers": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "level": {
+                "$ref": "dimmer.json#/properties/level"
+              }
+            }
+          },
+          "default": []
+        },
+        "windowCoverings": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "position": {
+                "$ref": "windowCovering.json#/properties/position"
+              }
+            }
+          },
+          "default": []
+        },
+        "thermostats": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.json#/definitions/id"
+              },
+              "hvacMode": {
+                "$ref": "thermostat.json#/properties/hvacMode"
+              },
+              "setpoints": {
+                "$ref": "thermostat.json#/properties/setpoints"
+              },
+              "fanMode": {
+                "$ref": "thermostat.json#/properties/fanMode"
+              },
+              "setpointDelta": {
+                "type": "number"
+              }
+            }
+          },
+          "default": []
+        },
+        "mediaSources": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "definitions.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/dist/cjs/schemas/shortLink.json

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

package/dist/cjs/schemas/smsMessage.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "smsMessage.json",
+  "title": "SMS Message",
+  "type": "object",
+  "required": ["to", "from", "body", "status"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "smsMessage"
+    },
+    "to": {
+      "type": "string",
+      "pattern": "^\\+[0-9]{1,14}$"
+    },
+    "from": {
+      "type": "string",
+      "pattern": "^\\+[0-9]{1,14}$"
+    },
+    "media": {
+      "type": "string",
+      "format": "uri"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "queued",
+        "accepted",
+        "sending",
+        "sent",
+        "failed",
+        "delivered",
+        "undelivered",
+        "receiving",
+        "received",
+        "read"
+      ]
+    },
+    "body": {
+      "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/space.json

@@ -0,0 +1,129 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "space.json",
+  "title": "Space",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "type": {
+      "type": "string",
+      "default": "space"
+    },
+    "discriminator": {
+      "type": "string",
+      "enum": [
+        "classRoom",
+        "hotelRoom",
+        "office",
+        "building",
+        "commonArea",
+        "conferenceRoom",
+        "lobby",
+        "gym",
+        "pool",
+        "restaurant"
+      ]
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "category": {
+      "type": "string",
+      "description": "This is the category id"
+    },
+    "rooms": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "subGroups": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "occupied": {
+      "type": "boolean"
+    },
+    "eco": {
+      "type": "object",
+      "additionalProperties": false,
+      "default": {
+        "active": false,
+        "allowed": false
+      },
+      "properties": {
+        "active": {
+          "type": "boolean",
+          "default": false
+        },
+        "activatedAt": {
+          "type": ["string", "object"],
+          "format": "date-time"
+        },
+        "allowed": {
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    "features": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "maximumOccupancy": {
+      "type": "number",
+      "minimum": 1
+    },
+    "housekeepingStatus": {
+      "type": "string",
+      "enum": ["clean", "dirty", "inspected", "pickup"]
+    },
+    "serviceStatus": {
+      "type": "string",
+      "enum": ["inService", "outOfOrder", "outOfService"]
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    }
+  },
+  "if": {
+    "properties": { "type": { "const": "hotelRoom" } }
+  },
+  "then": {
+    "required": [
+      "name",
+      "type",
+      "features",
+      "maximumOccupancy",
+      "housekeepingStatus",
+      "serviceStatus"
+    ],
+    "properties": {
+      "features": {
+        "default": []
+      },
+      "maximumOccupancy": {
+        "default": 2
+      },
+      "housekeepingStatus": {
+        "default": "dirty"
+      },
+      "serviceStatus": {
+        "default": "inService"
+      }
+    }
+  },
+  "else": {
+    "required": ["name", "type"]
+  }
+}

package/dist/cjs/schemas/switch.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "switch.json",
+  "title": "Switch",
+  "description": "Any smart switch",
+  "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"
+    },
+    "state": {
+      "type": "string",
+      "enum": ["on", "off"]
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "required": ["id", "type", "state", "driver"]
+}

package/dist/cjs/schemas/systemUser.json

@@ -0,0 +1,98 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "systemUser.json",
+  "title": "System User",
+  "description": "A system user is a user that originated from an external 3rd party system.",
+  "type": "object",
+  "required": ["firstName", "lastName"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "systemUser"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "firstName": {
+      "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
+    "phone": {
+      "type": ["string", "null"],
+      "pattern": "^\\+[0-9]{1,14}$"
+    },
+    "email": {
+      "type": ["string", "null"],
+      "format": "email"
+    },
+    "address": {
+      "$ref": "definitions.json#/definitions/address"
+    },
+    "photo": {
+      "type": "string"
+    },
+    "jobTitle": {
+      "type": "string"
+    },
+    "dob": {
+      "type": "string"
+    },
+    "gender": {
+      "type": "string",
+      "enum": ["male", "female"]
+    },
+    "roles": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["Guest", "User", "Manager", "Administrator", "SuperAdmin"]
+      }
+    },
+    "nationality": {
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 2
+    },
+    "notes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "files": {
+      "type": "array",
+      "items": {
+        "$ref": "mediaFile.json#"
+      }
+    },
+    "identifications": {
+      "type": "array",
+      "items": {
+        "$ref": "identification.json#"
+      }
+    },
+    "payments": {
+      "type": "array",
+      "items": {
+        "$ref": "payment.json#"
+      }
+    },
+    "revenue": {
+      "$ref": "definitions.json#/definitions/revenue"
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/updatedAt"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    }
+  }
+}

package/dist/cjs/schemas/thermostat.json

@@ -0,0 +1,150 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "thermostat.json",
+  "title": "Thermostat",
+  "description": "Any smart thermostat",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "$ref": "definitions.json#/definitions/name"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type",
+      "default": "thermostat"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "currentTemperature": {
+      "type": "number"
+    },
+    "currentHumidity": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 99
+    },
+    "hvacMode": {
+      "type": "string",
+      "$ref": "#/properties/supportedHvacModes/items"
+    },
+    "hvacState": {
+      "type": ["string", "null"],
+      "enum": ["cooling", "heating", "off", null]
+    },
+    "fanMode": {
+      "type": "string",
+      "$ref": "#/properties/supportedFanModes/items"
+    },
+    "fanState": {
+      "type": ["string", "null"],
+      "enum": ["off", "low", "medium", "high", "on", null]
+    },
+    "temperatureScale": {
+      "type": "string",
+      "enum": ["celsius", "fahrenheit"],
+      "default": "fahrenheit"
+    },
+    "humidityScale": {
+      "type": ["string", "null"],
+      "enum": ["absolute", "relative", null]
+    },
+    "supportedHvacModes": {
+      "type": "array",
+      "uniqueItems": true,
+      "minItems": 2,
+      "items": {
+        "enum": ["cool", "heat", "auto", "off"]
+      }
+    },
+    "supportedFanModes": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "enum": ["auto", "low", "medium", "high", "off", "on"]
+      }
+    },
+    "setpoints": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "cool": {
+          "$ref": "#/$defs/setpoint"
+        },
+        "heat": {
+          "$ref": "#/$defs/setpoint"
+        },
+        "auto": {
+          "$ref": "#/$defs/setpoint"
+        }
+      }
+    },
+    "minAutoDelta": {
+      "type": "number",
+      "default": 3
+    },
+    "cycleRate": {
+      "type": "number"
+    },
+    "batteryLevel": {
+      "$ref": "definitions.json#/definitions/batteryLevel"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "$defs": {
+    "setpoint": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "value": {
+          "$ref": "#/$defs/setpointValue"
+        },
+        "min": {
+          "$ref": "#/$defs/setpointMinMax"
+        },
+        "max": {
+          "$ref": "#/$defs/setpointMinMax"
+        }
+      }
+    },
+    "setpointValue": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 99
+    },
+    "setpointMinMax": {
+      "type": ["number", "null"],
+      "minimum": 0,
+      "maximum": 99
+    }
+  },
+  "required": [
+    "id",
+    "type",
+    "hvacMode",
+    "fanMode",
+    "hvacState",
+    "fanState",
+    "setpoints",
+    "temperatureScale",
+    "supportedHvacModes",
+    "supportedFanModes",
+    "driver"
+  ]
+}