homey-api 3.0.10 → 3.0.12

package/assets/specifications/HomeyAPIV3Cloud.json

@@ -178,7 +178,6 @@
             },
             "value": {
               "in": "body",
-              "type": "object",
               "required": true
             }
           }
@@ -1091,8 +1090,7 @@
               "required": true
             },
             "data": {
-              "in": "body",
-              "type": "object"
+              "in": "body"
             }
           }
         },
@@ -1115,8 +1113,7 @@
               "required": true
             },
             "data": {
-              "in": "body",
-              "type": "object"
+              "in": "body"
             }
           }
         },
@@ -1618,6 +1615,30 @@
             }
           }
         },
+        "getFlowCardTrigger": {
+          "method": "get",
+          "path": "/flowcardtrigger/:uri/:id",
+          "private": false,
+          "scopes": [
+            "homey.flow.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "FlowCardTrigger"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "uri": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "getFlowCardTriggers": {
           "method": "get",
           "path": "/flowcardtrigger",
@@ -1631,6 +1652,30 @@
           },
           "parameters": {}
         },
+        "getFlowCardCondition": {
+          "method": "get",
+          "path": "/flowcardcondition/:uri/:id",
+          "private": false,
+          "scopes": [
+            "homey.flow.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "FlowCardCondition"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "uri": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "getFlowCardConditions": {
           "method": "get",
           "path": "/flowcardcondition",
@@ -1649,7 +1694,7 @@
           "path": "/flowcardcondition/:uri/:id/run",
           "private": false,
           "scopes": [
-            "homey.flow.start"
+            "homey.flow"
           ],
           "parameters": {
             "id": {
@@ -1680,6 +1725,30 @@
             }
           }
         },
+        "getFlowCardAction": {
+          "method": "get",
+          "path": "/flowcardaction/:uri/:id",
+          "private": false,
+          "scopes": [
+            "homey.flow.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "FlowCardAction"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "uri": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
         "getFlowCardActions": {
           "method": "get",
           "path": "/flowcardaction",
@@ -1698,7 +1767,7 @@
           "path": "/flowcardaction/:uri/:id/run",
           "private": false,
           "scopes": [
-            "homey.flow.start"
+            "homey.flow"
           ],
           "parameters": {
             "id": {
@@ -1919,6 +1988,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
+            }
+          }
         }
       }
     },
@@ -1981,33 +2084,6 @@
             "homey.geolocation"
           ]
         },
-        "getOptionMode": {
-          "method": "GET",
-          "path": "/option/mode",
-          "scopes": [
-            "homey.geolocation.readonly"
-          ]
-        },
-        "setOptionMode": {
-          "method": "PUT",
-          "path": "/option/mode",
-          "scopes": [
-            "homey.geolocation"
-          ],
-          "parameters": {
-            "value": {
-              "in": "body",
-              "required": true
-            }
-          }
-        },
-        "unsetOptionMode": {
-          "method": "DELETE",
-          "path": "/option/mode",
-          "scopes": [
-            "homey.geolocation"
-          ]
-        },
         "getState": {
           "method": "get",
           "path": "/state",
@@ -2340,6 +2416,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",
@@ -2698,6 +2793,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",
@@ -2739,6 +2849,21 @@
               "type": "boolean"
             }
           }
+        },
+        "getAsleep": {
+          "method": "get",
+          "path": "/:id/asleep",
+          "private": false,
+          "scopes": [
+            "homey.presence.readonly"
+          ],
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -2935,7 +3060,8 @@
                 "type": "string",
                 "enum": [
                   "OAUTH",
-                  "APP"
+                  "APP",
+                  "PAT"
                 ]
               },
               "scopes": {
@@ -3525,13 +3651,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",
@@ -3690,6 +3837,48 @@
               "type": "object"
             }
           }
+        },
+        "verifyFirmware": {
+          "method": "get",
+          "path": "/verify-firmware",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
+        },
+        "flashFirmware": {
+          "method": "put",
+          "path": "/flash-firmware",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "keepNV": {
+              "in": "body",
+              "type": "boolean",
+              "required": true
+            }
+          }
+        },
+        "getLastFlashResult": {
+          "method": "get",
+          "path": "/get-last-flash-result",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
+        },
+        "eraseNV": {
+          "method": "put",
+          "path": "/erase-nv",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
         }
       }
     }

package/assets/specifications/HomeyAPIV3Local.json

@@ -1704,16 +1704,20 @@
           "method": "get",
           "path": "/experiment",
           "private": false,
-          "scopes": [],
+          "scopes": [
+            "homey.system"
+          ],
           "parameters": {}
         },
         "enableExperiment": {
           "method": "put",
-          "path": "/experiment/:experimentId/enable",
+          "path": "/experiment/:id/enable",
           "private": false,
-          "scopes": [],
+          "scopes": [
+            "homey.system"
+          ],
           "parameters": {
-            "experimentId": {
+            "id": {
               "in": "path",
               "type": "string",
               "required": true
@@ -1722,11 +1726,13 @@
         },
         "disableExperiment": {
           "method": "put",
-          "path": "/experiment/:experimentId/disable",
+          "path": "/experiment/:id/disable",
           "private": false,
-          "scopes": [],
+          "scopes": [
+            "homey.system"
+          ],
           "parameters": {
-            "experimentId": {
+            "id": {
               "in": "path",
               "type": "string",
               "required": true
@@ -3166,6 +3172,33 @@
       "idCamelCase": "matter",
       "items": {},
       "operations": {
+        "getOptionPaaSettings": {
+          "method": "GET",
+          "path": "/option/paaSettings",
+          "scopes": [
+            "homey.system"
+          ]
+        },
+        "setOptionPaaSettings": {
+          "method": "PUT",
+          "path": "/option/paaSettings",
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "value": {
+              "in": "body",
+              "required": true
+            }
+          }
+        },
+        "unsetOptionPaaSettings": {
+          "method": "DELETE",
+          "path": "/option/paaSettings",
+          "scopes": [
+            "homey.system"
+          ]
+        },
         "getState": {
           "method": "get",
           "path": "/state",
@@ -3174,6 +3207,79 @@
             "homey.system.readonly"
           ],
           "parameters": {}
+        },
+        "pairApi": {
+          "method": "post",
+          "path": "/pair",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "code": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            },
+            "zone": {
+              "in": "body",
+              "type": "string"
+            }
+          }
+        },
+        "updateDCLPaaCerts": {
+          "method": "get",
+          "path": "/update-dcl-paa-certs",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
+        },
+        "interview": {
+          "method": "get",
+          "path": "/interview",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "nodeId": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "makeDeviceApi": {
+          "method": "get",
+          "path": "/make-device",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "nodeId": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "readBasicInformation": {
+          "method": "get",
+          "path": "/read-basic-info",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "nodeId": {
+              "in": "query",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -3853,6 +3959,24 @@
               "required": true
             }
           }
+        },
+        "enableWifi": {
+          "method": "post",
+          "path": "/enable-wifi",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
+        },
+        "disableWifi": {
+          "method": "post",
+          "path": "/disable-wifi",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
         }
       }
     },
@@ -4424,6 +4548,28 @@
               }
             }
           }
+        },
+        "VirtualDriverMatter": {
+          "id": "virtualdrivermatter",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "VirtualDeviceMatter": {
+          "id": "virtualdevicematter",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            }
+          }
         }
       },
       "operations": {
@@ -4737,6 +4883,21 @@
               "required": true
             }
           }
+        },
+        "setLBTThreshold": {
+          "method": "put",
+          "path": "/lbt-threshold",
+          "private": true,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "threshold": {
+              "in": "body",
+              "type": "number",
+              "required": true
+            }
+          }
         }
       }
     }