@kohost/api-client 3.0.0-beta.12 → 3.0.0-beta.18

package/dist/cjs/Models.js

@@ -897,7 +897,7 @@ var require_thermostat = __commonJS({
           type: "array",
           uniqueItems: true,
           items: {
-            enum: ["auto", "low", "medium", "high", "off"]
+            enum: ["auto", "low", "medium", "high", "off", "on"]
           }
         },
         setpoints: {
@@ -915,6 +915,9 @@ var require_thermostat = __commonJS({
             }
           }
         },
+        minAutoDelta: {
+          type: "number"
+        },
         batteryLevel: {
           $ref: "https://api.kohost.app/schemas/v3/definitions/device.json#/definitions/batteryLevel"
         },
@@ -1225,7 +1228,7 @@ var require_user = __commonJS({
       $id: "https://api.kohost.app/schemas/v3/user.json",
       title: "User",
       type: "object",
-      required: ["active", "lastName", "roles"],
+      required: ["firstName", "lastName"],
       properties: {
         id: {
           $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
@@ -1234,10 +1237,6 @@ var require_user = __commonJS({
           type: "string",
           default: "user"
         },
-        active: {
-          type: "boolean",
-          default: true
-        },
         firstName: {
           type: "string"
         },
@@ -1282,32 +1281,44 @@ var require_user = __commonJS({
           minLength: 2,
           maxLength: 2
         },
-        notes: {
+        permissions: {
           type: "array",
+          default: [],
           items: {
-            type: "string"
+            type: "object",
+            required: ["organization", "property", "role"],
+            properties: {
+              organization: {
+                type: "string",
+                description: "The ID of the organization the permission is applies to."
+              },
+              property: {
+                type: "string",
+                description: "The ID of the property the permission is applies to."
+              },
+              role: {
+                type: "string",
+                enum: ["Guest", "User", "Manager", "Administrator", "SuperAdmin"]
+              },
+              customPermissions: {
+                type: "array",
+                items: {
+                  type: "string"
+                }
+              }
+            }
           }
         },
-        files: {
+        notes: {
           type: "array",
           items: {
-            $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/file"
+            type: "string"
           }
         },
-        roles: {
+        files: {
           type: "array",
           items: {
-            type: "string",
-            enum: [
-              "Guest",
-              "Staff",
-              "Faculty",
-              "Student",
-              "Visitor",
-              "Manager",
-              "Administrator",
-              "SuperAdmin"
-            ]
+            $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/file"
           }
         },
         identifications: {
@@ -1322,25 +1333,6 @@ var require_user = __commonJS({
             $ref: "https://api.kohost.app/schemas/v3/payment.json#"
           }
         },
-        preferences: {
-          type: "object",
-          additionalProperties: false,
-          properties: {
-            notifications: {
-              type: "array",
-              items: {
-                type: "string"
-              },
-              examples: [["roomControl", "marketing"]]
-            },
-            location: {
-              title: "The location Schema",
-              type: "boolean",
-              default: false,
-              examples: [true]
-            }
-          }
-        },
         location: {
           type: "object",
           required: ["accuracy", "latitude", "longitude", "timestamp"],
@@ -1360,31 +1352,6 @@ var require_user = __commonJS({
             }
           }
         },
-        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"
         },
@@ -1392,7 +1359,10 @@ var require_user = __commonJS({
           $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/updatedAt"
         },
         systemData: {
-          $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+          type: "array",
+          items: {
+            $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+          }
         }
       }
     };
@@ -1428,6 +1398,9 @@ var require_payment = __commonJS({
             "vpay"
           ]
         },
+        storageData: {
+          type: ["string", "null"]
+        },
         maskedNumber: {
           string: "string"
         },
@@ -1489,10 +1462,161 @@ var require_user2 = __commonJS({
         return `${this.firstName} ${this.lastName}`;
       }
     });
+    Object.defineProperty(User2.prototype, "roles", {
+      get: function() {
+        const roles = /* @__PURE__ */ new Set();
+        if (this.permissions) {
+          for (const permission of this.permissions) {
+            roles.add(permission.role);
+          }
+        }
+        return Array.from(roles);
+      }
+    });
     module2.exports = User2;
   }
 });
 
+// src/schemas/systemUser.json
+var require_systemUser = __commonJS({
+  "src/schemas/systemUser.json"(exports2, module2) {
+    module2.exports = {
+      $schema: "http://json-schema.org/draft-07/schema",
+      $id: "https://api.kohost.app/schemas/v3/systemUser.json",
+      title: "System User",
+      description: "A system user is a user that originated from an external 3rd party system.",
+      type: "object",
+      required: ["firstName", "lastName"],
+      properties: {
+        id: {
+          $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+        },
+        type: {
+          type: "string",
+          default: "systemUser"
+        },
+        firstName: {
+          type: "string"
+        },
+        lastName: {
+          type: "string"
+        },
+        phone: {
+          type: ["string", "null"],
+          pattern: "^\\+[0-9]{1,14}$"
+        },
+        email: {
+          type: ["string", "null"],
+          format: "email"
+        },
+        address: {
+          $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/address"
+        },
+        photo: {
+          type: "string"
+        },
+        jobTitle: {
+          type: "string"
+        },
+        dob: {
+          type: "string"
+        },
+        gender: {
+          type: "string",
+          enum: ["male", "female"]
+        },
+        roles: {
+          type: "array",
+          items: {
+            type: "string",
+            enum: ["Guest", "User", "Manager", "Administrator", "SuperAdmin"]
+          }
+        },
+        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"
+          }
+        },
+        identifications: {
+          type: "array",
+          items: {
+            $ref: "https://api.kohost.app/schemas/v3/identification.json#"
+          }
+        },
+        payments: {
+          type: "array",
+          items: {
+            $ref: "https://api.kohost.app/schemas/v3/payment.json#"
+          }
+        },
+        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"
+        },
+        systemData: {
+          $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
+        }
+      }
+    };
+  }
+});
+
+// src/Models/systemUser.js
+var require_systemUser2 = __commonJS({
+  "src/Models/systemUser.js"(exports2, module2) {
+    var schemas = require_schema();
+    var schema = require_systemUser();
+    var Kohost = require_kohost();
+    schemas.add(schema);
+    var validator = schemas.compile(schema);
+    var SystemUser2 = class extends Kohost {
+      constructor(data) {
+        super(data);
+      }
+      static validatePhone(phoneNumber) {
+        const regex = /^\+?[1-9]\d{1,14}$/;
+        return regex.test(phoneNumber);
+      }
+      static validateEmail(email) {
+        const regex = /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+        return regex.test(email);
+      }
+    };
+    __name(SystemUser2, "SystemUser");
+    Object.defineProperty(SystemUser2.prototype, "schema", {
+      value: schema
+    });
+    Object.defineProperty(SystemUser2.prototype, "validator", {
+      get: function() {
+        return validator;
+      }
+    });
+    Object.defineProperty(SystemUser2, "validProperties", {
+      value: Object.keys(schema.properties)
+    });
+    Object.defineProperty(SystemUser2.prototype, "fullName", {
+      get: function() {
+        return `${this.firstName} ${this.lastName}`;
+      }
+    });
+    module2.exports = SystemUser2;
+  }
+});
+
 // src/schemas/courtesy.json
 var require_courtesy = __commonJS({
   "src/schemas/courtesy.json"(exports2, module2) {
@@ -2233,6 +2357,30 @@ var require_room2 = __commonJS({
             return `${type}s`;
         }
       }
+      static getDeviceTypeFromPath(path) {
+        const validPaths = [
+          "dimmers",
+          "switches",
+          "thermostats",
+          "locks",
+          "windowCoverings",
+          "courtesy",
+          "cameras",
+          "sources",
+          "motionSensors",
+          "alarms"
+        ];
+        if (!validPaths.includes(path))
+          throw new Error("Invalid device path:" + path);
+        switch (path) {
+          case "courtesy":
+            return path;
+          case "switches":
+            return "switch";
+          default:
+            return path.slice(0, -1);
+        }
+      }
       get hasDimmer() {
         var _a;
         return ((_a = this.dimmers) == null ? void 0 : _a.length) > 0;
@@ -2245,10 +2393,16 @@ var require_room2 = __commonJS({
         var _a;
         return ((_a = this.windowCoverings) == null ? void 0 : _a.length) > 0;
       }
+      get hasShade() {
+        return this.hasWindowCovering;
+      }
       get hasThermostat() {
         var _a;
         return ((_a = this.thermostats) == null ? void 0 : _a.length) > 0;
       }
+      get hasClimate() {
+        return this.hasThermostat;
+      }
       get hasLock() {
         var _a;
         return ((_a = this.locks) == null ? void 0 : _a.length) > 0;
@@ -2269,6 +2423,13 @@ var require_room2 = __commonJS({
         var _a;
         return ((_a = this.sources) == null ? void 0 : _a.length) > 0;
       }
+      get hasLight() {
+        var _a;
+        const hasSubTypeLight = (_a = this.switches) == null ? void 0 : _a.some((sw) => {
+          return sw.subType === "light" || sw.subType === "fan";
+        });
+        return this.hasDimmer || hasSubTypeLight;
+      }
       get occupied() {
         const now = /* @__PURE__ */ new Date();
         const lastOccupied = new Date(this.occupiedAt);
@@ -3133,7 +3294,7 @@ var require_product = __commonJS({
       $id: "https://api.kohost.app/schemas/v3/product.json",
       title: "Product",
       type: "object",
-      required: ["name", "description", "price", "currency"],
+      required: ["name", "price", "currency"],
       properties: {
         id: {
           $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
@@ -3159,6 +3320,10 @@ var require_product = __commonJS({
         image: {
           $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/file"
         },
+        imageUrl: {
+          format: "uri",
+          pattern: "^https?://"
+        },
         systemData: {
           $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/systemData"
         }
@@ -3205,7 +3370,7 @@ var require_discoveredDevice = __commonJS({
       title: "Discovered Device",
       description: "A device that has been discovered by Kohost, but not yet added to the Kohost system.",
       type: "object",
-      required: ["name", "deviceId", "driver", "deviceData"],
+      required: ["name", "deviceId", "deviceData"],
       properties: {
         id: {
           $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
@@ -3402,83 +3567,16 @@ var require_shortLink2 = __commonJS({
   }
 });
 
-// src/schemas/admin/customer.json
-var require_customer = __commonJS({
-  "src/schemas/admin/customer.json"(exports2, module2) {
-    module2.exports = {
-      $schema: "http://json-schema.org/draft-07/schema",
-      $id: "https://api.kohost.app/schemas/v3/admin/customer.json",
-      title: "Customer",
-      type: "object",
-      description: "A Kohost customer",
-      required: ["accountNumber", "name"],
-      properties: {
-        id: {
-          $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
-        },
-        accountNumber: {
-          type: "number",
-          minimum: 1e4
-        },
-        name: {
-          type: "string"
-        },
-        properties: {
-          type: "array",
-          items: {
-            type: "string"
-          }
-        },
-        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"
-        }
-      }
-    };
-  }
-});
-
-// src/Models/admin/customer.js
-var require_customer2 = __commonJS({
-  "src/Models/admin/customer.js"(exports2, module2) {
-    var schemas = require_schema();
-    var schema = require_customer();
-    var Kohost = require_kohost();
-    schemas.add(schema);
-    var validator = schemas.compile(schema);
-    var Customer = class extends Kohost {
-      constructor(data) {
-        super(data);
-      }
-    };
-    __name(Customer, "Customer");
-    Object.defineProperty(Customer.prototype, "schema", {
-      value: schema
-    });
-    Object.defineProperty(Customer.prototype, "validator", {
-      get: function() {
-        return validator;
-      }
-    });
-    Object.defineProperty(Customer, "validProperties", {
-      value: Object.keys(schema.properties)
-    });
-    module2.exports = Customer;
-  }
-});
-
-// src/schemas/admin/property.json
+// src/schemas/property.json
 var require_property = __commonJS({
-  "src/schemas/admin/property.json"(exports2, module2) {
+  "src/schemas/property.json"(exports2, module2) {
     module2.exports = {
       $schema: "http://json-schema.org/draft-07/schema",
       $id: "https://api.kohost.app/schemas/v3/admin/property.json",
       title: "Property",
       type: "object",
       description: "A property is a physical asset or building",
-      required: ["id", "name", "type", "hostname"],
+      required: ["id", "name", "type", "hostname", "organization"],
       properties: {
         id: {
           $ref: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
@@ -3499,6 +3597,10 @@ var require_property = __commonJS({
         hostname: {
           type: "string"
         },
+        organization: {
+          type: "string",
+          description: "Reference to the organization that owns this property"
+        },
         address: {
           type: "object",
           properties: {
@@ -3654,32 +3756,103 @@ var require_property = __commonJS({
   }
 });
 
-// src/Models/admin/property.js
+// src/Models/property.js
 var require_property2 = __commonJS({
-  "src/Models/admin/property.js"(exports2, module2) {
+  "src/Models/property.js"(exports2, module2) {
     var schemas = require_schema();
     var schema = require_property();
     var Kohost = require_kohost();
     schemas.add(schema);
     var validator = schemas.compile(schema);
-    var Property = class extends Kohost {
+    var Property2 = class extends Kohost {
+      constructor(data) {
+        super(data);
+      }
+    };
+    __name(Property2, "Property");
+    Object.defineProperty(Property2.prototype, "schema", {
+      value: schema
+    });
+    Object.defineProperty(Property2.prototype, "validator", {
+      get: function() {
+        return validator;
+      }
+    });
+    Object.defineProperty(Property2, "validProperties", {
+      value: Object.keys(schema.properties)
+    });
+    module2.exports = Property2;
+  }
+});
+
+// src/schemas/organization.json
+var require_organization = __commonJS({
+  "src/schemas/organization.json"(exports2, module2) {
+    module2.exports = {
+      $schema: "http://json-schema.org/draft-07/schema",
+      $id: "https://api.kohost.app/schemas/v3/admin/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: "https://api.kohost.app/schemas/v3/definitions/common.json#/definitions/id"
+        },
+        accountNumber: {
+          type: "number",
+          minimum: 1e4
+        },
+        name: {
+          type: "string"
+        },
+        properties: {
+          type: "array",
+          items: {
+            type: "string"
+          }
+        },
+        credentials: {
+          type: "object",
+          additionalProperties: true
+        },
+        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"
+        }
+      }
+    };
+  }
+});
+
+// src/Models/organization.js
+var require_organization2 = __commonJS({
+  "src/Models/organization.js"(exports2, module2) {
+    var schemas = require_schema();
+    var schema = require_organization();
+    var Kohost = require_kohost();
+    schemas.add(schema);
+    var validator = schemas.compile(schema);
+    var Organization2 = class extends Kohost {
       constructor(data) {
         super(data);
       }
     };
-    __name(Property, "Property");
-    Object.defineProperty(Property.prototype, "schema", {
+    __name(Organization2, "Organization");
+    Object.defineProperty(Organization2.prototype, "schema", {
       value: schema
     });
-    Object.defineProperty(Property.prototype, "validator", {
+    Object.defineProperty(Organization2.prototype, "validator", {
       get: function() {
         return validator;
       }
     });
-    Object.defineProperty(Property, "validProperties", {
+    Object.defineProperty(Organization2, "validProperties", {
       value: Object.keys(schema.properties)
     });
-    module2.exports = Property;
+    module2.exports = Organization2;
   }
 });
 
@@ -3692,6 +3865,7 @@ var Thermostat = require_thermostat2();
 var WindowCovering = require_windowCovering2();
 var Identification = require_identification2();
 var User = require_user2();
+var SystemUser = require_systemUser2();
 var Courtesy = require_courtesy2();
 var Camera = require_camera2();
 var MotionSensor = require_motionSensor2();
@@ -3708,13 +3882,11 @@ var Product = require_product2();
 var DiscoveredDevice = require_discoveredDevice2();
 var Credential = require_credential2();
 var ShortLink = require_shortLink2();
-var AdminCustomer = require_customer2();
-var AdminProperty = require_property2();
+var Property = require_property2();
+var Organization = require_organization2();
 module.exports = {
-  Admin: {
-    Customer: AdminCustomer,
-    Property: AdminProperty
-  },
+  Organization,
+  Property,
   Gateway,
   Switch,
   Alarm,
@@ -3729,6 +3901,7 @@ module.exports = {
   Identification,
   Product,
   User,
+  SystemUser,
   Room,
   Application,
   Space,