@kohost/api-client 3.0.0-beta.47 → 3.0.0-beta.50

package/dist/cjs/schemas/mediaFile.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "mediaFile.json",
+  "title": "Media File",
+  "description": "Any media file",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "mediaFile"
+    },
+    "fileHash": {
+      "type": "string"
+    },
+    "mimeType": {
+      "type": "string",
+      "enum": [
+        "image/*",
+        "image/jpeg",
+        "image/png",
+        "image/gif",
+        "image/webp",
+        "image/avif",
+        "image/svg+xml",
+        "application/pdf"
+      ]
+    },
+    "data": {
+      "type": "string"
+    },
+    "url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "width": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "height": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "size": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Size in bytes"
+    },
+    "uploadUrl": {
+      "type": "string",
+      "format": "uri"
+    },
+    "uploadUrlExpires": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "createdBy": {
+      "type": "string"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type"]
+}

package/dist/cjs/schemas/mediaSource.json

@@ -0,0 +1,184 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "mediaSource.json",
+  "title": "Media Source",
+  "description": "Any media source",
+  "type": "object",
+  "required": ["id", "type", "systemData", "audio", "video", "driver"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "tv",
+        "dvr",
+        "appleTv",
+        "discPlayer",
+        "mediaPlayer",
+        "uncontrolledDevice"
+      ]
+    },
+    "name": {
+      "$ref": "definitions.json#/definitions/name"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "audio": {
+      "type": "boolean"
+    },
+    "video": {
+      "type": "boolean"
+    },
+    "powerFeedback": {
+      "type": "boolean"
+    },
+    "volumeFeedback": {
+      "type": "boolean"
+    },
+    "muted": {
+      "type": "boolean"
+    },
+    "volume": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "power": {
+      "type": "string",
+      "enum": ["on", "off"]
+    },
+    "input": {
+      "type": "string"
+    },
+    "supportedInputs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "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",
+        "enterVolume",
+        "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",
+        "red",
+        "green",
+        "yellow",
+        "blue",
+        "alert"
+      ]
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false
+}

package/dist/cjs/schemas/motionSensor.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "motionSensor.json",
+  "title": "Motion Sensor",
+  "description": "Any smart motion sensor",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData", "driver"]
+}

package/dist/cjs/schemas/organization.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "organization.json",
+  "title": "Organization",
+  "type": "object",
+  "description": "An organization is a group or entity that subscribes to Kohost software.",
+  "required": ["accountNumber", "name"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "accountNumber": {
+      "type": "number",
+      "minimum": 10000
+    },
+    "name": {
+      "type": "string"
+    },
+    "properties": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "credentials": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/updatedAt"
+    }
+  }
+}

package/dist/cjs/schemas/payment.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "payment.json",
+  "title": "Payment",
+  "type": "object",
+  "required": ["type", "maskedNumber", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "amex",
+        "visa",
+        "masterCard",
+        "maestro",
+        "discover",
+        "diners",
+        "jcb",
+        "applePay",
+        "alipay",
+        "chinaUnionPay",
+        "vpay"
+      ]
+    },
+    "enabled": {
+      "type": "boolean",
+      "default": true
+    },
+    "storageData": {
+      "type": ["string", "null"]
+    },
+    "maskedNumber": {
+      "string": "string"
+    },
+    "issued": {
+      "type": ["string", "null"]
+    },
+    "expires": {
+      "string": "string"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}

package/dist/cjs/schemas/product.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "product.json",
+  "title": "Product",
+  "type": "object",
+  "required": ["name", "price", "driver"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "description": {
+      "string": "string"
+    },
+    "price": {
+      "type": "number"
+    },
+    "image": {
+      "$ref": "definitions.json#/definitions/file"
+    },
+    "category": {
+      "type": "string"
+    },
+    "imageUrl": {
+      "format": "uri",
+      "pattern": "^https?://"
+    },
+    "systemData": {
+      "$ref": "definitions.json#/definitions/systemData"
+    }
+  }
+}

package/dist/cjs/schemas/property.json

@@ -0,0 +1,246 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "property.json",
+  "title": "Property",
+  "type": "object",
+  "description": "A property is a physical asset or building",
+  "required": ["id", "name", "type", "hostname", "organization"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["hospitality", "education", "commercial"]
+    },
+    "timezone": {
+      "type": "string"
+    },
+    "smsNumber": {
+      "type": "string"
+    },
+    "hostname": {
+      "type": "string"
+    },
+    "organization": {
+      "type": "string",
+      "description": "Reference (id) to the organization that owns this property"
+    },
+    "address": {
+      "type": "object",
+      "properties": {
+        "street": {
+          "type": "string"
+        },
+        "city": {
+          "type": "string"
+        },
+        "state": {
+          "type": "string"
+        },
+        "zip": {
+          "type": "string"
+        },
+        "country": {
+          "type": "string"
+        }
+      }
+    },
+    "latitude": {
+      "type": "number"
+    },
+    "longitude": {
+      "type": "number"
+    },
+    "appManifest": {
+      "type": "object",
+
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "short_name": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "start_url": {
+          "type": "string"
+        },
+        "themeColor": {
+          "type": "string"
+        },
+        "backgroundColor": {
+          "type": "string"
+        },
+        "display": {
+          "type": "string",
+          "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
+          "default": "fullscreen"
+        },
+        "orientation": {
+          "type": "string",
+          "enum": ["portrait", "landscape"],
+          "default": "portrait"
+        },
+        "splash": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        },
+        "icons": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "src": {
+                "type": "string"
+              },
+              "sizes": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "logo": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "default": {
+        "name": "Kohost",
+        "short_name": "Kohost",
+        "start_url": "/",
+        "scope": "/",
+        "display": "fullscreen",
+        "orientation": "portrait",
+        "theme_color": "#1d1f22",
+        "background_color": "#1d1f22",
+        "icons": [
+          {
+            "src": "https://cdn.kohost.app/defaultIcon.png",
+            "sizes": "512x512",
+            "type": "image/png"
+          }
+        ],
+        "splash": {
+          "src": "https://cdn.kohost.app/defaultSplash.jpg",
+          "sizes": "1500x800",
+          "type": "image/jpg"
+        },
+        "logo": {
+          "src": "https://cdn.kohost.app/defaultLogo.png",
+          "sizes": "300x75",
+          "type": "image/png"
+        }
+      }
+    },
+    "appFeatures": {
+      "type": "object",
+      "properties": {
+        "RoomControl": {},
+        "CheckIn": {
+          "properties": {
+            "payment": {},
+            "identification": {},
+            "earlyCheckIn": {
+              "type": "object",
+              "required": ["dynamic", "checkInTime", "checkOutTime"],
+              "properties": {
+                "dynamic": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "checkInTime": {
+                  "type": "string"
+                },
+                "checkOutTime": {
+                  "type": "string"
+                }
+              }
+            },
+            "roomUpgrades": {}
+          }
+        },
+        "CheckOut": {},
+        "Concierge": {},
+        "DigitalKey": {
+          "type": "object",
+          "properties": {
+            "system": {
+              "type": "string",
+              "enum": ["salto"]
+            },
+            "systemOnline": {
+              "type": "boolean",
+              "default": false
+            },
+            "branding": {
+              "type": "object",
+              "properties": {
+                "logo": {
+                  "type": "string",
+                  "format": "uri"
+                },
+                "gradient": {
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "pattern": "^(?!#ffffff)(#[0-9a-fA-F]{6})$"
+                  },
+                  "minItems": 2,
+                  "maxItems": 2
+                },
+                "highlightedGradient": {
+                  "type": "array",
+                  "items": {
+                    "type": "string",
+                    "pattern": "^(?!#ffffff)(#[0-9a-fA-F]{6})$"
+                  },
+                  "minItems": 2,
+                  "maxItems": 3
+                }
+              }
+            }
+          }
+        },
+        "Elevator": {}
+      },
+      "additionalProperties": false,
+      "default": {
+        "RoomControl": {}
+      }
+    },
+    "credentials": {
+      "type": "object",
+      "additionalProperties": true
+    },
+    "additionalProperties": false
+  }
+}