homey-api 3.6.6 → 3.6.8

package/assets/specifications/AthomAppsAPI.json

@@ -330,6 +330,40 @@
         }
       }
     },
+    "getAppSettings": {
+      "path": "/app/{appId}/settings",
+      "method": "get",
+      "parameters": {
+        "appId": {
+          "in": "path",
+          "type": "string",
+          "required": true
+        }
+      }
+    },
+    "updateAppSettings": {
+      "path": "/app/{appId}/settings",
+      "method": "put",
+      "parameters": {
+        "appId": {
+          "in": "path",
+          "type": "string",
+          "required": true
+        },
+        "sendEmailCrash": {
+          "type": "boolean",
+          "in": "body"
+        },
+        "sendEmailSuggestion": {
+          "type": "boolean",
+          "in": "body"
+        },
+        "sendEmailThanks": {
+          "type": "boolean",
+          "in": "body"
+        }
+      }
+    },
     "getAppChangelog": {
       "path": "/app/{appId}/changelog",
       "method": "get",
@@ -820,6 +854,25 @@
         }
       }
     },
+    "getAppSuggestions": {
+      "path": "/app/{appId}/suggestion",
+      "method": "get",
+      "parameters": {
+        "appId": {
+          "in": "path",
+          "type": "string",
+          "required": true
+        },
+        "offset": {
+          "in": "query",
+          "type": "number"
+        },
+        "length": {
+          "in": "query",
+          "type": "number"
+        }
+      }
+    },
     "createAppSuggestion": {
       "path": "/app/{appId}/suggestion",
       "method": "post",

package/assets/specifications/HomeyAPIV2.json

@@ -4555,6 +4555,9 @@
                   "number",
                   "string"
                 ]
+              },
+              "transparent": {
+                "type": "boolean"
               }
             },
             "x-realtime-bindings": {
@@ -4564,9 +4567,106 @@
               "delete": "appwidget.delete"
             }
           }
+        },
+        "WidgetStore": {
+          "id": "widgetstore",
+          "type": "id",
+          "schema": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "id": {
+                "type": "string",
+                "format": "uuid"
+              },
+              "ownerUri": {
+                "type": "string"
+              },
+              "state": {
+                "type": "object"
+              }
+            },
+            "x-realtime-bindings": {
+              "read": "getWidgetStore",
+              "create": "widgetstore.create",
+              "update": "widgetstore.update",
+              "delete": "widgetstore.delete"
+            }
+          }
         }
       },
       "operations": {
+        "setWidgetStoreState": {
+          "method": "POST",
+          "path": "/widgetstore/:id/state",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "required": true,
+              "type": "string"
+            },
+            "replace": {
+              "in": "body",
+              "type": "boolean"
+            },
+            "state": {
+              "in": "body",
+              "type": "object",
+              "required": true
+            }
+          }
+        },
+        "getWidgetStoreState": {
+          "method": "GET",
+          "path": "/widgetstore/:id/state",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "required": true,
+              "type": "string"
+            }
+          }
+        },
+        "getWidgetStore": {
+          "method": "GET",
+          "path": "/widgetstore/:id",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "WidgetStore"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "required": true,
+              "type": "string"
+            }
+          }
+        },
+        "getWidgetStores": {
+          "method": "GET",
+          "path": "/widgetstore",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getAll",
+            "item": "WidgetStore"
+          },
+          "parameters": {}
+        },
         "getAppWidgetAutocomplete": {
           "method": "GET",
           "path": "/appwidget/:id/autocomplete",

package/assets/specifications/HomeyAPIV3Local.json

@@ -816,6 +816,17 @@
               }
             }
           }
+        },
+        "WidgetStore": {
+          "id": "widgetstore",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
         }
       },
       "operations": {
@@ -955,11 +966,32 @@
           },
           "parameters": {}
         },
+        "getAppWidget": {
+          "method": "get",
+          "path": "/appwidget/:id",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "AppWidget"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "getAppWidgetAutocomplete": {
           "method": "get",
           "path": "/appwidget/:id/autocomplete",
           "private": false,
-          "scopes": [],
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
           "parameters": {
             "id": {
               "in": "path",
@@ -981,6 +1013,77 @@
               "type": "object"
             }
           }
+        },
+        "getWidgetStores": {
+          "method": "get",
+          "path": "/widgetstore",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getAll",
+            "item": "WidgetStore"
+          },
+          "parameters": {}
+        },
+        "getWidgetStore": {
+          "method": "get",
+          "path": "/widgetstore/:id",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "WidgetStore"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "getWidgetStoreState": {
+          "method": "get",
+          "path": "/widgetstore/:id/state",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "setWidgetStoreState": {
+          "method": "post",
+          "path": "/widgetstore/:id/state",
+          "private": false,
+          "scopes": [
+            "homey.dashboard.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "state": {
+              "in": "body",
+              "type": "object",
+              "required": true
+            },
+            "replace": {
+              "in": "body",
+              "type": "boolean"
+            }
+          }
         }
       }
     },
@@ -3278,6 +3381,29 @@
               "required": true
             }
           }
+        },
+        "openCommissioningWindow": {
+          "method": "post",
+          "path": "/open-commissioning-window",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "deviceId": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "timeout": {
+              "in": "body",
+              "type": "number"
+            },
+            "revokeExisting": {
+              "in": "body",
+              "type": "boolean"
+            }
+          }
         }
       }
     },
@@ -4237,19 +4363,14 @@
           ],
           "parameters": {}
         },
-        "reset": {
+        "apiReset": {
           "method": "get",
           "path": "/reset",
           "private": true,
           "scopes": [
             "homey.system"
           ],
-          "parameters": {
-            "target": {
-              "in": "query",
-              "type": "string"
-            }
-          }
+          "parameters": {}
         },
         "executeCommand": {
           "method": "post",
@@ -4263,6 +4384,18 @@
               "in": "body",
               "type": "string",
               "required": true
+            },
+            "timeout": {
+              "in": "body",
+              "type": "number"
+            },
+            "flush": {
+              "in": "body",
+              "type": "boolean"
+            },
+            "preventThreadSetup": {
+              "in": "body",
+              "type": "boolean"
             }
           }
         },

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

@@ -145,6 +145,8 @@ export namespace HomeyAPIV2.ManagerDashboards {
     settings: object;
 
     height: number | string;
+
+    transparent: boolean;
   }
 
   export class Dashboard extends HomeyAPIV3Local.ManagerDashboards.Dashboard {
@@ -154,6 +156,15 @@ export namespace HomeyAPIV2.ManagerDashboards {
 
     columns: Array<any>;
   }
+
+  export class WidgetStore extends HomeyAPIV3Local.ManagerDashboards
+    .WidgetStore {
+    id: string;
+
+    ownerUri: string;
+
+    state: object;
+  }
 }
 
 export namespace HomeyAPIV2.ManagerDevices {
@@ -1141,6 +1152,10 @@ export namespace HomeyAPIV3Local.ManagerDashboards {
 
     columns: Array<any>;
   }
+
+  export class WidgetStore {
+    id: string;
+  }
 }
 
 export namespace HomeyAPIV3Local.ManagerDevices {
@@ -1735,6 +1750,18 @@ export class AthomAppsAPI {
 
   deleteApp(opts: { appId: string }): Promise<any>;
 
+  getAppSettings(opts: { appId: string }): Promise<any>;
+
+  updateAppSettings(opts: {
+    appId: string;
+
+    sendEmailCrash?: boolean;
+
+    sendEmailSuggestion?: boolean;
+
+    sendEmailThanks?: boolean;
+  }): Promise<any>;
+
   getAppChangelog(opts: { appId: string }): Promise<any>;
 
   updateAppAuthor(opts: {
@@ -1905,6 +1932,14 @@ export class AthomAppsAPI {
     mac?: Array<any>;
   }): Promise<any>;
 
+  getAppSuggestions(opts: {
+    appId: string;
+
+    offset?: number;
+
+    length?: number;
+  }): Promise<any>;
+
   createAppSuggestion(opts: {
     appId: string;
 
@@ -2049,6 +2084,18 @@ export class AthomAppsAPI {
 
   deleteApp(opts: { appId: string }): Promise<any>;
 
+  getAppSettings(opts: { appId: string }): Promise<any>;
+
+  updateAppSettings(opts: {
+    appId: string;
+
+    sendEmailCrash?: boolean;
+
+    sendEmailSuggestion?: boolean;
+
+    sendEmailThanks?: boolean;
+  }): Promise<any>;
+
   getAppChangelog(opts: { appId: string }): Promise<any>;
 
   updateAppAuthor(opts: {
@@ -2219,6 +2266,14 @@ export class AthomAppsAPI {
     mac?: Array<any>;
   }): Promise<any>;
 
+  getAppSuggestions(opts: {
+    appId: string;
+
+    offset?: number;
+
+    length?: number;
+  }): Promise<any>;
+
   createAppSuggestion(opts: {
     appId: string;
 
@@ -5047,6 +5102,18 @@ export class AthomAppsAPI {
 
   deleteApp(opts: { appId: string }): Promise<any>;
 
+  getAppSettings(opts: { appId: string }): Promise<any>;
+
+  updateAppSettings(opts: {
+    appId: string;
+
+    sendEmailCrash?: boolean;
+
+    sendEmailSuggestion?: boolean;
+
+    sendEmailThanks?: boolean;
+  }): Promise<any>;
+
   getAppChangelog(opts: { appId: string }): Promise<any>;
 
   updateAppAuthor(opts: {
@@ -5217,6 +5284,14 @@ export class AthomAppsAPI {
     mac?: Array<any>;
   }): Promise<any>;
 
+  getAppSuggestions(opts: {
+    appId: string;
+
+    offset?: number;
+
+    length?: number;
+  }): Promise<any>;
+
   createAppSuggestion(opts: {
     appId: string;
 
@@ -5361,6 +5436,18 @@ export class AthomAppsAPI {
 
   deleteApp(opts: { appId: string }): Promise<any>;
 
+  getAppSettings(opts: { appId: string }): Promise<any>;
+
+  updateAppSettings(opts: {
+    appId: string;
+
+    sendEmailCrash?: boolean;
+
+    sendEmailSuggestion?: boolean;
+
+    sendEmailThanks?: boolean;
+  }): Promise<any>;
+
   getAppChangelog(opts: { appId: string }): Promise<any>;
 
   updateAppAuthor(opts: {
@@ -5531,6 +5618,14 @@ export class AthomAppsAPI {
     mac?: Array<any>;
   }): Promise<any>;
 
+  getAppSuggestions(opts: {
+    appId: string;
+
+    offset?: number;
+
+    length?: number;
+  }): Promise<any>;
+
   createAppSuggestion(opts: {
     appId: string;
 
@@ -9868,6 +9963,10 @@ export namespace HomeyAPIV3Local {
       [key: string]: HomeyAPIV3Local.ManagerDashboards.AppWidget;
     }>;
 
+    getAppWidget(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerDashboards.AppWidget>;
+
     getAppWidgetAutocomplete(opts: {
       id: string;
 
@@ -9877,6 +9976,24 @@ export namespace HomeyAPIV3Local {
 
       settings?: object;
     }): Promise<any>;
+
+    getWidgetStores(): Promise<{
+      [key: string]: HomeyAPIV3Local.ManagerDashboards.WidgetStore;
+    }>;
+
+    getWidgetStore(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerDashboards.WidgetStore>;
+
+    getWidgetStoreState(opts: { id: string }): Promise<any>;
+
+    setWidgetStoreState(opts: {
+      id: string;
+
+      state: object;
+
+      replace?: boolean;
+    }): Promise<any>;
   }
 
   export class ManagerDatabase extends HomeyAPIV3.ManagerDatabase {
@@ -10457,6 +10574,14 @@ export namespace HomeyAPIV3Local {
     makeDeviceApi(opts: { nodeId: string }): Promise<any>;
 
     readBasicInformation(opts: { nodeId: string }): Promise<any>;
+
+    openCommissioningWindow(opts: {
+      deviceId: string;
+
+      timeout?: number;
+
+      revokeExisting?: boolean;
+    }): Promise<any>;
   }
 
   export class ManagerMobile extends HomeyAPIV3.ManagerMobile {
@@ -10664,9 +10789,17 @@ export namespace HomeyAPIV3Local {
 
     getActiveDataset(): Promise<any>;
 
-    reset(opts: { target?: string }): Promise<any>;
+    apiReset(): Promise<any>;
+
+    executeCommand(opts: {
+      command: string;
+
+      timeout?: number;
 
-    executeCommand(opts: { command: string }): Promise<any>;
+      flush?: boolean;
+
+      preventThreadSetup?: boolean;
+    }): Promise<any>;
 
     apiDisable(): Promise<any>;
 

package/package.json

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