homey-api 3.13.3 → 3.14.0

package/assets/specifications/HomeyAPIV3Cloud.json

@@ -914,6 +914,9 @@
                 },
                 "uiIndicator": {
                   "type": "string"
+                },
+                "hidden": {
+                  "type": "boolean"
                 }
               }
             }
@@ -994,6 +997,141 @@
               "type": "string"
             }
           }
+        },
+        "createGroup": {
+          "method": "post",
+          "path": "/group",
+          "private": false,
+          "scopes": [
+            "homey.device"
+          ],
+          "parameters": {
+            "group": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "required": true
+                },
+                "class": {
+                  "type": "string",
+                  "required": true
+                },
+                "zoneId": {
+                  "type": "string",
+                  "required": true
+                },
+                "deviceIds": {
+                  "type": "array",
+                  "required": true
+                },
+                "iconOverride": {
+                  "type": "string"
+                },
+                "iconDeviceId": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "deleteDeviceFromGroup": {
+          "method": "delete",
+          "path": "/group/:groupId/device/:deviceId",
+          "private": false,
+          "scopes": [
+            "homey.device"
+          ],
+          "parameters": {
+            "deviceId": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "groupId": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "updateGroup": {
+          "method": "put",
+          "path": "/group/:id",
+          "private": false,
+          "scopes": [
+            "homey.device"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "group": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "deviceIds": {
+                  "type": "array"
+                },
+                "iconOverride": {
+                  "type": "string"
+                },
+                "iconDeviceId": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "hideDeviceFromExternalService": {
+          "method": "put",
+          "path": "/device/:id/external-service-hide",
+          "private": false,
+          "scopes": [
+            "homey.device"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "service": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "unhideDeviceFromExternalService": {
+          "method": "put",
+          "path": "/device/:id/external-service-unhide",
+          "private": false,
+          "scopes": [
+            "homey.device"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "service": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -1452,6 +1590,33 @@
             "homey.energy"
           ]
         },
+        "getOptionElectricityPriceDynamicPreferredInterval": {
+          "method": "GET",
+          "path": "/option/electricityPriceDynamicPreferredInterval",
+          "scopes": [
+            "homey.energy.readonly"
+          ]
+        },
+        "setOptionElectricityPriceDynamicPreferredInterval": {
+          "method": "PUT",
+          "path": "/option/electricityPriceDynamicPreferredInterval",
+          "scopes": [
+            "homey.energy"
+          ],
+          "parameters": {
+            "value": {
+              "in": "body",
+              "required": true
+            }
+          }
+        },
+        "unsetOptionElectricityPriceDynamicPreferredInterval": {
+          "method": "DELETE",
+          "path": "/option/electricityPriceDynamicPreferredInterval",
+          "scopes": [
+            "homey.energy"
+          ]
+        },
         "getState": {
           "method": "get",
           "path": "/state",
@@ -1604,6 +1769,129 @@
             }
           }
         },
+        "fetchDynamicElectricityPrices": {
+          "method": "get",
+          "path": "/price/electricity/dynamic",
+          "private": false,
+          "scopes": [
+            "homey.energy.readonly"
+          ],
+          "parameters": {
+            "date": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "setDynamicElectricityPriceUserCosts": {
+          "method": "put",
+          "path": "/price/electricity/dynamic/user-costs",
+          "private": false,
+          "scopes": [
+            "homey.energy"
+          ],
+          "parameters": {
+            "mathExpression": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "type": {
+              "in": "body",
+              "type": "string"
+            }
+          }
+        },
+        "getDynamicElectricityPriceUserCosts": {
+          "method": "get",
+          "path": "/price/electricity/dynamic/user-costs",
+          "private": false,
+          "scopes": [
+            "homey.energy.readonly"
+          ],
+          "parameters": {}
+        },
+        "unsetDynamicElectricityPriceUserCosts": {
+          "method": "delete",
+          "path": "/price/electricity/dynamic/user-costs",
+          "private": false,
+          "scopes": [
+            "homey.energy"
+          ],
+          "parameters": {}
+        },
+        "setElectricityPriceType": {
+          "method": "put",
+          "path": "/price/electricity/:type",
+          "private": false,
+          "scopes": [
+            "homey.energy"
+          ],
+          "parameters": {
+            "type": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "getElectricityPriceType": {
+          "method": "get",
+          "path": "/price/electricity/type",
+          "private": false,
+          "scopes": [
+            "homey.energy.readonly"
+          ],
+          "parameters": {}
+        },
+        "getDynamicPricesElectricityZones": {
+          "method": "get",
+          "path": "/price/electricity/dynamic/zones",
+          "private": false,
+          "scopes": [
+            "homey.energy.readonly"
+          ],
+          "parameters": {}
+        },
+        "getDynamicPricesElectricityZone": {
+          "method": "get",
+          "path": "/price/electricity/dynamic/zone",
+          "private": false,
+          "scopes": [
+            "homey.energy.readonly"
+          ],
+          "parameters": {}
+        },
+        "setDynamicPricesElectricityZone": {
+          "method": "put",
+          "path": "/price/electricity/dynamic/zone",
+          "private": false,
+          "scopes": [
+            "homey.energy"
+          ],
+          "parameters": {
+            "options": {
+              "in": "body",
+              "type": "object",
+              "required": true,
+              "properties": {
+                "zoneId": {
+                  "type": "string"
+                },
+                "zoneVersion": {
+                  "type": "string"
+                },
+                "zoneName": {
+                  "type": "string"
+                },
+                "zoneCountryKey": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
         "enableDummyEnergyReports": {
           "method": "post",
           "path": "/reports/dummy/enable",
@@ -1784,6 +2072,10 @@
             "dataRequestActiveState": {
               "in": "body",
               "type": "string"
+            },
+            "mode": {
+              "in": "body",
+              "type": "string"
             }
           }
         },
@@ -1840,7 +2132,9 @@
           "method": "put",
           "path": "/:deviceId/phase-load",
           "private": true,
-          "scopes": [],
+          "scopes": [
+            "homey.device"
+          ],
           "parameters": {
             "deviceId": {
               "in": "path",
@@ -1863,7 +2157,9 @@
           "method": "get",
           "path": "/:deviceId/phase-load",
           "private": true,
-          "scopes": [],
+          "scopes": [
+            "homey.device.readonly"
+          ],
           "parameters": {
             "deviceId": {
               "in": "path",
@@ -4455,6 +4751,28 @@
             }
           }
         },
+        "VirtualDriverRF433": {
+          "id": "virtualdriverrf433",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDeviceRF433": {
+          "id": "virtualdevicerf433",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
         "VirtualDriverHomeyBridge": {
           "id": "virtualdriverbridge",
           "schema": {
@@ -4498,6 +4816,28 @@
               }
             }
           }
+        },
+        "VirtualDriverGroup": {
+          "id": "virtualdrivergroup",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDeviceGroup": {
+          "id": "virtualdevicegroup",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
         }
       },
       "operations": {

package/assets/specifications/HomeyAPIV3Local.json

@@ -6468,45 +6468,6 @@
             }
           }
         },
-        "getFirmwareVersion": {
-          "method": "get",
-          "path": "/firmware-version",
-          "private": true,
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {}
-        },
-        "flashFirmware": {
-          "method": "put",
-          "path": "/flash-firmware",
-          "private": true,
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {
-            "erase": {
-              "in": "body",
-              "type": "string"
-            },
-            "downgrade": {
-              "in": "body",
-              "type": "string"
-            },
-            "version": {
-              "in": "body",
-              "type": "string"
-            },
-            "firmware": {
-              "in": "body",
-              "type": "string"
-            },
-            "shasum": {
-              "in": "body",
-              "type": "string"
-            }
-          }
-        },
         "getLog": {
           "method": "get",
           "path": "/log",
@@ -6530,30 +6491,6 @@
               "required": true
             }
           }
-        },
-        "setLBTThreshold": {
-          "method": "put",
-          "path": "/lbt-threshold",
-          "private": true,
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {
-            "threshold": {
-              "in": "body",
-              "type": "number",
-              "required": true
-            }
-          }
-        },
-        "attemptNvmFix": {
-          "method": "put",
-          "path": "/attempt-nvm-fix",
-          "private": true,
-          "scopes": [
-            "homey.system"
-          ],
-          "parameters": {}
         }
       }
     }

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

@@ -976,6 +976,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDeviceGroup {
+    id: string;
+  }
+
   export class VirtualDeviceHomeyBridge {
     id: string;
   }
@@ -984,6 +988,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDeviceRF433 {
+    id: string;
+  }
+
   export class VirtualDeviceZigbee {
     id: string;
   }
@@ -1000,6 +1008,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDriverGroup {
+    id: string;
+  }
+
   export class VirtualDriverHomeyBridge {
     id: string;
   }
@@ -1008,6 +1020,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDriverRF433 {
+    id: string;
+  }
+
   export class VirtualDriverZigbee {
     id: string;
   }
@@ -2129,6 +2145,8 @@ export namespace HomeyAPIV3Cloud {
         virtualClass?: string;
 
         uiIndicator?: string;
+
+        hidden?: boolean;
       };
     }): Promise<HomeyAPIV3Cloud.ManagerDevices.Device>;
 
@@ -2151,6 +2169,54 @@ export namespace HomeyAPIV3Cloud {
 
       transactionId?: string;
     }): Promise<any>;
+
+    createGroup(opts: {
+      group: {
+        name: string;
+
+        class: string;
+
+        zoneId: string;
+
+        deviceIds: Array<any>;
+
+        iconOverride?: string;
+
+        iconDeviceId?: string;
+      };
+    }): Promise<any>;
+
+    deleteDeviceFromGroup(opts: {
+      deviceId: string;
+
+      groupId: string;
+    }): Promise<any>;
+
+    updateGroup(opts: {
+      id: string;
+
+      group: {
+        name?: string;
+
+        deviceIds?: Array<any>;
+
+        iconOverride?: string;
+
+        iconDeviceId?: string;
+      };
+    }): Promise<any>;
+
+    hideDeviceFromExternalService(opts: {
+      id: string;
+
+      service: string;
+    }): Promise<any>;
+
+    unhideDeviceFromExternalService(opts: {
+      id: string;
+
+      service: string;
+    }): Promise<any>;
   }
 
   export class ManagerDevkit extends HomeyAPIV3.ManagerDevkit {
@@ -2308,6 +2374,14 @@ export namespace HomeyAPIV3Cloud {
 
     unsetOptionWaterPriceFixed(): Promise<any>;
 
+    getOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
+
+    setOptionElectricityPriceDynamicPreferredInterval(opts: {
+      value: any;
+    }): Promise<any>;
+
+    unsetOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
+
     getState(): Promise<any>;
 
     getLiveReport(opts: { zone?: string }): Promise<any>;
@@ -2351,6 +2425,38 @@ export namespace HomeyAPIV3Cloud {
         deviceIds?: Array<any>;
       };
     }): Promise<any>;
+
+    fetchDynamicElectricityPrices(opts: { date: string }): Promise<any>;
+
+    setDynamicElectricityPriceUserCosts(opts: {
+      mathExpression: string;
+
+      type?: string;
+    }): Promise<any>;
+
+    getDynamicElectricityPriceUserCosts(): Promise<any>;
+
+    unsetDynamicElectricityPriceUserCosts(): Promise<any>;
+
+    setElectricityPriceType(opts: { type: string }): Promise<any>;
+
+    getElectricityPriceType(): Promise<any>;
+
+    getDynamicPricesElectricityZones(): Promise<any>;
+
+    getDynamicPricesElectricityZone(): Promise<any>;
+
+    setDynamicPricesElectricityZone(opts: {
+      options: {
+        zoneId?: string;
+
+        zoneVersion?: string;
+
+        zoneName?: string;
+
+        zoneCountryKey?: string;
+      };
+    }): Promise<any>;
   }
 
   export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {

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

@@ -1059,6 +1059,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDeviceGroup {
+    id: string;
+  }
+
   export class VirtualDeviceHomeyBridge {
     id: string;
   }
@@ -1067,6 +1071,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDeviceRF433 {
+    id: string;
+  }
+
   export class VirtualDeviceZigbee {
     id: string;
   }
@@ -1083,6 +1091,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDriverGroup {
+    id: string;
+  }
+
   export class VirtualDriverHomeyBridge {
     id: string;
   }
@@ -1091,6 +1103,10 @@ export namespace HomeyAPIV3Cloud.ManagerVirtualDevice {
     id: string;
   }
 
+  export class VirtualDriverRF433 {
+    id: string;
+  }
+
   export class VirtualDriverZigbee {
     id: string;
   }
@@ -9018,6 +9034,8 @@ export namespace HomeyAPIV3Cloud {
         virtualClass?: string;
 
         uiIndicator?: string;
+
+        hidden?: boolean;
       };
     }): Promise<HomeyAPIV3Cloud.ManagerDevices.Device>;
 
@@ -9040,6 +9058,54 @@ export namespace HomeyAPIV3Cloud {
 
       transactionId?: string;
     }): Promise<any>;
+
+    createGroup(opts: {
+      group: {
+        name: string;
+
+        class: string;
+
+        zoneId: string;
+
+        deviceIds: Array<any>;
+
+        iconOverride?: string;
+
+        iconDeviceId?: string;
+      };
+    }): Promise<any>;
+
+    deleteDeviceFromGroup(opts: {
+      deviceId: string;
+
+      groupId: string;
+    }): Promise<any>;
+
+    updateGroup(opts: {
+      id: string;
+
+      group: {
+        name?: string;
+
+        deviceIds?: Array<any>;
+
+        iconOverride?: string;
+
+        iconDeviceId?: string;
+      };
+    }): Promise<any>;
+
+    hideDeviceFromExternalService(opts: {
+      id: string;
+
+      service: string;
+    }): Promise<any>;
+
+    unhideDeviceFromExternalService(opts: {
+      id: string;
+
+      service: string;
+    }): Promise<any>;
   }
 
   export class ManagerDevkit extends HomeyAPIV3.ManagerDevkit {
@@ -9197,6 +9263,14 @@ export namespace HomeyAPIV3Cloud {
 
     unsetOptionWaterPriceFixed(): Promise<any>;
 
+    getOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
+
+    setOptionElectricityPriceDynamicPreferredInterval(opts: {
+      value: any;
+    }): Promise<any>;
+
+    unsetOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
+
     getState(): Promise<any>;
 
     getLiveReport(opts: { zone?: string }): Promise<any>;
@@ -9241,6 +9315,38 @@ export namespace HomeyAPIV3Cloud {
       };
     }): Promise<any>;
 
+    fetchDynamicElectricityPrices(opts: { date: string }): Promise<any>;
+
+    setDynamicElectricityPriceUserCosts(opts: {
+      mathExpression: string;
+
+      type?: string;
+    }): Promise<any>;
+
+    getDynamicElectricityPriceUserCosts(): Promise<any>;
+
+    unsetDynamicElectricityPriceUserCosts(): Promise<any>;
+
+    setElectricityPriceType(opts: { type: string }): Promise<any>;
+
+    getElectricityPriceType(): Promise<any>;
+
+    getDynamicPricesElectricityZones(): Promise<any>;
+
+    getDynamicPricesElectricityZone(): Promise<any>;
+
+    setDynamicPricesElectricityZone(opts: {
+      options: {
+        zoneId?: string;
+
+        zoneVersion?: string;
+
+        zoneName?: string;
+
+        zoneCountryKey?: string;
+      };
+    }): Promise<any>;
+
     enableDummyEnergyReports(opts: {
       fromDate?: string;
 
@@ -9295,6 +9401,8 @@ export namespace HomeyAPIV3Cloud {
       persistent?: boolean;
 
       dataRequestActiveState?: string;
+
+      mode?: string;
     }): Promise<any>;
 
     checkFirmwareUpdateAvailable(opts: { deviceId: string }): Promise<any>;
@@ -11973,27 +12081,9 @@ export namespace HomeyAPIV3Local {
       opts?: object;
     }): Promise<any>;
 
-    getFirmwareVersion(): Promise<any>;
-
-    flashFirmware(opts: {
-      erase?: string;
-
-      downgrade?: string;
-
-      version?: string;
-
-      firmware?: string;
-
-      shasum?: string;
-    }): Promise<any>;
-
     getLog(): Promise<any>;
 
     setLogEnabled(opts: { enabled: boolean }): Promise<any>;
-
-    setLBTThreshold(opts: { threshold: number }): Promise<any>;
-
-    attemptNvmFix(): Promise<any>;
   }
 }
 

package/package.json

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