@kohost/api-client 3.0.0-beta.99 → 3.0.1

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

@@ -11,6 +11,7 @@
 export interface Scene {
   id?: string;
   name?: string;
+  description?: string;
   devices?: {
     switches?: {
       id?: string;
@@ -24,7 +25,7 @@ export interface Scene {
     }[];
     windowCoverings?: {
       id?: string;
-      position?: number;
+      position?: number | null;
       [k: string]: unknown;
     }[];
     thermostats?: {

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

@@ -38,6 +38,7 @@ export interface Space {
     | "mht"
     | "paxton"
     | "pelican-wireless"
+    | "power-shades"
     | "rebrandly"
     | "salto"
     | "salto-irn"

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

@@ -130,6 +130,7 @@ export interface Switch {
     | "mht"
     | "paxton"
     | "pelican-wireless"
+    | "power-shades"
     | "rebrandly"
     | "salto"
     | "salto-irn"

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

@@ -61,6 +61,7 @@ export interface SystemUser {
     | "mht"
     | "paxton"
     | "pelican-wireless"
+    | "power-shades"
     | "rebrandly"
     | "salto"
     | "salto-irn"

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

@@ -129,6 +129,7 @@ export interface Thermostat {
     | "mht"
     | "paxton"
     | "pelican-wireless"
+    | "power-shades"
     | "rebrandly"
     | "salto"
     | "salto-irn"

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

@@ -207,6 +207,7 @@ export interface Reservation {
     | "mht"
     | "paxton"
     | "pelican-wireless"
+    | "power-shades"
     | "rebrandly"
     | "salto"
     | "salto-irn"
@@ -271,6 +272,7 @@ export interface Reservation {
     id?: string;
     price?: number;
     unit?: "night" | "stay" | "hour";
+    isUpgrade?: boolean;
     [k: string]: unknown;
   }[];
   revenue?: Revenue;

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

@@ -109,6 +109,7 @@ export interface WindowCovering {
     | "discPlayer"
     | "mediaPlayer"
     | "uncontrolledDevice";
+  discriminator?: "basic" | "variable";
   supportedNotifications?: SupportedNotifications;
   notification?: Notification;
   driver:
@@ -129,6 +130,7 @@ export interface WindowCovering {
     | "mht"
     | "paxton"
     | "pelican-wireless"
+    | "power-shades"
     | "rebrandly"
     | "salto"
     | "salto-irn"
@@ -140,7 +142,7 @@ export interface WindowCovering {
     | "cloudflare-stream"
     | "insperia-privacy";
   offline?: boolean;
-  position: number;
+  position: number | null;
   systemId?: string;
   watts?: number;
   [k: string]: unknown;

package/dist/cjs/schemas/alarm.json

@@ -43,9 +43,6 @@
           "securityMode": {
             "type": ["string", "null"],
             "enum": ["arming", "disarming", "armed", "disarmed", "alarm", null]
-          },
-          "readyToArm": {
-            "type": ["boolean", "null"]
           }
         },
         "additionalProperties": false
@@ -64,7 +61,7 @@
             "type": "string"
           },
           "secure": {
-            "type": "boolean"
+            "type": ["boolean", "null"]
           },
           "bypassed": {
             "type": ["boolean", "null"]
@@ -75,6 +72,9 @@
     },
     "watts": {
       "$ref": "definitions.json#/definitions/watts"
+    },
+    "address": {
+      "$ref": "definitions.json#/definitions/address"
     }
   },
   "required": ["id", "type", "areas", "zones", "driver"]

package/dist/cjs/schemas/credential.json

@@ -23,6 +23,7 @@
         "mobileKey",
         "pin",
         "publicKey",
+        "passkeyChallenge",
         "id"
       ]
     },

package/dist/cjs/schemas/definitions.json

@@ -100,6 +100,7 @@
         "mht",
         "paxton",
         "pelican-wireless",
+        "power-shades",
         "rebrandly",
         "salto",
         "salto-irn",

package/dist/cjs/schemas/discoveredDevice.json

@@ -30,6 +30,10 @@
     "organization": {
       "type": ["string", "null"],
       "description": "Reference (id) to the organization that owns this device"
+    },
+    "property": {
+      "type": ["string", "null"],
+      "description": "Reference (id) to the property that this device belongs to"
     }
   }
 }

package/dist/cjs/schemas/mediaSource.json

@@ -4,12 +4,16 @@
   "title": "Media Source",
   "description": "Any media source",
   "type": "object",
-  "required": ["id", "type", "audio", "video", "driver"],
+  "required": ["id", "type", "discriminator", "audio", "video", "driver"],
   "properties": {
     "id": {
       "$ref": "definitions.json#/definitions/id"
     },
     "type": {
+      "type": "string",
+      "default": "mediaSource"
+    },
+    "discriminator": {
       "type": "string",
       "enum": [
         "tv",
@@ -20,6 +24,12 @@
         "uncontrolledDevice"
       ]
     },
+    "remote": {
+      "type": "string",
+      "enum": [
+        "MR22GA"
+      ]
+    },
     "name": {
       "$ref": "definitions.json#/definitions/name"
     },

package/dist/cjs/schemas/organization.json

@@ -26,6 +26,115 @@
         "type": "string"
       }
     },
+    "hostname": {
+      "type": ["string", "null"]
+    },
+    "appManifest": {
+      "type": "object",
+
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "short_name": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "start_url": {
+          "type": "string"
+        },
+        "themeColor": {
+          "type": "string"
+        },
+        "backgroundColor": {
+          "type": "string"
+        },
+        "display": {
+          "type": "string",
+          "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
+          "default": "fullscreen"
+        },
+        "orientation": {
+          "type": "string",
+          "enum": ["portrait", "landscape"],
+          "default": "portrait"
+        },
+        "splash": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        },
+        "icons": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "src": {
+                "type": "string"
+              },
+              "sizes": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "logo": {
+          "type": "object",
+          "properties": {
+            "src": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "sizes": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "default": {
+        "name": "Kohost",
+        "short_name": "Kohost",
+        "start_url": "/",
+        "scope": "/",
+        "display": "fullscreen",
+        "orientation": "portrait",
+        "theme_color": "#1d1f22",
+        "background_color": "#1d1f22",
+        "icons": [
+          {
+            "src": "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/9c85047f-ccba-4b1c-3070-5463fbe93b00/w=512",
+            "sizes": "512x512",
+            "type": "image/png"
+          }
+        ],
+        "splash": {
+          "src": "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/034fb112-5326-4d37-373e-d1cc2a4d0400/w=1500",
+          "sizes": "1500x800",
+          "type": "image/jpg"
+        },
+        "logo": {
+          "src": "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/1e54c54d-3bac-4745-f46f-c2f98036af00/h=75",
+          "sizes": "300x75",
+          "type": "image/png"
+        }
+      }
+    },
     "credentials": {
       "type": "object",
       "additionalProperties": true

package/dist/cjs/schemas/property.json

@@ -4,7 +4,7 @@
   "title": "Property",
   "type": "object",
   "description": "A property is a physical asset or building",
-  "required": ["id", "name", "type", "hostname", "organization"],
+  "required": ["id", "name", "type", "organization"],
   "properties": {
     "id": {
       "$ref": "definitions.json#/definitions/id"
@@ -20,6 +20,10 @@
       "type": "string",
       "enum": ["hospitality", "education", "commercial"]
     },
+    "organization": {
+      "type": ["string", "null"],
+      "description": "Reference (id) to the organization that owns this property"
+    },
     "testModeEnabled": {
       "type": "boolean"
     },
@@ -41,13 +45,6 @@
     "smsNumber": {
       "type": "string"
     },
-    "hostname": {
-      "type": ["string", "null"]
-    },
-    "organization": {
-      "type": ["string", "null"],
-      "description": "Reference (id) to the organization that owns this property"
-    },
     "checkInTime": {
       "type": "string"
     },
@@ -63,112 +60,6 @@
     "longitude": {
       "type": "number"
     },
-    "appManifest": {
-      "type": "object",
-
-      "properties": {
-        "name": {
-          "type": "string"
-        },
-        "short_name": {
-          "type": "string"
-        },
-        "scope": {
-          "type": "string"
-        },
-        "start_url": {
-          "type": "string"
-        },
-        "themeColor": {
-          "type": "string"
-        },
-        "backgroundColor": {
-          "type": "string"
-        },
-        "display": {
-          "type": "string",
-          "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
-          "default": "fullscreen"
-        },
-        "orientation": {
-          "type": "string",
-          "enum": ["portrait", "landscape"],
-          "default": "portrait"
-        },
-        "splash": {
-          "type": "object",
-          "properties": {
-            "src": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string"
-            },
-            "sizes": {
-              "type": "string"
-            }
-          }
-        },
-        "icons": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "src": {
-                "type": "string"
-              },
-              "sizes": {
-                "type": "string"
-              },
-              "type": {
-                "type": "string"
-              }
-            }
-          }
-        },
-        "logo": {
-          "type": "object",
-          "properties": {
-            "src": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string"
-            },
-            "sizes": {
-              "type": "string"
-            }
-          }
-        }
-      },
-      "default": {
-        "name": "Kohost",
-        "short_name": "Kohost",
-        "start_url": "/",
-        "scope": "/",
-        "display": "fullscreen",
-        "orientation": "portrait",
-        "theme_color": "#1d1f22",
-        "background_color": "#1d1f22",
-        "icons": [
-          {
-            "src": "https://cdn.kohost.app/defaultIcon.png",
-            "sizes": "512x512",
-            "type": "image/png"
-          }
-        ],
-        "splash": {
-          "src": "https://cdn.kohost.app/defaultSplash.jpg",
-          "sizes": "1500x800",
-          "type": "image/jpg"
-        },
-        "logo": {
-          "src": "https://cdn.kohost.app/defaultLogo.png",
-          "sizes": "300x75",
-          "type": "image/png"
-        }
-      }
-    },
     "appFeatures": {
       "type": "object",
       "properties": {
@@ -185,6 +76,32 @@
                   }
                 }
               }
+            },
+            "alarmConfig": {
+              "type": "object",
+              "patternProperties": {
+                "^[a-zA-Z0-9]+$": {
+                  "type": "object",
+                  "properties": {
+                    "zoneLockMap": {
+                      "type": "object",
+                      "description": "Maps zone numbers to lock ids",
+                      "additionalProperties": { "type": "string" }
+                    }
+                  }
+                }
+              },
+              "examples": [
+                {
+                  "wZz7hucY": {
+                    "zoneLockMap": {
+                      "1": "wc87hucc",
+                      "2": "bc86hzxc",
+                      "3": "zv5ah5jv"
+                    }
+                  }
+                }
+              ]
             }
           },
           "additionalProperties": false
@@ -250,7 +167,7 @@
           "properties": {
             "system": {
               "type": "string",
-              "enum": ["salto"]
+              "enum": ["salto", "legic"]
             },
             "systemOnline": {
               "type": "boolean",
@@ -288,7 +205,13 @@
             }
           }
         },
-        "Elevator": {}
+        "Elevator": {},
+        "Experiences": {},
+        "Dining": {},
+        "Rentals": {},
+        "Shop": {},
+        "Spa": {},
+        "Valet": {}
       },
       "additionalProperties": false,
       "default": {

package/dist/cjs/schemas/reservation.json

@@ -105,6 +105,9 @@
           "unit": {
             "type": "string",
             "enum": ["night", "stay", "hour"]
+          },
+          "isUpgrade": {
+            "type": "boolean"
           }
         }
       }

package/dist/cjs/schemas/scene.json

@@ -11,6 +11,9 @@
     "name": {
       "type": "string"
     },
+    "description": {
+      "type": "string"
+    },
     "devices": {
       "type": "object",
       "properties": {

package/dist/cjs/schemas/windowCovering.json

@@ -12,7 +12,13 @@
       "type": "string"
     },
     "type": {
-      "$ref": "definitions.json#/definitions/type"
+      "$ref": "definitions.json#/definitions/type",
+      "default": "windowCovering"
+    },
+    "discriminator": {
+      "type": "string",
+      "enum": ["basic", "variable"],
+      "default": "variable"
     },
     "supportedNotifications": {
       "$ref": "definitions.json#/definitions/supportedNotifications"
@@ -27,7 +33,7 @@
       "type": "boolean"
     },
     "position": {
-      "type": "number",
+      "type": ["number", "null"],
       "minimum": 0,
       "maximum": 100
     },