@kohost/api-client 3.9.12 → 4.0.5

package/dist/cjs/schemas/announcement.json

@@ -1,47 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "announcement.json",
-  "title": "Announcement",
-  "description": "Announcement message sent to users",
-  "type": "object",
-  "properties": {
-    "id": { "$ref": "definitions.json#/definitions/id" },
-    "type": {
-      "type": "string",
-      "enum": ["announcement"],
-      "default": "announcement"
-    },
-    "users": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      },
-      "minItems": 1
-    },
-    "group": {
-      "type": "string"
-    },
-    "body": {
-      "type": "string"
-    },
-    "media": {
-      "$ref": "mediaFile.json"
-    },
-    "sentBy": {
-      "type": "string"
-    },
-    "tags": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      }
-    },
-    "createdAt": {
-      "$ref": "definitions.json#/definitions/date"
-    },
-    "updatedAt": {
-      "$ref": "definitions.json#/definitions/date"
-    }
-  },
-  "additionalProperties": false
-}

package/dist/cjs/schemas/camera.json

@@ -1,105 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "camera.json",
-  "title": "Camera",
-  "description": "Any smart camera",
-  "type": "object",
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "name": {
-      "type": "string"
-    },
-    "type": {
-      "$ref": "definitions.json#/definitions/type",
-      "default": "camera"
-    },
-    "offline": {
-      "type": "boolean"
-    },
-    "supportedNotifications": {
-      "$ref": "definitions.json#/definitions/supportedNotifications"
-    },
-    "notification": {
-      "$ref": "definitions.json#/definitions/notification"
-    },
-    "driver": {
-      "$ref": "definitions.json#/definitions/driver"
-    },
-    "liveStreams": {
-      "type": "object",
-      "additionalProperties": false,
-      "$comment": "This is now deprecated. Use liveStream instead. This will remain here for backwards compatibility.",
-      "properties": {
-        "iframe": {
-          "type": ["string", "null"]
-        },
-        "hls": {
-          "type": ["string", "null"]
-        },
-        "webRTC": {
-          "type": ["string", "null"]
-        },
-        "rtsp": {
-          "type": ["string", "null"]
-        }
-      }
-    },
-    "liveStream": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "driver": {
-          "type": "string",
-          "enum": ["cloudflare-stream", "aws-kinesis", "digital-watchdog"]
-        },
-        "allowedOrigins": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "authRequired": {
-          "type": "boolean"
-        },
-        "iframe": {
-          "type": ["string", "null"]
-        },
-        "hls": {
-          "type": ["string", "null"]
-        },
-        "webRTC": {
-          "type": ["string", "null"]
-        },
-        "rtsp": {
-          "type": ["string", "null"],
-          "description": "Local RTSP stream URL",
-          "examples": [
-            "rtsp://192.168.1.4:544/channels/1",
-            "rtsp://10.145.6.129:8554/unicast"
-          ]
-        },
-        "previewImage": {
-          "type": ["string", "null"],
-          "description": "Source to preview the camera stream",
-          "examples": [
-            "https://example.com/preview.jpg",
-            "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD/4QBYRXhpZgAATU0AKgAAAAgAA1EQAAEAAAABAQAAAFERAAQAAAABAAABAgABAA"
-          ]
-        }
-      }
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    },
-    "watts": {
-      "$ref": "definitions.json#/definitions/watts"
-    }
-  },
-  "additionalProperties": false,
-  "required": ["id", "type", "driver"]
-}

package/dist/cjs/schemas/category.json

@@ -1,42 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "category.json",
-  "title": "Category",
-  "type": "object",
-  "required": ["type", "discriminator"],
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "type": {
-      "type": "string",
-      "default": "category"
-    },
-    "name": {
-      "type": "string",
-      "minLength": 1
-    },
-    "driver": {
-      "$ref": "definitions.json#/definitions/driver"
-    },
-    "description": {
-      "type": "string"
-    },
-    "image": {
-      "$ref": "mediaFile.json"
-    },
-    "rating": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 10,
-      "default": 9
-    },
-    "discriminator": {
-      "type": "string",
-      "enum": ["space", "product", "mediaFile"]
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    }
-  }
-}

package/dist/cjs/schemas/courtesy.json

@@ -1,48 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "courtesy.json",
-  "title": "Courtesy",
-  "description": "Any smart courtesy system",
-  "type": "object",
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "name": {
-      "type": "string"
-    },
-    "type": {
-      "$ref": "definitions.json#/definitions/type"
-    },
-    "supportedNotifications": {
-      "$ref": "definitions.json#/definitions/supportedNotifications"
-    },
-    "notification": {
-      "$ref": "definitions.json#/definitions/notification"
-    },
-    "driver": {
-      "$ref": "definitions.json#/definitions/driver"
-    },
-    "offline": {
-      "type": "boolean"
-    },
-    "supportedStates": {
-      "type": "array",
-      "uniqueItems": true,
-      "items": {
-        "enum": ["privacy", "service", "none"]
-      }
-    },
-    "state": {
-      "type": "string",
-      "$ref": "#/properties/supportedStates/items"
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    },
-    "watts": {
-      "$ref": "definitions.json#/definitions/watts"
-    }
-  },
-  "required": ["id", "type", "driver", "supportedStates", "state"]
-}

package/dist/cjs/schemas/credential.json

@@ -1,54 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "credential.json",
-  "title": "Credential",
-  "type": "object",
-  "required": ["type", "credential", "expires"],
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "type": {
-      "type": "string",
-      "default": "credential"
-    },
-    "driver": {
-      "$ref": "definitions.json#/definitions/driver"
-    },
-    "discriminator": {
-      "type": "string",
-      "enum": [
-        "verificationCode",
-        "token",
-        "mobileKey",
-        "pin",
-        "publicKey",
-        "passkeyChallenge"
-      ]
-    },
-    "credential": {
-      "type": "string"
-    },
-    "userId": {
-      "type": "string"
-    },
-    "organizationId": {
-      "type": "string"
-    },
-    "propertyId": {
-      "type": "string"
-    },
-    "deviceId": {
-      "type": "string"
-    },
-    "userAgent": {
-      "type": "string"
-    },
-    "expires": {
-      "type": ["string", "object", "null"]
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    }
-  }
-}

package/dist/cjs/schemas/definitions.json

@@ -1,245 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "definitions.json",
-  "title": "Definitions",
-  "definitions": {
-    "id": {
-      "type": "string",
-      "not": {
-        "enum": ["global", "system"]
-      }
-    },
-    "systemId": {
-      "type": "string"
-    },
-    "systemData": {
-      "type": "object"
-    },
-    "metadata": {
-      "type": "object",
-      "default": {}
-    },
-    "date": {
-      "type": ["string", "object"],
-      "format": "date-time"
-    },
-    "createdAt": {
-      "type": ["string", "object"],
-      "format": "date-time"
-    },
-    "updatedAt": {
-      "type": ["string", "object"],
-      "format": "date-time"
-    },
-    "file": {
-      "type": "object",
-      "required": ["name", "type", "data"],
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "Name of the file."
-        },
-        "type": {
-          "type": "string",
-          "description": "MIME type of the file (e.g. application/pdf)."
-        },
-        "data": {
-          "type": "string",
-          "description": "Base64-encoded data of the file."
-        }
-      }
-    },
-    "address": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "line1": {
-          "type": "string"
-        },
-        "line2": {
-          "type": "string"
-        },
-        "line3": {
-          "type": "string"
-        },
-        "city": {
-          "type": "string"
-        },
-        "state": {
-          "type": "string"
-        },
-        "postalCode": {
-          "type": "string"
-        },
-        "countryCode": {
-          "type": "string",
-          "minLength": 2,
-          "maxLength": 2
-        }
-      }
-    },
-    "driver": {
-      "type": "string",
-      "enum": [
-        "aws-kinesis",
-        "butler",
-        "crestron",
-        "dell",
-        "dmp",
-        "doorbird",
-        "dormakaba",
-        "dsc",
-        "ecobee",
-        "epson",
-        "geovision-rs",
-        "geovision-as-manager",
-        "honeywell-vista",
-        "igor",
-        "inncom",
-        "isapi",
-        "kohost-k7",
-        "kohost",
-        "lg",
-        "lg-webos",
-        "lapi",
-        "lirc",
-        "mews",
-        "mht",
-        "paxton",
-        "pelican-wireless",
-        "power-shades",
-        "rachio",
-        "rebrandly",
-        "rtsp",
-        "salto",
-        "salto-irn",
-        "samsung",
-        "se",
-        "sendgrid",
-        "sonifi",
-        "stay-n-touch",
-        "storable",
-        "twilio",
-        "unifi",
-        "valcom",
-        "vizio",
-        "wisenet",
-        "cloudflare-images",
-        "cloudflare-stream",
-        "insperia-privacy"
-      ]
-    },
-    "type": {
-      "type": "string",
-      "enum": [
-        "alarm",
-        "dimmer",
-        "switch",
-        "motionSensor",
-        "windowCovering",
-        "camera",
-        "mediaSource",
-        "thermostat",
-        "lock",
-        "courtesy",
-        "gateway",
-        "tv",
-        "dvr",
-        "appleTv",
-        "discPlayer",
-        "mediaPlayer",
-        "uncontrolledDevice"
-      ]
-    },
-    "name": {
-      "type": "string"
-    },
-    "supportedNotifications": {
-      "type": "array",
-      "uniqueItems": true,
-      "items": {
-        "enum": [
-          "button 1",
-          "button 2",
-          "button 3",
-          "button 4",
-          "button 5",
-          "idle",
-          "powerHasBeedApplied",
-          "acMainsDisconnected",
-          "acMainsReconnected",
-          "replaceBatterySoon",
-          "replaceBatteryNow",
-          "batteryOk",
-          "hardwareFailure",
-          "softwareFailure",
-          "hardwareFailureWithCode",
-          "softwareFailureWithCode",
-          "motionDetection",
-          "airFilterNeedsCleaned",
-          "airFilterNeedsReplaced",
-          "smokeDetected",
-          "outsideSafeTemperatureRange",
-          "outsideSafeHumidityRange",
-          "scheduleMaintenance",
-          "doorAjar",
-          "communicationFailure",
-          "communicationOk",
-          "burglarAlarm",
-          "fireAlarm"
-        ]
-      }
-    },
-    "notification": {
-      "type": ["object", "null"],
-      "properties": {
-        "name": {
-          "type": "string",
-          "$ref": "#/definitions/supportedNotifications/items"
-        },
-        "timestamp": {
-          "type": "number",
-          "minimum": 1655907956593
-        },
-        "description": {
-          "type": "string"
-        }
-      }
-    },
-    "batteryLevel": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 100
-    },
-    "watts": {
-      "type": "number",
-      "minimum": 0
-    },
-    "revenue": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "id": {
-            "$ref": "definitions.json#/definitions/id"
-          },
-          "name": {
-            "type": "string"
-          },
-          "date": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "price": {
-            "type": "number"
-          },
-          "tax": {
-            "type": ["number", "null"]
-          }
-        }
-      }
-    }
-  }
-}

package/dist/cjs/schemas/deviceRouter.json

@@ -1,29 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "deviceRouter.json",
-  "title": "Device Router",
-  "description": "A device router contains instructions on where to route devices based on their organization and driver.",
-  "type": "object",
-  "required": ["driver", "organizationId"],
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "type": {
-      "type": "string",
-      "default": "deviceRouter",
-      "enum": ["deviceRouter"]
-    },
-    "driver": {
-      "type": "string"
-    },
-    "organizationId": {
-      "type": ["string", "null"],
-      "description": "Reference (id) to the organization that owns this router"
-    },
-    "devices": {
-      "type": "object",
-      "additionalProperties": true
-    }
-  }
-}

package/dist/cjs/schemas/dimmer.json

@@ -1,42 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "dimmer.json",
-  "title": "Dimmer",
-  "description": "Any smart dimmer",
-  "type": "object",
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "name": {
-      "type": "string"
-    },
-    "type": {
-      "$ref": "definitions.json#/definitions/type"
-    },
-    "supportedNotifications": {
-      "$ref": "definitions.json#/definitions/supportedNotifications"
-    },
-    "notification": {
-      "$ref": "definitions.json#/definitions/notification"
-    },
-    "driver": {
-      "$ref": "definitions.json#/definitions/driver"
-    },
-    "offline": {
-      "type": "boolean"
-    },
-    "level": {
-      "type": ["number", "null"],
-      "minimum": 0,
-      "maximum": 100
-    },
-    "systemId": {
-      "$ref": "definitions.json#/definitions/systemId"
-    },
-    "watts": {
-      "$ref": "definitions.json#/definitions/watts"
-    }
-  },
-  "required": ["id", "type", "level", "driver"]
-}

package/dist/cjs/schemas/discoveredDevice.json

@@ -1,44 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "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", "deviceData"],
-  "properties": {
-    "id": {
-      "$ref": "definitions.json#/definitions/id"
-    },
-    "name": {
-      "type": "string"
-    },
-    "deviceId": {
-      "type": "string"
-    },
-    "type": {
-      "type": "string",
-      "enum": ["discoveredDevice"],
-      "default": "discoveredDevice"
-    },
-    "discriminator": {
-      "$ref": "definitions.json#/definitions/type"
-    },
-    "driver": {
-      "type": "string"
-    },
-    "deviceData": {
-      "type": "object"
-    },
-    "ignore": {
-      "type": "boolean"
-    },
-    "organizationId": {
-      "type": ["string", "null"],
-      "description": "Reference (id) to the organization that owns this device"
-    },
-    "propertyId": {
-      "type": ["string", "null"],
-      "description": "Reference (id) to the property that this device belongs to"
-    }
-  }
-}