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

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

@@ -0,0 +1,244 @@
+/* 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 media source
+ */
+export interface MediaSource {
+  id: string;
+  type: "tv" | "dvr" | "appleTv" | "discPlayer" | "mediaPlayer" | "uncontrolledDevice";
+  name?: 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";
+  offline?: boolean;
+  audio: boolean;
+  video: boolean;
+  powerFeedback?: boolean;
+  volumeFeedback?: boolean;
+  muted?: boolean;
+  volume?: number;
+  power?: "on" | "off";
+  input?: string;
+  supportedInputs?: string[];
+  command?:
+    | (
+        | "mute"
+        | "volumeUp"
+        | "volumeDown"
+        | "channelUp"
+        | "channelDown"
+        | "number0"
+        | "number1"
+        | "number2"
+        | "number3"
+        | "number4"
+        | "number5"
+        | "number6"
+        | "number7"
+        | "number8"
+        | "number9"
+        | "lastChannel"
+        | "display"
+        | "favoriteChannel"
+        | "play"
+        | "stop"
+        | "pause"
+        | "fastForward"
+        | "rewind"
+        | "instantReplay"
+        | "record"
+        | "ac3"
+        | "pvrMenu"
+        | "guide"
+        | "menu"
+        | "menuUp"
+        | "menuDown"
+        | "menuLeft"
+        | "menuRight"
+        | "pageUp"
+        | "pageDown"
+        | "select"
+        | "exit"
+        | "input"
+        | "power"
+        | "enterChannel"
+        | "enterVolume"
+        | "number10"
+        | "number11"
+        | "number12"
+        | "number13"
+        | "number14"
+        | "number15"
+        | "number16"
+        | "number10Plus"
+        | "number20Plus"
+        | "number100"
+        | "dash"
+        | "threeChan"
+        | "threeD"
+        | "sixChan"
+        | "a"
+        | "add"
+        | "alarm"
+        | "am"
+        | "analog"
+        | "angle"
+        | "antenna"
+        | "antennaEast"
+        | "antennaWest"
+        | "aspect"
+        | "audio1"
+        | "audio2"
+        | "audio3"
+        | "audioDumming"
+        | "audioLevelDown"
+        | "audioLevelUp"
+        | "b"
+        | "back"
+        | "c"
+        | "component1"
+        | "component2"
+        | "component3"
+        | "d"
+        | "home"
+        | "list"
+        | "liveTv"
+        | "discreteInputCable"
+        | "powerOff"
+        | "powerOn"
+        | "setupMenu"
+        | "skipForward"
+        | "skipReverse"
+        | "video1"
+        | "video2"
+        | "video3"
+        | "video4"
+        | "video5"
+        | "details"
+        | "hdmi1"
+        | "hdmi2"
+        | "hdmi3"
+        | "cecDeviceList"
+        | "mtsSap"
+        | "red"
+        | "green"
+        | "yellow"
+        | "blue"
+        | "alert"
+      )
+    | null;
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  systemId?: string;
+  watts?: number;
+}

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

@@ -0,0 +1,143 @@
+/* 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 motion sensor
+ */
+export interface MotionSensor {
+  id: 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";
+  systemId?: string;
+  supportedNotifications?: SupportedNotifications;
+  notification?: Notification;
+  watts?: number;
+}

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

@@ -0,0 +1,91 @@
+/* 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 purchase order for products or services.
+ */
+export interface Order {
+  id?: string;
+  type: string;
+  orderNumber?: string;
+  status:
+    | "draft"
+    | "pendingPayment"
+    | "processing"
+    | "outForDelivery"
+    | "completed"
+    | "paymentFailed"
+    | "cancelled"
+    | "refunded";
+  /**
+   * User id of purchaser
+   */
+  user?: string;
+  date?: Date;
+  items?: {
+    additionalProperties?: never;
+    name: string;
+    sku?: string;
+    quantity?: number;
+    price: number;
+    taxClass?: string;
+    deliveryClass?: string;
+    [k: string]: unknown;
+  }[];
+  taxes?: {
+    additionalProperties?: never;
+    name: string;
+    class?: string;
+    rateType?: "percentage" | "flat";
+    rate: number;
+    total?: number;
+    [k: string]: unknown;
+  }[];
+  fees?: {
+    additionalProperties?: never;
+    name: string;
+    price: number;
+    [k: string]: unknown;
+  }[];
+  delivery?: {
+    additionalProperties?: never;
+    name: string;
+    class?: string;
+    rateType?: "percentage" | "flat";
+    rate: number;
+    total?: number;
+    [k: string]: unknown;
+  }[];
+  payments?: {
+    method?:
+      | "folio"
+      | "invoice"
+      | "amex"
+      | "visa"
+      | "masterCard"
+      | "maestro"
+      | "discover"
+      | "diners"
+      | "jcb"
+      | "applePay"
+      | "alipay"
+      | "chinaUnionPay"
+      | "vpay";
+    name?: string;
+    date?: Date;
+    amount?: number;
+    transactionReference?: string;
+    [k: string]: unknown;
+  }[];
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,34 @@
+/* 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 UpdatedAt =
+  | string
+  | {
+      [k: string]: unknown;
+    };
+
+/**
+ * An organization is a group or entity that subscribes to Kohost software.
+ */
+export interface Organization {
+  id?: string;
+  type?: string;
+  accountNumber: number | null;
+  name: string;
+  properties?: string[];
+  credentials?: {
+    [k: string]: unknown;
+  };
+  createdAt?: CreatedAt;
+  updatedAt?: UpdatedAt;
+  [k: string]: unknown;
+}

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

@@ -0,0 +1,33 @@
+/* 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 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/ProductSchema.d.ts

@@ -0,0 +1,66 @@
+/* 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 Product {
+  id?: string;
+  type?: string;
+  name: 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";
+  description?: {
+    [k: string]: unknown;
+  };
+  price: number;
+  image?: File;
+  category?: string;
+  imageUrl?: {
+    [k: string]: unknown;
+  };
+  systemId?: string;
+  [k: string]: unknown;
+}
+export interface File {
+  /**
+   * Name of the file.
+   */
+  name: string;
+  /**
+   * MIME type of the file (e.g. application/pdf).
+   */
+  type: string;
+  /**
+   * Base64-encoded data of the file.
+   */
+  data: string;
+  [k: string]: unknown;
+}