@kohost/api-client 1.0.0-alpha.3 → 1.0.0-beta.0

package/schemas/gateway.json

@@ -1,61 +1,30 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://api.kohost.app/schemas/v3/gateway.json",
-  "title": "Gateway",
-  "description": "Any Kohost gateway",
+  "$id": "https://api.kohost.app/schemas/v3/iotGateway.json",
+  "title": "IoT Gateway",
+  "description": "Any smart gateway that is an entrypoint for controlling devices",
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
-    "name": {
-      "type": "string"
-    },
-    "hashedAuthKey": {
-      "type": "string"
+    "type": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
-    "integrations": {
-      "type": "array",
-      "items": {
-        "oneOf": [
-          {
-            "$ref": "https://api.kohost.app/schemas/v3/integration.json"
-          },
-          {
-            "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
-          }
-        ]
-      },
-      "default": []
+
+    "supportedNotifications": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
-    "health": {
-      "type": "object",
-      "properties": {
-        "upSince": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "lastSeen": {
-          "type": "string",
-          "format": "date-time"
-        }
-      },
-      "additionalProperties": false
+    "notification": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
-    "roles": {
-      "type": "array",
-      "items": {
-        "type": "string"
-      },
-      "default": ["Gateway"]
-    },
-    "createdAt": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    "status": {
+      "type": "string"
     },
-    "updatedAt": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/updatedAt"
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,
-  "required": ["id", "name", "hashedAuthKey", "integrations", "health"]
+  "required": ["id", "type", "systemData", "status"]
 }

package/schemas/identification.json

@@ -3,26 +3,40 @@
   "$id": "https://api.kohost.app/schemas/v3/identification.json",
   "title": "Identification",
   "type": "object",
-  "required": ["type", "number", "expires", "issuingCountry"],
+  "required": ["type", "number", "expires"],
   "properties": {
     "id": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
     },
     "type": {
       "type": "string",
-      "enum": ["driversLicense", "passport", "identityCard"]
+      "enum": ["driversLicense", "passport", "identityCard", "visa"]  
     },
     "number": {
       "string": "string"
     },
     "issued": {
-      "string": "string",
+      "type": ["string", "object"],
       "format": "date-time"
     },
     "expires": {
-      "string": "string",
+      "type": ["string", "object"],
       "format": "date-time"
     },
+    "verified": {
+      "type": "boolean",
+      "default": false
+    },
+    "matched": {
+      "type": "boolean",
+      "default": false
+    },
+    "firstName": {
+      "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
     "issuingCountry": {
       "string": "string",
       "minLength": 2,

package/schemas/lock.json

@@ -8,15 +8,15 @@
     "id": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
+    "name": {
+      "type": "string"
+    },
     "type": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
     "subType": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -26,6 +26,9 @@
     "state": {
       "type": "string",
       "enum": ["locked", "unlocked"]
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/mediaSource.json

@@ -136,14 +136,14 @@
         "mtsSap"
       ]
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/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"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/motionSensor.json

@@ -12,14 +12,14 @@
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/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

@@ -14,12 +14,14 @@
         "amex",
         "visa",
         "masterCard",
+        "maestro",
         "discover",
         "diners",
         "jcb",
         "applePay",
         "alipay",
-        "chinaUnionPay"
+        "chinaUnionPay",
+        "vpay"
       ]
     },
     "maskedNumber": {

package/schemas/product.json

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

@@ -20,23 +20,24 @@
         "type": "string"
       }
     },
-    "group": {
+    "space": {
       "type": "string"
     },
     "status": {
-      "type": "string",
-      "enum": ["reserved", "checkedIn", "checkedOut", "cancelled", "noShow"]
+      "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",
+      "type": ["string", "object"],
       "format": "date-time"
     },
     "checkOutDateTime": {
-      "type": "string",
-      "format": "date-time" 
+      "type": ["string", "object"],
+      "format": "date-time"
     },
     "adultCount": {
       "type": "number",
@@ -61,6 +62,10 @@
     },
     "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

@@ -56,18 +56,11 @@
         "$ref": "https://api.kohost.app/schemas/v3/courtesy.json"
       }
     },
-    "sceneControllers": {
-      "type": "array",
-      "default": [],
-      "items": {
-        "$ref": "https://api.kohost.app/schemas/v3/sceneController.json"
-      }
-    },
     "cameras": {
       "type": "array",
       "default": [],
       "items": {
-        "$ref": "https://api.kohost.app/schemas/v3/camera.json"
+        "$ref": "https://api.kohost.app/schemas/v3/camera.json" 
       }
     },
     "sources": {

package/schemas/shortLink.json

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

package/schemas/switch.json

@@ -14,9 +14,6 @@
     "subType": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -26,6 +23,9 @@
     "state": {
       "type": "string",
       "enum": ["on", "off"]
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/schemas/thermostat.json

@@ -18,10 +18,6 @@
     "subType": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData",
-      "default": {}
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -29,12 +25,10 @@
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "currentTemperature": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 130
+      "type": "number"
     },
     "currentHumidity": {
-      "type": ["number", "null"],
+      "type": "number",
       "minimum": 0,
       "maximum": 99
     },
@@ -80,6 +74,7 @@
     },
     "setpoints": {
       "type": "object",
+      "additionalProperties": false,
       "properties": {
         "cool": {
           "$ref": "#/$defs/setpoint"
@@ -91,6 +86,13 @@
           "$ref": "#/$defs/setpoint"
         }
       }
+    },
+    "batteryLevel": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/batteryLevel"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData",
+      "default": {}
     }
   },
   "additionalProperties": false,
@@ -125,7 +127,6 @@
     "id",
     "type",
     "systemData",
-    "currentTemperature",
     "hvacMode",
     "fanMode",
     "hvacState",
@@ -133,6 +134,6 @@
     "setpoints",
     "temperatureScale",
     "supportedHvacModes",
-    "supportedFanModes"
+    "supportedFanModes" 
   ]
 }

package/schemas/user.json

@@ -13,7 +13,7 @@
       "default": "user"
     },
     "active": {
-      "type": "boolean", 
+      "type": "boolean",
       "default": true
     },
     "firstName": {
@@ -23,14 +23,23 @@
       "type": "string"
     },
     "phone": {
-      "type": "string",
-      "pattern": "^\\+?[0-9]{1,14}$"  
+      "type": ["string", "null"],
+      "pattern": "^\\+[0-9]{1,14}$"
+    },
+    "phoneVerified": {
+      "type": "boolean"
     },
     "email": {
-      "type": "string",
+      "type": ["string", "null"],
       "format": "email"
     },
-    "hashedPassword": {
+    "emailVerified": {
+      "type": "boolean"
+    },
+    "address": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/address"
+    },
+    "secretKey": {
       "type": "string"
     },
     "photo": {
@@ -43,7 +52,25 @@
       "type": "string"
     },
     "gender": {
-      "type": "string"
+      "type": "string",
+      "enum": ["male", "female"]
+    },
+    "nationality": {
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 2
+    },
+    "notes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "files": {
+      "type": "array",
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/file"
+      }
     },
     "roles": {
       "type": "array",
@@ -62,20 +89,20 @@
       }
     },
     "identifications": {
-      "type":"array",
+      "type": "array",
       "items": {
-        "$ref": "https://api.kohost.app/schemas/v3/identification.json"
+        "$ref": "https://api.kohost.app/schemas/v3/identification.json#"
       }
-    },    
+    },
     "payments": {
-      "type":"array",
+      "type": "array",
       "items": {
-        "$ref": "https://api.kohost.app/schemas/v3/payment.json"
+        "$ref": "https://api.kohost.app/schemas/v3/payment.json#"
       }
     },
     "preferences": {
       "type": "object",
-      "additionalProperties": false, 
+      "additionalProperties": false,
       "properties": {
         "notifications": {
           "type": "array",
@@ -110,7 +137,32 @@
           "type": ["number", "null"]
         }
       }
-    },   
+    },
+    "registeredDevices": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "userAgent": {
+            "type": "string"
+          },
+          "fingerPrint": {
+            "type": "string"
+          },
+          "ip": {
+            "type": "string"
+          },
+          "registeredAt": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "expiresAt": {
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      }
+    },
     "createdAt": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
     },

package/schemas/windowCovering.json

@@ -14,9 +14,6 @@
     "subType": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
-    "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
-    },
     "supportedNotifications": {
       "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
@@ -27,6 +24,9 @@
       "type": "number",
       "minimum": 0,
       "maximum": 100
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     }
   },
   "additionalProperties": false,

package/tests/unit/models/user.test.js

@@ -0,0 +1,28 @@
+const User = require("../../../models/user");
+
+const valid = {
+  firstName: "Ian",
+  lastName: "Rogers",
+  active: true,
+  type: "user",
+  email: "a3@bc.com",
+  phone: "+15555555555",
+  roles: ["Guest"],
+};
+
+test("does not throw error if invalid name provided ", () => {
+  const data = { ...valid };
+  expect(() => new User(data)).not.toThrow();
+});
+
+test("allows email to be empty", () => {
+  const data = { ...valid };
+  delete data.email;
+  expect(() => new User(data)).not.toThrow();
+});
+
+test("allows phone to be empty", () => {
+  const data = { ...valid };
+  delete data.phone;
+  expect(() => new User(data)).not.toThrow();
+});