homey-api 3.6.1 → 3.6.3

package/assets/specifications/HomeyAPIV2.json

@@ -4525,9 +4525,109 @@
               "delete": "dashboard.delete"
             }
           }
+        },
+        "AppWidget": {
+          "id": "appwidget",
+          "type": "id",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "ownerId": {
+                "type": "string"
+              },
+              "ownerUri": {
+                "type": "string"
+              },
+              "ownerName": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "settings": {
+                "type": "object"
+              },
+              "height": {
+                "type": [
+                  "number",
+                  "string"
+                ]
+              }
+            },
+            "x-realtime-bindings": {
+              "read": "getAppWidget",
+              "create": "appwidget.create",
+              "update": "appwidget.update",
+              "delete": "appwidget.delete"
+            }
+          }
         }
       },
       "operations": {
+        "getAppWidgetAutocomplete": {
+          "method": "GET",
+          "path": "/appwidget/:id/autocomplete",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "required": true,
+              "type": "string"
+            },
+            "settings": {
+              "in": "query",
+              "type": "string"
+            },
+            "query": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            },
+            "settingId": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "getAppWidget": {
+          "method": "GET",
+          "path": "/appwidget/:id",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "AppWidget"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "required": true,
+              "type": "string"
+            }
+          }
+        },
+        "getAppWidgets": {
+          "method": "GET",
+          "path": "/appwidget",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getAll",
+            "item": "AppWidget"
+          },
+          "parameters": {}
+        },
         "deleteDashboard": {
           "method": "DELETE",
           "path": "/dashboard/:id",

package/assets/types/homey-api.d.ts

@@ -609,6 +609,12 @@ export namespace HomeyAPIV2.ManagerZones {
     active: boolean;
 
     icon: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
   }
 }
 
@@ -982,8 +988,20 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
 }
 
 export namespace HomeyAPIV3Cloud.ManagerZones {
-  export class Zone {
+  export class Zone extends HomeyAPIV3.ManagerZones.Zone {
     id: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
+
+    getParent(): Promise<HomeyAPIV3.ManagerZones.Zone | null>;
+
+    connect(): Promise<any>;
+
+    disconnect(): Promise<any>;
   }
 }
 
@@ -1425,8 +1443,20 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
 }
 
 export namespace HomeyAPIV3Local.ManagerZones {
-  export class Zone {
+  export class Zone extends HomeyAPIV3.ManagerZones.Zone {
     id: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
+
+    getParent(): Promise<HomeyAPIV3.ManagerZones.Zone | null>;
+
+    connect(): Promise<any>;
+
+    disconnect(): Promise<any>;
   }
 }
 
@@ -4425,3 +4455,21 @@ export namespace HomeyAPIV3.ManagerInsights {
     disconnect(): Promise<any>;
   }
 }
+
+export namespace HomeyAPIV3.ManagerZones {
+  export class Zone extends HomeyAPIV3.Item {
+    id: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
+
+    getParent(): Promise<HomeyAPIV3.ManagerZones.Zone | null>;
+
+    connect(): Promise<any>;
+
+    disconnect(): Promise<any>;
+  }
+}

package/assets/types/homey-api.private.d.ts

@@ -131,6 +131,22 @@ export namespace HomeyAPIV2.ManagerApps {
 }
 
 export namespace HomeyAPIV2.ManagerDashboards {
+  export class AppWidget extends HomeyAPIV3Local.ManagerDashboards.AppWidget {
+    id: string;
+
+    ownerId: string;
+
+    ownerUri: string;
+
+    ownerName: string;
+
+    name: string;
+
+    settings: object;
+
+    height: number | string;
+  }
+
   export class Dashboard extends HomeyAPIV3Local.ManagerDashboards.Dashboard {
     id: string;
 
@@ -633,6 +649,12 @@ export namespace HomeyAPIV2.ManagerZones {
     active: boolean;
 
     icon: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
   }
 }
 
@@ -1030,8 +1052,20 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
 }
 
 export namespace HomeyAPIV3Cloud.ManagerZones {
-  export class Zone {
+  export class Zone extends HomeyAPIV3.ManagerZones.Zone {
     id: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
+
+    getParent(): Promise<HomeyAPIV3.ManagerZones.Zone | null>;
+
+    connect(): Promise<any>;
+
+    disconnect(): Promise<any>;
   }
 }
 
@@ -1501,8 +1535,20 @@ export namespace HomeyAPIV3Local.ManagerVirtualDevice {
 }
 
 export namespace HomeyAPIV3Local.ManagerZones {
-  export class Zone {
+  export class Zone extends HomeyAPIV3.ManagerZones.Zone {
     id: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
+
+    getParent(): Promise<HomeyAPIV3.ManagerZones.Zone | null>;
+
+    connect(): Promise<any>;
+
+    disconnect(): Promise<any>;
   }
 }
 
@@ -10955,3 +11001,21 @@ export namespace HomeyAPIV3.ManagerInsights {
     disconnect(): Promise<any>;
   }
 }
+
+export namespace HomeyAPIV3.ManagerZones {
+  export class Zone extends HomeyAPIV3.Item {
+    id: string;
+
+    uri: string;
+
+    manager: HomeyAPIV3.Manager;
+
+    homey: HomeyAPIV3;
+
+    getParent(): Promise<HomeyAPIV3.ManagerZones.Zone | null>;
+
+    connect(): Promise<any>;
+
+    disconnect(): Promise<any>;
+  }
+}

package/lib/HomeyAPI/HomeyAPIV3/ManagerZones/Zone.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const Item = require('../Item');
+
+/**
+ * @class
+ * @hideconstructor
+ * @extends HomeyAPIV3.Item
+ * @memberof HomeyAPIV3.ManagerZones
+ */
+class Zone extends Item {
+
+  /**
+   * Get the parent zone.
+   * @returns {Promise<HomeyAPIV3.ManagerZones.Zone|null>}
+   */
+  async getParent() {
+    if (!this.parent) return null;
+
+    return this.homey.zones.getZone({
+      id: this.parent,
+    });
+  }
+
+}
+
+module.exports = Zone;

package/lib/HomeyAPI/HomeyAPIV3/ManagerZones.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const Manager = require('./Manager');
+const Zone = require('./ManagerZones/Zone');
+
+class ManagerZones extends Manager {
+
+  static CRUD = {
+    ...super.CRUD,
+    Zone,
+  }
+
+}
+
+module.exports = ManagerZones;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -12,6 +12,7 @@ const ManagerFlow = require('./HomeyAPIV3/ManagerFlow');
 const ManagerFlowToken = require('./HomeyAPIV3/ManagerFlowToken');
 const ManagerInsights = require('./HomeyAPIV3/ManagerInsights');
 const ManagerUsers = require('./HomeyAPIV3/ManagerUsers');
+const ManagerZones = require('./HomeyAPIV3/ManagerZones');
 const Manager = require('./HomeyAPIV3/Manager');
 
 /**
@@ -29,6 +30,7 @@ class HomeyAPIV3 extends HomeyAPI {
     ManagerFlowToken,
     ManagerInsights,
     ManagerUsers,
+    ManagerZones,
   };
 
   static DEFAULT_TIMEOUT = 1000 * 10;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.6.1",
+  "version": "3.6.3",
   "description": "Homey API",
   "main": "index.js",
   "files": [