homey-api 3.5.1 → 3.5.2

package/assets/specifications/HomeyAPIV3Local.json

@@ -767,6 +767,7 @@
           "id": "dashboard",
           "schema": {
             "type": "object",
+            "additionalProperties": false,
             "properties": {
               "id": {
                 "type": "string",
@@ -775,56 +776,28 @@
               "name": {
                 "type": "string"
               },
-              "widgets": {
-                "type": "object",
-                "additionalProperties": false,
-                "patternProperties": {
-                  "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$": {
-                    "type": "object",
-                    "properties": {
-                      "type": {
-                        "type": "string"
-                      },
-                      "x": {
-                        "type": "number"
-                      },
-                      "y": {
-                        "type": "number"
-                      },
-                      "width": {
-                        "type": "number"
-                      },
-                      "height": {
-                        "type": "number"
-                      },
-                      "settings": {
-                        "type": "object"
-                      }
-                    }
-                  }
-                }
-              },
-              "lines": {
-                "type": "object",
-                "additionalProperties": false,
-                "patternProperties": {
-                  "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$": {
-                    "type": "object",
-                    "properties": {
-                      "x1": {
-                        "type": "number"
-                      },
-                      "x2": {
-                        "type": "number"
-                      },
-                      "y1": {
-                        "type": "number"
-                      },
-                      "y2": {
-                        "type": "number"
-                      },
-                      "settings": {
-                        "type": "object"
+              "columns": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "format": "uuid"
+                    },
+                    "widgets": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "id"
+                        ],
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "format": "uuid"
+                          }
+                        }
                       }
                     }
                   }
@@ -832,6 +805,17 @@
               }
             }
           }
+        },
+        "AppWidget": {
+          "id": "appwidget",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
         }
       },
       "operations": {
@@ -898,12 +882,8 @@
                   "type": "string",
                   "required": true
                 },
-                "widgets": {
-                  "type": "object",
-                  "required": true
-                },
-                "lines": {
-                  "type": "object",
+                "columns": {
+                  "type": "array",
                   "required": true
                 }
               }
@@ -936,11 +916,8 @@
                 "name": {
                   "type": "string"
                 },
-                "widgets": {
-                  "type": "object"
-                },
-                "lines": {
-                  "type": "object"
+                "columns": {
+                  "type": "array"
                 }
               }
             }
@@ -964,6 +941,46 @@
               "required": true
             }
           }
+        },
+        "getAppWidgets": {
+          "method": "get",
+          "path": "/appwidget",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getAll",
+            "item": "AppWidget"
+          },
+          "parameters": {}
+        },
+        "getAppWidgetAutocomplete": {
+          "method": "get",
+          "path": "/appwidget/:id/autocomplete",
+          "private": false,
+          "scopes": [],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "settingId": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            },
+            "query": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            },
+            "settings": {
+              "in": "query",
+              "type": "object"
+            }
+          }
         }
       }
     },
@@ -3296,6 +3313,15 @@
               "name": {
                 "type": "string"
               },
+              "preset": {
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "zone": {
+                "type": "string"
+              },
               "devices": {
                 "type": "object",
                 "additionalProperties": false,
@@ -3399,6 +3425,9 @@
                 "devices": {
                   "type": "object",
                   "required": true
+                },
+                "preset": {
+                  "type": "string"
                 }
               }
             }
@@ -3432,6 +3461,9 @@
                 },
                 "devices": {
                   "type": "object"
+                },
+                "preset": {
+                  "type": "string"
                 }
               }
             }
@@ -3442,7 +3474,7 @@
           "path": "/mood/:id/set",
           "private": false,
           "scopes": [
-            "homey.mood.start"
+            "homey.mood.set"
           ],
           "parameters": {
             "id": {
@@ -3470,15 +3502,6 @@
               "required": true
             }
           }
-        },
-        "debug": {
-          "method": "get",
-          "path": "/debug",
-          "private": true,
-          "scopes": [
-            "homey.mood"
-          ],
-          "parameters": {}
         }
       }
     },
@@ -4043,7 +4066,12 @@
           "path": "/ping",
           "private": false,
           "scopes": [],
-          "parameters": {}
+          "parameters": {
+            "id": {
+              "in": "query",
+              "type": "string"
+            }
+          }
         },
         "getInfo": {
           "method": "get",
@@ -4160,6 +4188,29 @@
             "homey.system"
           ],
           "parameters": {}
+        },
+        "startProfile": {
+          "method": "post",
+          "path": "/profile/start",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "duration": {
+              "in": "body",
+              "type": "number"
+            }
+          }
+        },
+        "stopProfile": {
+          "method": "post",
+          "path": "/profile/stop",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
         }
       }
     },
@@ -4214,6 +4265,24 @@
               "required": true
             }
           }
+        },
+        "apiDisable": {
+          "method": "get",
+          "path": "/disable",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
+        },
+        "apiEnable": {
+          "method": "get",
+          "path": "/enable",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
         }
       }
     },
@@ -5106,7 +5175,12 @@
           "scopes": [
             "homey.system"
           ],
-          "parameters": {}
+          "parameters": {
+            "erase": {
+              "in": "query",
+              "type": "string"
+            }
+          }
         },
         "getLog": {
           "method": "get",

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

@@ -4020,7 +4020,7 @@ export namespace HomeyAPIV3Local {
 
     getState(): Promise<any>;
 
-    ping(): Promise<any>;
+    ping(opts: { id?: string }): Promise<any>;
 
     getInfo(): Promise<any>;
 

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

@@ -137,10 +137,6 @@ export namespace HomeyAPIV2.ManagerDashboards {
     name: string;
 
     columns: Array<any>;
-
-    widgets: object;
-
-    lines: object;
   }
 }
 
@@ -1100,14 +1096,16 @@ export namespace HomeyAPIV3Local.ManagerCron {
 }
 
 export namespace HomeyAPIV3Local.ManagerDashboards {
+  export class AppWidget {
+    id: string;
+  }
+
   export class Dashboard {
     id: string;
 
     name: string;
 
-    widgets: object;
-
-    lines: object;
+    columns: Array<any>;
   }
 }
 
@@ -1382,6 +1380,10 @@ export namespace HomeyAPIV3Local.ManagerMoods {
 
     name: string;
 
+    preset: string | null;
+
+    zone: string;
+
     devices: object;
   }
 }
@@ -9680,9 +9682,7 @@ export namespace HomeyAPIV3Local {
       dashboard: {
         name: string;
 
-        widgets: object;
-
-        lines: object;
+        columns: Array<any>;
       };
     }): Promise<HomeyAPIV3Local.ManagerDashboards.Dashboard>;
 
@@ -9692,13 +9692,25 @@ export namespace HomeyAPIV3Local {
       dashboard: {
         name?: string;
 
-        widgets?: object;
-
-        lines?: object;
+        columns?: Array<any>;
       };
     }): Promise<HomeyAPIV3Local.ManagerDashboards.Dashboard>;
 
     deleteDashboard(opts: { id: string }): Promise<any>;
+
+    getAppWidgets(): Promise<{
+      [key: string]: HomeyAPIV3Local.ManagerDashboards.AppWidget;
+    }>;
+
+    getAppWidgetAutocomplete(opts: {
+      id: string;
+
+      settingId: string;
+
+      query: string;
+
+      settings?: object;
+    }): Promise<any>;
   }
 
   export class ManagerDatabase extends HomeyAPIV3.ManagerDatabase {
@@ -10297,6 +10309,8 @@ export namespace HomeyAPIV3Local {
         name: string;
 
         devices: object;
+
+        preset?: string;
       };
     }): Promise<HomeyAPIV3Local.ManagerMoods.Mood>;
 
@@ -10307,14 +10321,14 @@ export namespace HomeyAPIV3Local {
         name?: string;
 
         devices?: object;
+
+        preset?: string;
       };
     }): Promise<HomeyAPIV3Local.ManagerMoods.Mood>;
 
     setMood(opts: { id: string }): Promise<any>;
 
     deleteMood(opts: { id: string }): Promise<any>;
-
-    debug(): Promise<any>;
   }
 
   export class ManagerNotifications extends HomeyAPIV3.ManagerNotifications {
@@ -10450,7 +10464,7 @@ export namespace HomeyAPIV3Local {
 
     getState(): Promise<any>;
 
-    ping(): Promise<any>;
+    ping(opts: { id?: string }): Promise<any>;
 
     getInfo(): Promise<any>;
 
@@ -10473,6 +10487,10 @@ export namespace HomeyAPIV3Local {
     enableWifi(): Promise<any>;
 
     disableWifi(): Promise<any>;
+
+    startProfile(opts: { duration?: number }): Promise<any>;
+
+    stopProfile(): Promise<any>;
   }
 
   export class ManagerThread extends HomeyAPIV3.ManagerThread {
@@ -10483,6 +10501,10 @@ export namespace HomeyAPIV3Local {
     reset(opts: { target?: string }): Promise<any>;
 
     executeCommand(opts: { command: string }): Promise<any>;
+
+    apiDisable(): Promise<any>;
+
+    apiEnable(): Promise<any>;
   }
 
   export class ManagerUpdates extends HomeyAPIV3.ManagerUpdates {
@@ -10638,7 +10660,7 @@ export namespace HomeyAPIV3Local {
       opts?: object;
     }): Promise<any>;
 
-    flashFirmware(): Promise<any>;
+    flashFirmware(opts: { erase?: string }): Promise<any>;
 
     getLog(): Promise<any>;
 

package/package.json

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