@kohost/api-client 3.0.0-beta.8 → 3.0.0-beta.80

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

@@ -0,0 +1,57 @@
+/* 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.
+ */
+
+/**
+ * A room represents a physical space of controllable IoT devices
+ */
+export interface Scene {
+  id?: string;
+  name?: string;
+  devices?: {
+    switches?: {
+      id?: string;
+      state?: "on" | "off";
+      [k: string]: unknown;
+    }[];
+    dimmers?: {
+      id?: string;
+      level?: number;
+      [k: string]: unknown;
+    }[];
+    windowCoverings?: {
+      id?: string;
+      position?: number;
+      [k: string]: unknown;
+    }[];
+    thermostats?: {
+      id?: string;
+      hvacMode?: "cool" | "heat" | "auto" | "off";
+      setpoints?: Setpoints;
+      fanMode?: "auto" | "low" | "medium" | "high" | "off" | "on";
+      setpointDelta?: number;
+      [k: string]: unknown;
+    }[];
+    mediaSources?: {
+      id?: string;
+      volume?: number;
+      commands?: string[];
+      [k: string]: unknown;
+    }[];
+  };
+  isDefault?: boolean;
+  showOnUi?: boolean;
+}
+export interface Setpoints {
+  cool?: Setpoint;
+  heat?: Setpoint;
+  auto?: Setpoint;
+}
+export interface Setpoint {
+  value?: number;
+  min?: number | null;
+  max?: number | null;
+}

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

@@ -0,0 +1,20 @@
+/* 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 interface ShortLink {
+  id?: string;
+  type?: string;
+  title?: string;
+  destination: {
+    [k: string]: unknown;
+  };
+  url: {
+    [k: string]: unknown;
+  };
+  systemId?: string;
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,40 @@
+/* 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 interface SMSMessage {
+  id?: string;
+  type?: string;
+  to: string;
+  from: string;
+  media?: string;
+  status:
+    | "queued"
+    | "accepted"
+    | "sending"
+    | "sent"
+    | "failed"
+    | "delivered"
+    | "undelivered"
+    | "receiving"
+    | "received"
+    | "read";
+  body: string;
+  driver?: string;
+  appData?: {
+    [k: string]: unknown;
+  };
+  createdAt?: Date;
+  updatedAt?: Date;
+  systemId?: string;
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,69 @@
+/* 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 interface Space {
+  id?: string;
+  name?: string;
+  type?: string;
+  discriminator?:
+    | "classRoom"
+    | "hotelRoom"
+    | "office"
+    | "building"
+    | "commonArea"
+    | "conferenceRoom"
+    | "lobby"
+    | "gym"
+    | "pool"
+    | "restaurant";
+  driver?:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "dmp"
+    | "dormakaba"
+    | "dsc"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "mht"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  /**
+   * This is the category id
+   */
+  category?: string;
+  rooms?: string[];
+  subGroups?: string[];
+  occupied?: boolean;
+  eco?: {
+    active?: boolean;
+    activatedAt?: string;
+    allowed?: boolean;
+  };
+  features?: string[];
+  maximumOccupancy?: number;
+  housekeepingStatus?: "clean" | "dirty" | "inspected" | "pickup";
+  serviceStatus?: "inService" | "outOfOrder" | "outOfService";
+  systemId?: string;
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,142 @@
+/* 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 switch
+ */
+export interface Switch {
+  id: string;
+  name?: string;
+  type:
+    | "alarm"
+    | "dimmer"
+    | "switch"
+    | "motionSensor"
+    | "windowCovering"
+    | "camera"
+    | "mediaSource"
+    | "thermostat"
+    | "lock"
+    | "courtesy"
+    | "gateway"
+    | "tv"
+    | "dvr"
+    | "appleTv"
+    | "discPlayer"
+    | "mediaPlayer"
+    | "uncontrolledDevice";
+  subType?: string | null;
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  driver:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "dmp"
+    | "dormakaba"
+    | "dsc"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "mht"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  offline?: boolean;
+  state: "on" | "off";
+  systemId?: string;
+  watts?: number;
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,193 @@
+/* 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 Revenue = {
+  id?: string;
+  name?: string;
+  date?: string;
+  price?: number;
+  [k: string]: unknown;
+}[];
+export type CreatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+export type UpdatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+
+/**
+ * A system user is a user that originated from an external 3rd party system.
+ */
+export interface SystemUser {
+  id?: string;
+  type?: string;
+  driver?:
+    | "aws-kinesis"
+    | "butler"
+    | "crestron"
+    | "dmp"
+    | "dormakaba"
+    | "dsc"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "mht"
+    | "paxton"
+    | "pelican-wireless"
+    | "rebrandly"
+    | "salto"
+    | "salto-irn"
+    | "se"
+    | "sendgrid"
+    | "stay-n-touch"
+    | "twilio"
+    | "cloudflare-images"
+    | "cloudflare-stream"
+    | "insperia-privacy";
+  firstName: string;
+  lastName: string;
+  phone?: string | null;
+  email?: string | null;
+  address?: Address;
+  photo?: string;
+  jobTitle?: string;
+  dob?: string;
+  gender?: "male" | "female";
+  roles?: ("Guest" | "User" | "Manager" | "Administrator" | "SuperAdmin")[];
+  nationality?: string;
+  notes?: string[];
+  files?: MediaFile[];
+  identifications?: Identification[];
+  payments?: Payment[];
+  revenue?: Revenue;
+  createdAt?: CreatedAt;
+  updatedAt?: UpdatedAt;
+  systemId?: string;
+  [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;
+  systemId?: string;
+}
+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;
+  };
+  systemId?: string;
+  [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;
+  };
+  systemId?: string;
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,172 @@
+/* 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"
+    | "dmp"
+    | "dormakaba"
+    | "dsc"
+    | "ecobee"
+    | "igor"
+    | "inncom"
+    | "kohost-k7"
+    | "kohost-pms"
+    | "lg"
+    | "lirc"
+    | "mews"
+    | "mht"
+    | "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;
+  systemId?: string;
+  watts?: number;
+  [k: string]: unknown;
+}
+export interface Setpoint {
+  value?: SetpointValue;
+  min?: SetpointMinMax;
+  max?: SetpointMinMax;
+}