@kohost/api-client 3.1.23 → 3.2.0

package/dist/esm/Models.js

@@ -7737,7 +7737,8 @@ var require_reservation = __commonJS({
         },
         type: {
           type: "string",
-          default: "reservation"
+          default: "reservation",
+          enum: ["reservation"]
         },
         sharedGuests: {
           type: "array",
@@ -8353,7 +8354,8 @@ var require_mediaFile = __commonJS({
         },
         type: {
           type: "string",
-          default: "mediaFile"
+          default: "mediaFile",
+          enum: ["mediaFile"]
         },
         name: {
           type: "string"
@@ -9330,6 +9332,111 @@ var require_Identification = __commonJS({
   }
 });
 
+// src/schemas/policy.json
+var require_policy = __commonJS({
+  "src/schemas/policy.json"(exports, module) {
+    module.exports = {
+      $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"]
+              }
+            }
+          }
+        }
+      }
+    };
+  }
+});
+
+// src/Models/Policy.js
+var require_Policy = __commonJS({
+  "src/Models/Policy.js"(exports, module) {
+    var schemas = require_schema();
+    var schema = require_policy();
+    var Entity = require_Entity();
+    schemas.add(schema);
+    var validator = schemas.compile(schema);
+    var Policy = class extends Entity {
+      static {
+        __name(this, "Policy");
+      }
+      /**
+       * @typedef {import("../schemas/PolicySchema").Policy} PolicyType
+       * Create a Permission Policy instance.
+       * @constructor
+       * @param {PolicyType} policy - The policy object of type PolicyType.
+       */
+      constructor(policy) {
+        super(policy);
+      }
+    };
+    Object.defineProperty(Policy.prototype, "schema", {
+      value: schema
+    });
+    Object.defineProperty(Policy.prototype, "validator", {
+      get: function() {
+        return validator;
+      }
+    });
+    Object.defineProperty(Policy, "validProperties", {
+      value: Object.keys(schema.properties)
+    });
+    module.exports = Policy;
+  }
+});
+
 // src/schemas/user.json
 var require_user = __commonJS({
   "src/schemas/user.json"(exports, module) {
@@ -9396,42 +9503,39 @@ var require_user = __commonJS({
           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"
                 }
               }
             },
@@ -9508,14 +9612,14 @@ var require_user = __commonJS({
               systemId: {
                 type: "string"
               },
-              property: {
+              propertyId: {
                 type: "string"
               },
               driver: {
                 type: "string"
               }
             },
-            required: ["systemId", "property", "driver"],
+            required: ["systemId", "propertyId", "driver"],
             additionalProperties: false
           }
         }
@@ -9633,6 +9737,7 @@ var require_User = __commonJS({
     var Entity = require_Entity();
     var MediaFile = require_MediaFile();
     var Reservation = require_Reservation();
+    var Policy = require_Policy();
     var Identification = require_Identification();
     var { nanoid: nanoid3 } = (init_index_browser2(), __toCommonJS(index_browser_exports2));
     schemas.add(paymentSchema);
@@ -9651,12 +9756,24 @@ var require_User = __commonJS({
       constructor(user) {
         if (user.photo)
           user.photo = new MediaFile(user.photo);
-        if (user.reservations)
+        if (user.reservations) {
           user.reservations = user.reservations.map((res) => new Reservation(res));
-        if (user.identifications)
+        }
+        if (user.identifications) {
           user.identifications = user.identifications.map(
             (id) => new Identification(id)
           );
+        }
+        if (user.permissions) {
+          user.permissions = user.permissions.map((permission) => {
+            if (permission.policies && Array.isArray(permission.policies)) {
+              permission.policies = permission.policies.map(
+                (policy) => new Policy(policy)
+              );
+            }
+            return permission;
+          });
+        }
         super(user);
       }
       static validatePhone(phoneNumber) {
@@ -9743,7 +9860,8 @@ var require_systemUser = __commonJS({
         },
         type: {
           type: "string",
-          default: "systemUser"
+          default: "systemUser",
+          enum: ["systemUser"]
         },
         driver: {
           $ref: "definitions.json#/definitions/driver"
@@ -9782,7 +9900,14 @@ var require_systemUser = __commonJS({
           type: "array",
           items: {
             type: "string",
-            enum: ["Guest", "User", "Manager", "Administrator", "SuperAdmin"]
+            enum: [
+              "Guest",
+              "User",
+              "Manager",
+              "Maintenance",
+              "Administrator",
+              "SuperAdmin"
+            ]
           }
         },
         nationality: {
@@ -9992,7 +10117,8 @@ var require_camera = __commonJS({
           type: "string"
         },
         type: {
-          $ref: "definitions.json#/definitions/type"
+          $ref: "definitions.json#/definitions/type",
+          default: "camera"
         },
         supportedNotifications: {
           $ref: "definitions.json#/definitions/supportedNotifications"
@@ -10159,7 +10285,8 @@ var require_mediaSource = __commonJS({
         },
         type: {
           type: "string",
-          default: "mediaSource"
+          default: "mediaSource",
+          enum: ["mediaSource"]
         },
         discriminator: {
           type: "string",
@@ -10255,10 +10382,15 @@ var require_mediaSource = __commonJS({
             "display",
             "favoriteChannel",
             "play",
+            "playing",
             "stop",
+            "stopped",
             "pause",
+            "paused",
             "fastForward",
+            "fastForwarding",
             "rewind",
+            "rewinding",
             "instantReplay",
             "record",
             "ac3",
@@ -10410,6 +10542,11 @@ var require_room = __commonJS({
         id: {
           $ref: "definitions.json#/definitions/id"
         },
+        type: {
+          type: "string",
+          enum: ["room"],
+          default: "room"
+        },
         name: {
           type: "string"
         },
@@ -10520,6 +10657,11 @@ var require_scene = __commonJS({
         description: {
           type: "string"
         },
+        type: {
+          type: "string",
+          enum: ["scene"],
+          default: "scene"
+        },
         devices: {
           type: "object",
           properties: {
@@ -11025,7 +11167,8 @@ var require_space = __commonJS({
         },
         type: {
           type: "string",
-          default: "space"
+          default: "space",
+          enum: ["space"]
         },
         discriminator: {
           type: "string",
@@ -11460,6 +11603,11 @@ var require_ticket = __commonJS({
           enum: ["open", "pending", "solved", "closed"],
           default: "open"
         },
+        priority: {
+          type: "string",
+          enum: ["low", "normal", "high"],
+          default: "normal"
+        },
         tags: {
           type: "array",
           default: [],
@@ -11656,7 +11804,8 @@ var require_product = __commonJS({
         },
         type: {
           type: "string",
-          default: "product"
+          default: "product",
+          enum: ["product"]
         },
         name: {
           type: "string"
@@ -11741,7 +11890,8 @@ var require_order = __commonJS({
         },
         type: {
           type: "string",
-          default: "order"
+          default: "order",
+          enum: ["order"]
         },
         orderNumber: {
           type: "string"
@@ -11759,10 +11909,14 @@ var require_order = __commonJS({
             "refunded"
           ]
         },
-        user: {
+        userId: {
           $ref: "definitions.json#/definitions/id",
           description: "User id of purchaser"
         },
+        reservationId: {
+          $ref: "definitions.json#/definitions/id",
+          description: "Reservation id if the order is for a reservation"
+        },
         date: {
           $ref: "definitions.json#/definitions/date"
         },
@@ -11792,6 +11946,9 @@ var require_order = __commonJS({
               },
               deliveryClass: {
                 type: "string"
+              },
+              productId: {
+                type: "string"
               }
             }
           }
@@ -12105,7 +12262,8 @@ var require_deviceRouter = __commonJS({
         },
         type: {
           type: "string",
-          default: "deviceRouter"
+          default: "deviceRouter",
+          enum: ["deviceRouter"]
         },
         driver: {
           type: "string"
@@ -12194,13 +12352,13 @@ var require_credential = __commonJS({
         credential: {
           type: "string"
         },
-        user: {
+        userId: {
           type: "string"
         },
-        organization: {
+        organizationId: {
           type: "string"
         },
-        property: {
+        propertyId: {
           type: "string"
         },
         deviceId: {
@@ -12272,7 +12430,8 @@ var require_shortLink = __commonJS({
         },
         type: {
           type: "string",
-          default: "shortLink"
+          default: "shortLink",
+          enum: ["shortLink"]
         },
         title: {
           type: "string"
@@ -12592,7 +12751,8 @@ var require_smsMessage = __commonJS({
         },
         type: {
           type: "string",
-          default: "smsMessage"
+          default: "smsMessage",
+          enum: ["smsMessage"]
         },
         to: {
           type: "string",
@@ -12696,7 +12856,8 @@ var require_emailMessage = __commonJS({
         },
         type: {
           type: "string",
-          default: "emailMessage"
+          default: "emailMessage",
+          enum: ["emailMessage"]
         },
         to: {
           type: "string",
@@ -12926,7 +13087,7 @@ var require_timeSheet = __commonJS({
               },
               discriminator: {
                 type: "string",
-                enum: ["working", "driving", "meeting"]
+                enum: ["working", "driving", "meeting", "break"]
               },
               start: {
                 type: ["string", "object"],
@@ -13033,7 +13194,8 @@ var require_property = __commonJS({
         },
         type: {
           type: "string",
-          default: "property"
+          default: "property",
+          enum: ["property"]
         },
         discriminator: {
           type: "string",
@@ -13167,7 +13329,7 @@ var require_property = __commonJS({
                 },
                 roomUpgrades: {},
                 pet: {},
-                promo: {}
+                promos: {}
               }
             },
             CheckOut: {
@@ -13393,7 +13555,8 @@ var require_organization = __commonJS({
         },
         type: {
           type: "string",
-          default: "organization"
+          default: "organization",
+          enum: ["organization"]
         },
         accountNumber: {
           type: ["number", "null"],
@@ -13589,6 +13752,7 @@ var require_Models = __commonJS({
     var Thermostat = require_Thermostat();
     var WindowCovering = require_WindowCovering();
     var Identification = require_Identification();
+    var Policy = require_Policy();
     var User = require_User();
     var SystemUser = require_SystemUser();
     var Courtesy = require_Courtesy();
@@ -13652,7 +13816,8 @@ var require_Models = __commonJS({
       EmailMessage,
       Order,
       Announcement,
-      TimeSheet
+      TimeSheet,
+      Policy
     };
   }
 });