@kohost/api-client 4.11.0 → 4.11.1

package/dist/models/user.d.cts

@@ -7,29 +7,29 @@ import { Entity } from './entity.cjs';
  * @property {string} [type] - Default: "user"
  * @property {string} firstName
  * @property {string} lastName
- * @property {string} [phone]
+ * @property {(string|null)} [phone]
  * @property {boolean} [phoneVerified]
- * @property {string} [email]
+ * @property {(string|null)} [email]
  * @property {boolean} [emailVerified]
- * @property {string} [whatsapp]
+ * @property {(string|null)} [whatsapp]
  * @property {boolean} [whatsappVerified]
  * @property {{id?: string, line1?: string, line2?: string, line3?: string, city?: string, state?: string, postalCode?: string, countryCode?: string}} [address]
  * @property {string} [secretKey]
- * @property {{id?: any, type: "mediaFile", name?: string, fileHash?: string, category?: 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?: number, uploadUrl?: string, uploadUrlExpires?: any, createdBy?: string, systemId?: any, createdAt?: any, updatedAt?: any, deletedAt?: any}} [photo] - Any media file
+ * @property {{id?: string, type: "mediaFile", name?: string, fileHash?: string, category?: 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?: number, uploadUrl?: string, uploadUrlExpires?: (string|object), createdBy?: string, systemId?: string, createdAt?: (string|object), updatedAt?: (string|object), deletedAt?: (string|object)}} [photo] - Any media file
  * @property {string} [jobTitle]
  * @property {string} [dob]
  * @property {("male"|"female")} [gender]
  * @property {string} [nationality]
- * @property {{organizationId: string, propertyId: string, role: ("Guest"|"User"|"Agent"|"Manager"|"Maintenance"|"Administrator"|"SuperAdmin"), timeTrackingEnabled?: boolean, department?: string, policyIds?: string[], policies?: {id: any, type: "policy", discriminator: "user", name: string, description?: string, organizationId: string, propertyId: string, permissions: {entities: string[], effect: ("Allow"|"Deny")}[], createdAt?: any, updatedAt?: any, deletedAt?: any}[]}[]} [permissions] - Default: []
+ * @property {{organizationId: string, propertyId: string, role: ("Guest"|"User"|"Agent"|"Manager"|"Maintenance"|"Administrator"|"SuperAdmin"), timeTrackingEnabled?: boolean, department?: string, policyIds?: string[], policies?: {id: string, type: "policy", discriminator: "user", name: string, description?: string, organizationId: string, propertyId: string, permissions: {entities: string[], effect: ("Allow"|"Deny")}[], createdAt?: (string|object), updatedAt?: (string|object), deletedAt?: (string|object)}[]}[]} [permissions] - Default: []
  * @property {{organizationId: string, propertyId: string, notifications?: {discriminator: ("observerTicketCreated"|"observerTicketResolved"), enabled: boolean}[]}[]} [preferences]
  * @property {string[]} [notes]
- * @property {{id?: any, type: "mediaFile", name?: string, fileHash?: string, category?: 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?: number, uploadUrl?: string, uploadUrlExpires?: any, createdBy?: string, systemId?: any, createdAt?: any, updatedAt?: any, deletedAt?: any}[]} [files]
- * @property {{id?: any, type: ("driversLicense"|"passport"|"identityCard"|"visa"), number?: string, maskedNumber?: string, encryptedNumber?: string, issued?: (string|object), expires?: (string|object), verified?: boolean, matched?: boolean, firstName?: string, lastName?: string, issuingCountry?: string, issuingState?: string, systemId?: any}[]} [identifications]
- * @property {{id?: any, type: ("amex"|"visa"|"masterCard"|"maestro"|"discover"|"diners"|"jcb"|"applePay"|"alipay"|"chinaUnionPay"|"vpay"), enabled?: boolean, storageData?: string, maskedNumber: string, issued?: string, expires: string, systemId?: any}[]} [payments]
- * @property {{accuracy: number, latitude: number, longitude: number, timestamp: number}} [location]
- * @property {{id?: any, driver?: any, primaryGuest?: string, type: "reservation", sharedGuests?: string[], spaceCategory?: string, space?: string, previousSpace?: string, status: ("reserved"|"checkedIn"|"checkedOut"|"cancelled"|"noShow"|"enquired"|"requested"|"optional"), mobileCheckInSpaceCategoryChanged?: boolean, mobileCheckInSpaceChanged?: boolean, mobileCheckInStatus?: ("ready"|"blocked"|"preArrivalStepsRequired"|"spaceNotAssigned"|"spaceNotReady"|"checkInTimeNotStarted"), mobileCheckInStatusMessage?: string, confirmationNumber?: string, expectedCheckInDateTime?: (string|object), checkInDateTime: (string|object), checkOutDateTime: (string|object), adultCount?: number, childCount?: number, spaceCategoryAvailabilites?: {id?: string, price?: number, unit?: ("night"|"stay"|"hour"), isUpgrade?: boolean}[], revenue?: any, rateSuppressed?: boolean, payment?: string, company?: string, travelAgent?: string, systemId?: any, metadata?: any, createdAt?: any, updatedAt?: any, deletedAt?: any}[]} [reservations]
+ * @property {{id?: string, type: "mediaFile", name?: string, fileHash?: string, category?: 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?: number, uploadUrl?: string, uploadUrlExpires?: (string|object), createdBy?: string, systemId?: string, createdAt?: (string|object), updatedAt?: (string|object), deletedAt?: (string|object)}[]} [files]
+ * @property {{id?: string, type: ("driversLicense"|"passport"|"identityCard"|"visa"), number?: string, maskedNumber?: string, encryptedNumber?: string, issued?: (string|object), expires?: (string|object|null), verified?: boolean, matched?: boolean, firstName?: string, lastName?: string, issuingCountry?: string, issuingState?: string, systemId?: string}[]} [identifications]
+ * @property {{id?: string, type: ("amex"|"visa"|"masterCard"|"maestro"|"discover"|"diners"|"jcb"|"applePay"|"alipay"|"chinaUnionPay"|"vpay"), enabled?: boolean, storageData?: (string|null), maskedNumber: string, issued?: (string|null), expires: string, systemId?: string}[]} [payments]
+ * @property {{accuracy: (number|null), latitude: (number|null), longitude: (number|null), timestamp: (number|null)}} [location]
+ * @property {{id?: string, driver?: ("adlink"|"aws-kinesis"|"bacnet"|"benq"|"butler"|"comelit"|"crestron"|"dell"|"digital-watchdog"|"distech"|"dmp"|"doorbird"|"dormakaba"|"dsc"|"ecobee"|"epson"|"geovision-rs"|"geovision-as-manager"|"honeywell-vista"|"igor"|"inncom"|"isapi"|"kohost-k7"|"kohost"|"lg"|"lg-webos"|"lapi"|"lirc"|"mews"|"mht"|"newline"|"paxton"|"pelican-wireless"|"power-shades"|"rachio"|"rebrandly"|"relay"|"rtsp"|"salto"|"salto-irn"|"samsung"|"se"|"sendgrid"|"smartboard"|"sonifi"|"stay-n-touch"|"storable"|"twilio"|"unifi"|"valcom"|"veracross"|"vivotek"|"vizio"|"wisenet"|"cloudflare-images"|"cloudflare-stream"|"insperia-privacy"), primaryGuest?: string, type: "reservation", sharedGuests?: string[], spaceCategory?: string, space?: (string|null), previousSpace?: (string|null), status: ("reserved"|"checkedIn"|"checkedOut"|"cancelled"|"noShow"|"enquired"|"requested"|"optional"), mobileCheckInSpaceCategoryChanged?: boolean, mobileCheckInSpaceChanged?: boolean, mobileCheckInStatus?: ("ready"|"blocked"|"preArrivalStepsRequired"|"spaceNotAssigned"|"spaceNotReady"|"checkInTimeNotStarted"), mobileCheckInStatusMessage?: string, confirmationNumber?: string, expectedCheckInDateTime?: (string|object), checkInDateTime: (string|object), checkOutDateTime: (string|object), adultCount?: number, childCount?: number, spaceCategoryAvailabilites?: {id?: string, price?: number, unit?: ("night"|"stay"|"hour"), isUpgrade?: boolean}[], revenue?: {id?: string, name?: string, date?: string, price?: number, tax?: (number|null)}[], rateSuppressed?: boolean, payment?: string, company?: string, travelAgent?: string, systemId?: string, metadata?: {}, createdAt?: (string|object), updatedAt?: (string|object), deletedAt?: (string|object)}[]} [reservations]
  * @property {string} [spaceName]
- * @property {{id?: string, name?: string, date?: string, price?: number, tax?: number}[]} [revenue]
+ * @property {{id?: string, name?: string, date?: string, price?: number, tax?: (number|null)}[]} [revenue]
  * @property {{systemId: string, propertyId: string, driver: string}[]} [systems] - Default: []
  * @property {(string|object)} [createdAt]
  * @property {(string|object)} [updatedAt]
@@ -50,11 +50,11 @@ declare class User extends Entity {
     type: string | undefined;
     firstName: string;
     lastName: string;
-    phone: string | undefined;
+    phone: string | null | undefined;
     phoneVerified: boolean | undefined;
-    email: string | undefined;
+    email: string | null | undefined;
     emailVerified: boolean | undefined;
-    whatsapp: string | undefined;
+    whatsapp: string | null | undefined;
     whatsappVerified: boolean | undefined;
     address: {
         id?: string;
@@ -68,7 +68,7 @@ declare class User extends Entity {
     } | undefined;
     secretKey: string | undefined;
     photo: {
-        id?: any;
+        id?: string;
         type: "mediaFile";
         name?: string;
         fileHash?: string;
@@ -80,12 +80,12 @@ declare class User extends Entity {
         height?: number;
         size?: number;
         uploadUrl?: string;
-        uploadUrlExpires?: any;
+        uploadUrlExpires?: (string | object);
         createdBy?: string;
-        systemId?: any;
-        createdAt?: any;
-        updatedAt?: any;
-        deletedAt?: any;
+        systemId?: string;
+        createdAt?: (string | object);
+        updatedAt?: (string | object);
+        deletedAt?: (string | object);
     } | undefined;
     jobTitle: string | undefined;
     dob: string | undefined;
@@ -99,7 +99,7 @@ declare class User extends Entity {
         department?: string;
         policyIds?: string[];
         policies?: {
-            id: any;
+            id: string;
             type: "policy";
             discriminator: "user";
             name: string;
@@ -110,9 +110,9 @@ declare class User extends Entity {
                 entities: string[];
                 effect: ("Allow" | "Deny");
             }[];
-            createdAt?: any;
-            updatedAt?: any;
-            deletedAt?: any;
+            createdAt?: (string | object);
+            updatedAt?: (string | object);
+            deletedAt?: (string | object);
         }[];
     }[] | undefined;
     preferences: {
@@ -125,7 +125,7 @@ declare class User extends Entity {
     }[] | undefined;
     notes: string[] | undefined;
     files: {
-        id?: any;
+        id?: string;
         type: "mediaFile";
         name?: string;
         fileHash?: string;
@@ -137,54 +137,54 @@ declare class User extends Entity {
         height?: number;
         size?: number;
         uploadUrl?: string;
-        uploadUrlExpires?: any;
+        uploadUrlExpires?: (string | object);
         createdBy?: string;
-        systemId?: any;
-        createdAt?: any;
-        updatedAt?: any;
-        deletedAt?: any;
+        systemId?: string;
+        createdAt?: (string | object);
+        updatedAt?: (string | object);
+        deletedAt?: (string | object);
     }[] | undefined;
     identifications: {
-        id?: any;
+        id?: string;
         type: ("driversLicense" | "passport" | "identityCard" | "visa");
         number?: string;
         maskedNumber?: string;
         encryptedNumber?: string;
         issued?: (string | object);
-        expires?: (string | object);
+        expires?: (string | object | null);
         verified?: boolean;
         matched?: boolean;
         firstName?: string;
         lastName?: string;
         issuingCountry?: string;
         issuingState?: string;
-        systemId?: any;
+        systemId?: string;
     }[] | undefined;
     payments: {
-        id?: any;
+        id?: string;
         type: ("amex" | "visa" | "masterCard" | "maestro" | "discover" | "diners" | "jcb" | "applePay" | "alipay" | "chinaUnionPay" | "vpay");
         enabled?: boolean;
-        storageData?: string;
+        storageData?: (string | null);
         maskedNumber: string;
-        issued?: string;
+        issued?: (string | null);
         expires: string;
-        systemId?: any;
+        systemId?: string;
     }[] | undefined;
     location: {
-        accuracy: number;
-        latitude: number;
-        longitude: number;
-        timestamp: number;
+        accuracy: (number | null);
+        latitude: (number | null);
+        longitude: (number | null);
+        timestamp: (number | null);
     } | undefined;
     reservations: {
-        id?: any;
-        driver?: any;
+        id?: string;
+        driver?: ("adlink" | "aws-kinesis" | "bacnet" | "benq" | "butler" | "comelit" | "crestron" | "dell" | "digital-watchdog" | "distech" | "dmp" | "doorbird" | "dormakaba" | "dsc" | "ecobee" | "epson" | "geovision-rs" | "geovision-as-manager" | "honeywell-vista" | "igor" | "inncom" | "isapi" | "kohost-k7" | "kohost" | "lg" | "lg-webos" | "lapi" | "lirc" | "mews" | "mht" | "newline" | "paxton" | "pelican-wireless" | "power-shades" | "rachio" | "rebrandly" | "relay" | "rtsp" | "salto" | "salto-irn" | "samsung" | "se" | "sendgrid" | "smartboard" | "sonifi" | "stay-n-touch" | "storable" | "twilio" | "unifi" | "valcom" | "veracross" | "vivotek" | "vizio" | "wisenet" | "cloudflare-images" | "cloudflare-stream" | "insperia-privacy");
         primaryGuest?: string;
         type: "reservation";
         sharedGuests?: string[];
         spaceCategory?: string;
-        space?: string;
-        previousSpace?: string;
+        space?: (string | null);
+        previousSpace?: (string | null);
         status: ("reserved" | "checkedIn" | "checkedOut" | "cancelled" | "noShow" | "enquired" | "requested" | "optional");
         mobileCheckInSpaceCategoryChanged?: boolean;
         mobileCheckInSpaceChanged?: boolean;
@@ -202,16 +202,22 @@ declare class User extends Entity {
             unit?: ("night" | "stay" | "hour");
             isUpgrade?: boolean;
         }[];
-        revenue?: any;
+        revenue?: {
+            id?: string;
+            name?: string;
+            date?: string;
+            price?: number;
+            tax?: (number | null);
+        }[];
         rateSuppressed?: boolean;
         payment?: string;
         company?: string;
         travelAgent?: string;
-        systemId?: any;
-        metadata?: any;
-        createdAt?: any;
-        updatedAt?: any;
-        deletedAt?: any;
+        systemId?: string;
+        metadata?: {};
+        createdAt?: (string | object);
+        updatedAt?: (string | object);
+        deletedAt?: (string | object);
     }[] | undefined;
     spaceName: string | undefined;
     revenue: {
@@ -219,7 +225,7 @@ declare class User extends Entity {
         name?: string;
         date?: string;
         price?: number;
-        tax?: number;
+        tax?: (number | null);
     }[] | undefined;
     systems: {
         systemId: string;
@@ -479,11 +485,11 @@ type UserData = {
     type?: string | undefined;
     firstName: string;
     lastName: string;
-    phone?: string | undefined;
+    phone?: string | null | undefined;
     phoneVerified?: boolean | undefined;
-    email?: string | undefined;
+    email?: string | null | undefined;
     emailVerified?: boolean | undefined;
-    whatsapp?: string | undefined;
+    whatsapp?: string | null | undefined;
     whatsappVerified?: boolean | undefined;
     address?: {
         id?: string;
@@ -500,7 +506,7 @@ type UserData = {
      * - Any media file
      */
     photo?: {
-        id?: any;
+        id?: string;
         type: "mediaFile";
         name?: string;
         fileHash?: string;
@@ -512,12 +518,12 @@ type UserData = {
         height?: number;
         size?: number;
         uploadUrl?: string;
-        uploadUrlExpires?: any;
+        uploadUrlExpires?: (string | object);
         createdBy?: string;
-        systemId?: any;
-        createdAt?: any;
-        updatedAt?: any;
-        deletedAt?: any;
+        systemId?: string;
+        createdAt?: (string | object);
+        updatedAt?: (string | object);
+        deletedAt?: (string | object);
     } | undefined;
     jobTitle?: string | undefined;
     dob?: string | undefined;
@@ -534,7 +540,7 @@ type UserData = {
         department?: string;
         policyIds?: string[];
         policies?: {
-            id: any;
+            id: string;
             type: "policy";
             discriminator: "user";
             name: string;
@@ -545,9 +551,9 @@ type UserData = {
                 entities: string[];
                 effect: ("Allow" | "Deny");
             }[];
-            createdAt?: any;
-            updatedAt?: any;
-            deletedAt?: any;
+            createdAt?: (string | object);
+            updatedAt?: (string | object);
+            deletedAt?: (string | object);
         }[];
     }[] | undefined;
     preferences?: {
@@ -560,7 +566,7 @@ type UserData = {
     }[] | undefined;
     notes?: string[] | undefined;
     files?: {
-        id?: any;
+        id?: string;
         type: "mediaFile";
         name?: string;
         fileHash?: string;
@@ -572,54 +578,54 @@ type UserData = {
         height?: number;
         size?: number;
         uploadUrl?: string;
-        uploadUrlExpires?: any;
+        uploadUrlExpires?: (string | object);
         createdBy?: string;
-        systemId?: any;
-        createdAt?: any;
-        updatedAt?: any;
-        deletedAt?: any;
+        systemId?: string;
+        createdAt?: (string | object);
+        updatedAt?: (string | object);
+        deletedAt?: (string | object);
     }[] | undefined;
     identifications?: {
-        id?: any;
+        id?: string;
         type: ("driversLicense" | "passport" | "identityCard" | "visa");
         number?: string;
         maskedNumber?: string;
         encryptedNumber?: string;
         issued?: (string | object);
-        expires?: (string | object);
+        expires?: (string | object | null);
         verified?: boolean;
         matched?: boolean;
         firstName?: string;
         lastName?: string;
         issuingCountry?: string;
         issuingState?: string;
-        systemId?: any;
+        systemId?: string;
     }[] | undefined;
     payments?: {
-        id?: any;
+        id?: string;
         type: ("amex" | "visa" | "masterCard" | "maestro" | "discover" | "diners" | "jcb" | "applePay" | "alipay" | "chinaUnionPay" | "vpay");
         enabled?: boolean;
-        storageData?: string;
+        storageData?: (string | null);
         maskedNumber: string;
-        issued?: string;
+        issued?: (string | null);
         expires: string;
-        systemId?: any;
+        systemId?: string;
     }[] | undefined;
     location?: {
-        accuracy: number;
-        latitude: number;
-        longitude: number;
-        timestamp: number;
+        accuracy: (number | null);
+        latitude: (number | null);
+        longitude: (number | null);
+        timestamp: (number | null);
     } | undefined;
     reservations?: {
-        id?: any;
-        driver?: any;
+        id?: string;
+        driver?: ("adlink" | "aws-kinesis" | "bacnet" | "benq" | "butler" | "comelit" | "crestron" | "dell" | "digital-watchdog" | "distech" | "dmp" | "doorbird" | "dormakaba" | "dsc" | "ecobee" | "epson" | "geovision-rs" | "geovision-as-manager" | "honeywell-vista" | "igor" | "inncom" | "isapi" | "kohost-k7" | "kohost" | "lg" | "lg-webos" | "lapi" | "lirc" | "mews" | "mht" | "newline" | "paxton" | "pelican-wireless" | "power-shades" | "rachio" | "rebrandly" | "relay" | "rtsp" | "salto" | "salto-irn" | "samsung" | "se" | "sendgrid" | "smartboard" | "sonifi" | "stay-n-touch" | "storable" | "twilio" | "unifi" | "valcom" | "veracross" | "vivotek" | "vizio" | "wisenet" | "cloudflare-images" | "cloudflare-stream" | "insperia-privacy");
         primaryGuest?: string;
         type: "reservation";
         sharedGuests?: string[];
         spaceCategory?: string;
-        space?: string;
-        previousSpace?: string;
+        space?: (string | null);
+        previousSpace?: (string | null);
         status: ("reserved" | "checkedIn" | "checkedOut" | "cancelled" | "noShow" | "enquired" | "requested" | "optional");
         mobileCheckInSpaceCategoryChanged?: boolean;
         mobileCheckInSpaceChanged?: boolean;
@@ -637,16 +643,22 @@ type UserData = {
             unit?: ("night" | "stay" | "hour");
             isUpgrade?: boolean;
         }[];
-        revenue?: any;
+        revenue?: {
+            id?: string;
+            name?: string;
+            date?: string;
+            price?: number;
+            tax?: (number | null);
+        }[];
         rateSuppressed?: boolean;
         payment?: string;
         company?: string;
         travelAgent?: string;
-        systemId?: any;
-        metadata?: any;
-        createdAt?: any;
-        updatedAt?: any;
-        deletedAt?: any;
+        systemId?: string;
+        metadata?: {};
+        createdAt?: (string | object);
+        updatedAt?: (string | object);
+        deletedAt?: (string | object);
     }[] | undefined;
     spaceName?: string | undefined;
     revenue?: {
@@ -654,7 +666,7 @@ type UserData = {
         name?: string;
         date?: string;
         price?: number;
-        tax?: number;
+        tax?: (number | null);
     }[] | undefined;
     /**
      * - Default: []