@kohost/api-client 1.0.0-alpha.4 → 1.0.0-beta.1

package/schemas/reservation.json

@@ -20,12 +20,13 @@
         "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"
@@ -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

@@ -24,13 +24,22 @@
     },
     "phone": {
       "type": ["string", "null"],
-      "pattern": "^\\+?[0-9]{1,14}$"
+      "pattern": "^\\+[0-9]{1,14}$"
+    },
+    "phoneVerified": {
+      "type": "boolean"
     },
     "email": {
       "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",
@@ -64,13 +91,13 @@
     "identifications": {
       "type": "array",
       "items": {
-        "$ref": "https://api.kohost.app/schemas/v3/identification.json"
+        "$ref": "https://api.kohost.app/schemas/v3/identification.json#"
       }
     },
     "payments": {
       "type": "array",
       "items": {
-        "$ref": "https://api.kohost.app/schemas/v3/payment.json"
+        "$ref": "https://api.kohost.app/schemas/v3/payment.json#"
       }
     },
     "preferences": {
@@ -111,6 +138,31 @@
         }
       }
     },
+    "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/useCases/http.json

@@ -17,6 +17,33 @@
       }
     }
   ],
+  [
+    "AdminUpdateProperty",
+    {
+      "http": {
+        "method": "PUT",
+        "path": "/admin/properties/:id"
+      }
+    }
+  ],
+  [
+    "AdminDescribeProperty",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/admin/properties/:id"
+      }
+    }
+  ],
+  [
+    "AdminCreateProperty",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/admin/properties"
+      }
+    }
+  ],
   [
     "LoginUser",
     {
@@ -47,6 +74,16 @@
       }
     }
   ],
+  [
+    "RequestLoginLink",
+    {
+      "http": {
+        "disableAuth": true,
+        "method": "POST",
+        "path": "/auth/loginToken"
+      }
+    }
+  ],
   [
     "DescribeSelf",
     {
@@ -84,83 +121,84 @@
     }
   ],
   [
-    "UpdateUser",
+    "UpdateSelf",
     {
       "http": {
         "method": "PUT",
-        "path": "/users/:id"
+        "path": "/users/me"
       }
     }
   ],
   [
-    "DeleteUser",
+    "UpdateUser",
     {
       "http": {
-        "method": "DELETE",
+        "method": "PUT",
         "path": "/users/:id"
       }
     }
   ],
   [
-    "DescribeGateway",
+    "DeleteUser",
     {
       "http": {
-        "method": "GET",
-        "path": "/gateways/:gatewayId"
+        "method": "DELETE",
+        "path": "/users/:id"
       }
     }
   ],
   [
-    "ListGateways",
+    "SendVerificationCode",
     {
       "http": {
-        "method": "GET",
-        "path": "/gateways"
+        "method": "POST",
+        "path": "/users/:id/sendVerificationCode"
       }
     }
   ],
   [
-    "CreateGateway",
+    "CheckVerificationCode",
     {
       "http": {
         "method": "POST",
-        "path": "/gateways"
+        "path": "/users/:id/checkVerificationCode"
       }
     }
   ],
   [
-    "UpdateGateway",
+    "MatchUserIdentification",
     {
       "http": {
-        "method": "PUT",
-        "path": "/gateways/:gatewayId"
+        "method": "POST",
+        "path": "/users/:id/identifications/match",
+        "maxSize": "2mb"
       }
     }
   ],
   [
-    "DeleteGateway",
+    "ListSpaces",
     {
       "http": {
-        "method": "DELETE",
-        "path": "/gateways/:gatewayId"
+        "method": "GET",
+        "path": "/spaces"
       }
     }
   ],
   [
-    "EmailUserAccountSetup",
+    "ListMySpaces",
     {
       "http": {
-        "method": "POST",
-        "path": "/users/:id/email/setup"
+        "method": "GET",
+        "path": "/spaces/mine"
       }
     }
   ],
   [
-    "ListSpaces",
+    "ListRoomsInSpace",
     {
       "http": {
         "method": "GET",
-        "path": "/spaces"
+        "path": "/spaces/:id/rooms"
       }
     }
   ],
@@ -300,7 +338,7 @@
     }
   ],
   [
-    "SetLocks",
+    "SetLock",
     {
       "http": {
         "method": "POST",
@@ -354,7 +392,7 @@
     }
   ],
   [
-    "SetCameras",
+    "SetCamera",
     {
       "http": {
         "method": "POST",
@@ -552,7 +590,7 @@
     }
   ],
   [
-    "SetSwitches",
+    "SetSwitch",
     {
       "http": {
         "method": "POST",
@@ -606,7 +644,7 @@
     }
   ],
   [
-    "SetSceneControllers",
+    "SetSceneController",
     {
       "http": {
         "method": "POST",
@@ -660,7 +698,7 @@
     }
   ],
   [
-    "SetSources",
+    "SetSource",
     {
       "http": {
         "method": "POST",
@@ -714,7 +752,7 @@
     }
   ],
   [
-    "SetThermostats",
+    "SetThermostat",
     {
       "http": {
         "method": "POST",
@@ -768,7 +806,7 @@
     }
   ],
   [
-    "SetWindowCoverings",
+    "SetWindowCovering",
     {
       "http": {
         "method": "POST",
@@ -781,7 +819,7 @@
     {
       "http": {
         "method": "POST",
-        "path": "/rooms/:roomId/scenes"
+        "path": "/rooms/:id/scenes"
       }
     }
   ],
@@ -808,7 +846,7 @@
     {
       "http": {
         "method": "POST",
-        "path": "/tickets/:ticketId/messages"
+        "path": "/tickets/:id/messages"
       }
     }
   ],
@@ -817,7 +855,7 @@
     {
       "http": {
         "method": "DELETE",
-        "path": "/tickets/:ticketId"
+        "path": "/tickets/:id"
       }
     }
   ],
@@ -826,7 +864,7 @@
     {
       "http": {
         "method": "GET",
-        "path": "/tickets/:ticketId"
+        "path": "/tickets/:id"
       }
     }
   ],
@@ -844,7 +882,7 @@
     {
       "http": {
         "method": "POST",
-        "path": "/tickets/:ticketId/readAll"
+        "path": "/tickets/:id/readAll"
       }
     }
   ],
@@ -853,7 +891,7 @@
     {
       "http": {
         "method": "PUT",
-        "path": "/tickets/:ticketId"
+        "path": "/tickets/:id"
       }
     }
   ],
@@ -862,7 +900,7 @@
     {
       "http": {
         "method": "PUT",
-        "path": "/tickets/:ticketId/status"
+        "path": "/tickets/:id/status"
       }
     }
   ],
@@ -1005,21 +1043,24 @@
     }
   ],
   [
-    "UpsertSystemReservation",
+    "UpsertSystemSpace",
     {
       "http": false
     }
   ],
   [
-    "UpsertSystemSpace",
+    "UpsertSystemUser",
     {
       "http": false
     }
   ],
   [
-    "UpsertSystemUser",
+    "DiscoverReservations",
     {
-      "http": false
+      "http": {
+        "method": "GET",
+        "path": "/reservations/discover"
+      }
     }
   ],
   [
@@ -1077,11 +1118,62 @@
     }
   ],
   [
-    "VerifyDocument",
+    "DescribeReservationCheckinStatus",
+    {
+      "http": {
+        "method": "GET",
+        "path": "/reservations/:id/checkinStatus"
+      }
+    }
+  ],
+  [
+    "CheckInReservation",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/:id/checkin"
+      }
+    }
+  ],
+  [
+    "SendPreArrivalSMS",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/:id/sendPreArrivalSMS"
+      }
+    }
+  ],
+  [
+    "SendPreArrivalEmail",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/:id/sendPreArrivalEmail"
+      }
+    }
+  ],
+  [
+    "BatchNotifyPreArrival",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/reservations/batchNotifyPreArrival"
+      }
+    }
+  ],
+  [
+    "UpsertSystemReservation",
+    {
+      "http": false
+    }
+  ],
+  [
+    "OCRDocument",
     {
       "http": {
         "method": "POST",
-        "path": "/documents/verify",
+        "path": "/documents/ocr",
         "maxSize": "2mb"
       }
     }
@@ -1091,8 +1183,24 @@
     {
       "http": {
         "method": "GET",
-        "path": "/properties/mine"
+        "path": "/properties/mine",
+        "disableAuth": true
       }
     }
+  ],
+  [
+    "EmailUserAccountSetup",
+    {
+      "http": {
+        "method": "POST",
+        "path": "/users/:id/email/setup"
+      }
+    }
+  ],
+  [
+    "LogEvent",
+    {
+      "http": false
+    }
   ]
 ]

package/utils/schema.js

@@ -16,13 +16,13 @@ addFormats(ajv);
 
 ajv.addSchema(commonDefs);
 
-ajv.addSchema(deviceDefs);
+ajv.addSchema(deviceDefs); 
 
 module.exports = {
   add: function add(schema) {
     ajv.addSchema(schema);
   },
-  compile: function compile(schema) { 
+  compile: function compile(schema) {  
     return ajv.compile(schema);
   },
 };