@kohost/api-client 3.0.0-beta.99 → 3.0.0

package/dist/cjs/Commands/CreateShortLinkCommand.js

@@ -2,10 +2,10 @@ const Command = require("./Command");
 const RequestError = require("../Errors/RequestError");
 
 class CreateShortLinkCommand extends Command {
-  constructor({ title, destination }) {
+  constructor({ title, destination, ...rest }) {
     if (!title) throw new RequestError("title is required");
     if (!destination) throw new RequestError("destination to is required");
-    super({ title, destination });
+    super({ title, destination, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/OCRDocumentCommand.js

@@ -2,9 +2,9 @@ const Command = require("./Command");
 const RequestError = require("../Errors/RequestError");
 
 class OCRDocumentCommand extends Command {
-  constructor({ type, image }) {
+  constructor({ type, image, ...rest }) {
     if (!image) throw new RequestError("document image is required");
-    super({ type, image });
+    super({ type, image, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/SetAlarmCommand.js

@@ -1,8 +1,8 @@
 const Command = require("./Command");
 
 class SetAlarmCommand extends Command {
-  constructor({ id, zones, areas }) {
-    super({ id, zones, areas });
+  constructor({ id, zones, areas, code, ...rest }) {
+    super({ id, zones, areas, code, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/SetCourtesyCommand.js

@@ -1,8 +1,8 @@
 const Command = require("./Command");
 
 class SetCourtesyCommand extends Command {
-  constructor({ id, state }) {
-    super({ id, state });
+  constructor({ id, state, ...rest }) {
+    super({ id, state, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/SetDimmerCommand.js

@@ -1,8 +1,8 @@
 const Command = require("./Command");
 
 class SetDimmerCommand extends Command {
-  constructor({ id, level }) {
-    super({ id, level });
+  constructor({ id, level, ...rest }) {
+    super({ id, level, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/SetLockCommand.js

@@ -1,8 +1,8 @@
 const Command = require("./Command");
 
 class SetLockCommand extends Command {
-  constructor({ id, state }) {
-    super({ id, state });
+  constructor({ id, state, ...rest }) {
+    super({ id, state, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/SetSwitchCommand.js

@@ -1,8 +1,8 @@
 const Command = require("./Command");
 
 class SetSwitchCommand extends Command {
-  constructor({ id, state }) {
-    super({ id, state });
+  constructor({ id, state, ...rest }) {
+    super({ id, state, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/SetThermostatCommand.js

@@ -1,8 +1,8 @@
 const Command = require("./Command");
 
 class SetThermostatCommand extends Command {
-  constructor({ id, setpoints, hvacMode, fanMode }) {
-    super({ id, setpoints, hvacMode, fanMode });
+  constructor({ id, setpoints, hvacMode, fanMode, ...rest }) {
+    super({ id, setpoints, hvacMode, fanMode, ...rest });
   }
 
   get name() {

package/dist/cjs/Commands/SetWindowCoveringCommand.js

@@ -1,8 +1,8 @@
 const Command = require("./Command");
 
 class SetWindowCoveringCommand extends Command {
-  constructor({ id, position }) {
-    super({ id, position });
+  constructor({ id, position, ...rest }) {
+    super({ id, position, ...rest });
   }
 
   get name() {

package/dist/cjs/Events/ReservationCheckInEvent.js

@@ -0,0 +1,23 @@
+const Event = require("./Event");
+
+class ReservationCheckInEvent extends Event {
+  constructor(reservation) {
+    super(reservation);
+  }
+
+  get name() {
+    return "ReservationCheckIn";
+  }
+
+  get routingKey() {
+    return `${this.data[0].organizationId || "#"}.${
+      this.data[0].propertyId || "#"
+    }.reservation.ReservationCheckIn`;
+  }
+
+  static get entity() {
+    return "reservation";
+  }
+}
+
+module.exports = ReservationCheckInEvent;

package/dist/cjs/Events/ReservationCheckOutEvent.js

@@ -0,0 +1,23 @@
+const Event = require("./Event");
+
+class ReservationCheckOutEvent extends Event {
+  constructor(reservation) {
+    super(reservation);
+  }
+
+  get name() {
+    return "ReservationCheckIn";
+  }
+
+  get routingKey() {
+    return `${this.data[0].organizationId || "#"}.${
+      this.data[0].propertyId || "#"
+    }.reservation.ReservationCheckOut`;
+  }
+
+  static get entity() {
+    return "reservation";
+  }
+}
+
+module.exports = ReservationCheckOutEvent;

package/dist/cjs/Events/index.js

@@ -30,6 +30,10 @@ const ShortLinkCreatedEvent = require("./ShortLinkCreatedEvent");
 const ApplicationInUseEvent = require("./ApplicationInUseEvent");
 const ApplicationOutOfUseEvent = require("./ApplicationOutOfUseEvent");
 
+const ReservationCheckInEvent = require("./ReservationCheckInEvent");
+const ReservationCheckOutEvent = require("./ReservationCheckOutEvent");
+
+
 // Delete Events
 const SystemEntityDeletedEvent = require("./SystemEntityDeletedEvent");
 
@@ -62,4 +66,6 @@ module.exports = {
   ShortLinkCreatedEvent,
   ApplicationInUseEvent,
   ApplicationOutOfUseEvent,
+  ReservationCheckInEvent,
+  ReservationCheckOutEvent
 };

package/dist/cjs/SocketIoClient/index.js

@@ -2,12 +2,15 @@ const io = require("socket.io-client");
 const { EventEmitter } = require("events");
 
 module.exports = class SocketIoClient extends EventEmitter {
-  constructor(config = { url: null, propertyId: null, options: {} }) {
+  constructor(
+    config = {
+      url: null,
+      options: {},
+    }
+  ) {
     super();
-    if (!config.url) throw new Error("Websocket URL / endpoint not provided");
-    if (!config.propertyId) throw new Error("Property ID not provided");
+    if (!config.url) throw new Error("config.url is required");
     this.url = config.url;
-    this.propertyId = config.propertyId;
     this.options = {
       autoConnect: false,
       forceNew: false,
@@ -39,6 +42,16 @@ module.exports = class SocketIoClient extends EventEmitter {
     });
   }
 
+  #url = null;
+
+  get url() {
+    return this.#url;
+  }
+
+  set url(url) {
+    this.#url = url;
+  }
+
   get connected() {
     return this.socket?.connected || false;
   }
@@ -71,4 +84,10 @@ module.exports = class SocketIoClient extends EventEmitter {
   send(event, { data = {}, query = {}, ...rest }) {
     this.socket.emit(event, { data, query, ...rest });
   }
+
+  destroy() {
+    this.disconnect();
+    this.socket.removeAllListeners();
+    this.socket = null;
+  }
 };

package/dist/cjs/schemas/AlarmSchema.d.ts

@@ -145,14 +145,25 @@ export interface Alarm {
     number?: number;
     name?: string;
     securityMode?: "arming" | "disarming" | "armed" | "disarmed" | "alarm" | null;
-    readyToArm?: boolean | null;
   }[];
   zones: {
     number?: number;
     name?: string;
-    secure?: boolean;
+    secure?: boolean | null;
     bypassed?: boolean | null;
   }[];
   watts?: number;
+  address?: Address;
+  [k: string]: unknown;
+}
+export interface Address {
+  id?: string;
+  line1?: string;
+  line2?: string;
+  line3?: string;
+  city?: string;
+  state?: string;
+  postalCode?: string;
+  countryCode?: string;
   [k: string]: unknown;
 }

package/dist/cjs/schemas/CredentialSchema.d.ts

@@ -36,7 +36,7 @@ export interface Credential {
     | "cloudflare-images"
     | "cloudflare-stream"
     | "insperia-privacy";
-  discriminator?: "verificationCode" | "token" | "mobileKey" | "pin" | "publicKey" | "id";
+  discriminator?: "verificationCode" | "token" | "mobileKey" | "pin" | "publicKey" | "passkeyChallenge" | "id";
   credential: string;
   user?: string;
   organization?: string;

package/dist/cjs/schemas/DiscoveredDeviceSchema.d.ts

@@ -39,5 +39,9 @@ export interface DiscoveredDevice {
    * Reference (id) to the organization that owns this device
    */
   organization?: string | null;
+  /**
+   * Reference (id) to the property that this device belongs to
+   */
+  property?: string | null;
   [k: string]: unknown;
 }

package/dist/cjs/schemas/MediaSourceSchema.d.ts

@@ -90,7 +90,9 @@ export type Notification = {
  */
 export interface MediaSource {
   id: string;
-  type: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "uncontrolledDevice";
+  type: string;
+  discriminator: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "uncontrolledDevice";
+  remote?: "MR22GA";
   name?: string;
   driver:
     | "aws-kinesis"

package/dist/cjs/schemas/OrganizationSchema.d.ts

@@ -25,6 +25,36 @@ export interface Organization {
   accountNumber: number | null;
   name: string;
   properties?: string[];
+  hostname?: string | null;
+  appManifest?: {
+    name?: string;
+    short_name?: string;
+    scope?: string;
+    start_url?: string;
+    themeColor?: string;
+    backgroundColor?: string;
+    display?: "fullscreen" | "standalone" | "minimal-ui" | "browser";
+    orientation?: "portrait" | "landscape";
+    splash?: {
+      src?: string;
+      type?: string;
+      sizes?: string;
+      [k: string]: unknown;
+    };
+    icons?: {
+      src?: string;
+      sizes?: string;
+      type?: string;
+      [k: string]: unknown;
+    }[];
+    logo?: {
+      src?: string;
+      type?: string;
+      sizes?: string;
+      [k: string]: unknown;
+    };
+    [k: string]: unknown;
+  };
   credentials?: {
     [k: string]: unknown;
   };

package/dist/cjs/schemas/PropertySchema.d.ts

@@ -13,6 +13,10 @@ export interface Property {
   name: string;
   type: string;
   discriminator?: "hospitality" | "education" | "commercial";
+  /**
+   * Reference (id) to the organization that owns this property
+   */
+  organization: string | null;
   testModeEnabled?: boolean;
   testMode?: {
     /**
@@ -23,51 +27,32 @@ export interface Property {
   };
   timezone?: string;
   smsNumber?: string;
-  hostname: string | null;
-  /**
-   * Reference (id) to the organization that owns this property
-   */
-  organization: string | null;
   checkInTime?: string;
   checkOutTime?: string;
   address?: Address;
   latitude?: number;
   longitude?: number;
-  appManifest?: {
-    name?: string;
-    short_name?: string;
-    scope?: string;
-    start_url?: string;
-    themeColor?: string;
-    backgroundColor?: string;
-    display?: "fullscreen" | "standalone" | "minimal-ui" | "browser";
-    orientation?: "portrait" | "landscape";
-    splash?: {
-      src?: string;
-      type?: string;
-      sizes?: string;
-      [k: string]: unknown;
-    };
-    icons?: {
-      src?: string;
-      sizes?: string;
-      type?: string;
-      [k: string]: unknown;
-    }[];
-    logo?: {
-      src?: string;
-      type?: string;
-      sizes?: string;
-      [k: string]: unknown;
-    };
-    [k: string]: unknown;
-  };
   appFeatures?: {
     RoomControl?: {
       commonAreas?: {
         spaces?: string[];
         [k: string]: unknown;
       };
+      alarmConfig?: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^[a-zA-Z0-9]+$".
+         */
+        [k: string]: {
+          /**
+           * Maps zone numbers to lock ids
+           */
+          zoneLockMap?: {
+            [k: string]: string;
+          };
+          [k: string]: unknown;
+        };
+      };
     };
     CheckIn?: {
       payment?: unknown;
@@ -114,6 +99,12 @@ export interface Property {
       [k: string]: unknown;
     };
     Elevator?: unknown;
+    Experiences?: unknown;
+    Dining?: unknown;
+    Rentals?: unknown;
+    Shop?: unknown;
+    Spa?: unknown;
+    Valet?: unknown;
   };
   notifications?: {
     email?: {

package/dist/cjs/schemas/ReservationSchema.d.ts

@@ -103,6 +103,7 @@ export interface Reservation {
     id?: string;
     price?: number;
     unit?: "night" | "stay" | "hour";
+    isUpgrade?: boolean;
     [k: string]: unknown;
   }[];
   revenue?: Revenue;

package/dist/cjs/schemas/RoomSchema.d.ts

@@ -496,6 +496,7 @@ export interface WindowCovering {
     | "discPlayer"
     | "mediaPlayer"
     | "uncontrolledDevice";
+  discriminator?: "basic" | "variable";
   supportedNotifications?: SupportedNotifications;
   notification?: {
     name?:
@@ -554,7 +555,7 @@ export interface WindowCovering {
     | "cloudflare-stream"
     | "insperia-privacy";
   offline?: boolean;
-  position: number;
+  position: number | null;
   systemId?: string;
   watts?: number;
   [k: string]: unknown;
@@ -741,7 +742,9 @@ export interface Camera {
  */
 export interface MediaSource {
   id: string;
-  type: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "uncontrolledDevice";
+  type: string;
+  discriminator: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "uncontrolledDevice";
+  remote?: "MR22GA";
   name?: string;
   driver:
     | "aws-kinesis"
@@ -1090,14 +1093,25 @@ export interface Alarm {
     number?: number;
     name?: string;
     securityMode?: "arming" | "disarming" | "armed" | "disarmed" | "alarm" | null;
-    readyToArm?: boolean | null;
   }[];
   zones: {
     number?: number;
     name?: string;
-    secure?: boolean;
+    secure?: boolean | null;
     bypassed?: boolean | null;
   }[];
   watts?: number;
+  address?: Address;
+  [k: string]: unknown;
+}
+export interface Address {
+  id?: string;
+  line1?: string;
+  line2?: string;
+  line3?: string;
+  city?: string;
+  state?: string;
+  postalCode?: string;
+  countryCode?: string;
   [k: string]: unknown;
 }

package/dist/cjs/schemas/SceneSchema.d.ts

@@ -11,6 +11,7 @@
 export interface Scene {
   id?: string;
   name?: string;
+  description?: string;
   devices?: {
     switches?: {
       id?: string;
@@ -24,7 +25,7 @@ export interface Scene {
     }[];
     windowCoverings?: {
       id?: string;
-      position?: number;
+      position?: number | null;
       [k: string]: unknown;
     }[];
     thermostats?: {

package/dist/cjs/schemas/UserSchema.d.ts

@@ -271,6 +271,7 @@ export interface Reservation {
     id?: string;
     price?: number;
     unit?: "night" | "stay" | "hour";
+    isUpgrade?: boolean;
     [k: string]: unknown;
   }[];
   revenue?: Revenue;

package/dist/cjs/schemas/WindowCoveringSchema.d.ts

@@ -109,6 +109,7 @@ export interface WindowCovering {
     | "discPlayer"
     | "mediaPlayer"
     | "uncontrolledDevice";
+  discriminator?: "basic" | "variable";
   supportedNotifications?: SupportedNotifications;
   notification?: Notification;
   driver:
@@ -140,7 +141,7 @@ export interface WindowCovering {
     | "cloudflare-stream"
     | "insperia-privacy";
   offline?: boolean;
-  position: number;
+  position: number | null;
   systemId?: string;
   watts?: number;
   [k: string]: unknown;

package/dist/cjs/schemas/alarm.json

@@ -43,9 +43,6 @@
           "securityMode": {
             "type": ["string", "null"],
             "enum": ["arming", "disarming", "armed", "disarmed", "alarm", null]
-          },
-          "readyToArm": {
-            "type": ["boolean", "null"]
           }
         },
         "additionalProperties": false
@@ -64,7 +61,7 @@
             "type": "string"
           },
           "secure": {
-            "type": "boolean"
+            "type": ["boolean", "null"]
           },
           "bypassed": {
             "type": ["boolean", "null"]
@@ -75,6 +72,9 @@
     },
     "watts": {
       "$ref": "definitions.json#/definitions/watts"
+    },
+    "address": {
+      "$ref": "definitions.json#/definitions/address"
     }
   },
   "required": ["id", "type", "areas", "zones", "driver"]

package/dist/cjs/schemas/credential.json

@@ -23,6 +23,7 @@
         "mobileKey",
         "pin",
         "publicKey",
+        "passkeyChallenge",
         "id"
       ]
     },

package/dist/cjs/schemas/discoveredDevice.json

@@ -30,6 +30,10 @@
     "organization": {
       "type": ["string", "null"],
       "description": "Reference (id) to the organization that owns this device"
+    },
+    "property": {
+      "type": ["string", "null"],
+      "description": "Reference (id) to the property that this device belongs to"
     }
   }
 }

package/dist/cjs/schemas/mediaSource.json

@@ -4,12 +4,16 @@
   "title": "Media Source",
   "description": "Any media source",
   "type": "object",
-  "required": ["id", "type", "audio", "video", "driver"],
+  "required": ["id", "type", "discriminator", "audio", "video", "driver"],
   "properties": {
     "id": {
       "$ref": "definitions.json#/definitions/id"
     },
     "type": {
+      "type": "string",
+      "default": "mediaSource"
+    },
+    "discriminator": {
       "type": "string",
       "enum": [
         "tv",
@@ -20,6 +24,12 @@
         "uncontrolledDevice"
       ]
     },
+    "remote": {
+      "type": "string",
+      "enum": [
+        "MR22GA"
+      ]
+    },
     "name": {
       "$ref": "definitions.json#/definitions/name"
     },