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

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

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

@@ -0,0 +1,54 @@
+/* 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;
+    };
+
+/**
+ * Notification sent to users
+ */
+export interface NotificationJson {
+  id?: string;
+  title: string;
+  body: string;
+  image?: MediaFile;
+  tag?: string;
+  createdAt?: 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/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;
+}

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

@@ -0,0 +1,144 @@
+/* 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 property is a physical asset or building
+ */
+export interface Property {
+  id: string;
+  name: string;
+  type: string;
+  discriminator?: "hospitality" | "education" | "commercial";
+  testModeEnabled?: boolean;
+  testMode?: {
+    /**
+     * Only users with email addreses ending in these domains will receive notifications in test mode, including sms, email, or push.
+     */
+    notificationEmailDomains?: string[];
+    [k: string]: unknown;
+  };
+  timezone?: string;
+  smsNumber?: string;
+  hostname: string | null;
+  /**
+   * Reference (id) to the organization that owns this property
+   */
+  organization: string | null;
+  checkInTime?: string;
+  checkOutTime?: string;
+  address?: Address;
+  latitude?: number;
+  longitude?: number;
+  appManifest?: {
+    name?: string;
+    short_name?: string;
+    scope?: string;
+    start_url?: string;
+    themeColor?: string;
+    backgroundColor?: string;
+    display?: "fullscreen" | "standalone" | "minimal-ui" | "browser";
+    orientation?: "portrait" | "landscape";
+    splash?: {
+      src?: string;
+      type?: string;
+      sizes?: string;
+      [k: string]: unknown;
+    };
+    icons?: {
+      src?: string;
+      sizes?: string;
+      type?: string;
+      [k: string]: unknown;
+    }[];
+    logo?: {
+      src?: string;
+      type?: string;
+      sizes?: string;
+      [k: string]: unknown;
+    };
+    [k: string]: unknown;
+  };
+  appFeatures?: {
+    RoomControl?: {
+      commonAreas?: {
+        spaces?: string[];
+        [k: string]: unknown;
+      };
+    };
+    CheckIn?: {
+      payment?: unknown;
+      identification?: unknown;
+      earlyCheckIn?: {
+        dynamic: boolean;
+        minimumPrice?: number;
+        maximumPrice?: number;
+        priceRatioPerHour?: number;
+        [k: string]: unknown;
+      };
+      roomUpgrades?: unknown;
+      [k: string]: unknown;
+    };
+    CheckOut?: {
+      lateCheckOut?: {
+        dynamic: boolean;
+        minimumPrice?: number;
+        maximumPrice?: number;
+        priceRatioPerHour?: number;
+        [k: string]: unknown;
+      };
+      [k: string]: unknown;
+    };
+    Concierge?: unknown;
+    DigitalKey?: {
+      system?: "salto";
+      systemOnline?: boolean;
+      enableApp?: boolean;
+      branding?: {
+        logo?: string;
+        /**
+         * @minItems 2
+         * @maxItems 2
+         */
+        gradient?: [string, string];
+        /**
+         * @minItems 2
+         * @maxItems 3
+         */
+        highlightedGradient?: [string, string] | [string, string, string];
+        [k: string]: unknown;
+      };
+      [k: string]: unknown;
+    };
+    Elevator?: unknown;
+  };
+  notifications?: {
+    email?: {
+      enabled?: boolean;
+    };
+    sms?: {
+      enabled?: boolean;
+    };
+    push?: {
+      enabled?: boolean;
+    };
+  };
+  credentials?: {
+    [k: string]: unknown;
+  };
+  [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;
+}

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

@@ -0,0 +1,118 @@
+/* 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 Revenue = {
+  id?: string;
+  name?: string;
+  date?: string;
+  price?: number;
+  [k: string]: unknown;
+}[];
+export type UpdatedAt =
+  | 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;
+}