homey-api 1.8.0 → 1.9.1

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

@@ -1704,6 +1704,10 @@
 
   
 
+  
+
+  
+
   
 
   
@@ -1757,6 +1761,20 @@
   
 
   
+    export namespace HomeyAPIV3Cloud.ManagerCron {
+      
+  export class Cronjob  {
+    
+
+    
+      id: string;
+    
+
+    
+  }
+
+    }
+  
 
   
 
@@ -1783,6 +1801,8 @@
     
       name: string;
     
+      note: string;
+    
 
     
   }
@@ -1825,7 +1845,7 @@
   
     export namespace HomeyAPIV3Cloud.ManagerFlow {
       
-  export class Flow  {
+  export class AdvancedFlow  {
     
 
     
@@ -1833,6 +1853,14 @@
     
 
     
+  }
+
+  export class Flow  {
+    
+
+    
+
+    
   }
 
   export class FlowCardAction  {
@@ -2005,6 +2033,8 @@
   
 
   
+
+  
     export namespace HomeyAPIV3Cloud.ManagerRF {
       
   export class Signal  {
@@ -2021,6 +2051,10 @@
   
 
   
+
+  
+
+  
     export namespace HomeyAPIV3Cloud.ManagerSessions {
       
   export class Session  {
@@ -2371,6 +2405,8 @@
     
       name: string;
     
+      note: string;
+    
 
     
   }
@@ -2509,8 +2545,6 @@
     
 
     
-      id: string;
-    
 
     
   }
@@ -3130,6 +3164,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      getAppStd(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      message: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -3476,7 +3533,7 @@
     
   
     
-      settings: *,
+      settings: object,
     
   
 },
@@ -3504,7 +3561,29 @@
     
   
     
-      device: *,
+      device: {
+  
+    
+      name: string,
+    
+  
+    
+      zone: string,
+    
+  
+    
+      note: string,
+    
+  
+    
+      iconOverride: string,
+    
+  
+    
+      virtualClass: string,
+    
+  
+},
     
   
 },
@@ -3573,7 +3652,7 @@
     
   
     
-      value: *,
+      value: string | number | boolean,
     
   
     
@@ -3722,7 +3801,25 @@
       opts: {
   
     
-      pairsession: *,
+      pairsession: {
+  
+    
+      type: string,
+    
+  
+    
+      driverId: string,
+    
+  
+    
+      deviceId: string,
+    
+  
+    
+      zoneId: string,
+    
+  
+},
     
   
 },
@@ -3837,30 +3934,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,
+    
+  
+},
     
   
 },
@@ -3997,7 +4117,33 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -4020,7 +4166,33 @@
     
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -4058,7 +4230,21 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
     
@@ -4147,7 +4333,17 @@
       opts: {
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -4170,7 +4366,17 @@
     
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -4200,7 +4406,17 @@
       ):
         Promise<any>;
     
-      getFlowCardTrigger(
+      getFlowCardTriggers(
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardTrigger>;
+    
+      getFlowCardConditions(
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardCondition>;
+    
+      runFlowCardCondition(
         
           
   
@@ -4211,20 +4427,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(
         
           
   
@@ -4235,20 +4467,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(
         
           
   
@@ -4265,14 +4551,14 @@
 
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardAction>;
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
-      getFlowCardActions(
+      getAdvancedFlows(
         
       ):
-        Promise<HomeyAPIV3Cloud.ManagerFlow.FlowCardAction>;
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
-      getFlowCardAutocomplete(
+      createAdvancedFlow(
         
           
   
@@ -4280,27 +4566,49 @@
       opts: {
   
     
-      id: string,
+      advancedflow: *,
     
   
+},
     
-      uri: string,
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
+      updateAdvancedFlow(
+        
+          
   
     
-      type: string,
+      opts: {
+  
+    
+      id: string,
     
   
     
-      name: string,
+      advancedflow: *,
     
   
+},
     
-      query: string,
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Cloud.ManagerFlow.AdvancedFlow>;
     
+      deleteAdvancedFlow(
+        
+          
   
     
-      args: object,
+      opts: {
+  
+    
+      id: string,
     
   
 },
@@ -4661,6 +4969,29 @@
           
   
     
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      uri: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      deleteLogEntries(
+        
+          
+  
+    
       opts: {
   
     
@@ -4720,7 +5051,21 @@
       opts: {
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      type: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -4743,7 +5088,17 @@
     
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -4801,7 +5156,7 @@
       ):
         Promise<any>;
     
-      emitMobileEvent(
+      onMobileEvent(
         
           
   
@@ -4947,20 +5302,43 @@
       opts: {
   
     
-      uri: string,
+      uri: string,
+    
+  
+    
+      push: boolean,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
     
-  
+      disconnect(
+        
+      ):
+        Promise<void>;
     
-      push: boolean,
+  }
+
+  export class ManagerPremium extends HomeyAPIV3Cloud.Manager {
     
-  
-},
+
     
-  
 
-        
-      ):
-        Promise<any>;
     
       isConnected(
         
@@ -5002,7 +5380,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -5048,7 +5432,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -5130,6 +5520,29 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      emulate(
+        
+          
+  
+    
+      opts: {
+  
+    
+      frequency: string,
+    
+  
+    
+      data: Array<any>,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -5196,6 +5609,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>;
     
@@ -5294,22 +5763,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>;
@@ -5422,7 +5910,13 @@
       opts: {
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+},
     
   
 },
@@ -5445,7 +5939,17 @@
     
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+},
     
   
 },
@@ -5514,25 +6018,6 @@
   
 
         
-      ):
-        Promise<any>;
-    
-      swapOwner(
-        
-          
-  
-    
-      opts: {
-  
-    
-      newOwnerUserId: string,
-    
-  
-},
-    
-  
-
-        
       ):
         Promise<any>;
     
@@ -5748,7 +6233,21 @@
       opts: {
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -5771,7 +6270,21 @@
     
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -10372,7 +10885,13 @@
     
   
     
-      app: object,
+      app: {
+  
+    
+      autoupdate: boolean,
+    
+  
+},
     
   
 },
@@ -10668,6 +11187,25 @@
     
       getState(
         
+      ):
+        Promise<any>;
+    
+      pairBridge(
+        
+          
+  
+    
+      opts: {
+  
+    
+      serialHash: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -10805,35 +11343,57 @@
     
   
     
-      settings: *,
+      settings: object,
     
   
 },
     
   
-
-        
-      ):
-        Promise<any>;
+
+        
+      ):
+        Promise<any>;
+    
+      getDevices(
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerDevices.Device>;
+    
+      updateDevice(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      device: {
+  
+    
+      name: string,
+    
+  
+    
+      zone: string,
+    
+  
     
-      getDevices(
-        
-      ):
-        Promise<HomeyAPIV3Local.ManagerDevices.Device>;
+      note: string,
     
-      updateDevice(
-        
-          
   
     
-      opts: {
+      iconOverride: string,
+    
   
     
-      id: string,
+      virtualClass: string,
     
   
-    
-      device: *,
+},
     
   
 },
@@ -10902,7 +11462,7 @@
     
   
     
-      value: *,
+      value: string | number | boolean,
     
   
     
@@ -11079,7 +11639,25 @@
       opts: {
   
     
-      pairsession: *,
+      pairsession: {
+  
+    
+      type: string,
+    
+  
+    
+      driverId: string,
+    
+  
+    
+      deviceId: string,
+    
+  
+    
+      zoneId: string,
+    
+  
+},
     
   
 },
@@ -11194,30 +11772,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,
+    
+  
+},
     
   
 },
@@ -11425,7 +12026,33 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -11448,7 +12075,33 @@
     
   
     
-      flow: *,
+      flow: {
+  
+    
+      name: string,
+    
+  
+    
+      folder: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
 },
@@ -11486,7 +12139,21 @@
       opts: {
   
     
-      flow: *,
+      flow: {
+  
+    
+      trigger: object,
+    
+  
+    
+      conditions: Array<any>,
+    
+  
+    
+      actions: Array<any>,
+    
+  
+},
     
   
     
@@ -11575,7 +12242,17 @@
       opts: {
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -11598,7 +12275,17 @@
     
   
     
-      flowfolder: *,
+      flowfolder: {
+  
+    
+      name: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -12364,7 +13051,21 @@
       opts: {
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      type: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -12387,7 +13088,17 @@
     
   
     
-      variable: *,
+      variable: {
+  
+    
+      name: string,
+    
+  
+    
+      value: string | number | boolean,
+    
+  
+},
     
   
 },
@@ -12635,7 +13346,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -12681,7 +13398,13 @@
     
   
     
-      opts: object,
+      opts: {
+  
+    
+      forceFlowTrigger: boolean,
+    
+  
+},
     
   
 },
@@ -12939,6 +13662,35 @@
     
 
     
+      getOptionForwardedPort(
+        
+      ):
+        Promise<any>;
+    
+      setOptionForwardedPort(
+        
+          
+  
+    
+      opts: {
+  
+    
+      value: *,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
+      unsetOptionForwardedPort(
+        
+      ):
+        Promise<any>;
+    
       getState(
         
       ):
@@ -13277,7 +14029,13 @@
       opts: {
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+},
     
   
 },
@@ -13300,7 +14058,17 @@
     
   
     
-      user: *,
+      user: {
+  
+    
+      role: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+},
     
   
 },
@@ -13553,7 +14321,21 @@
       opts: {
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },
@@ -13576,7 +14358,21 @@
     
   
     
-      zone: *,
+      zone: {
+  
+    
+      name: string,
+    
+  
+    
+      icon: string,
+    
+  
+    
+      parent: string,
+    
+  
+},
     
   
 },