homey-api 3.14.4 → 3.14.6

package/assets/specifications/HomeyAPIV3Local.json

@@ -370,6 +370,14 @@
             "channel": {
               "in": "body",
               "type": "string"
+            },
+            "waitForInstall": {
+              "in": "body",
+              "type": "boolean"
+            },
+            "version": {
+              "in": "body",
+              "type": "string"
             }
           }
         },
@@ -2036,6 +2044,23 @@
           },
           "parameters": {}
         },
+        "getDriver": {
+          "method": "get",
+          "path": "/driver/:id",
+          "private": false,
+          "scopes": ["homey.device.readonly"],
+          "crud": {
+            "type": "getOne",
+            "item": "Driver"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "getPairSession": {
           "method": "get",
           "path": "/pairsession/:id",
@@ -2377,27 +2402,6 @@
           "path": "/option/waterPriceFixed",
           "scopes": ["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",
@@ -2625,10 +2629,7 @@
                 "zoneVersion": {
                   "type": "string"
                 },
-                "zoneName": {
-                  "type": "string"
-                },
-                "zoneCountryKey": {
+                "priceInterval": {
                   "type": "string"
                 }
               }
@@ -4954,7 +4955,24 @@
     "ManagerMatter": {
       "id": "matter",
       "idCamelCase": "matter",
-      "items": {},
+      "items": {
+        "MatterNode": {
+          "id": "matternode",
+          "schema": {
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+              "id": {
+                "description": "The unique identifier of the item.",
+                "type": "string",
+                "format": "uuid",
+                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      },
       "operations": {
         "getOptionPaaSettings": {
           "method": "GET",
@@ -4984,47 +5002,199 @@
           "scopes": ["homey.system.readonly"],
           "parameters": {}
         },
-        "updateDCLPaaCerts": {
+        "getMatterNode": {
           "method": "get",
-          "path": "/update-dcl-paa-certs",
-          "private": true,
-          "scopes": ["homey.system"],
-          "parameters": {}
+          "path": "/node/:id",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "crud": {
+            "type": "getOne",
+            "item": "MatterNode"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
         },
-        "interview": {
+        "getMatterNodes": {
           "method": "get",
-          "path": "/interview",
-          "private": true,
+          "path": "/nodes",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "crud": {
+            "type": "getAll",
+            "item": "MatterNode"
+          },
+          "parameters": {}
+        },
+        "deleteMatterNode": {
+          "method": "delete",
+          "path": "/node/:id",
+          "private": false,
           "scopes": ["homey.system"],
+          "crud": {
+            "type": "deleteOne",
+            "item": "MatterNode"
+          },
           "parameters": {
-            "nodeId": {
-              "in": "query",
+            "id": {
+              "in": "path",
               "type": "string",
               "required": true
             }
           }
         },
-        "makeDeviceApi": {
+        "getNodeAttributes": {
           "method": "get",
-          "path": "/make-device",
-          "private": true,
-          "scopes": ["homey.system"],
+          "path": "/node/:id/attributes",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
           "parameters": {
-            "nodeId": {
-              "in": "query",
+            "id": {
+              "in": "path",
               "type": "string",
               "required": true
             }
           }
         },
-        "readBasicInformation": {
+        "getNodeFabrics": {
           "method": "get",
-          "path": "/read-basic-info",
-          "private": true,
+          "path": "/node/:id/fabrics",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "deleteNodeFabric": {
+          "method": "delete",
+          "path": "/node/:id/fabric/:fabricIndex",
+          "private": false,
           "scopes": ["homey.system"],
           "parameters": {
-            "nodeId": {
-              "in": "query",
+            "fabricIndex": {
+              "in": "path",
+              "type": "number",
+              "required": true
+            },
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "resolveNodeAddress": {
+          "method": "post",
+          "path": "/node/:id/resolve-address",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "forceNodeUpdate": {
+          "method": "post",
+          "path": "/node/:id/force-update",
+          "private": false,
+          "scopes": ["homey.system"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "pingNode": {
+          "method": "post",
+          "path": "/node/:id/ping",
+          "private": false,
+          "scopes": ["homey.system"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "getNodeAvailableFirmwareUpdate": {
+          "method": "get",
+          "path": "/node/:id/firmware-update",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "installNodeAvailableFirmwareUpdate": {
+          "method": "post",
+          "path": "/node/:id/firmware-update",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "softwareVersion": {
+              "in": "body",
+              "type": "number",
+              "required": true
+            }
+          }
+        },
+        "nodeDiagnosticReport": {
+          "method": "post",
+          "path": "/node/:id/diagnostic-report",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "nodeThreadNetworkInformation": {
+          "method": "get",
+          "path": "/node/:id/thread-network",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "nodeWiFiNetworkInformation": {
+          "method": "get",
+          "path": "/node/:id/wifi-network",
+          "private": false,
+          "scopes": ["homey.system.readonly"],
+          "parameters": {
+            "id": {
+              "in": "path",
               "type": "string",
               "required": true
             }
@@ -6196,13 +6366,11 @@
             "type": "object",
             "properties": {
               "id": {
-                "description": "The unique identifier of the user.",
                 "type": "string",
                 "format": "uuid",
                 "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
               },
               "name": {
-                "description": "The name of the user.",
                 "anyOf": [
                   {
                     "type": "string"
@@ -6213,7 +6381,6 @@
                 ]
               },
               "role": {
-                "description": "The role of the user.",
                 "type": "string"
               },
               "properties": {
@@ -6224,7 +6391,6 @@
                 "additionalProperties": {}
               },
               "athomId": {
-                "description": "The Athom id of the user.",
                 "anyOf": [
                   {
                     "type": "string"
@@ -6235,12 +6401,10 @@
                 ]
               },
               "enabled": {
-                "description": "Whether the user is enabled.",
                 "default": true,
                 "type": "boolean"
               },
               "enabledUntil": {
-                "description": "The date until the user is enabled.",
                 "anyOf": [
                   {
                     "type": "string",
@@ -6252,7 +6416,6 @@
                 ]
               },
               "present": {
-                "description": "Whether the user is present.",
                 "default": false,
                 "anyOf": [
                   {
@@ -6264,7 +6427,6 @@
                 ]
               },
               "asleep": {
-                "description": "Whether the user is asleep.",
                 "default": false,
                 "anyOf": [
                   {
@@ -6276,7 +6438,6 @@
                 ]
               },
               "avatar": {
-                "description": "The avatar URL of the user.",
                 "anyOf": [
                   {
                     "type": "string"
@@ -6287,12 +6448,21 @@
                 ]
               },
               "verified": {
-                "description": "Whether the user is verified.",
                 "default": false,
                 "type": "boolean"
               },
               "inviteUrl": {
-                "description": "The invite URL for the user.",
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "localUsername": {
+                "description": "The local username of the user.",
                 "anyOf": [
                   {
                     "type": "string"
@@ -6536,6 +6706,95 @@
             }
           }
         },
+        "loginLocal": {
+          "method": "post",
+          "path": "/login-local",
+          "private": false,
+          "scopes": [],
+          "parameters": {
+            "username": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "password": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "clientId": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "clientName": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "updateUserMeLocalCredentials": {
+          "method": "put",
+          "path": "/user/me/local-credentials",
+          "private": false,
+          "scopes": ["homey.user.self"],
+          "parameters": {
+            "username": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "password": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "updateUserLocalCredentials": {
+          "method": "put",
+          "path": "/user/:id/local-credentials",
+          "private": false,
+          "scopes": [],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "username": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "password": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "deleteUserMeLocalCredentials": {
+          "method": "delete",
+          "path": "/user/me/local-credentials",
+          "private": false,
+          "scopes": ["homey.user.self"],
+          "parameters": {}
+        },
+        "deleteUserLocalCredentials": {
+          "method": "delete",
+          "path": "/user/:id/local-credentials",
+          "private": false,
+          "scopes": [],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "grantInstallerAccess": {
           "method": "post",
           "path": "/installer/grant",

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

@@ -665,6 +665,8 @@ export namespace HomeyAPIV2.ManagerUsers {
     avatar: string | null;
 
     inviteUrl: string | null;
+
+    localUsername: string | null;
   }
 }
 
@@ -2062,6 +2064,12 @@ export namespace HomeyAPIV3Local.ManagerLogic {
   }
 }
 
+export namespace HomeyAPIV3Local.ManagerMatter {
+  export class MatterNode {
+    id: string;
+  }
+}
+
 export namespace HomeyAPIV3Local.ManagerMoods {
   export class Mood {
     id: string;
@@ -2135,6 +2143,8 @@ export namespace HomeyAPIV3Local.ManagerUsers {
     verified: boolean;
 
     inviteUrl: string | null;
+
+    localUsername: string | null;
   }
 }
 
@@ -4444,6 +4454,10 @@ export namespace HomeyAPIV3Local {
       id: string;
 
       channel?: string;
+
+      waitForInstall?: boolean;
+
+      version?: string;
     }): Promise<any>;
 
     uninstallApp(opts: { id: string }): Promise<any>;
@@ -4758,6 +4772,10 @@ export namespace HomeyAPIV3Local {
       [key: string]: HomeyAPIV3Local.ManagerDrivers.Driver;
     }>;
 
+    getDriver(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerDrivers.Driver>;
+
     getPairSession(opts: {
       id: string;
     }): Promise<HomeyAPIV3Local.ManagerDrivers.PairSession>;
@@ -4890,14 +4908,6 @@ export namespace HomeyAPIV3Local {
 
     unsetOptionWaterPriceFixed(): Promise<any>;
 
-    getOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
-
-    setOptionElectricityPriceDynamicPreferredInterval(opts: {
-      value: any;
-    }): Promise<any>;
-
-    unsetOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
-
     getState(): Promise<any>;
 
     getLiveReport(opts: { zone?: string }): Promise<any>;
@@ -4968,9 +4978,7 @@ export namespace HomeyAPIV3Local {
 
         zoneVersion?: string;
 
-        zoneName?: string;
-
-        zoneCountryKey?: string;
+        priceInterval?: string;
       };
     }): Promise<any>;
   }
@@ -5338,6 +5346,46 @@ export namespace HomeyAPIV3Local {
 
     getState(): Promise<any>;
 
+    getMatterNode(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerMatter.MatterNode>;
+
+    getMatterNodes(): Promise<{
+      [key: string]: HomeyAPIV3Local.ManagerMatter.MatterNode;
+    }>;
+
+    deleteMatterNode(opts: { id: string }): Promise<any>;
+
+    getNodeAttributes(opts: { id: string }): Promise<any>;
+
+    getNodeFabrics(opts: { id: string }): Promise<any>;
+
+    deleteNodeFabric(opts: {
+      fabricIndex: number;
+
+      id: string;
+    }): Promise<any>;
+
+    resolveNodeAddress(opts: { id: string }): Promise<any>;
+
+    forceNodeUpdate(opts: { id: string }): Promise<any>;
+
+    pingNode(opts: { id: string }): Promise<any>;
+
+    getNodeAvailableFirmwareUpdate(opts: { id: string }): Promise<any>;
+
+    installNodeAvailableFirmwareUpdate(opts: {
+      id: string;
+
+      softwareVersion: number;
+    }): Promise<any>;
+
+    nodeDiagnosticReport(opts: { id: string }): Promise<any>;
+
+    nodeThreadNetworkInformation(opts: { id: string }): Promise<any>;
+
+    nodeWiFiNetworkInformation(opts: { id: string }): Promise<any>;
+
     getFabrics(opts: { deviceId: string }): Promise<any>;
 
     deleteFabric(opts: {
@@ -5632,6 +5680,34 @@ export namespace HomeyAPIV3Local {
 
     deletePersonalAccessToken(opts: { id: string }): Promise<any>;
 
+    loginLocal(opts: {
+      username: string;
+
+      password: string;
+
+      clientId: string;
+
+      clientName: string;
+    }): Promise<any>;
+
+    updateUserMeLocalCredentials(opts: {
+      username: string;
+
+      password: string;
+    }): Promise<any>;
+
+    updateUserLocalCredentials(opts: {
+      id: string;
+
+      username: string;
+
+      password: string;
+    }): Promise<any>;
+
+    deleteUserMeLocalCredentials(): Promise<any>;
+
+    deleteUserLocalCredentials(opts: { id: string }): Promise<any>;
+
     grantInstallerAccess(): Promise<any>;
 
     revokeInstallerAccess(): Promise<any>;

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

@@ -716,6 +716,8 @@ export namespace HomeyAPIV2.ManagerUsers {
     avatar: string | null;
 
     inviteUrl: string | null;
+
+    localUsername: string | null;
   }
 }
 
@@ -2119,6 +2121,12 @@ export namespace HomeyAPIV3Local.ManagerLogic {
   }
 }
 
+export namespace HomeyAPIV3Local.ManagerMatter {
+  export class MatterNode {
+    id: string;
+  }
+}
+
 export namespace HomeyAPIV3Local.ManagerMoods {
   export class Mood {
     id: string;
@@ -2192,6 +2200,8 @@ export namespace HomeyAPIV3Local.ManagerUsers {
     verified: boolean;
 
     inviteUrl: string | null;
+
+    localUsername: string | null;
   }
 }
 
@@ -11331,6 +11341,10 @@ export namespace HomeyAPIV3Local {
       id: string;
 
       channel?: string;
+
+      waitForInstall?: boolean;
+
+      version?: string;
     }): Promise<any>;
 
     uninstallApp(opts: { id: string }): Promise<any>;
@@ -11651,6 +11665,10 @@ export namespace HomeyAPIV3Local {
       [key: string]: HomeyAPIV3Local.ManagerDrivers.Driver;
     }>;
 
+    getDriver(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerDrivers.Driver>;
+
     getPairSession(opts: {
       id: string;
     }): Promise<HomeyAPIV3Local.ManagerDrivers.PairSession>;
@@ -11783,14 +11801,6 @@ export namespace HomeyAPIV3Local {
 
     unsetOptionWaterPriceFixed(): Promise<any>;
 
-    getOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
-
-    setOptionElectricityPriceDynamicPreferredInterval(opts: {
-      value: any;
-    }): Promise<any>;
-
-    unsetOptionElectricityPriceDynamicPreferredInterval(): Promise<any>;
-
     getState(): Promise<any>;
 
     getLiveReport(opts: { zone?: string }): Promise<any>;
@@ -11861,9 +11871,7 @@ export namespace HomeyAPIV3Local {
 
         zoneVersion?: string;
 
-        zoneName?: string;
-
-        zoneCountryKey?: string;
+        priceInterval?: string;
       };
     }): Promise<any>;
 
@@ -12301,13 +12309,45 @@ export namespace HomeyAPIV3Local {
 
     getState(): Promise<any>;
 
-    updateDCLPaaCerts(): Promise<any>;
+    getMatterNode(opts: {
+      id: string;
+    }): Promise<HomeyAPIV3Local.ManagerMatter.MatterNode>;
+
+    getMatterNodes(): Promise<{
+      [key: string]: HomeyAPIV3Local.ManagerMatter.MatterNode;
+    }>;
+
+    deleteMatterNode(opts: { id: string }): Promise<any>;
+
+    getNodeAttributes(opts: { id: string }): Promise<any>;
+
+    getNodeFabrics(opts: { id: string }): Promise<any>;
+
+    deleteNodeFabric(opts: {
+      fabricIndex: number;
+
+      id: string;
+    }): Promise<any>;
+
+    resolveNodeAddress(opts: { id: string }): Promise<any>;
 
-    interview(opts: { nodeId: string }): Promise<any>;
+    forceNodeUpdate(opts: { id: string }): Promise<any>;
 
-    makeDeviceApi(opts: { nodeId: string }): Promise<any>;
+    pingNode(opts: { id: string }): Promise<any>;
 
-    readBasicInformation(opts: { nodeId: string }): Promise<any>;
+    getNodeAvailableFirmwareUpdate(opts: { id: string }): Promise<any>;
+
+    installNodeAvailableFirmwareUpdate(opts: {
+      id: string;
+
+      softwareVersion: number;
+    }): Promise<any>;
+
+    nodeDiagnosticReport(opts: { id: string }): Promise<any>;
+
+    nodeThreadNetworkInformation(opts: { id: string }): Promise<any>;
+
+    nodeWiFiNetworkInformation(opts: { id: string }): Promise<any>;
 
     openCommissioningWindow(opts: {
       deviceId: string;
@@ -12649,6 +12689,34 @@ export namespace HomeyAPIV3Local {
 
     deletePersonalAccessToken(opts: { id: string }): Promise<any>;
 
+    loginLocal(opts: {
+      username: string;
+
+      password: string;
+
+      clientId: string;
+
+      clientName: string;
+    }): Promise<any>;
+
+    updateUserMeLocalCredentials(opts: {
+      username: string;
+
+      password: string;
+    }): Promise<any>;
+
+    updateUserLocalCredentials(opts: {
+      id: string;
+
+      username: string;
+
+      password: string;
+    }): Promise<any>;
+
+    deleteUserMeLocalCredentials(): Promise<any>;
+
+    deleteUserLocalCredentials(opts: { id: string }): Promise<any>;
+
     grantInstallerAccess(): Promise<any>;
 
     revokeInstallerAccess(): Promise<any>;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -58,7 +58,7 @@ class HomeyAPIV3 extends HomeyAPI {
     this.__refreshMap = {};
 
     Object.defineProperty(this, '__baseUrl', {
-      value: null,
+      value: baseUrl,
       enumerable: false,
       writable: true,
     });

package/package.json

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