homey-api 3.0.0-rc.8 → 3.0.0

package/README.md

@@ -42,7 +42,7 @@ You can then access the APIs using `window.AthomCloudAPI` etc.
 
 ### In-app
 
-To use Homey API inside of an Homey Pro app with the `homey:manager:api` permission, see {@link HomeyAPI#createAppAPI}.
+To use Homey API inside of an Homey Pro app with the `homey:manager:api` permission, see [HomeyAPI.createAppAPI](./HomeyAPI.html#.createAppAPI).
 
 ## Issues
 

package/assets/specifications/AthomCloudAPI.json

@@ -863,6 +863,22 @@
         }
       }
     },
+    "activateHomey": {
+      "path": "/homey/{id}/activate",
+      "method": "post",
+      "private": true,
+      "parameters": {
+        "id": {
+          "in": "path",
+          "type": "string",
+          "required": true
+        },
+        "userId": {
+          "type": "string",
+          "in": "body"
+        }
+      }
+    },
     "addHomeyLicense": {
       "path": "/homey/{homeyId}/license/{license}",
       "method": "post",

package/assets/specifications/HomeyAPIV3Local.json

@@ -483,6 +483,21 @@
               "required": true
             }
           }
+        },
+        "getAppUsage": {
+          "method": "get",
+          "path": "/app/:id/usage",
+          "private": false,
+          "scopes": [
+            "homey.app.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -590,6 +605,25 @@
             "homey.system.readonly"
           ],
           "parameters": {}
+        },
+        "runCommand": {
+          "method": "post",
+          "path": "/command",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "command": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "opts": {
+              "in": "body",
+              "type": "object"
+            }
+          }
         }
       }
     },
@@ -674,6 +708,25 @@
               "required": true
             }
           }
+        },
+        "setDebugLogging": {
+          "method": "put",
+          "path": "/debug",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "peripheral": {
+              "in": "body",
+              "type": "string"
+            },
+            "enabled": {
+              "in": "body",
+              "type": "boolean",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -1480,8 +1533,7 @@
               "required": true
             },
             "data": {
-              "in": "body",
-              "type": "object"
+              "in": "body"
             }
           }
         },
@@ -1504,8 +1556,7 @@
               "required": true
             },
             "data": {
-              "in": "body",
-              "type": "object"
+              "in": "body"
             }
           }
         },
@@ -1627,6 +1678,17 @@
             }
           }
         },
+        "ExperimentHomeKit": {
+          "id": "experiment-homekit",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
         "ExperimentPowerUser": {
           "id": "experiment-poweruser",
           "schema": {
@@ -2169,7 +2231,7 @@
           "path": "/flowcardcondition/:uri/:id/run",
           "private": false,
           "scopes": [
-            "homey.flow.start"
+            "homey.flow"
           ],
           "parameters": {
             "id": {
@@ -2242,7 +2304,7 @@
           "path": "/flowcardaction/:uri/:id/run",
           "private": false,
           "scopes": [
-            "homey.flow.start"
+            "homey.flow"
           ],
           "parameters": {
             "id": {
@@ -2463,6 +2525,40 @@
             "item": "FlowToken"
           },
           "parameters": {}
+        },
+        "getFlowToken": {
+          "method": "get",
+          "path": "/flowtoken/:id",
+          "private": false,
+          "scopes": [
+            "homey.flow.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "FlowToken"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "getFlowTokenValue": {
+          "method": "get",
+          "path": "/flowtoken/:id/value",
+          "private": false,
+          "scopes": [
+            "homey.flow.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -2959,6 +3055,25 @@
           ],
           "parameters": {}
         },
+        "getVariable": {
+          "method": "get",
+          "path": "/variable/:id",
+          "private": false,
+          "scopes": [
+            "homey.logic.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "Variable"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "getVariables": {
           "method": "get",
           "path": "/variable",
@@ -3291,6 +3406,21 @@
             }
           }
         },
+        "getPresent": {
+          "method": "get",
+          "path": "/:id/present",
+          "private": false,
+          "scopes": [
+            "homey.presence.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "setAsleepMe": {
           "method": "put",
           "path": "/me/asleep",
@@ -3332,6 +3462,21 @@
               "type": "boolean"
             }
           }
+        },
+        "getAsleep": {
+          "method": "get",
+          "path": "/:id/asleep",
+          "private": false,
+          "scopes": [
+            "homey.presence.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -4430,13 +4575,34 @@
           "method": "get",
           "path": "/zone",
           "private": false,
-          "scopes": [],
+          "scopes": [
+            "homey.zone.readonly"
+          ],
           "crud": {
             "type": "getAll",
             "item": "Zone"
           },
           "parameters": {}
         },
+        "getZone": {
+          "method": "get",
+          "path": "/zone/:id",
+          "private": false,
+          "scopes": [
+            "homey.zone.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "Zone"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "createZone": {
           "method": "post",
           "path": "/zone",