@kohost/api-client 3.1.24 → 3.2.0

package/dist/cjs/schemas/policy.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "policy.json",
+  "title": "Policy",
+  "description": "A policy is a set of permissions that can be applied to a user to limit their access to resources.",
+  "type": "object",
+  "required": [
+    "name",
+    "type",
+    "organizationId",
+    "propertyId",
+    "permissions",
+    "discriminator"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "type": {
+      "type": "string",
+      "default": "policy",
+      "enum": ["policy"]
+    },
+    "discriminator": {
+      "type": "string",
+      "enum": ["user"]
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "description": {
+      "type": "string"
+    },
+    "organizationId": {
+      "type": "string"
+    },
+    "propertyId": {
+      "type": "string"
+    },
+    "permissions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["entities", "effect"],
+        "properties": {
+          "entities": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "pattern": "^[^:]+(:.+)+$"
+            }
+          },
+          "effect": {
+            "type": "string",
+            "enum": ["Allow", "Deny"]
+          }
+        }
+      }
+    }
+  }
+}

package/dist/cjs/schemas/product.json

@@ -10,7 +10,8 @@
     },
     "type": {
       "type": "string",
-      "default": "product"
+      "default": "product",
+      "enum": ["product"]
     },
     "name": {
       "type": "string"

package/dist/cjs/schemas/property.json

@@ -14,7 +14,8 @@
     },
     "type": {
       "type": "string",
-      "default": "property"
+      "default": "property",
+      "enum": ["property"]
     },
     "discriminator": {
       "type": "string",
@@ -148,7 +149,7 @@
             },
             "roomUpgrades": {},
             "pet": {},
-            "promo": {}
+            "promos": {}
           }
         },
         "CheckOut": {

package/dist/cjs/schemas/reservation.json

@@ -16,7 +16,8 @@
     },
     "type": {
       "type": "string",
-      "default": "reservation"
+      "default": "reservation",
+      "enum": ["reservation"]
     },
     "sharedGuests": {
       "type": "array",

package/dist/cjs/schemas/room.json

@@ -8,6 +8,11 @@
     "id": {
       "$ref": "definitions.json#/definitions/id"
     },
+    "type": {
+      "type": "string",
+      "enum": ["room"],
+      "default": "room"
+    },
     "name": {
       "type": "string"
     },

package/dist/cjs/schemas/scene.json

@@ -14,6 +14,11 @@
     "description": {
       "type": "string"
     },
+    "type": {
+      "type": "string",
+      "enum": ["scene"],
+      "default": "scene"
+    },
     "devices": {
       "type": "object",
       "properties": {

package/dist/cjs/schemas/shortLink.json

@@ -10,7 +10,8 @@
     },
     "type": {
       "type": "string",
-      "default": "shortLink"
+      "default": "shortLink",
+      "enum": ["shortLink"]
     },
     "title": {
       "type": "string"

package/dist/cjs/schemas/smsMessage.json

@@ -10,7 +10,8 @@
     },
     "type": {
       "type": "string",
-      "default": "smsMessage"
+      "default": "smsMessage",
+      "enum": ["smsMessage"]
     },
     "to": {
       "type": "string",

package/dist/cjs/schemas/space.json

@@ -13,7 +13,8 @@
     },
     "type": {
       "type": "string",
-      "default": "space"
+      "default": "space",
+      "enum": ["space"]
     },
     "discriminator": {
       "type": "string",

package/dist/cjs/schemas/systemUser.json

@@ -11,7 +11,8 @@
     },
     "type": {
       "type": "string",
-      "default": "systemUser"
+      "default": "systemUser",
+      "enum": ["systemUser"]
     },
     "driver": {
       "$ref": "definitions.json#/definitions/driver"
@@ -50,7 +51,14 @@
       "type": "array",
       "items": {
         "type": "string",
-        "enum": ["Guest", "User", "Manager", "Administrator", "SuperAdmin"]
+        "enum": [
+          "Guest",
+          "User",
+          "Manager",
+          "Maintenance",
+          "Administrator",
+          "SuperAdmin"
+        ]
       }
     },
     "nationality": {

package/dist/cjs/schemas/ticket.json

@@ -140,6 +140,11 @@
       "enum": ["open", "pending", "solved", "closed"],
       "default": "open"
     },
+    "priority": {
+      "type": "string",
+      "enum": ["low", "normal", "high"],
+      "default": "normal"
+    },
     "tags": {
       "type": "array",
       "default": [],

package/dist/cjs/schemas/timeSheet.json

@@ -36,7 +36,7 @@
           },
           "discriminator": {
             "type": "string",
-            "enum": ["working", "driving", "meeting"]
+            "enum": ["working", "driving", "meeting", "break"]
           },
           "start": {
             "type": ["string", "object"],

package/dist/cjs/schemas/user.json

@@ -61,42 +61,39 @@
       "default": [],
       "items": {
         "type": "object",
-        "required": ["organization", "property", "role"],
+        "required": ["organizationId", "propertyId", "role"],
         "properties": {
-          "organization": {
+          "organizationId": {
             "type": "string",
             "description": "The ID of the organization the permission is applies to."
           },
-          "property": {
+          "propertyId": {
             "type": "string",
             "description": "The ID of the property the permission is applies to."
           },
           "role": {
             "type": "string",
-            "enum": ["Guest", "User", "Manager", "Administrator", "SuperAdmin"]
+            "enum": [
+              "Guest",
+              "User",
+              "Manager",
+              "Maintenance",
+              "Administrator",
+              "SuperAdmin"
+            ]
           },
-          "customPermissions": {
+          "policyIds": {
             "type": "array",
             "items": {
-              "type": "object",
-              "properties": {
-                "discriminator": {
-                  "type": "string",
-                  "enum": ["RoomControl.spaces", "Concierge.timeTracking"]
-                },
-                "onlyIncludeIds": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                },
-                "excludeSubSystems": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                }
-              }
+              "type": "string",
+              "description": "ID of a policy that is applied to this role."
+            }
+          },
+          "policies": {
+            "type": "array",
+            "items": {
+              "description": "A policy object populated from the policyIds array.",
+              "$ref": "policy.json"
             }
           }
         },
@@ -173,14 +170,14 @@
           "systemId": {
             "type": "string"
           },
-          "property": {
+          "propertyId": {
             "type": "string"
           },
           "driver": {
             "type": "string"
           }
         },
-        "required": ["systemId", "property", "driver"],
+        "required": ["systemId", "propertyId", "driver"],
         "additionalProperties": false
       }
     }

package/dist/cjs/utils/entityFactory.js

@@ -0,0 +1,80 @@
+const Models = require("../Models");
+
+module.exports = function entityFactory(type) {
+  switch (type) {
+    case "reservation":
+      return Models.Reservation;
+    case "mediaFile":
+      return Models.MediaFile;
+    case "switch":
+      return Models.Switch;
+    case "alarm":
+      return Models.Alarm;
+    case "dimmer":
+      return Models.Dimmer;
+    case "lock":
+      return Models.Lock;
+    case "thermostat":
+      return Models.Thermostat;
+    case "windowCovering":
+      return Models.WindowCovering;
+    case "identification":
+      return Models.Identification;
+    case "user":
+      return Models.User;
+    case "systemUser":
+      return Models.SystemUser;
+    case "policy":
+      return Models.Policy;
+    case "courtesy":
+      return Models.Courtesy;
+    case "camera":
+      return Models.Camera;
+    case "motionSensor":
+      return Models.MotionSensor;
+    case "mediaSource":
+      return Models.MediaSource;
+    case "room":
+      return Models.Room;
+    case "space":
+      return Models.Space;
+    case "category":
+      return Models.Category;
+    case "ticket":
+      return Models.Ticket;
+    case "scene":
+      return Models.Scene;
+    case "gateway":
+      return Models.Gateway;
+    case "product":
+      return Models.Product;
+    case "order":
+      return Models.Order;
+    case "discoveredDevice":
+      return Models.DiscoveredDevice;
+    case "deviceRouter":
+      return Models.DeviceRouter;
+    case "credential":
+      return Models.Credential;
+    case "shortLink":
+      return Models.ShortLink;
+    case "energyReportShard":
+      return Models.EnergyReportShard;
+    case "energyReport":
+      return Models.EnergyReport;
+    case "smsMessage":
+      return Models.SMSMessage;
+    case "emailMessage":
+      return Models.EmailMessage;
+    case "announcement":
+      return Models.Announcement;
+    case "timeSheet":
+      return Models.TimeSheet;
+    case "property":
+      return Models.Property;
+    case "organization":
+      return Models.Organization;
+    default:
+      throw new Error("Unknown entity type: " + type);
+  }
+};

package/dist/cjs/utils/index.js

@@ -2,10 +2,12 @@ const getFormalDeviceType = require("./getFormalDeviceType");
 const getDeviceTypes = require("./getDeviceTypes");
 const schema = require("./schema");
 const errorFactory = require("./errorFactory");
+const entityFactory = require("./entityFactory");
 
 module.exports = {
   getFormalDeviceType: getFormalDeviceType,
   getDeviceTypes: getDeviceTypes,
   schema: schema,
   errorFactory: errorFactory,
+  entityFactory: entityFactory,
 };