npm - @kohost/api-client - Versions diffs - 1.0.0-alpha.1 → 1.0.0-alpha.3 - Mend

@kohost/api-client 1.0.0-alpha.1 → 1.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (111) hide show

package/.eslintrc.js +10 -0
package/bitbucket-pipelines.yml +39 -0
package/commands/Command.js +38 -0
package/commands/SetAlarmCommand.js +21 -0
package/commands/SetCourtesyCommand.js +21 -0
package/commands/SetDimmerCommand.js +21 -0
package/commands/SetLockCommand.js +21 -0
package/commands/SetSceneControllerCommand.js +21 -0
package/commands/SetSwitchCommand.js +21 -0
package/commands/SetThermostatCommand.js +21 -0
package/commands/SetWindowCoveringCommand.js +21 -0
package/commands/VerifyDocumentCommand.js +24 -0
package/commands/index.js +21 -0
package/defs/deviceTypes.js +15 -0
package/defs/formalDeviceTypes.js +6 -0
package/defs/http.js +7 -0
package/defs/index.js +11 -0
package/errors/AppError.js +8 -0
package/errors/AuthenticationError.js +9 -0
package/errors/AuthorizationError.js +9 -0
package/errors/DeviceCommError.js +9 -0
package/errors/LoginError.js +9 -0
package/errors/NotFoundError.js +9 -0
package/errors/RequestError.js +9 -0
package/errors/SystemCommError.js +9 -0
package/errors/TokenExpiredError.js +9 -0
package/errors/UnprocessableRequestError.js +9 -0
package/errors/ValidationError.js +9 -0
package/errors/index.js +15 -0
package/events/Event.js +33 -0
package/events/SystemCameraUpdatedEvent.js +17 -0
package/events/SystemCourtesyUpdatedEvent.js +17 -0
package/events/SystemDimmerUpdatedEvent.js +17 -0
package/events/SystemLockUpdatedEvent.js +17 -0
package/events/SystemReservationUpdatedEvent.js +17 -0
package/events/SystemSceneControllerUpdatedEvent.js +17 -0
package/events/SystemSourceUpdatedEvent.js +17 -0
package/events/SystemSpaceUpdatedEvent.js +17 -0
package/events/SystemSwitchUpdatedEvent.js +17 -0
package/events/SystemThermostatUpdatedEvent.js +17 -0
package/events/SystemUserUpdatedEvent.js +17 -0
package/events/SystemWindowCoveringUpdatedEvent.js +17 -0
package/events/index.js +28 -0
package/http/handleResponseError.js +53 -0
package/http/handleResponseSuccess.js +15 -0
package/http/index.js +159 -0
package/index.js +21 -71
package/models/acl.js +29 -0
package/models/admin/customer.js +28 -0
package/models/admin/property.js +28 -0
package/models/alarm.js +29 -0
package/models/application.js +28 -0
package/models/camera.js +29 -0
package/models/courtesy.js +33 -0
package/models/dimmer.js +49 -0
package/models/discoveredDevice.js +30 -0
package/models/gateway.js +37 -0
package/models/index.js +56 -0
package/models/integration.js +76 -0
package/models/iotGateway.js +29 -0
package/models/kohost.js +95 -0
package/models/lock.js +33 -0
package/models/mediaSource.js +29 -0
package/models/motionSensor.js +29 -0
package/models/reservation.js +36 -0
package/models/room.js +185 -0
package/models/scene.js +28 -0
package/models/sceneController.js +29 -0
package/models/space.js +99 -0
package/models/switch.js +33 -0
package/models/thermostat.js +80 -0
package/models/ticket.js +91 -0
package/models/user.js +58 -0
package/models/windowCovering.js +49 -0
package/package.json +27 -5
package/prepare.js +4 -0
package/schemas/acl.json +111 -0
package/schemas/admin/customer.json +32 -0
package/schemas/admin/property.json +54 -0
package/schemas/alarm.json +5 -5
package/schemas/application.json +24 -0
package/schemas/camera.json +41 -0
package/schemas/courtesy.json +5 -6
package/schemas/definitions/common.json +21 -0
package/schemas/{device.json → definitions/device.json} +22 -4
package/schemas/dimmer.json +8 -5
package/schemas/discoveredDevice.json +43 -0
package/schemas/gateway.json +45 -13
package/schemas/identification.json +35 -0
package/schemas/integration.json +94 -0
package/schemas/iotGateway.json +29 -0
package/schemas/lock.json +8 -5
package/schemas/mediaSource.json +151 -0
package/schemas/motionSensor.json +26 -0
package/schemas/payment.json +38 -0
package/schemas/reservation.json +66 -0
package/schemas/room.json +138 -0
package/schemas/scene.json +118 -0
package/schemas/sceneController.json +18 -6
package/schemas/space.json +111 -0
package/schemas/switch.json +8 -5
package/schemas/thermostat.json +19 -10
package/schemas/ticket.json +82 -0
package/schemas/user.json +124 -0
package/schemas/windowCovering.json +8 -5
package/tests/unit/models/space.test.js +31 -0
package/tests/unit/models/thermostat.test.js +146 -0
package/useCases/http.json +902 -0
package/utils/getDeviceTypes.js +7 -0
package/utils/getFormalDeviceType.js +5 -0
package/utils/schema.js +28 -0

package/schemas/motionSensor.json ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/motionSensor.json",
+  "title": "Motion Sensor",
+  "description": "Any smart motion sensor",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
+    },
+    "type": {
+      "$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"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "systemData"]
+}

package/schemas/payment.json ADDED Viewed

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/payment.json",
+  "title": "Payment",
+  "type": "object",
+  "required": ["type", "maskedNumber", "expires"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "amex",
+        "visa",
+        "masterCard",
+        "discover",
+        "diners",
+        "jcb",
+        "applePay",
+        "alipay",
+        "chinaUnionPay"
+      ]
+    },
+    "maskedNumber": {
+      "string": "string"
+    },
+    "issued": {
+      "type": ["string", "null"]
+    },
+    "expires": {
+      "string": "string"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  }
+}

package/schemas/reservation.json ADDED Viewed

@@ -0,0 +1,66 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/reservation.json",
+  "title": "Reservation",
+  "type": "object",
+  "required": ["type", "status", "checkInDateTime", "checkOutDateTime"],
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "primaryGuest": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string"
+    },
+    "sharedGuests": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "group": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["reserved", "checkedIn", "checkedOut", "cancelled", "noShow"]
+    },
+    "confirmationNumber": {
+      "type": "string"
+    },
+    "checkInDateTime": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "checkOutDateTime": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "adultCount": {
+      "type": "number",
+      "default": 1,
+      "minimum": 1
+    },
+    "childCount": {
+      "type": "number",
+      "default": 0
+    },
+    "rateSuppressed": {
+      "type": "boolean"
+    },
+    "payment": {
+      "type": "string"
+    },
+    "company": {
+      "type": "string"
+    },
+    "travelAgent": {
+      "type": "string"
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  }
+}

package/schemas/room.json ADDED Viewed

@@ -0,0 +1,138 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/room.json",
+  "title": "Room",
+  "description": "A room represents a physical space of controllable IoT devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "floor": {
+      "type": "string"
+    },
+    "dimmers": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/dimmer.json"
+      }
+    },
+    "switches": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/switch.json"
+      }
+    },
+    "thermostats": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/thermostat.json"
+      }
+    },
+    "locks": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/lock.json"
+      }
+    },
+    "windowCoverings": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/windowCovering.json"
+      }
+    },
+    "courtesy": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$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"
+      }
+    },
+    "sources": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/mediaSource.json"
+      }
+    },
+    "motionSensors": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/motionSensor.json"
+      }
+    },
+    "alarms": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "$ref": "https://api.kohost.app/schemas/v3/alarm.json"
+      }
+    },
+    "media": {
+      "type": "object",
+      "additionalProperties": false,
+      "default": {
+        "volume": 0,
+        "currentSource": null
+      },
+      "properties": {
+        "volume": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "currentSource": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "scenes": {
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "A list of scene IDs for later population, or entire scene objects",
+        "oneOf": [
+          {
+            "$ref": "https://api.kohost.app/schemas/v3/scene.json"
+          },
+          {
+            "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+          }
+        ]
+      }
+    },
+    "occupiedAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    },
+    "createdAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/createdAt"
+    },
+    "updatedAt": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/updatedAt"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/scene.json ADDED Viewed

@@ -0,0 +1,118 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/scene.json",
+  "title": "Scene",
+  "description": "A room represents a physical space of controllable IoT devices",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "devices": {
+      "type": "object",
+      "properties": {
+        "switches": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "state": {
+                "$ref": "https://api.kohost.app/schemas/v3/switch.json#/properties/state"
+              }
+            },
+            "default": []
+          }
+        },
+        "dimmers": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "level": {
+                "$ref": "https://api.kohost.app/schemas/v3/dimmer.json#/properties/level"
+              }
+            }
+          },
+          "default": []
+        },
+        "windowCoverings": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "position": {
+                "$ref": "https://api.kohost.app/schemas/v3/windowCovering.json#/properties/position"
+              }
+            }
+          },
+          "default": []
+        },
+        "thermostats": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "hvacMode": {
+                "$ref": "https://api.kohost.app/schemas/v3/thermostat.json#/properties/hvacMode"
+              },
+              "setpoints": {
+                "$ref": "https://api.kohost.app/schemas/v3/thermostat.json#/properties/setpoints"
+              },
+              "fanMode": {
+                "$ref": "https://api.kohost.app/schemas/v3/thermostat.json#/properties/fanMode"
+              }
+            }
+          },
+          "default": []
+        },
+        "media": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+              },
+              "volume": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 100
+              },
+              "commands": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "isDefault": {
+      "type": "boolean",
+      "default": false
+    },
+    "showOnUi": {
+      "type": "boolean",
+      "default": true
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/sceneController.json CHANGED Viewed

@@ -6,19 +6,22 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/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/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "supportedScenes": {
       "type": "array",
@@ -28,7 +31,7 @@
       }
     },
     "scene": {
-      "type": "object",
+      "type": ["object", "null"],
       "properties": {
         "name": {
           "type": "string",
@@ -39,6 +42,15 @@
           "minimum": 1655907956593
         }
       }
+    },
+    "level": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "state": {
+      "type": "string",
+      "enum": ["on", "off"]
     }
   },
   "additionalProperties": false,

package/schemas/space.json ADDED Viewed

@@ -0,0 +1,111 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://api.kohost.app/schemas/v3/space.json",
+  "title": "Space",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "type": {
+      "type": ["string"],
+      "enum": [
+        "classRoom",
+        "hotelRoom",
+        "office",
+        "building",
+        "commonArea",
+        "other"
+      ]
+    },
+    "rooms": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "subGroups": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "eco": {
+      "type": "object",
+      "additionalProperties": false,
+      "default": {
+        "active": false,
+        "allowed": false
+      },
+      "properties": {
+        "active": {
+          "type": "boolean",
+          "default": false
+        },
+        "activatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "allowed": {
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    "features": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "maximumOccupancy": {
+      "type": "number",
+      "minimum": 1
+    },
+    "housekeepingStatus": {
+      "type": "string",
+      "enum": ["clean", "dirty", "inspected", "pickup"]
+    },
+    "serviceStatus": {
+      "type": "string",
+      "enum": ["inService", "outOfOrder", "outOfService"]
+    },
+    "systemData": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+    }
+  },
+  "if": {
+    "properties": { "type": { "const": "hotelRoom" } }
+  },
+  "then": {
+    "required": [
+      "name",
+      "type",
+      "features",
+      "maximumOccupancy",
+      "housekeepingStatus",
+      "serviceStatus"
+    ],
+    "properties": {
+      "features": {
+        "default": []
+      },
+      "maximumOccupancy": {
+        "default": 2
+      },
+      "housekeepingStatus": {
+        "default": "dirty"
+      },
+      "serviceStatus": {
+        "default": "inService"
+      }
+    }
+  },
+  "else": {
+    "required": ["name", "type"]
+  }
+}

package/schemas/switch.json CHANGED Viewed

@@ -6,19 +6,22 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/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/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData"
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "state": {
       "type": "string",

package/schemas/thermostat.json CHANGED Viewed

@@ -6,27 +6,35 @@
   "type": "object",
   "properties": {
     "id": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/id"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/id"
+    },
+    "name": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/name"
     },
     "type": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/type"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/type",
+      "default": "thermostat"
+    },
+    "subType": {
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/subType"
     },
     "systemData": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/systemData"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/systemData",
+      "default": {}
     },
     "supportedNotifications": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/supportedNotifications"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/supportedNotifications"
     },
     "notification": {
-      "$ref": "https://api.kohost.app/schemas/v3/device.json#/definitions/notification"
+      "$ref": "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/notification"
     },
     "currentTemperature": {
       "type": "number",
       "minimum": 0,
-      "maximum": 99
+      "maximum": 130
     },
     "currentHumidity": {
-      "type": "number",
+      "type": ["number", "null"],
       "minimum": 0,
       "maximum": 99
     },
@@ -48,11 +56,12 @@
     },
     "temperatureScale": {
       "type": "string",
-      "enum": ["celcius", "farenheit"]
+      "enum": ["celsius", "fahrenheit"],
+      "default": "fahrenheit"
     },
     "humidityScale": {
-      "type": "string",
-      "enum": ["absolute", "relative"]
+      "type": ["string", "null"],
+      "enum": ["absolute", "relative", null]
     },
     "supportedHvacModes": {
       "type": "array",