homey-api 1.10.5 → 1.10.6

package/assets/specifications/HomeyAPIV3Local.json

@@ -16,22 +16,6 @@
         }
       }
     },
-    "ManagerArp": {
-      "id": "arp",
-      "idCamelCase": "arp",
-      "items": {},
-      "operations": {
-        "getState": {
-          "method": "get",
-          "path": "/state",
-          "private": false,
-          "scopes": [
-            "homey.system.readonly"
-          ],
-          "parameters": {}
-        }
-      }
-    },
     "ManagerApps": {
       "id": "apps",
       "idCamelCase": "apps",
@@ -82,6 +66,25 @@
           },
           "parameters": {}
         },
+        "getApp": {
+          "method": "get",
+          "path": "/app/:id",
+          "private": false,
+          "scopes": [
+            "homey.app.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "App"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "installFromAppStore": {
           "method": "post",
           "path": "/store",
@@ -274,6 +277,37 @@
               "required": true
             }
           }
+        },
+        "getAppLocales": {
+          "method": "get",
+          "path": "/app/:id/locale",
+          "private": false,
+          "scopes": [
+            "homey.app.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        }
+      }
+    },
+    "ManagerArp": {
+      "id": "arp",
+      "idCamelCase": "arp",
+      "items": {},
+      "operations": {
+        "getState": {
+          "method": "get",
+          "path": "/state",
+          "private": false,
+          "scopes": [
+            "homey.system.readonly"
+          ],
+          "parameters": {}
         }
       }
     },
@@ -426,6 +460,15 @@
           ],
           "parameters": {}
         },
+        "getBridges": {
+          "method": "get",
+          "path": "/bridge",
+          "private": false,
+          "scopes": [
+            "homey.system.readonly"
+          ],
+          "parameters": {}
+        },
         "pairBridge": {
           "method": "post",
           "path": "/bridge",
@@ -845,6 +888,9 @@
                 },
                 "virtualClass": {
                   "type": "string"
+                },
+                "uiIndicator": {
+                  "type": "string"
                 }
               }
             }
@@ -975,6 +1021,28 @@
               "required": true
             }
           }
+        },
+        "runApp": {
+          "method": "post",
+          "path": "/",
+          "private": false,
+          "scopes": [
+            "homey.app"
+          ],
+          "parameters": {
+            "debug": {
+              "in": "body",
+              "type": "string"
+            },
+            "env": {
+              "in": "body",
+              "type": "string"
+            },
+            "purgeSettings": {
+              "in": "body",
+              "type": "string"
+            }
+          }
         }
       }
     },
@@ -1192,8 +1260,7 @@
             },
             "data": {
               "in": "body",
-              "type": "object",
-              "required": true
+              "type": "object"
             }
           }
         },
@@ -1217,8 +1284,7 @@
             },
             "data": {
               "in": "body",
-              "type": "object",
-              "required": true
+              "type": "object"
             }
           }
         },
@@ -1242,8 +1308,7 @@
               "required": true,
               "properties": {
                 "name": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 },
                 "data": {
                   "required": true
@@ -1867,6 +1932,10 @@
               "in": "body",
               "type": "object"
             },
+            "state": {
+              "in": "body",
+              "type": "object"
+            },
             "droptoken": {
               "in": "body",
               "type": "string"
@@ -1912,6 +1981,10 @@
               "in": "body",
               "type": "object"
             },
+            "state": {
+              "in": "body",
+              "type": "object"
+            },
             "droptoken": {
               "in": "body",
               "type": "string"
@@ -2052,6 +2125,21 @@
               "required": true
             }
           }
+        },
+        "triggerAdvancedFlow": {
+          "method": "post",
+          "path": "/advancedflow/:id/trigger",
+          "private": false,
+          "scopes": [
+            "homey.flow.start"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -2101,16 +2189,16 @@
       "idCamelCase": "geolocation",
       "items": {},
       "operations": {
-        "getOptionMode": {
+        "getOptionAddress": {
           "method": "GET",
-          "path": "/option/mode",
+          "path": "/option/address",
           "scopes": [
             "homey.geolocation.readonly"
           ]
         },
-        "setOptionMode": {
+        "setOptionAddress": {
           "method": "PUT",
-          "path": "/option/mode",
+          "path": "/option/address",
           "scopes": [
             "homey.geolocation"
           ],
@@ -2121,9 +2209,9 @@
             }
           }
         },
-        "unsetOptionMode": {
+        "unsetOptionAddress": {
           "method": "DELETE",
-          "path": "/option/mode",
+          "path": "/option/address",
           "scopes": [
             "homey.geolocation"
           ]
@@ -2476,33 +2564,6 @@
             "homey.system"
           ]
         },
-        "getOptionBrightness": {
-          "method": "GET",
-          "path": "/option/brightness",
-          "scopes": [
-            "homey.system.readonly"
-          ]
-        },
-        "setOptionBrightness": {
-          "method": "PUT",
-          "path": "/option/brightness",
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {
-            "value": {
-              "in": "body",
-              "required": true
-            }
-          }
-        },
-        "unsetOptionBrightness": {
-          "method": "DELETE",
-          "path": "/option/brightness",
-          "scopes": [
-            "homey.system"
-          ]
-        },
         "getState": {
           "method": "get",
           "path": "/state",
@@ -2984,6 +3045,26 @@
             }
           }
         },
+        "replay": {
+          "method": "post",
+          "path": "/replay",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "frequency": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "data": {
+              "in": "body",
+              "type": "array",
+              "required": true
+            }
+          }
+        },
         "emulate": {
           "method": "post",
           "path": "/:frequency/emulate",
@@ -3064,6 +3145,22 @@
         }
       }
     },
+    "ManagerSafety": {
+      "id": "safety",
+      "idCamelCase": "safety",
+      "items": {},
+      "operations": {
+        "getState": {
+          "method": "get",
+          "path": "/state",
+          "private": false,
+          "scopes": [
+            "homey.system.readonly"
+          ],
+          "parameters": {}
+        }
+      }
+    },
     "ManagerSatellites": {
       "id": "satellites",
       "idCamelCase": "satellites",
@@ -3080,6 +3177,22 @@
         }
       }
     },
+    "ManagerSecurity": {
+      "id": "security",
+      "idCamelCase": "security",
+      "items": {},
+      "operations": {
+        "getState": {
+          "method": "get",
+          "path": "/state",
+          "private": false,
+          "scopes": [
+            "homey.system.readonly"
+          ],
+          "parameters": {}
+        }
+      }
+    },
     "ManagerSessions": {
       "id": "sessions",
       "idCamelCase": "sessions",
@@ -3267,24 +3380,6 @@
             "homey.system"
           ],
           "parameters": {}
-        },
-        "startBluFi": {
-          "method": "post",
-          "path": "/blufi/start",
-          "private": false,
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {}
-        },
-        "stopBluFi": {
-          "method": "post",
-          "path": "/blufi/stop",
-          "private": false,
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {}
         }
       }
     },
@@ -3394,6 +3489,13 @@
               "type": "boolean"
             }
           }
+        },
+        "abortInstallUpdate": {
+          "method": "delete",
+          "path": "/update",
+          "private": false,
+          "scopes": [],
+          "parameters": {}
         }
       }
     },
@@ -3619,8 +3721,8 @@
       "id": "vdevice",
       "idCamelCase": "vdevice",
       "items": {
-        "VirtualDriverVirtualSocket": {
-          "id": "virtualdrivervirtualsocket",
+        "VirtualDriverDummySocket": {
+          "id": "virtualdriverdummysocket",
           "schema": {
             "type": "object",
             "properties": {
@@ -3630,8 +3732,8 @@
             }
           }
         },
-        "VirtualDeviceVirtualSocket": {
-          "id": "virtualdevicevirtualsocket",
+        "VirtualDeviceDummySocket": {
+          "id": "virtualdevicedummysocket",
           "schema": {
             "type": "object",
             "properties": {
@@ -3728,6 +3830,72 @@
               }
             }
           }
+        },
+        "VirtualDriverVirtualSocket": {
+          "id": "virtualdrivervirtualsocket",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDeviceVirtualSocket": {
+          "id": "virtualdevicevirtualsocket",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDriverVirtualButton": {
+          "id": "virtualdrivervirtualbutton",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDeviceVirtualButton": {
+          "id": "virtualdevicevirtualbutton",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDriverVirtualIPCamera": {
+          "id": "virtualdrivervirtualipcamera",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDeviceVirtualIPCamera": {
+          "id": "virtualdevicevirtualipcamera",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
         }
       },
       "operations": {
@@ -3922,16 +4090,13 @@
               "required": true,
               "properties": {
                 "name": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 },
                 "icon": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 },
                 "parent": {
-                  "type": "string",
-                  "required": true
+                  "type": "string"
                 }
               }
             }

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

@@ -2739,6 +2739,10 @@
   
 
   
+
+  
+
+  
     export namespace HomeyAPIV3Local.ManagerSessions {
       
   export class Session  {
@@ -2785,6 +2789,16 @@
   
     export namespace HomeyAPIV3Local.ManagerVirtualDevice {
       
+  export class VirtualDeviceDummySocket  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
   export class VirtualDeviceHomeyBridge  {
     
 
@@ -2803,6 +2817,26 @@
     
 
     
+  }
+
+  export class VirtualDeviceVirtualButton  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
+  export class VirtualDeviceVirtualIPCamera  {
+    
+
+    
+      id: string;
+    
+
+    
   }
 
   export class VirtualDeviceVirtualSocket  {
@@ -2833,6 +2867,16 @@
     
 
     
+  }
+
+  export class VirtualDriverDummySocket  {
+    
+
+    
+      id: string;
+    
+
+    
   }
 
   export class VirtualDriverHomeyBridge  {
@@ -2853,6 +2897,26 @@
     
 
     
+  }
+
+  export class VirtualDriverVirtualButton  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
+  export class VirtualDriverVirtualIPCamera  {
+    
+
+    
+      id: string;
+    
+
+    
   }
 
   export class VirtualDriverVirtualSocket  {
@@ -2946,6 +3010,18 @@
 
   
 
+  
+
+  
+
+  
+
+  
+
+  
+
+  
+
   
 
   
@@ -10734,6 +10810,25 @@
     
       getApps(
         
+      ):
+        Promise<HomeyAPIV3Local.ManagerApps.App>;
+    
+      getApp(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<HomeyAPIV3Local.ManagerApps.App>;
     
@@ -10943,6 +11038,25 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      getAppLocales(
+        
+          
+  
+    
       opts: {
   
     
@@ -11185,6 +11299,11 @@
     
       getState(
         
+      ):
+        Promise<any>;
+    
+      getBridges(
+        
       ):
         Promise<any>;
     
@@ -11391,6 +11510,10 @@
       virtualClass: string,
     
   
+    
+      uiIndicator: string,
+    
+  
 },
     
   
@@ -11546,6 +11669,33 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      runApp(
+        
+          
+  
+    
+      opts: {
+  
+    
+      debug: string,
+    
+  
+    
+      env: string,
+    
+  
+    
+      purgeSettings: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -12347,6 +12497,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -12387,6 +12541,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -12512,6 +12670,25 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      triggerAdvancedFlow(
+        
+          
+  
+    
       opts: {
   
     
@@ -12582,12 +12759,12 @@
     
 
     
-      getOptionMode(
+      getOptionAddress(
         
       ):
         Promise<any>;
     
-      setOptionMode(
+      setOptionAddress(
         
           
   
@@ -12606,7 +12783,7 @@
       ):
         Promise<any>;
     
-      unsetOptionMode(
+      unsetOptionAddress(
         
       ):
         Promise<any>;
@@ -12966,35 +13143,6 @@
     
       unsetOptionScreensaver(
         
-      ):
-        Promise<any>;
-    
-      getOptionBrightness(
-        
-      ):
-        Promise<any>;
-    
-      setOptionBrightness(
-        
-          
-  
-    
-      opts: {
-  
-    
-      value: *,
-    
-  
-},
-    
-  
-
-        
-      ):
-        Promise<any>;
-    
-      unsetOptionBrightness(
-        
       ):
         Promise<any>;
     
@@ -13484,6 +13632,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      replay(
+        
+          
+  
+    
+      opts: {
+  
+    
+      frequency: string,
+    
+  
+    
+      data: Array<any>,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -13573,6 +13744,34 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerSafety extends HomeyAPIV3Local.Manager {
+    
+
+    
+
+    
+      getState(
+        
       ):
         Promise<any>;
     
@@ -13599,6 +13798,34 @@
     
 
     
+      getState(
+        
+      ):
+        Promise<any>;
+    
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerSecurity extends HomeyAPIV3Local.Manager {
+    
+
+    
+
+    
       getState(
         
       ):
@@ -13764,16 +13991,6 @@
     
       rebootOTA(
         
-      ):
-        Promise<any>;
-    
-      startBluFi(
-        
-      ):
-        Promise<any>;
-    
-      stopBluFi(
-        
       ):
         Promise<any>;
     
@@ -13916,6 +14133,11 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      abortInstallUpdate(
+        
       ):
         Promise<any>;
     

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

@@ -8141,6 +8141,10 @@
   
 
   
+
+  
+
+  
     export namespace HomeyAPIV3Local.ManagerSessions {
       
   export class Session  {
@@ -8187,6 +8191,16 @@
   
     export namespace HomeyAPIV3Local.ManagerVirtualDevice {
       
+  export class VirtualDeviceDummySocket  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
   export class VirtualDeviceHomeyBridge  {
     
 
@@ -8205,6 +8219,26 @@
     
 
     
+  }
+
+  export class VirtualDeviceVirtualButton  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
+  export class VirtualDeviceVirtualIPCamera  {
+    
+
+    
+      id: string;
+    
+
+    
   }
 
   export class VirtualDeviceVirtualSocket  {
@@ -8235,6 +8269,16 @@
     
 
     
+  }
+
+  export class VirtualDriverDummySocket  {
+    
+
+    
+      id: string;
+    
+
+    
   }
 
   export class VirtualDriverHomeyBridge  {
@@ -8255,6 +8299,26 @@
     
 
     
+  }
+
+  export class VirtualDriverVirtualButton  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
+  export class VirtualDriverVirtualIPCamera  {
+    
+
+    
+      id: string;
+    
+
+    
   }
 
   export class VirtualDriverVirtualSocket  {
@@ -8348,6 +8412,18 @@
 
   
 
+  
+
+  
+
+  
+
+  
+
+  
+
+  
+
   
 
   
@@ -16683,6 +16759,25 @@
     
       getApps(
         
+      ):
+        Promise<HomeyAPIV3Local.ManagerApps.App>;
+    
+      getApp(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<HomeyAPIV3Local.ManagerApps.App>;
     
@@ -16892,6 +16987,25 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      getAppLocales(
+        
+          
+  
+    
       opts: {
   
     
@@ -17134,6 +17248,11 @@
     
       getState(
         
+      ):
+        Promise<any>;
+    
+      getBridges(
+        
       ):
         Promise<any>;
     
@@ -17481,6 +17600,10 @@
       virtualClass: string,
     
   
+    
+      uiIndicator: string,
+    
+  
 },
     
   
@@ -17636,6 +17759,33 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      runApp(
+        
+          
+  
+    
+      opts: {
+  
+    
+      debug: string,
+    
+  
+    
+      env: string,
+    
+  
+    
+      purgeSettings: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -18437,6 +18587,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -18477,6 +18631,10 @@
     
   
     
+      state: object,
+    
+  
+    
       droptoken: string,
     
   
@@ -18602,6 +18760,25 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      triggerAdvancedFlow(
+        
+          
+  
+    
       opts: {
   
     
@@ -18672,12 +18849,12 @@
     
 
     
-      getOptionMode(
+      getOptionAddress(
         
       ):
         Promise<any>;
     
-      setOptionMode(
+      setOptionAddress(
         
           
   
@@ -18696,7 +18873,7 @@
       ):
         Promise<any>;
     
-      unsetOptionMode(
+      unsetOptionAddress(
         
       ):
         Promise<any>;
@@ -19056,35 +19233,6 @@
     
       unsetOptionScreensaver(
         
-      ):
-        Promise<any>;
-    
-      getOptionBrightness(
-        
-      ):
-        Promise<any>;
-    
-      setOptionBrightness(
-        
-          
-  
-    
-      opts: {
-  
-    
-      value: *,
-    
-  
-},
-    
-  
-
-        
-      ):
-        Promise<any>;
-    
-      unsetOptionBrightness(
-        
       ):
         Promise<any>;
     
@@ -19574,6 +19722,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      replay(
+        
+          
+  
+    
+      opts: {
+  
+    
+      frequency: string,
+    
+  
+    
+      data: Array<any>,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -19663,6 +19834,34 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerSafety extends HomeyAPIV3Local.Manager {
+    
+
+    
+
+    
+      getState(
+        
       ):
         Promise<any>;
     
@@ -19689,6 +19888,34 @@
     
 
     
+      getState(
+        
+      ):
+        Promise<any>;
+    
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerSecurity extends HomeyAPIV3Local.Manager {
+    
+
+    
+
+    
       getState(
         
       ):
@@ -19854,16 +20081,6 @@
     
       rebootOTA(
         
-      ):
-        Promise<any>;
-    
-      startBluFi(
-        
-      ):
-        Promise<any>;
-    
-      stopBluFi(
-        
       ):
         Promise<any>;
     
@@ -20006,6 +20223,11 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      abortInstallUpdate(
+        
       ):
         Promise<any>;
     

package/package.json

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