@kohost/api-client 3.6.2 → 3.7.0

package/dist/types/Models/Issue.d.ts

@@ -0,0 +1,17 @@
+export = Issue;
+declare class Issue extends Entity {
+    /**
+     * @typedef {import("../schemas/IssueSchema").Issue} IssueType
+     * Create a Ticket instance.
+     * @constructor
+     * @param {IssueType} issue - The ticket object of type Ticket.
+     */
+    constructor(issue: any);
+    readonly schema: any;
+    get validator(): any;
+}
+declare namespace Issue {
+    let validProperties: string[];
+}
+import Entity = require("./Entity");
+//# sourceMappingURL=Issue.d.ts.map

package/dist/types/Models/Issue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Issue.d.ts","sourceRoot":"","sources":["../../../src/Models/Issue.js"],"names":[],"mappings":";AAQA;IACE;;;;;OAKG;IACH,wBAEC;;;CACF"}

package/dist/types/Models/index.d.ts

@@ -35,5 +35,6 @@ import Order = require("./Order");
 import Announcement = require("./Announcement");
 import TimeSheet = require("./TimeSheet");
 import Policy = require("./Policy");
-export { Entity, Organization, Property, MediaFile, Gateway, Switch, Alarm, Dimmer, Lock, Courtesy, Camera, MotionSensor, Thermostat, WindowCovering, MediaSource, Identification, Product, User, SystemUser, Room, Space, Category, Ticket, Scene, DiscoveredDevice, DeviceRouter, Reservation, Credential, ShortLink, EnergyReportShard, EnergyReport, SMSMessage, EmailMessage, Order, Announcement, TimeSheet, Policy };
+import Issue = require("./Issue");
+export { Entity, Organization, Property, MediaFile, Gateway, Switch, Alarm, Dimmer, Lock, Courtesy, Camera, MotionSensor, Thermostat, WindowCovering, MediaSource, Identification, Product, User, SystemUser, Room, Space, Category, Ticket, Scene, DiscoveredDevice, DeviceRouter, Reservation, Credential, ShortLink, EnergyReportShard, EnergyReport, SMSMessage, EmailMessage, Order, Announcement, TimeSheet, Policy, Issue };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/schemas/IssueSchema.d.ts

@@ -0,0 +1,24 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * An issue associated with ticketing and concierge.
+ */
+export interface Issue {
+  id: string;
+  type: "issue";
+  name: string;
+  description?: string;
+  department: string;
+  autoAssign?: {
+    userId?: string;
+    priority?: "low" | "normal" | "high";
+    tags?: string[];
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}

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

@@ -104,6 +104,10 @@ export interface Property {
         image: MediaFile;
         [k: string]: unknown;
       }[];
+      issues?: {
+        syncWithPropertyId?: string;
+        [k: string]: unknown;
+      };
       [k: string]: unknown;
     };
     DigitalKey?: {

package/dist/types/schemas/TicketSchema.d.ts

@@ -18,6 +18,7 @@ export interface Ticket {
   id: string;
   type?: "ticket";
   number?: string;
+  issueId?: string;
   conversation: {
     [k: string]: unknown;
   }[];

package/dist/types/utils/entityFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entityFactory.d.ts","sourceRoot":"","sources":["../../../src/utils/entityFactory.js"],"names":[],"mappings":"AAEiB,0DA6EhB"}
+{"version":3,"file":"entityFactory.d.ts","sourceRoot":"","sources":["../../../src/utils/entityFactory.js"],"names":[],"mappings":"AAEiB,0DA+EhB"}

package/dist/useCases/{AddDefaultScenesToRooms.js → CreateIssue.js}

@@ -1,8 +1,8 @@
-module.exports = function AddDefaultScenesToRooms(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+module.exports = function CreateIssue(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
   if (!requestData) requestData = {};
   const pathParams = null;
   const { data, query, headers } = requestData;
-  let url = "/rooms/scenes/default";
+  let url = "/issues";
   if (pathParams && data) {
     for (const param of pathParams) {
       const paramName = param.replace(":", "");

package/dist/useCases/{AddScenesToRoom.js → DeleteIssue.js}

@@ -1,8 +1,8 @@
-module.exports = function AddScenesToRoom(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+module.exports = function DeleteIssue(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
   if (!requestData) requestData = {};
   const pathParams = [":id"];
   const { data, query, headers } = requestData;
-  let url = "/rooms/:id/scenes";
+  let url = "/issues/:id";
   if (pathParams && data) {
     for (const param of pathParams) {
       const paramName = param.replace(":", "");
@@ -17,7 +17,7 @@ module.exports = function AddScenesToRoom(requestData = { data: null, query: nul
     );
   }
   const config = {
-    method: "post",
+    method: "delete",
     url,
     ...httpConfigOptions
   };

package/dist/useCases/DescribeIssue.js

@@ -0,0 +1,28 @@
+module.exports = function DescribeIssue(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+  if (!requestData) requestData = {};
+  const pathParams = [":id"];
+  const { data, query, headers } = requestData;
+  let url = "/issues/:id";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "get",
+    url,
+    ...httpConfigOptions
+  };
+  if (data) config.data = data;
+  if (query) config.params = query;
+  if (headers) config.headers = headers;
+  return this._http.request(config);
+};

package/dist/useCases/ListIssues.js

@@ -0,0 +1,28 @@
+module.exports = function ListIssues(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+  if (!requestData) requestData = {};
+  const pathParams = null;
+  const { data, query, headers } = requestData;
+  let url = "/issues";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "get",
+    url,
+    ...httpConfigOptions
+  };
+  if (data) config.data = data;
+  if (query) config.params = query;
+  if (headers) config.headers = headers;
+  return this._http.request(config);
+};

package/dist/useCases/UpdateIssue.js

@@ -0,0 +1,28 @@
+module.exports = function UpdateIssue(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+  if (!requestData) requestData = {};
+  const pathParams = [":id"];
+  const { data, query, headers } = requestData;
+  let url = "/issues/:id";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "put",
+    url,
+    ...httpConfigOptions
+  };
+  if (data) config.data = data;
+  if (query) config.params = query;
+  if (headers) config.headers = headers;
+  return this._http.request(config);
+};

package/dist/useCases/UpdatePropertySettings.js

@@ -0,0 +1,28 @@
+module.exports = function UpdatePropertySettings(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
+  if (!requestData) requestData = {};
+  const pathParams = [":id"];
+  const { data, query, headers } = requestData;
+  let url = "/properties/:id/settings";
+  if (pathParams && data) {
+    for (const param of pathParams) {
+      const paramName = param.replace(":", "");
+      url = url.replace(param, data[paramName]);
+    }
+  }
+  if (url.match(/:[a-zA-Z0-9]+/g)) {
+    const missingParams = url.match(/:[a-zA-Z0-9]+/g);
+    const missing = missingParams.map((param) => param.replace(":", ""));
+    return Promise.reject(
+      new Error("Missing parameters: " + missing.join(", "))
+    );
+  }
+  const config = {
+    method: "put",
+    url,
+    ...httpConfigOptions
+  };
+  if (data) config.data = data;
+  if (query) config.params = query;
+  if (headers) config.headers = headers;
+  return this._http.request(config);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kohost/api-client",
-  "version": "3.6.2",
+  "version": "3.7.0",
   "description": "API client, models, schemas, commands, and events for Kohost applications",
   "author": "Ian Rogers",
   "readme": "README.md",