homey-api 3.0.0-rc.1 → 3.0.0-rc.10

package/assets/specifications/HomeyAPIV3Local.json

@@ -1,5 +1,177 @@
 {
   "managers": {
+    "ManagerAlarms": {
+      "id": "alarms",
+      "idCamelCase": "alarms",
+      "items": {
+        "Alarm": {
+          "id": "alarm",
+          "schema": {
+            "repetition": {
+              "type": "object",
+              "properties": {
+                "required": [
+                  "monday",
+                  "tuesday",
+                  "wednesday",
+                  "thursday",
+                  "friday",
+                  "saturday",
+                  "sunday"
+                ],
+                "monday": {
+                  "type": "boolean"
+                },
+                "tuesday": {
+                  "type": "boolean"
+                },
+                "wednesday": {
+                  "type": "boolean"
+                },
+                "thursday": {
+                  "type": "boolean"
+                },
+                "friday": {
+                  "type": "boolean"
+                },
+                "saturday": {
+                  "type": "boolean"
+                },
+                "sunday": {
+                  "type": "boolean"
+                }
+              }
+            }
+          }
+        }
+      },
+      "operations": {
+        "getAlarms": {
+          "method": "get",
+          "path": "/alarm",
+          "private": false,
+          "scopes": [
+            "homey.alarm.readonly"
+          ],
+          "crud": {
+            "type": "getAll",
+            "item": "Alarm"
+          },
+          "parameters": {}
+        },
+        "getAlarm": {
+          "method": "get",
+          "path": "/alarm/:id",
+          "private": false,
+          "scopes": [
+            "homey.alarm.readonly"
+          ],
+          "crud": {
+            "type": "getOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        },
+        "createAlarm": {
+          "method": "post",
+          "path": "/alarm",
+          "private": false,
+          "scopes": [
+            "homey.alarm"
+          ],
+          "crud": {
+            "type": "createOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "alarm": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "time": {
+                  "type": "string"
+                },
+                "enabled": {
+                  "type": "boolean"
+                },
+                "repetition": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "updateAlarm": {
+          "method": "put",
+          "path": "/alarm/:id",
+          "private": false,
+          "scopes": [
+            "homey.alarm"
+          ],
+          "crud": {
+            "type": "updateOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            },
+            "alarm": {
+              "in": "body",
+              "type": "object",
+              "root": true,
+              "required": true,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "time": {
+                  "type": "string"
+                },
+                "enabled": {
+                  "type": "boolean"
+                },
+                "repetition": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "deleteAlarm": {
+          "method": "delete",
+          "path": "/alarm/:id",
+          "private": false,
+          "scopes": [
+            "homey.alarm"
+          ],
+          "crud": {
+            "type": "deleteOne",
+            "item": "Alarm"
+          },
+          "parameters": {
+            "id": {
+              "in": "path",
+              "type": "string",
+              "required": true
+            }
+          }
+        }
+      }
+    },
     "ManagerApi": {
       "id": "api",
       "idCamelCase": "api",
@@ -1327,8 +1499,7 @@
               "required": true
             },
             "data": {
-              "in": "body",
-              "type": "object"
+              "in": "body"
             }
           }
         },
@@ -1351,8 +1522,7 @@
               "required": true
             },
             "data": {
-              "in": "body",
-              "type": "object"
+              "in": "body"
             }
           }
         },
@@ -2310,6 +2480,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
+            }
+          }
         }
       }
     },
@@ -3562,6 +3766,21 @@
             "homey.system"
           ],
           "parameters": {}
+        },
+        "setDebug": {
+          "method": "put",
+          "path": "/debug",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "namespace": {
+              "in": "body",
+              "type": "string",
+              "required": true
+            }
+          }
         }
       }
     },
@@ -4262,13 +4481,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",
@@ -4401,6 +4641,30 @@
             "homey.system"
           ],
           "parameters": {}
+        },
+        "getLog": {
+          "method": "get",
+          "path": "/log",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {}
+        },
+        "setLogEnabled": {
+          "method": "put",
+          "path": "/log",
+          "private": false,
+          "scopes": [
+            "homey.system"
+          ],
+          "parameters": {
+            "enabled": {
+              "in": "body",
+              "type": "boolean",
+              "required": true
+            }
+          }
         }
       }
     }

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

@@ -279,7 +279,7 @@
     
   
     
-      debug: function,
+      debug: function | null,
     
   
 },
@@ -1063,62 +1063,6 @@
     
 
     
-      makeCapabilityInstance(
-        
-          
-  
-    
-      capabilityId: string,
-    
-  
-    
-      listener: {
-  
-    
-      value: number | boolean | string,
-    
-  
-},
-    
-  
-
-        
-      ):
-        HomeyAPIV2.ManagerDevices.Device.DeviceCapability;
-    
-      setCapabilityValue(
-        
-          
-  
-    
-      opts: {
-  
-    
-      capabilityId: string,
-    
-  
-    
-      value: number | boolean | string,
-    
-  
-    
-      opts: {
-  
-    
-      duration: number,
-    
-  
-},
-    
-  
-},
-    
-  
-
-        
-      ):
-        Promise<void>;
-    
   }
 
     }
@@ -2280,6 +2224,22 @@
 
   
 
+  
+
+  
+
+  
+    export namespace HomeyAPIV3Local.ManagerAlarms {
+      
+  export class Alarm  {
+    
+
+    
+
+    
+  }
+
+    }
   
 
   
@@ -10337,6 +10297,150 @@
     
 
     
+      isConnected(
+        
+      ):
+        Boolean;
+    
+      connect(
+        
+      ):
+        Promise<void>;
+    
+      disconnect(
+        
+      ):
+        Promise<void>;
+    
+  }
+
+  export class ManagerAlarms extends HomeyAPIV3Local.Manager {
+    
+
+    
+
+    
+      getAlarms(
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      getAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      createAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      alarm: {
+  
+    
+      name: string,
+    
+  
+    
+      time: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      repetition: object,
+    
+  
+},
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      updateAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+    
+      alarm: {
+  
+    
+      name: string,
+    
+  
+    
+      time: string,
+    
+  
+    
+      enabled: boolean,
+    
+  
+    
+      repetition: object,
+    
+  
+},
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
+    
+      deleteAlarm(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
       isConnected(
         
       ):
@@ -11539,7 +11643,7 @@
     
   
     
-      data: object,
+      data: *,
     
   
 },
@@ -11566,7 +11670,7 @@
     
   
     
-      data: object,
+      data: *,
     
   
 },
@@ -12474,6 +12578,44 @@
       ):
         Promise<HomeyAPIV3Local.ManagerFlowToken.FlowToken>;
     
+      getFlowToken(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<HomeyAPIV3Local.ManagerFlowToken.FlowToken>;
+    
+      getFlowTokenValue(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
+      ):
+        Promise<any>;
+    
       isConnected(
         
       ):
@@ -13791,6 +13933,25 @@
     
       rebootOTA(
         
+      ):
+        Promise<any>;
+    
+      setDebug(
+        
+          
+  
+    
+      opts: {
+  
+    
+      namespace: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -14396,6 +14557,25 @@
     
       getZones(
         
+      ):
+        Promise<HomeyAPIV3Local.ManagerZones.Zone>;
+    
+      getZone(
+        
+          
+  
+    
+      opts: {
+  
+    
+      id: string,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<HomeyAPIV3Local.ManagerZones.Zone>;
     
@@ -14536,6 +14716,30 @@
   
 
         
+      ):
+        Promise<any>;
+    
+      getLog(
+        
+      ):
+        Promise<any>;
+    
+      setLogEnabled(
+        
+          
+  
+    
+      opts: {
+  
+    
+      enabled: boolean,
+    
+  
+},
+    
+  
+
+        
       ):
         Promise<any>;
     
@@ -14573,6 +14777,10 @@
 
   
 
+  
+
+  
+