homey-api 1.8.0 → 1.9.0

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

@@ -7080,6 +7080,10 @@
 
   
 
+  
+
+  
+
   
 
   
@@ -7133,6 +7137,20 @@
   
 
   
+    export namespace HomeyAPIV3Cloud.ManagerCron {
+      
+  export class Cronjob  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
+    }
+  
 
   
     export namespace HomeyAPIV3Cloud.ManagerDashboards {
@@ -7179,6 +7197,8 @@
     
       name: string;
     
+      note: string;
+    
 
     
   }
@@ -7221,7 +7241,7 @@
   
     export namespace HomeyAPIV3Cloud.ManagerFlow {
       
-  export class Flow  {
+  export class AdvancedFlow  {
     
 
     
@@ -7229,6 +7249,14 @@
     
 
     
+  }
+
+  export class Flow  {
+    
+
+    
+
+    
   }
 
   export class FlowCardAction  {
@@ -7401,6 +7429,8 @@
   
 
   
+
+  
     export namespace HomeyAPIV3Cloud.ManagerRF {
       
   export class Signal  {
@@ -7417,6 +7447,10 @@
   
 
   
+
+  
+
+  
     export namespace HomeyAPIV3Cloud.ManagerSessions {
       
   export class Session  {
@@ -7787,6 +7821,8 @@
     
       name: string;
     
+      note: string;
+    
 
     
   }
@@ -7925,8 +7961,6 @@
     
 
     
-      id: string;
-    
 
     
   }
@@ -8546,6 +8580,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      getAppStd(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      message: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -8846,7 +8903,21 @@
       opts: {
   
     
-      dashboard: *,
+      dashboard: {
+  
+    
+      name: string,
+    
+  
+    
+      widgets: object,
+    
+  
+    
+      lines: object,
+    
+  
+},
     
   
 },
@@ -8869,7 +8940,21 @@
     
   
     
-      dashboard: *,
+      dashboard: {
+  
+    
+      name: string,
+    
+  
+    
+      widgets: object,
+    
+  
+    
+      lines: object,
+    
+  
+},
     
   
 },
@@ -9005,7 +9090,7 @@
     
   
     
-      settings: *,
+      settings: object,
     
   
 },
@@ -9033,7 +9118,29 @@
     
   
     
-      device: *,
+      device: {
+  
+    
+      name: string,
+    
+  
+    
+      zone: string,
+    
+  
+    
+      note: string,
+    
+  
+    
+      iconOverride: string,
+    
+  
+    
+      virtualClass: string,
+    
+  
+},
     
   
 },
@@ -9102,7 +9209,7 @@
     
   
     
-      value: *,
+      value: string | number | boolean,
     
   
     
@@ -9251,7 +9358,25 @@
       opts: {
   
     
-      pairsession: *,
+      pairsession: {
+  
+    
+      type: string,
+    
+  
+    
+      driverId: string,
+    
+  
+    
+      deviceId: string,
+    
+  
+    
+      zoneId: string,
+    
+  
+},
     
   
 },
@@ -9366,30 +9491,53 @@
     
   
     
-      device: *,
+      device: {
+  
+    
+      name: string,
     
   
-},
+    
+      data: *,
     
   
-
-        
-      ):
-        Promise<any>;
     
-      updatePairSessionDevice(
-        
-          
+      zone: string,
+    
   
     
-      opts: {
+      store: object,
+    
   
     
-      id: string,
+      capabilities: Array<any>,
     
   
     
-      device: *,
+      capabilitiesOptions: object,
+    
+  
+    
+      class: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      iconOverride: string,
+    
+  
+    
+      settings: object,
+    
+  
+    
+      energy: object,
+    
+  
+},
     
   
 },
@@ -9526,7 +9674,33 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -9549,7 +9723,33 @@
     
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -9587,7 +9787,21 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
     
@@ -9676,7 +9890,17 @@
       opts: {
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -9699,7 +9923,17 @@
     
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -9729,7 +9963,17 @@
       ):
         Promise<any>;
     
-      getFlowCardTrigger(
+      getFlowCardTriggers(
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger>;
+    
+      getFlowCardConditions(
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition>;
+    
+      runFlowCardCondition(
         
           
   
@@ -9740,20 +9984,36 @@
       id: string,
     
   
+    
+      uri: string,
+    
+  
+    
+      args: object,
+    
+  
+    
+      tokens: object,
+    
+  
+    
+      droptoken: string,
+    
+  
 },
     
   
 
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger>;
+        Promise<any>;
     
-      getFlowCardTriggers(
+      getFlowCardActions(
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger>;
+        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardAction>;
     
-      getFlowCardCondition(
+      runFlowCardAction(
         
           
   
@@ -9764,20 +10024,74 @@
       id: string,
     
   
+    
+      uri: string,
+    
+  
+    
+      args: object,
+    
+  
+    
+      tokens: object,
+    
+  
+    
+      droptoken: string,
+    
+  
+    
+      duration: number,
+    
+  
 },
     
   
 
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition>;
+        Promise<any>;
     
-      getFlowCardConditions(
+      getFlowCardAutocomplete(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      uri: string,
+    
+  
+    
+      type: string,
+    
+  
+    
+      name: string,
+    
+  
+    
+      query: string,
+    
+  
+    
+      args: object,
+    
+  
+},
+    
+  
+
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition>;
+        Promise<any>;
     
-      getFlowCardAction(
+      getAdvancedFlow(
         
           
   
@@ -9794,14 +10108,14 @@
 
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardAction>;
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
-      getFlowCardActions(
+      getAdvancedFlows(
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardAction>;
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
-      getFlowCardAutocomplete(
+      createAdvancedFlow(
         
           
   
@@ -9809,27 +10123,49 @@
       opts: {
   
     
-      id: string,
+      advancedflow: *,
+    
+  
+},
     
   
+
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
-      uri: string,
+      updateAdvancedFlow(
+        
+          
+  
     
+      opts: {
   
     
-      type: string,
+      id: string,
     
   
     
-      name: string,
+      advancedflow: *,
     
   
+},
     
-      query: string,
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
+      deleteAdvancedFlow(
+        
+          
   
     
-      args: object,
+      opts: {
+  
+    
+      id: string,
     
   
 },
@@ -10190,6 +10526,29 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      uri: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      deleteLogEntries(
+        
+          
+  
+    
       opts: {
   
     
@@ -10249,7 +10608,21 @@
       opts: {
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      type: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -10272,7 +10645,17 @@
     
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -10330,7 +10713,7 @@
       ):
         Promise<any>;
     
-      emitMobileEvent(
+      onMobileEvent(
         
           
   
@@ -10491,6 +10874,29 @@
       ):
         Promise<any>;
     
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerPremium extends HomeyAPIV3Cloud.Manager {
+    
+
+    
+
+    
       isConnected(
         
       ):
@@ -10531,7 +10937,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -10577,7 +10989,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -10659,6 +11077,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      emulate(
+        
+          
+  
+    
+      opts: {
+  
+    
+      frequency: string,
+    
+  
+    
+      data: Array<any>,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -10725,6 +11166,62 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerSafety extends HomeyAPIV3Cloud.Manager {
+    
+
+    
+
+    
+      getState(
+        
+      ):
+        Promise<any>;
+    
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerSecurity extends HomeyAPIV3Cloud.Manager {
+    
+
+    
+
+    
+      getState(
+        
       ):
         Promise<any>;
     
@@ -10823,22 +11320,41 @@
       ):
         Promise<any>;
     
-      getMemoryInfo(
+      reboot(
         
       ):
         Promise<any>;
     
-      getStorageInfo(
+      sendLog(
+        
+          
+  
+    
+      opts: {
+  
+    
+      append: string,
+    
+  
+},
+    
+  
+
         
       ):
         Promise<any>;
     
-      reboot(
+      delete(
         
       ):
         Promise<any>;
     
-      delete(
+      getMemoryInfo(
+        
+      ):
+        Promise<any>;
+    
+      getStorageInfo(
         
       ):
         Promise<any>;
@@ -10951,7 +11467,13 @@
       opts: {
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+},
     
   
 },
@@ -10974,7 +11496,17 @@
     
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+},
     
   
 },
@@ -11043,25 +11575,6 @@
   
 
         
-      ):
-        Promise<any>;
-    
-      swapOwner(
-        
-          
-  
-    
-      opts: {
-  
-    
-      newOwnerUserId: string,
-    
-  
-},
-    
-  
-
-        
       ):
         Promise<any>;
     
@@ -11277,7 +11790,21 @@
       opts: {
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -11300,7 +11827,21 @@
     
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -16307,7 +16848,13 @@
     
   
     
-      app: object,
+      app: {
+  
+    
+      autoupdate: boolean,
+    
+  
+},
     
   
 },
@@ -16603,6 +17150,25 @@
     
       getState(
         
+      ):
+        Promise<any>;
+    
+      pairBridge(
+        
+          
+  
+    
+      opts: {
+  
+    
+      serialHash: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -16694,7 +17260,21 @@
       opts: {
   
     
-      dashboard: *,
+      dashboard: {
+  
+    
+      name: string,
+    
+  
+    
+      widgets: object,
+    
+  
+    
+      lines: object,
+    
+  
+},
     
   
 },
@@ -16717,7 +17297,21 @@
     
   
     
-      dashboard: *,
+      dashboard: {
+  
+    
+      name: string,
+    
+  
+    
+      widgets: object,
+    
+  
+    
+      lines: object,
+    
+  
+},
     
   
 },
@@ -16853,7 +17447,7 @@
     
   
     
-      settings: *,
+      settings: object,
     
   
 },
@@ -16877,11 +17471,33 @@
       opts: {
   
     
-      id: string,
+      id: string,
+    
+  
+    
+      device: {
+  
+    
+      name: string,
+    
+  
+    
+      zone: string,
+    
+  
+    
+      note: string,
+    
+  
+    
+      iconOverride: string,
+    
+  
+    
+      virtualClass: string,
     
   
-    
-      device: *,
+},
     
   
 },
@@ -16950,7 +17566,7 @@
     
   
     
-      value: *,
+      value: string | number | boolean,
     
   
     
@@ -17127,7 +17743,25 @@
       opts: {
   
     
-      pairsession: *,
+      pairsession: {
+  
+    
+      type: string,
+    
+  
+    
+      driverId: string,
+    
+  
+    
+      deviceId: string,
+    
+  
+    
+      zoneId: string,
+    
+  
+},
     
   
 },
@@ -17242,30 +17876,53 @@
     
   
     
-      device: *,
+      device: {
+  
+    
+      name: string,
     
   
-},
+    
+      data: *,
     
   
-
-        
-      ):
-        Promise<any>;
     
-      updatePairSessionDevice(
-        
-          
+      zone: string,
+    
   
     
-      opts: {
+      store: object,
+    
   
     
-      id: string,
+      capabilities: Array<any>,
     
   
     
-      device: *,
+      capabilitiesOptions: object,
+    
+  
+    
+      class: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      iconOverride: string,
+    
+  
+    
+      settings: object,
+    
+  
+    
+      energy: object,
+    
+  
+},
     
   
 },
@@ -17473,7 +18130,33 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -17496,7 +18179,33 @@
     
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -17534,7 +18243,21 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
     
@@ -17623,7 +18346,17 @@
       opts: {
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -17646,7 +18379,17 @@
     
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -18412,7 +19155,21 @@
       opts: {
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      type: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -18435,7 +19192,17 @@
     
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -18683,7 +19450,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -18729,7 +19502,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -18987,6 +19766,35 @@
     
 
     
+      getOptionForwardedPort(
+        
+      ):
+        Promise<any>;
+    
+      setOptionForwardedPort(
+        
+          
+  
+    
+      opts: {
+  
+    
+      value: *,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      unsetOptionForwardedPort(
+        
+      ):
+        Promise<any>;
+    
       getState(
         
       ):
@@ -19325,7 +20133,13 @@
       opts: {
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+},
     
   
 },
@@ -19348,7 +20162,17 @@
     
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+},
     
   
 },
@@ -19534,6 +20358,11 @@
     
       getState(
         
+      ):
+        Promise<any>;
+    
+      flashFirmware(
+        
       ):
         Promise<any>;
     
@@ -19601,7 +20430,21 @@
       opts: {
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -19624,7 +20467,21 @@
     
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -19702,6 +20559,11 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      flashFirmware(
+        
       ):
         Promise<any>;