@kohost/api-client 3.0.0-beta.9 → 3.0.0-beta.90

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

@@ -0,0 +1,89 @@
+/* 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;
+    };
+
+/**
+ * A ticket is a request from a user.
+ */
+export interface Ticket {
+  id: string;
+  conversation: (
+    | {
+        [k: string]: unknown;
+      }
+    | {
+        [k: string]: unknown;
+      }
+  )[];
+  openedBy?: {
+    userId?: string;
+    [k: string]: unknown;
+  };
+  requester: {
+    systemId?: string;
+    systemName?: string;
+    systemPhoto?: MediaFile | null | string;
+    userId?: string;
+    userName?: string;
+    userPhoto?: MediaFile | null | string;
+    deviceId?: string;
+    roomId?: string;
+    spaceId?: string;
+    spaceName?: string;
+    [k: string]: unknown;
+  };
+  assignedTo?: {
+    userId?: string;
+    userName?: string;
+    userPhoto?: MediaFile | null | string;
+    [k: string]: unknown;
+  };
+  status: "open" | "pending" | "solved" | "closed";
+  tags: string[];
+  rating?: number;
+  ratingComment?: string;
+  tipAmount?: 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;
+  systemId?: string;
+}

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

@@ -0,0 +1,287 @@
+/* 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;
+  tax?: number | null;
+  [k: string]: unknown;
+}[];
+export type UpdatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+export type CreatedAt =
+  | 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[];
+  }[];
+  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;
+  revenue?: Revenue;
+  createdAt?: CreatedAt;
+  updatedAt?: UpdatedAt;
+  systems?: {
+    systemId: string;
+    property: string;
+    driver: 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;
+}
+export interface Reservation {
+  id?: 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";
+  primaryGuest?: string;
+  type: string;
+  sharedGuests?: string[];
+  spaceCategory?: string;
+  space?: string | null;
+  /**
+   *  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";
+  /**
+   * spaceCategory has changed from original.
+   */
+  mobileCheckInSpaceCategoryChanged?: boolean;
+  mobileCheckInSpaceChanged?: boolean;
+  mobileCheckInStatus?:
+    | "ready"
+    | "blocked"
+    | "preArrivalStepsRequired"
+    | "spaceNotAssigned"
+    | "spaceNotReady"
+    | "checkInTimeNotStarted";
+  mobileCheckInStatusMessage?: string;
+  confirmationNumber?: string;
+  /**
+   * Expected arrival time of guest.
+   */
+  expectedCheckInDateTime?:
+    | string
+    | {
+        [k: string]: unknown;
+      };
+  checkInDateTime:
+    | string
+    | {
+        [k: string]: unknown;
+      };
+  checkOutDateTime:
+    | string
+    | {
+        [k: string]: unknown;
+      };
+  adultCount?: number;
+  childCount?: number;
+  spaceCategoryAvailabilites?: {
+    id?: string;
+    price?: number;
+    unit?: "night" | "stay" | "hour";
+    [k: string]: unknown;
+  }[];
+  revenue?: Revenue;
+  rateSuppressed?: boolean;
+  payment?: string;
+  company?: string;
+  travelAgent?: string;
+  systemId?: string;
+  metadata?: {
+    [k: string]: unknown;
+  };
+  updatedAt?: UpdatedAt;
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,147 @@
+/* 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"
+  | "airFilterNeedsReplaced"
+  | "smokeDetected"
+  | "outsideSafeTemperatureRange"
+  | "outsideSafeHumidityRange"
+  | "scheduleMaintenance"
+)[];
+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"
+    | "airFilterNeedsReplaced"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange"
+    | "scheduleMaintenance";
+  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"
+    | "airFilterNeedsReplaced"
+    | "smokeDetected"
+    | "outsideSafeTemperatureRange"
+    | "outsideSafeHumidityRange"
+    | "scheduleMaintenance";
+  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"
+    | "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;
+  position: number;
+  systemId?: string;
+  watts?: number;
+  [k: string]: unknown;
+}

package/dist/cjs/schemas/alarm.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "alarm.json",
+  "title": "Alarm",
+  "description": "Any smart alarm system",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "offline": {
+      "type": "boolean"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "areas": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "number": {
+            "type": "number"
+          },
+          "name": {
+            "type": "string"
+          },
+          "securityMode": {
+            "type": ["string", "null"],
+            "enum": ["arming", "disarming", "armed", "disarmed", "alarm", null]
+          },
+          "readyToArm": {
+            "type": ["boolean", "null"]
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "zones": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "number": {
+            "type": "number",
+            "minimum": 0
+          },
+          "name": {
+            "type": "string"
+          },
+          "secure": {
+            "type": "boolean"
+          },
+          "bypassed": {
+            "type": ["boolean", "null"]
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "required": ["id", "type", "areas", "zones", "driver"]
+}

package/dist/cjs/schemas/announcement.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "announcement.json",
+  "title": "Announcement",
+  "description": "Announcement message sent to users",
+  "type": "object",
+  "properties": {
+    "id": { "$ref": "definitions.json#/definitions/id" },
+    "users": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "minItems": 1
+    },
+    "body": {
+      "type": "string"
+    },
+    "media": {
+      "$ref": "mediaFile.json"
+    },
+    "sentBy": {
+      "type": "string"
+    },
+    "tag": {
+      "type": "string"
+    },
+    "createdAt": {
+      "$ref": "definitions.json#/definitions/date"
+    },
+    "updatedAt": {
+      "$ref": "definitions.json#/definitions/date"
+    }
+  },
+  "additionalProperties": false
+}

package/dist/cjs/schemas/camera.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "camera.json",
+  "title": "Camera",
+  "description": "Any smart camera",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "definitions.json#/definitions/id"
+    },
+    "name": {
+      "type": "string"
+    },
+    "type": {
+      "$ref": "definitions.json#/definitions/type"
+    },
+    "supportedNotifications": {
+      "$ref": "definitions.json#/definitions/supportedNotifications"
+    },
+    "notification": {
+      "$ref": "definitions.json#/definitions/notification"
+    },
+    "driver": {
+      "$ref": "definitions.json#/definitions/driver"
+    },
+    "liveStreams": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "iframe": {
+          "type": ["string", "null"]
+        },
+        "hls": {
+          "type": ["string", "null"]
+        },
+        "webRTC": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "systemId": {
+      "$ref": "definitions.json#/definitions/systemId"
+    },
+    "watts": {
+      "$ref": "definitions.json#/definitions/watts"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "liveStreams", "driver"]
+}