@kohost/api-client 3.0.0-beta.54 → 3.0.0-beta.56

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

@@ -0,0 +1,170 @@
+/* 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.
+ */
+
+export type SupportedNotifications = (
+  | "button 1"
+  | "button 2"
+  | "button 3"
+  | "button 4"
+  | "button 5"
+  | "idle"
+  | "powerHasBeedApplied"
+  | "acMainsDisconnected"
+  | "acMainsReconnected"
+  | "replaceBatterySoon"
+  | "replaceBatteryNow"
+  | "hardwareFailure"
+  | "softwareFailure"
+  | "hardwareFailureWithCode"
+  | "softwareFailureWithCode"
+  | "motionDetection"
+  | "airFilterNeedsCleaned"
+  | "smokeDetected"
+  | "outsideSafeTemperatureRange"
+  | "outsideSafeHumidityRange"
+)[];
+export type Notification = {
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} & ({
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} | null);
+export type SetpointValue = number;
+export type SetpointMinMax = number | null;
+
+/**
+ * Any smart thermostat
+ */
+export interface Thermostat {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  currentTemperature?: number;
+  currentHumidity?: number;
+  hvacMode: "cool" | "heat" | "auto" | "off";
+  hvacState: "cooling" | "heating" | "off" | null;
+  fanMode: "auto" | "low" | "medium" | "high" | "off" | "on";
+  fanState: "off" | "low" | "medium" | "high" | "on" | null;
+  temperatureScale: "celsius" | "fahrenheit";
+  humidityScale?: "absolute" | "relative" | null;
+  /**
+   * @minItems 2
+   */
+  supportedHvacModes: [
+    "cool" | "heat" | "auto" | "off",
+    "cool" | "heat" | "auto" | "off",
+    ...("cool" | "heat" | "auto" | "off")[]
+  ];
+  supportedFanModes: ("auto" | "low" | "medium" | "high" | "off" | "on")[];
+  setpoints: {
+    cool?: Setpoint;
+    heat?: Setpoint;
+    auto?: Setpoint;
+  };
+  minAutoDelta?: number;
+  cycleRate?: number;
+  batteryLevel?: number;
+  systemData: SystemData;
+  watts?: number;
+}
+export interface Setpoint {
+  value?: SetpointValue;
+  min?: SetpointMinMax;
+  max?: SetpointMinMax;
+}
+export interface SystemData {
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,76 @@
+/* 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.
+ */
+
+export type CreatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+export type Date =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+
+/**
+ * A ticket is a request for help from a user.
+ */
+export interface Ticket {
+  id: string;
+  conversation: {
+    id: string;
+    userId: string;
+    userName?: string;
+    timestamp: CreatedAt;
+    body: string;
+    readBy?: string[];
+    media?: MediaFile;
+  }[];
+  requester: string;
+  assignedTo?: string | null;
+  status: "open" | "pending" | "solved" | "closed";
+  tags: string[];
+  rating?: number;
+  ratingComment?: string;
+  createdAt: Date;
+  updatedAt: Date;
+  solvedAt?: Date;
+  closedAt?: Date;
+}
+/**
+ * Any media file
+ */
+export interface MediaFile {
+  id?: string;
+  type: string;
+  name?: string;
+  fileHash?: string;
+  mimeType?:
+    | "image/*"
+    | "image/jpeg"
+    | "image/png"
+    | "image/gif"
+    | "image/webp"
+    | "image/avif"
+    | "image/svg+xml"
+    | "application/pdf";
+  data?: string;
+  url?: string;
+  width?: number;
+  height?: number;
+  /**
+   * Size in bytes
+   */
+  size?: number;
+  uploadUrl?: string;
+  uploadUrlExpires?: Date;
+  createdBy?: string;
+  systemData?: SystemData;
+}
+export interface SystemData {
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,259 @@
+/* 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.
+ */
+
+export type Date =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+export type Identification = Identification1 & Identification2;
+export type Identification2 =
+  | {
+      [k: string]: unknown;
+    }
+  | {
+      [k: string]: unknown;
+    };
+export type CreatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+export type UpdatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+
+export interface User {
+  id?: string;
+  type?: string;
+  firstName: string;
+  lastName: string;
+  phone?: string | null;
+  phoneVerified?: boolean;
+  email?: string | null;
+  emailVerified?: boolean;
+  address?: Address;
+  secretKey?: string;
+  photo?: MediaFile;
+  jobTitle?: string;
+  dob?: string;
+  gender?: "male" | "female";
+  nationality?: string;
+  permissions?: {
+    /**
+     * The ID of the organization the permission is applies to.
+     */
+    organization: string;
+    /**
+     * The ID of the property the permission is applies to.
+     */
+    property: string;
+    role: "Guest" | "User" | "Manager" | "Administrator" | "SuperAdmin";
+    customPermissions?: string[];
+    [k: string]: unknown;
+  }[];
+  notes?: string[];
+  files?: MediaFile[];
+  identifications?: Identification[];
+  payments?: Payment[];
+  location?: {
+    accuracy: number | null;
+    latitude: number | null;
+    longitude: number | null;
+    timestamp: number | null;
+  };
+  reservations?: Reservation[];
+  spaceName?: string;
+  createdAt?: CreatedAt;
+  updatedAt?: UpdatedAt;
+  systemData?: SystemData[];
+  [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;
+}
+/**
+ * Any media file
+ */
+export interface MediaFile {
+  id?: string;
+  type: string;
+  name?: string;
+  fileHash?: string;
+  mimeType?:
+    | "image/*"
+    | "image/jpeg"
+    | "image/png"
+    | "image/gif"
+    | "image/webp"
+    | "image/avif"
+    | "image/svg+xml"
+    | "application/pdf";
+  data?: string;
+  url?: string;
+  width?: number;
+  height?: number;
+  /**
+   * Size in bytes
+   */
+  size?: number;
+  uploadUrl?: string;
+  uploadUrlExpires?: Date;
+  createdBy?: string;
+  systemData?: SystemData;
+}
+export interface SystemData {
+  [k: string]: unknown;
+}
+export interface Identification1 {
+  id?: string;
+  type: "driversLicense" | "passport" | "identityCard" | "visa";
+  number?: {
+    [k: string]: unknown;
+  };
+  maskedNumber?: {
+    [k: string]: unknown;
+  };
+  encryptedNumber?: {
+    [k: string]: unknown;
+  };
+  issued?:
+    | string
+    | {
+        [k: string]: unknown;
+      };
+  expires?:
+    | string
+    | {
+        [k: string]: unknown;
+      }
+    | null;
+  verified?: boolean;
+  matched?: boolean;
+  firstName?: string;
+  lastName?: string;
+  issuingCountry?: {
+    [k: string]: unknown;
+  };
+  systemData?: SystemData;
+  [k: string]: unknown;
+}
+export interface Payment {
+  id?: string;
+  type:
+    | "amex"
+    | "visa"
+    | "masterCard"
+    | "maestro"
+    | "discover"
+    | "diners"
+    | "jcb"
+    | "applePay"
+    | "alipay"
+    | "chinaUnionPay"
+    | "vpay";
+  enabled?: boolean;
+  storageData?: string | null;
+  maskedNumber: {
+    [k: string]: unknown;
+  };
+  issued?: string | null;
+  expires: {
+    [k: string]: unknown;
+  };
+  systemData?: SystemData;
+  [k: string]: unknown;
+}
+export interface Reservation {
+  id?: string;
+  driver?:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  primaryGuest?: string;
+  type: string;
+  sharedGuests?: string[];
+  spaceType?: string;
+  space?: string;
+  /**
+   *  reserved - confirmed by both parties, before check-in
+   *  checkedIn - checked in
+   *  checkedOut - checked out
+   *  cancelled - Cancelled
+   *  noShow - No show
+   *  enquired - Confirmed neither by the customer nor enterprise
+   *  requested - Confirmed by the customer but not the enterprise (waitlist)
+   *  optional - Confirmed by the enterprise but not the customer (holding)
+   */
+  status: "reserved" | "checkedIn" | "checkedOut" | "cancelled" | "noShow" | "enquired" | "requested" | "optional";
+  mobileCheckInStatus?:
+    | "ready"
+    | "blocked"
+    | "preArrivalStepsRequired"
+    | "spaceNotAssigned"
+    | "spaceNotReady"
+    | "checkInTimeNotStarted";
+  mobileCheckInStatusMessage?: string;
+  confirmationNumber?: string;
+  checkInDateTime:
+    | string
+    | {
+        [k: string]: unknown;
+      };
+  checkOutDateTime:
+    | string
+    | {
+        [k: string]: unknown;
+      };
+  adultCount?: number;
+  childCount?: number;
+  revenue?: {
+    date?: string;
+    amount?: number;
+    type?: "service" | "product";
+    [k: string]: unknown;
+  }[];
+  rateSuppressed?: boolean;
+  payment?: string;
+  company?: string;
+  travelAgent?: string;
+  systemData?: SystemData;
+  metadata?: {
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,139 @@
+/* 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.
+ */
+
+export type SupportedNotifications = (
+  | "button 1"
+  | "button 2"
+  | "button 3"
+  | "button 4"
+  | "button 5"
+  | "idle"
+  | "powerHasBeedApplied"
+  | "acMainsDisconnected"
+  | "acMainsReconnected"
+  | "replaceBatterySoon"
+  | "replaceBatteryNow"
+  | "hardwareFailure"
+  | "softwareFailure"
+  | "hardwareFailureWithCode"
+  | "softwareFailureWithCode"
+  | "motionDetection"
+  | "airFilterNeedsCleaned"
+  | "smokeDetected"
+  | "outsideSafeTemperatureRange"
+  | "outsideSafeHumidityRange"
+)[];
+export type Notification = {
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} & ({
+  name?:
+    | "button 1"
+    | "button 2"
+    | "button 3"
+    | "button 4"
+    | "button 5"
+    | "idle"
+    | "powerHasBeedApplied"
+    | "acMainsDisconnected"
+    | "acMainsReconnected"
+    | "replaceBatterySoon"
+    | "replaceBatteryNow"
+    | "hardwareFailure"
+    | "softwareFailure"
+    | "hardwareFailureWithCode"
+    | "softwareFailureWithCode"
+    | "motionDetection"
+    | "airFilterNeedsCleaned"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange";
+  timestamp?: number;
+  description?: string;
+  [k: string]: unknown;
+} | null);
+
+/**
+ * Any smart window covering
+ */
+export interface WindowCovering {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  position: number;
+  systemData: SystemData;
+  watts?: number;
+}
+export interface SystemData {
+  [k: string]: unknown;
+}

package/dist/cjs/schemas/alarm.json

@@ -10,6 +10,9 @@
     },
     "name": {
       "type": "string"
+    }, 
+    "offline": {
+      "type": "boolean"
     },
     "type": {
       "$ref": "definitions.json#/definitions/type"
@@ -38,11 +41,11 @@
             "type": "string"
           },
           "securityMode": {
-            "type": "string",
-            "enum": ["arming", "disarming", "armed", "disarmed", "alarm"]
+            "type": ["string", "null"],
+            "enum": ["arming", "disarming", "armed", "disarmed", "alarm", null]
           },
           "readyToArm": {
-            "type": "boolean"
+            "type": ["boolean", "null"]
           }
         },
         "additionalProperties": false
@@ -64,27 +67,12 @@
             "type": "boolean"
           },
           "bypassed": {
-            "type": "boolean"
+            "type": ["boolean", "null"]
           }
         },
         "additionalProperties": false
       }
     },
-    "supportedTroubles": {
-      "type": "array",
-      "uniqueItems": true,
-      "items": {
-        "type": "string",
-        "enum": ["battery", "ac", "phone", "bell", "fire"]
-      }
-    },
-    "troubles": {
-      "type": "array",
-      "uniqueItems": true,
-      "items": {
-        "$ref": "#/properties/supportedTroubles/items"
-      }
-    },
     "watts": {
       "$ref": "definitions.json#/definitions/watts"
     }
@@ -96,8 +84,6 @@
     "systemData",
     "areas",
     "zones",
-    "supportedTroubles",
-    "troubles",
     "driver"
   ]
 }

package/dist/cjs/schemas/camera.json

@@ -46,5 +46,5 @@
     }
   },
   "additionalProperties": false,
-  "required": ["id", "type", "systemData", "streams", "driver"]
+  "required": ["id", "type", "systemData", "liveStreams", "driver"]
 }