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

package/dist/cjs/schemas/gateway.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "iotGateway.json",
+  "title": "IoT Gateway",
+  "description": "Any smart gateway that is an entrypoint for controlling devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "status": {
+      "type": "string"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "required": ["id", "type", "status", "driver"]
+}

package/dist/cjs/schemas/identification.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "identification.json",
+  "title": "Identification",
+  "type": "object",
+  "required": ["type"],
+  "oneOf": [
+    {
+      "required": ["number"]
+    },
+    {
+      "required": ["encryptedNumber"]
+    }
+  ],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["driversLicense", "passport", "identityCard", "visa"]
+    },
+    "number": {
+      "string": "string"
+    },
+    "maskedNumber": {
+      "string": "string"
+    },
+    "encryptedNumber": {
+      "string": "string"
+    },
+    "issued": {
+      "type": ["string", "object"],
+      "format": "date-time"
+    },
+    "expires": {
+      "type": ["string", "object", "null"],
+      "format": "date-time"
+    },
+    "verified": {
+      "type": "boolean"
+    },
+    "matched": {
+      "type": "boolean"
+    },
+    "firstName": {
+      "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
+    "issuingCountry": {
+      "string": "string",
+      "minLength": 2,
+      "maxLength": 2
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    }
+  }
+}

package/dist/cjs/schemas/lock.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "lock.json",
+  "title": "Lock",
+  "description": "Any smart lock",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "state": {
+      "type": ["string", "null"],
+      "enum": ["locked", "unlocked", null]
+    },
+    "mode": {
+      "type": ["string", "null"],
+      "enum": ["normal", "autoLock", null],
+      "description": "AutoLock: Lock automatically locks after set time. Normal - Lock needs told to lock or unlock.",
+      "default": "normal"
+    },
+    "batteryLevel": {
+      "$ref": "definitions.json#/definitions/batteryLevel"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "required": ["id", "type", "state", "driver"]
+}

package/dist/cjs/schemas/mediaFile.json

@@ -0,0 +1,70 @@
+{
+  "$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"
+    },
+    "name": {
+      "type": "string"
+    },
+    "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"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["type"]
+}

package/dist/cjs/schemas/mediaSource.json

@@ -0,0 +1,187 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "mediaSource.json",
+  "title": "Media Source",
+  "description": "Any media source",
+  "type": "object",
+  "required": ["id", "type", "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"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "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"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "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"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "driver"]
+}

package/dist/cjs/schemas/order.json

@@ -0,0 +1,182 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "order.json",
+  "title": "Order",
+  "description": "A purchase order for products or services.",
+  "type": "object",
+  "required": ["type", "status"],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "order"
+    },
+    "orderNumber": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "draft",
+        "pendingPayment",
+        "processing",
+        "outForDelivery",
+        "completed",
+        "paymentFailed",
+        "cancelled",
+        "refunded"
+      ]
+    },
+    "user": {
+      "$ref": "definitions.json#/definitions/id",
+      "description": "User id of purchaser"
+    },
+    "date": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "items": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "price"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "sku": {
+            "type": "string"
+          },
+          "quantity": {
+            "type": "number",
+            "default": 1
+          },
+          "price": {
+            "type": "number"
+          },
+          "taxClass": {
+            "type": "string"
+          },
+          "deliveryClass": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "taxes": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "rate"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "class": {
+            "type": "string"
+          },
+          "rateType": {
+            "type": "string",
+            "enum": ["percentage", "flat"],
+            "default": "percentage"
+          },
+          "rate": {
+            "type": "number"
+          },
+          "total": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "fees": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "price"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "price": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "delivery": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "required": ["name", "rate"],
+        "properties": {
+          "additionalProperties": false,
+          "name": {
+            "type": "string"
+          },
+          "class": {
+            "type": "string"
+          },
+          "rateType": {
+            "type": "string",
+            "enum": ["percentage", "flat"],
+            "default": "percentage"
+          },
+          "rate": {
+            "type": "number"
+          },
+          "total": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "payments": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "type": "object",
+        "properties": {
+          "method": {
+            "type": "string",
+            "enum": [
+              "folio",
+              "invoice",
+              "amex",
+              "visa",
+              "masterCard",
+              "maestro",
+              "discover",
+              "diners",
+              "jcb",
+              "applePay",
+              "alipay",
+              "chinaUnionPay",
+              "vpay"
+            ]
+          },
+          "name": {
+            "type": "string"
+          },
+          "date": {
+            "$ref": "definitions.json#/definitions/date"
+          },
+          "amount": {
+            "type": "number"
+          },
+          "transactionReference": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

package/dist/cjs/schemas/organization.json

@@ -0,0 +1,40 @@
+{
+  "$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"
+    },
+    "type": {
+      "type": "string",
+      "default": "organization"
+    },
+    "accountNumber": {
+      "type": ["number", "null"],
+      "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"
+    }
+  }
+}