{ "managers": { "ManagerAlarms": { "id": "alarms", "idCamelCase": "alarms", "private": false, "items": { "Alarm": { "id": "alarm", "type": "id", "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-homey-readonly": true }, "name": { "type": "string" }, "time": { "type": "string" }, "enabled": { "type": "boolean" }, "nextOccurance": { "type": "string", "format": "date-time", "x-homey-readonly": true }, "repetition": { "type": "object", "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "properties": { "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "sunday": { "type": "boolean" } } } }, "x-realtime-bindings": { "read": "getAlarm", "create": "alarm.create", "update": "alarm.update", "delete": "alarm.delete" } } } }, "operations": { "deleteAlarm": { "method": "DELETE", "path": "/alarm/:id", "private": false, "scopes": [ "homey.alarm" ], "crud": { "type": "deleteOne", "item": "Alarm" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateAlarm": { "method": "PUT", "path": "/alarm/:id", "private": false, "scopes": [ "homey.alarm" ], "crud": { "type": "updateOne", "item": "Alarm" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "alarm": { "in": "body", "root": true, "required": true } } }, "createAlarm": { "method": "POST", "path": "/alarm", "private": false, "scopes": [ "homey.alarm" ], "crud": { "type": "createOne", "item": "Alarm" }, "parameters": { "alarm": { "in": "body", "root": true, "required": true } } }, "getAlarm": { "method": "GET", "path": "/alarm/:id", "private": false, "scopes": [ "homey.alarm.readonly" ], "crud": { "type": "getOne", "item": "Alarm" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getAlarms": { "method": "GET", "path": "/alarm", "private": false, "scopes": [ "homey.alarm.readonly" ], "crud": { "type": "getAll", "item": "Alarm" }, "parameters": {} } } }, "ManagerApps": { "id": "apps", "idCamelCase": "apps", "private": false, "items": { "App": { "id": "app", "type": "id", "schema": { "type": "object", "properties": { "enabled": { "x-homey-readonly": true, "type": "boolean", "default": true }, "autoupdate": { "type": "boolean", "default": true }, "id": { "x-homey-readonly": true, "type": "string" }, "sdk": { "x-homey-readonly": true, "type": "number", "enum": [ 1, 2, 3 ] }, "name": { "x-homey-readonly": true, "type": "string" }, "origin": { "x-homey-updateable": false, "type": "string", "enum": [ "appstore", "devkit_run", "devkit_install", "unknown" ] }, "channel": { "x-homey-updateable": false, "type": "string", "enum": [ "stable", "beta", "alpha" ] }, "version": { "x-homey-readonly": true, "type": "string" }, "compatibility": { "x-homey-readonly": true, "type": "string" }, "icon": { "type": "string" }, "iconObj": { "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } }, "author": { "x-homey-readonly": true, "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } }, "permissions": { "x-homey-readonly": true, "type": "array", "items": { "type": "string" } }, "images": { "x-homey-readonly": true, "type": "object", "properties": { "small": { "type": "string" }, "large": { "type": "string" } } }, "session": { "x-homey-readonly": true, "type": "string" }, "ready": { "x-homey-readonly": true, "type": "boolean" }, "state": { "x-homey-readonly": true, "type": "string", "enum": [ "stopped", "stopping", "starting", "running" ] }, "crashed": { "x-homey-readonly": true, "type": "boolean" }, "crashedMessage": { "x-homey-readonly": true, "type": "string" }, "exitCode": { "x-homey-readonly": true, "type": "number" }, "exitSignal": { "x-homey-readonly": true, "type": "string" }, "exitCount": { "x-homey-readonly": true, "type": "number" }, "settings": { "x-homey-readonly": true, "type": "boolean" }, "brandColor": { "x-homey-readonly": true, "type": "string" }, "hasDrivers": { "x-homey-readonly": true, "type": "boolean" }, "usage": { "x-homey-readonly": true, "type": "object", "properties": { "cpu": { "type": "number" }, "mem": { "type": "number" } } }, "updateAvailable": { "type": "object", "properties": { "version": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } } } } }, "x-realtime-bindings": { "read": "getApp", "create": "app.create", "update": "app.update", "delete": "app.delete" } } } }, "operations": { "uninstallApp": { "method": "DELETE", "path": "/app/:id", "private": false, "scopes": [ "homey.app" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "purgeSettings": { "in": "query", "type": "string" } } }, "installFromAppStore": { "method": "POST", "path": "/store/", "private": false, "scopes": [ "homey.app" ], "parameters": { "version": { "in": "body", "type": "string" }, "channel": { "in": "body", "type": "string" }, "id": { "in": "body", "type": "string", "required": true } } }, "getAppLocales": { "method": "GET", "path": "/app/:id/locale", "private": false, "scopes": [ "homey.app.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "disableApp": { "method": "PUT", "path": "/app/:id/disable", "private": false, "scopes": [ "homey.app" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "enableApp": { "method": "PUT", "path": "/app/:id/enable", "private": false, "scopes": [ "homey.app" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "garbageCollectApp": { "method": "POST", "path": "/app/:id/gc", "private": false, "scopes": [ "homey.app" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "restartApp": { "method": "POST", "path": "/app/:id/restart", "private": false, "scopes": [ "homey.app" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "unsetAppSetting": { "method": "DELETE", "path": "/app/:id/setting/:name", "private": false, "scopes": [ "homey.app.control" ], "parameters": { "name": { "in": "path", "required": true, "type": "string" }, "id": { "in": "path", "required": true, "type": "string" } } }, "setAppSetting": { "method": "PUT", "path": "/app/:id/setting/:name", "private": false, "scopes": [ "homey.app.control" ], "parameters": { "name": { "in": "path", "required": true, "type": "string" }, "id": { "in": "path", "required": true, "type": "string" }, "value": { "in": "body", "required": true } } }, "getAppSetting": { "method": "GET", "path": "/app/:id/setting/:name", "private": false, "scopes": [ "homey.app.control" ], "parameters": { "name": { "in": "path", "required": true, "type": "string" }, "id": { "in": "path", "required": true, "type": "string" } } }, "getAppSettings": { "method": "GET", "path": "/app/:id/setting", "private": false, "scopes": [ "homey.app.control" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getAppStd": { "method": "POST", "path": "/app/:id/crashlog", "private": false, "scopes": [ "homey.app.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "message": { "in": "body", "type": "string" } } }, "updateApp": { "method": "PUT", "path": "/app/:id", "private": false, "scopes": [ "homey.app" ], "crud": { "type": "updateOne", "item": "App" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "app": { "in": "body", "root": true, "required": true } } }, "getApp": { "method": "GET", "path": "/app/:id", "private": false, "scopes": [ "homey.app.readonly" ], "crud": { "type": "getOne", "item": "App" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getApps": { "method": "GET", "path": "/app", "private": false, "scopes": [ "homey.app.readonly" ], "crud": { "type": "getAll", "item": "App" }, "parameters": {} } } }, "ManagerAudio": { "id": "audio", "idCamelCase": "audio", "private": false, "operations": { "getOptionVolume": { "method": "GET", "path": "/option/volume", "scopes": [ "SYSTEM" ] }, "setOptionVolume": { "method": "PUT", "path": "/option/volume", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "number", "required": true } } }, "unsetOptionVolume": { "method": "DELETE", "path": "/option/volume", "scopes": [ "SYSTEM" ] }, "playVolumeHint": { "method": "POST", "path": "/volume-hint/", "private": false, "scopes": [ "homey.system" ], "parameters": {} } } }, "ManagerBackup": { "id": "backup", "idCamelCase": "backup", "private": false, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "SYSTEM_READONLY" ] }, "getOptionAutomaticBackupsEnabled": { "method": "GET", "path": "/option/automaticBackupsEnabled", "scopes": [ "SYSTEM" ] }, "setOptionAutomaticBackupsEnabled": { "method": "PUT", "path": "/option/automaticBackupsEnabled", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "boolean", "required": true } } }, "unsetOptionAutomaticBackupsEnabled": { "method": "DELETE", "path": "/option/automaticBackupsEnabled", "scopes": [ "SYSTEM" ] }, "getOptionLastSuccessfulBackup": { "method": "GET", "path": "/option/lastSuccessfulBackup", "scopes": [ "SYSTEM" ] }, "setOptionLastSuccessfulBackup": { "method": "PUT", "path": "/option/lastSuccessfulBackup", "scopes": [], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionLastSuccessfulBackup": { "method": "DELETE", "path": "/option/lastSuccessfulBackup", "scopes": [] }, "scheduleBackup": { "method": "POST", "path": "/backup/", "private": false, "scopes": [ "homey.system" ], "parameters": {} } } }, "ManagerBLE": { "id": "ble", "idCamelCase": "ble", "private": false, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "SYSTEM_READONLY" ] }, "runCommand": { "method": "POST", "path": "/command", "private": false, "scopes": [ "homey.system" ], "parameters": { "opts": { "in": "body", "type": "object" }, "command": { "in": "body", "type": "string", "required": true } } } } }, "ManagerCloud": { "id": "cloud", "idCamelCase": "cloud", "private": false, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "SYSTEM_READONLY" ] } } }, "ManagerCoprocessor": { "id": "coprocessor", "idCamelCase": "coprocessor", "private": true, "operations": { "setConfig": { "method": "PUT", "path": "/:deviceId/config", "private": false, "scopes": [ "homey.system" ], "parameters": { "deviceId": { "in": "path", "type": "string" }, "config": { "in": "body", "type": "object", "root": true } } }, "setModulation": { "method": "PUT", "path": "/:deviceId/modulation", "private": false, "scopes": [ "homey.system" ], "parameters": { "deviceId": { "in": "path", "type": "string" }, "baudRate": { "in": "body", "type": "number" }, "channelSpacing": { "in": "body", "type": "number" }, "channelDeviation": { "in": "body", "type": "number" }, "carrier": { "in": "body", "type": "number" }, "type": { "in": "body", "type": "string" } } } } }, "ManagerDatabase": { "id": "database", "idCamelCase": "database", "private": false, "operations": { "optimize": { "method": "POST", "path": "/optimize", "private": false, "scopes": [ "homey.system" ], "parameters": {} } } }, "ManagerDevices": { "id": "devices", "idCamelCase": "devices", "private": false, "items": { "Device": { "id": "device", "type": "id", "schema": { "type": "object", "properties": { "id": { "x-homey-readonly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "driverUri": { "x-homey-updateable": false, "type": "string" }, "driverId": { "x-homey-updateable": false, "type": "string" }, "zone": { "type": "string", "description": "The id of the device's zone." }, "data": { "x-homey-updateable": false, "type": "object" }, "icon": { "type": "string" }, "iconObj": { "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } }, "iconOverride": { "type": [ "string", "null" ] }, "settings": { "x-homey-updateable": false, "type": "object" }, "settingsObj": { "x-homey-updateable": false, "type": "boolean", "description": "This property is true when there are settings, getable by the getDeviceSettingsObj method" }, "class": { "x-homey-updateable": false, "type": "string" }, "energy": { "x-homey-updateable": false, "type": "object", "properties": { "approximation": { "type": "object", "properties": { "usageOn": { "type": "number" }, "usageOff": { "type": "number" }, "usageConstant": { "type": "number" } } }, "cumulative": { "type": "boolean" }, "batteries": { "type": "array", "items": { "type": "string" } } } }, "energyObj": { "x-homey-updateable": false, "type": "object" }, "virtualClass": { "type": [ "string", "null" ] }, "ui": { "x-homey-updateable": false, "type": "object", "properties": { "quickAction": { "type": "string", "description": "Optional capabilityId of the quick action" }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the UI component" }, "capabilities": { "type": "array", "description": "An array of capabilityIds", "items": { "type": "string" } } } } } } }, "uiIndicator": { "type": [ "string", "null" ] }, "capabilities": { "x-homey-updateable": false, "type": "array", "items": { "type": "string" } }, "capabilitiesObj": { "x-homey-updateable": false, "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "title": { "type": "string" }, "desc": { "type": "string" }, "type": { "type": "string", "enum": [ "boolean", "number", "string", "enum" ] }, "getable": { "type": "boolean" }, "setable": { "type": "boolean" }, "chartType": { "type": "string", "enum": [ "line", "area", "stepLine", "column", "spline", "splineArea", "scatter" ] }, "decimals": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" }, "units": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" } } } }, "value": { "type": "object" }, "lastUpdated": { "type": "string", "format": "date-time" }, "options": { "type": "object" } } } }, "capabilitiesOptions": { "x-homey-updateable": false, "type": "object" }, "flags": { "x-homey-readonly": true, "type": "array", "items": { "type": "string" } }, "ready": { "x-homey-readonly": true, "type": "boolean", "description": "A device is when the device's driver is available and ready." }, "available": { "x-homey-readonly": true, "type": "boolean", "description": "A device can be available or unavailable, decided by the device's driver. If the driver is unavailable, the property `unavailableMessage` might be set. For example, a device can be unavailable when there is no wireless connection possible." }, "repair": { "x-homey-readonly": true, "type": "boolean", "description": "If true, this device can be repaired using a repair PairSession." }, "unpair": { "x-homey-readonly": true, "type": "boolean", "description": "If true, this device needs to be deleted using an unpair PairSession." }, "unavailableMessage": { "x-homey-readonly": true, "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "media", "camera" ] }, "id": { "type": "string" }, "imageObj": { "x-base-class": "ManagerImages.Image", "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "ownerUri": { "type": "string" }, "url": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" } } } } } }, "insights": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "titleTrue": { "type": "string" }, "titleFalse": { "type": "string" }, "units": { "type": "string" }, "decimals": { "type": "number" } } } }, "color": { "type": "string" }, "note": { "type": "string" } }, "x-realtime-bindings": { "read": "getDevice", "create": "device.create", "update": "device.update", "delete": "device.delete" } } }, "Capability": { "id": "capability", "type": "filter", "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "title": { "type": "string" }, "desc": { "type": "string" }, "type": { "type": "string", "enum": [ "boolean", "number", "string", "enum" ] }, "getable": { "type": "boolean" }, "setable": { "type": "boolean" }, "chartType": { "type": "string", "enum": [ "line", "area", "stepLine", "column", "spline", "splineArea", "scatter" ] }, "decimals": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" }, "units": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" } } } } }, "x-realtime-bindings": { "read": "getCapability", "create": "capability.create", "update": "capability.update", "delete": "capability.delete" } } } }, "operations": { "getCapability": { "method": "GET", "path": "/capability/:uri/:id", "private": false, "scopes": [ "homey.device.readonly" ], "crud": { "type": "getOne", "item": "Capability" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getCapabilities": { "method": "GET", "path": "/capability", "private": false, "scopes": [ "homey.device.readonly" ], "crud": { "type": "getAll", "item": "Capability" }, "parameters": {} }, "setDeviceSettings": { "method": "PUT", "path": "/device/:id/settings", "private": false, "scopes": [ "homey.device" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "settings": { "in": "body", "root": true, "required": true } } }, "getDeviceSettingsObj": { "method": "GET", "path": "/device/:id/settings_obj", "private": false, "scopes": [ "homey.device.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "setCapabilityValue": { "method": "PUT", "path": "/device/:deviceId/capability/:capabilityId", "private": false, "scopes": [ "homey.device.control" ], "parameters": { "capabilityId": { "in": "path", "required": true, "type": "string" }, "deviceId": { "in": "path", "required": true, "type": "string" }, "transactionId": { "in": "body" }, "opts": { "in": "body" }, "value": { "in": "body", "required": true } } }, "deleteDevice": { "method": "DELETE", "path": "/device/:id", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "deleteOne", "item": "Device" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateDevice": { "method": "PUT", "path": "/device/:id", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "updateOne", "item": "Device" }, "parameters": { "id": { "in": "path", "type": "string", "required": true }, "device": { "in": "body", "root": true, "required": true } } }, "getDevice": { "method": "GET", "path": "/device/:id", "private": false, "scopes": [ "homey.device.readonly" ], "crud": { "type": "getOne", "item": "Device" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getDevices": { "method": "GET", "path": "/device/", "private": false, "scopes": [ "homey.device.readonly" ], "crud": { "type": "getAll", "item": "Device" }, "parameters": {} } } }, "ManagerDevkit": { "id": "devkit", "idCamelCase": "devkit", "private": false, "operations": { "getAppStdOut": { "method": "GET", "path": "/std/:session", "private": false, "scopes": [ "homey.app.readonly" ], "parameters": { "session": { "in": "path", "required": true, "type": "string" } } }, "getAppUsage": { "method": "GET", "path": "/usage", "private": false, "scopes": [ "homey.app.readonly" ], "parameters": {} }, "setUsbMode": { "method": "PUT", "path": "/usb/", "private": false, "scopes": [ "homey.system" ], "parameters": { "os": { "in": "body", "type": "string", "required": true } } }, "getUsbMode": { "method": "GET", "path": "/usb/", "private": false, "scopes": [ "homey.system" ], "parameters": {} }, "stopApp": { "method": "DELETE", "path": "/:session", "private": false, "scopes": [ "homey.app" ], "parameters": { "session": { "in": "path", "required": true, "type": "string" } } }, "runApp": { "method": "POST", "path": "/", "private": false, "scopes": [ "homey.app" ], "parameters": { "purgeSettings": { "in": "formData", "type": "string", "required": true }, "env": { "in": "formData", "type": "string", "required": true }, "debug": { "in": "formData", "type": "string", "required": true }, "app": { "in": "formData", "type": "string", "required": true } } }, "stopLedringAnimation": { "method": "DELETE", "path": "/ledring", "private": false, "scopes": [ "homey.app" ], "parameters": { "animation_id": { "in": "query", "type": "string", "required": true } } }, "startLedringAnimation": { "method": "POST", "path": "/ledring", "private": false, "scopes": [ "homey.app" ], "parameters": { "animation": { "in": "body", "root": true, "required": true } } } } }, "ManagerDrivers": { "id": "drivers", "idCamelCase": "drivers", "private": false, "items": { "Driver": { "id": "driver", "type": "filter", "schema": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "uriObj": { "type": "object" }, "icon": { "type": "string" }, "iconObj": { "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } }, "ready": { "type": "boolean" }, "pair": { "type": "boolean" }, "unpair": { "type": "boolean" }, "repair": { "type": "boolean" }, "color": { "type": "string" }, "deprecated": { "type": "boolean" }, "class": { "type": "string" }, "connectivity": { "type": "array" } }, "x-realtime-bindings": { "read": "getDriver", "create": "driver.create", "update": "driver.update", "delete": "driver.delete" } } }, "Device": { "id": "device", "type": "id", "schema": { "type": "object", "properties": { "id": { "x-homey-readonly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "driverUri": { "x-homey-updateable": false, "type": "string" }, "driverId": { "x-homey-updateable": false, "type": "string" }, "zone": { "type": "string", "description": "The id of the device's zone." }, "data": { "x-homey-updateable": false, "type": "object" }, "icon": { "type": "string" }, "iconObj": { "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } }, "iconOverride": { "type": [ "string", "null" ] }, "settings": { "x-homey-updateable": false, "type": "object" }, "settingsObj": { "x-homey-updateable": false, "type": "boolean", "description": "This property is true when there are settings, getable by the getDeviceSettingsObj method" }, "class": { "x-homey-updateable": false, "type": "string" }, "energy": { "x-homey-updateable": false, "type": "object", "properties": { "approximation": { "type": "object", "properties": { "usageOn": { "type": "number" }, "usageOff": { "type": "number" }, "usageConstant": { "type": "number" } } }, "cumulative": { "type": "boolean" }, "batteries": { "type": "array", "items": { "type": "string" } } } }, "energyObj": { "x-homey-updateable": false, "type": "object" }, "virtualClass": { "type": [ "string", "null" ] }, "ui": { "x-homey-updateable": false, "type": "object", "properties": { "quickAction": { "type": "string", "description": "Optional capabilityId of the quick action" }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the UI component" }, "capabilities": { "type": "array", "description": "An array of capabilityIds", "items": { "type": "string" } } } } } } }, "uiIndicator": { "type": [ "string", "null" ] }, "capabilities": { "x-homey-updateable": false, "type": "array", "items": { "type": "string" } }, "capabilitiesObj": { "x-homey-updateable": false, "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "title": { "type": "string" }, "desc": { "type": "string" }, "type": { "type": "string", "enum": [ "boolean", "number", "string", "enum" ] }, "getable": { "type": "boolean" }, "setable": { "type": "boolean" }, "chartType": { "type": "string", "enum": [ "line", "area", "stepLine", "column", "spline", "splineArea", "scatter" ] }, "decimals": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" }, "units": { "type": "string" }, "values": { "type": "array", "items": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" } } } }, "value": { "type": "object" }, "lastUpdated": { "type": "string", "format": "date-time" }, "options": { "type": "object" } } } }, "capabilitiesOptions": { "x-homey-updateable": false, "type": "object" }, "flags": { "x-homey-readonly": true, "type": "array", "items": { "type": "string" } }, "ready": { "x-homey-readonly": true, "type": "boolean", "description": "A device is when the device's driver is available and ready." }, "available": { "x-homey-readonly": true, "type": "boolean", "description": "A device can be available or unavailable, decided by the device's driver. If the driver is unavailable, the property `unavailableMessage` might be set. For example, a device can be unavailable when there is no wireless connection possible." }, "repair": { "x-homey-readonly": true, "type": "boolean", "description": "If true, this device can be repaired using a repair PairSession." }, "unpair": { "x-homey-readonly": true, "type": "boolean", "description": "If true, this device needs to be deleted using an unpair PairSession." }, "unavailableMessage": { "x-homey-readonly": true, "type": "string" }, "images": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "media", "camera" ] }, "id": { "type": "string" }, "imageObj": { "x-base-class": "ManagerImages.Image", "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "ownerUri": { "type": "string" }, "url": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" } } } } } }, "insights": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "titleTrue": { "type": "string" }, "titleFalse": { "type": "string" }, "units": { "type": "string" }, "decimals": { "type": "number" } } } }, "color": { "type": "string" }, "note": { "type": "string" } } } }, "PairSession": { "id": "pairsession", "type": "id", "schema": { "type": "object", "required": [ "type" ], "properties": { "id": { "x-homey-readonly": true, "type": "string" }, "type": { "type": "string", "enum": [ "pair", "unpair", "repair" ] }, "driverId": { "type": "string" }, "driverUri": { "type": "string" }, "deviceId": { "type": "string" }, "zoneId": { "type": "string" }, "views": { "x-homey-readonly": true, "type": "array" } }, "x-realtime-bindings": { "read": "getPairSession", "create": "pairsession.create", "update": "pairsession.update", "delete": "pairsession.delete" } } } }, "operations": { "deletePairSessionDevice": { "method": "DELETE", "path": "/pairsession/:id/device", "private": false, "scopes": [ "homey.device" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "createPairSessionDevice": { "method": "POST", "path": "/pairsession/:id/device", "private": false, "scopes": [ "homey.device" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "device": { "in": "body", "root": true, "required": true } } }, "deletePairSession": { "method": "DELETE", "path": "/pairsession/:id", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "deleteOne", "item": "PairSession" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "emitPairingHeartbeat": { "method": "POST", "path": "/pairsession/:id/heartbeat", "private": false, "scopes": [ "homey.device" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "emitPairingCallback": { "method": "POST", "path": "/pairsession/:id/callback", "private": false, "scopes": [ "homey.device" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "data": { "in": "body", "type": "object" }, "callbackId": { "in": "body", "type": "string", "required": true } } }, "emitPairingEvent": { "method": "POST", "path": "/pairsession/:id/emit", "private": false, "scopes": [ "homey.device" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "data": { "in": "body", "required": true }, "event": { "in": "body", "type": "string", "required": true } } }, "createPairSession": { "method": "POST", "path": "/pairsession", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "createOne", "item": "PairSession" }, "parameters": { "pairsession": { "in": "body", "root": true, "required": true } } }, "getPairSession": { "method": "GET", "path": "/pairsession/:id", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "getOne", "item": "PairSession" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getPairSessions": { "method": "GET", "path": "/pairsession", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "getAll", "item": "PairSession" }, "parameters": {} }, "getDriver": { "method": "GET", "path": "/driver/:uri/:id", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "getOne", "item": "Driver" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getDrivers": { "method": "GET", "path": "/driver", "private": false, "scopes": [ "homey.device.readonly" ], "crud": { "type": "getAll", "item": "Driver" }, "parameters": {} } } }, "ManagerEnergy": { "id": "energy", "idCamelCase": "energy", "private": false, "operations": { "getOptionKWhCost": { "method": "GET", "path": "/option/kWhCost", "scopes": [ "SYSTEM_READONLY" ] }, "setOptionKWhCost": { "method": "PUT", "path": "/option/kWhCost", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "number", "required": true } } }, "unsetOptionKWhCost": { "method": "DELETE", "path": "/option/kWhCost", "scopes": [ "SYSTEM" ] }, "getOptionCurrency": { "method": "GET", "path": "/option/currency", "scopes": [ "SYSTEM_READONLY" ] }, "setOptionCurrency": { "method": "PUT", "path": "/option/currency", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionCurrency": { "method": "DELETE", "path": "/option/currency", "scopes": [ "SYSTEM" ] }, "getLiveReport": { "method": "GET", "path": "/live", "private": false, "scopes": [ "homey.insights.readonly" ], "parameters": { "zone": { "in": "query", "type": "string" } } } } }, "ManagerExperiments": { "id": "experiments", "idCamelCase": "experiments", "private": false, "operations": { "disableExperiment": { "method": "PUT", "path": "/experiment/:id/disable", "private": false, "scopes": [ "homey.system" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "enableExperiment": { "method": "PUT", "path": "/experiment/:id/enable", "private": false, "scopes": [ "homey.system" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getExperiments": { "method": "GET", "path": "/experiment", "private": false, "scopes": [ "homey.system" ], "parameters": {} } } }, "ManagerFlow": { "id": "flow", "idCamelCase": "flow", "private": false, "items": { "Flow": { "id": "flow", "type": "id", "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1 }, "enabled": { "type": "boolean" }, "folder": { "type": [ "string", "null" ], "format": "uuid" }, "order": { "type": "number" }, "broken": { "x-homey-readonly": true, "type": "boolean" }, "triggerable": { "x-homey-readonly": true, "type": "boolean" }, "trigger": { "type": "object", "required": [ "uri", "id" ], "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "droptoken": { "type": "string" }, "args": { "type": "object" } } }, "conditions": { "type": "array", "items": { "type": "object", "required": [ "uri", "id" ], "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "droptoken": { "type": "string" }, "args": { "type": "object" }, "group": { "type": "string", "enum": [ "group1", "group2", "group3" ] }, "inverted": { "type": "boolean", "default": false } } } }, "actions": { "type": "array", "items": { "type": "object", "required": [ "uri", "id" ], "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "droptoken": { "type": "string" }, "args": { "type": "object" }, "group": { "type": "string", "enum": [ "then", "else" ] }, "duration": { "type": [ "object", "null" ], "required": [ "multiplier", "number" ], "properties": { "multiplier": { "type": "number", "minimum": 0, "enum": [ 1, 60 ] }, "number": { "type": "string" } } }, "delay": { "type": [ "object", "null" ], "required": [ "multiplier", "number" ], "properties": { "multiplier": { "type": "number", "minimum": 0, "enum": [ 1, 60 ] }, "number": { "type": "string" } } } } } } }, "x-realtime-bindings": { "read": "getFlow", "create": "flow.create", "update": "flow.update", "delete": "flow.delete" } } }, "FlowCardTrigger": { "id": "flowcardtrigger", "type": "filter", "schema": { "type": "object", "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "args": { "type": "object" }, "deprecated": { "type": "boolean" }, "droptoken": { "type": "boolean" }, "duration": { "type": "boolean" }, "uriObj": { "type": "object" }, "advanced": { "type": "boolean" }, "title": { "type": "string" }, "hint": { "type": "string" }, "highlight": { "type": "boolean" }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "hint": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "boolean" ] }, "example": { "type": [ "string", "number", "boolean", "null" ] } } } } }, "x-realtime-bindings": { "read": "getFlowCardTrigger", "create": "flowcardtrigger.create", "update": "flowcardtrigger.update", "delete": "flowcardtrigger.delete" } } }, "FlowCardCondition": { "id": "flowcardcondition", "type": "filter", "schema": { "type": "object", "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "args": { "type": "object" }, "deprecated": { "type": "boolean" }, "droptoken": { "type": "boolean" }, "duration": { "type": "boolean" }, "uriObj": { "type": "object" }, "advanced": { "type": "boolean" }, "title": { "type": "string" }, "hint": { "type": "string" }, "highlight": { "type": "boolean" } }, "x-realtime-bindings": { "read": "getFlowCardCondition", "create": "flowcardcondition.create", "update": "flowcardcondition.update", "delete": "flowcardcondition.delete" } } }, "FlowCardAction": { "id": "flowcardaction", "type": "filter", "schema": { "type": "object", "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "args": { "type": "object" }, "deprecated": { "type": "boolean" }, "droptoken": { "type": "boolean" }, "duration": { "type": "boolean" }, "uriObj": { "type": "object" }, "advanced": { "type": "boolean" }, "title": { "type": "string" }, "hint": { "type": "string" }, "highlight": { "type": "boolean" }, "tokens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "hint": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "boolean" ] }, "example": { "type": [ "string", "number", "boolean", "null" ] } } } } }, "x-realtime-bindings": { "read": "getFlowCardAction", "create": "flowcardaction.create", "update": "flowcardaction.update", "delete": "flowcardaction.delete" } } }, "FlowFolder": { "id": "flowfolder", "type": "id", "schema": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "number" }, "parent": { "type": "string" } }, "x-realtime-bindings": { "read": "getFlowFolder", "create": "flowfolder.create", "update": "flowfolder.update", "delete": "flowfolder.delete" } } }, "AdvancedFlow": { "id": "advancedflow", "type": "id", "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-homey-updateable": false }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "broken": { "x-homey-readonly": true, "type": "boolean" }, "triggerable": { "x-homey-readonly": true, "type": "boolean" }, "folder": { "type": [ "string", "null" ], "format": "uuid" }, "cards": { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$": { "type": "object", "required": [ "type", "x", "y" ], "properties": { "type": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" } } } } } }, "x-realtime-bindings": { "read": "getAdvancedFlow", "create": "advancedflow.create", "update": "advancedflow.update", "delete": "advancedflow.delete" } } } }, "operations": { "triggerAdvancedFlow": { "method": "POST", "path": "/advancedflow/:id/trigger", "private": false, "scopes": [ "homey.flow.start" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "state": { "in": "body", "root": true } } }, "deleteAdvancedFlow": { "method": "DELETE", "path": "/advancedflow/:id", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "deleteOne", "item": "AdvancedFlow" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateAdvancedFlow": { "method": "PUT", "path": "/advancedflow/:id", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "updateOne", "item": "AdvancedFlow" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "advancedflow": { "in": "body", "root": true, "required": true } } }, "createAdvancedFlow": { "method": "POST", "path": "/advancedflow", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "createOne", "item": "AdvancedFlow" }, "parameters": { "advancedflow": { "in": "body", "root": true, "required": true } } }, "getAdvancedFlow": { "method": "GET", "path": "/advancedflow/:id", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getOne", "item": "AdvancedFlow" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getAdvancedFlows": { "method": "GET", "path": "/advancedflow", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getAll", "item": "AdvancedFlow" }, "parameters": {} }, "deleteFlowFolder": { "method": "DELETE", "path": "/flowfolder/:id", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "deleteOne", "item": "FlowFolder" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateFlowFolder": { "method": "PUT", "path": "/flowfolder/:id", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "updateOne", "item": "FlowFolder" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "flowfolder": { "in": "body", "root": true, "required": true } } }, "createFlowFolder": { "method": "POST", "path": "/flowfolder", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "createOne", "item": "FlowFolder" }, "parameters": { "flowfolder": { "in": "body", "root": true, "required": true } } }, "getFlowFolder": { "method": "GET", "path": "/flowfolder/:id", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getOne", "item": "FlowFolder" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getFlowFolders": { "method": "GET", "path": "/flowfolder", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getAll", "item": "FlowFolder" }, "parameters": {} }, "triggerFlow": { "method": "POST", "path": "/flow/:id/trigger", "private": false, "scopes": [ "homey.flow.start" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "state": { "in": "body", "root": true } } }, "testFlow": { "method": "POST", "path": "/flow/test", "private": false, "scopes": [ "homey.flow" ], "parameters": { "sessionId": { "in": "body", "type": "string" }, "tokens": { "in": "body", "type": "object", "required": true }, "flow": { "in": "body", "required": true } } }, "deleteFlow": { "method": "DELETE", "path": "/flow/:id", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "deleteOne", "item": "Flow" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateFlow": { "method": "PUT", "path": "/flow/:id", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "updateOne", "item": "Flow" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "flow": { "in": "body", "root": true, "required": true } } }, "createFlow": { "method": "POST", "path": "/flow", "private": false, "scopes": [ "homey.flow" ], "crud": { "type": "createOne", "item": "Flow" }, "parameters": { "flow": { "in": "body", "root": true, "required": true } } }, "shareFlow": { "method": "POST", "path": "/flow/:id/share", "private": false, "scopes": [ "homey.flow.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getFlow": { "method": "GET", "path": "/flow/:id", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getOne", "item": "Flow" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getFlows": { "method": "GET", "path": "/flow", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getAll", "item": "Flow" }, "parameters": {} }, "getFlowCardAutocomplete": { "method": "GET", "path": "/:type/:uri/:id/autocomplete", "private": false, "scopes": [ "homey.flow.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" }, "type": { "in": "path", "required": true, "type": "string" }, "args": { "in": "query", "type": "string" }, "query": { "in": "query", "type": "string", "required": true }, "name": { "in": "query", "type": "string", "required": true } } }, "runFlowCardAction": { "method": "POST", "path": "/flowcardaction/:uri/:id/run", "private": false, "scopes": [ "homey.flow" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" }, "duration": { "in": "body", "type": "number" }, "state": { "in": "body", "type": "object" }, "tokens": { "in": "body", "type": "object" }, "droptoken": { "in": "body", "type": "string" }, "args": { "in": "body", "type": "object" } } }, "getFlowCardAction": { "method": "GET", "path": "/flowcardaction/:uri/:id", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getOne", "item": "FlowCardAction" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getFlowCardActions": { "method": "GET", "path": "/flowcardaction", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getAll", "item": "FlowCardAction" }, "parameters": {} }, "runFlowCardCondition": { "method": "POST", "path": "/flowcardcondition/:uri/:id/run", "private": false, "scopes": [ "homey.flow" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" }, "state": { "in": "body", "type": "object" }, "tokens": { "in": "body", "type": "object" }, "droptoken": { "in": "body", "type": "string" }, "args": { "in": "body", "type": "object" } } }, "getFlowCardCondition": { "method": "GET", "path": "/flowcardcondition/:uri/:id", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getOne", "item": "FlowCardCondition" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getFlowCardConditions": { "method": "GET", "path": "/flowcardcondition", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getAll", "item": "FlowCardCondition" }, "parameters": {} }, "getFlowCardTrigger": { "method": "GET", "path": "/flowcardtrigger/:uri/:id", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getOne", "item": "FlowCardTrigger" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getFlowCardTriggers": { "method": "GET", "path": "/flowcardtrigger", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getAll", "item": "FlowCardTrigger" }, "parameters": {} } } }, "ManagerFlowToken": { "id": "flowtoken", "idCamelCase": "flowtoken", "private": false, "items": { "FlowToken": { "id": "flowtoken", "type": "filter", "schema": { "type": "object", "properties": { "uri": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "uriObj": { "type": "object" } }, "x-realtime-bindings": { "read": "getFlowToken", "create": "flowtoken.create", "update": "flowtoken.update", "delete": "flowtoken.delete" } } } }, "operations": { "getFlowToken": { "method": "GET", "path": "/flowtoken/:uri/:id", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getOne", "item": "FlowToken" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getFlowTokens": { "method": "GET", "path": "/flowtoken", "private": false, "scopes": [ "homey.flow.readonly" ], "crud": { "type": "getAll", "item": "FlowToken" }, "parameters": {} } } }, "ManagerGeolocation": { "id": "geolocation", "idCamelCase": "geolocation", "private": false, "operations": { "getOptionMode": { "method": "GET", "path": "/option/mode", "scopes": [ "GEOLOCATION_READONLY" ] }, "setOptionMode": { "method": "PUT", "path": "/option/mode", "scopes": [ "GEOLOCATION" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionMode": { "method": "DELETE", "path": "/option/mode", "scopes": [ "GEOLOCATION" ] }, "getOptionLocation": { "method": "GET", "path": "/option/location", "scopes": [ "GEOLOCATION_READONLY" ] }, "setOptionLocation": { "method": "PUT", "path": "/option/location", "scopes": [ "GEOLOCATION" ], "parameters": { "value": { "in": "body", "type": "object", "required": true } } }, "unsetOptionLocation": { "method": "DELETE", "path": "/option/location", "scopes": [ "GEOLOCATION" ] } } }, "ManagerGoogleAssistant": { "id": "google-assistant", "idCamelCase": "googleAssistant", "private": false, "operations": { "getOptionEnabled": { "method": "GET", "path": "/option/enabled", "scopes": [ "SYSTEM" ] }, "setOptionEnabled": { "method": "PUT", "path": "/option/enabled", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "boolean", "required": true } } }, "unsetOptionEnabled": { "method": "DELETE", "path": "/option/enabled", "scopes": [ "SYSTEM" ] }, "sync": { "method": "POST", "path": "/sync", "private": false, "scopes": [ "homey.system" ], "parameters": {} } } }, "ManagerI18n": { "id": "i18n", "idCamelCase": "i18n", "private": false, "operations": { "getOptionLanguage": { "method": "GET", "path": "/option/language", "scopes": [ "SYSTEM_READONLY" ] }, "setOptionLanguage": { "method": "PUT", "path": "/option/language", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionLanguage": { "method": "DELETE", "path": "/option/language", "scopes": [ "SYSTEM" ] }, "getOptionUnits": { "method": "GET", "path": "/option/units", "scopes": [ "SYSTEM_READONLY" ] }, "setOptionUnits": { "method": "PUT", "path": "/option/units", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionUnits": { "method": "DELETE", "path": "/option/units", "scopes": [ "SYSTEM" ] } } }, "ManagerImages": { "id": "images", "idCamelCase": "images", "private": false, "items": { "Image": { "id": "image", "type": "id", "schema": { "x-base-class": "ManagerImages.Image", "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "ownerUri": { "type": "string" }, "url": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" } }, "x-realtime-bindings": { "read": "getImage", "create": "image.create", "update": "image.update", "delete": "image.delete" } } } }, "operations": { "getImage": { "method": "GET", "path": "/image/:id", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "getOne", "item": "Image" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getImages": { "method": "GET", "path": "/image", "private": false, "scopes": [ "homey.device" ], "crud": { "type": "getAll", "item": "Image" }, "parameters": {} } } }, "ManagerInsights": { "id": "insights", "idCamelCase": "insights", "private": false, "items": { "Log": { "id": "log", "type": "filter", "schema": { "type": "object", "properties": { "uri": { "x-homey-readonly": true, "type": "string" }, "id": { "x-homey-readonly": true, "type": "string" }, "title": { "x-homey-readonly": true, "type": "string" }, "titleTrue": { "x-homey-readonly": true, "type": "string" }, "titleFalse": { "x-homey-readonly": true, "type": "string" }, "type": { "x-homey-readonly": true, "type": "string", "enum": [ "number", "boolean" ] }, "units": { "x-homey-readonly": true, "type": "string" }, "decimals": { "x-homey-readonly": true, "type": "number" }, "lastValue": { "type": "number" } }, "x-realtime-bindings": { "read": "getLog", "create": "log.create", "update": "log.update", "delete": "log.delete" } } } }, "operations": { "getStorageInfo": { "method": "GET", "path": "/storage", "private": false, "scopes": [ "homey.insights.readonly" ], "parameters": {} }, "deleteLogEntries": { "method": "DELETE", "path": "/log/:uri/:id/entry", "private": false, "scopes": [ "homey.insights" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getLogEntries": { "method": "GET", "path": "/log/:uri/:id/entry", "private": false, "scopes": [ "homey.insights.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" }, "resolution": { "in": "query", "type": "string" } } }, "deleteLogs": { "method": "DELETE", "path": "/log/", "private": false, "scopes": [ "homey.insights" ], "parameters": {} }, "deleteLog": { "method": "DELETE", "path": "/log/:uri/:id", "private": false, "scopes": [ "homey.insights" ], "crud": { "type": "deleteOne", "item": "Log" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "updateLog": { "method": "PUT", "path": "/log/:uri/:id", "private": false, "scopes": [ "homey.insights" ], "crud": { "type": "updateOne", "item": "Log" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" }, "log": { "in": "body", "root": true, "required": true } } }, "getLog": { "method": "GET", "path": "/log/:uri/:id", "private": false, "scopes": [ "homey.insights.readonly" ], "crud": { "type": "getOne", "item": "Log" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "uri": { "in": "path", "required": true, "type": "string" } } }, "getLogs": { "method": "GET", "path": "/log/", "private": false, "scopes": [ "homey.insights.readonly" ], "crud": { "type": "getAll", "item": "Log" }, "parameters": {} } } }, "ManagerLedring": { "id": "ledring", "idCamelCase": "ledring", "private": false, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "SYSTEM_READONLY" ] }, "getOptionBrightness": { "method": "GET", "path": "/option/brightness", "scopes": [ "SYSTEM_READONLY" ] }, "setOptionBrightness": { "method": "PUT", "path": "/option/brightness", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "number", "required": true } } }, "unsetOptionBrightness": { "method": "DELETE", "path": "/option/brightness", "scopes": [ "SYSTEM" ] }, "getOptionScreensaver": { "method": "GET", "path": "/option/screensaver", "scopes": [ "SYSTEM_READONLY" ] }, "setOptionScreensaver": { "method": "PUT", "path": "/option/screensaver", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "object", "required": true } } }, "unsetOptionScreensaver": { "method": "DELETE", "path": "/option/screensaver", "scopes": [ "SYSTEM" ] }, "getScreensavers": { "method": "GET", "path": "/screensaver/", "private": false, "scopes": [ "homey.system.readonly" ], "parameters": {} } } }, "ManagerLogic": { "id": "logic", "idCamelCase": "logic", "private": false, "items": { "Variable": { "id": "variable", "type": "id", "schema": { "type": "object", "properties": { "id": { "x-homey-readonly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "number", "boolean" ] }, "value": { "description": "Should be the same type as defined in the `type` property." } }, "x-realtime-bindings": { "read": "getVariable", "create": "variable.create", "update": "variable.update", "delete": "variable.delete" } } } }, "operations": { "triggerWebhook": { "method": "GET", "path": "/webhook/:event", "private": false, "scopes": [], "parameters": { "event": { "in": "path", "type": "string" }, "tag": { "in": "query", "type": "string" } } }, "deleteVariable": { "method": "DELETE", "path": "/variable/:id", "private": false, "scopes": [ "homey.logic" ], "crud": { "type": "deleteOne", "item": "Variable" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateVariable": { "method": "PUT", "path": "/variable/:id", "private": false, "scopes": [ "homey.logic" ], "crud": { "type": "updateOne", "item": "Variable" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "variable": { "in": "body", "root": true, "required": true } } }, "createVariable": { "method": "POST", "path": "/variable/", "private": false, "scopes": [ "homey.logic" ], "crud": { "type": "createOne", "item": "Variable" }, "parameters": { "variable": { "in": "body", "root": true, "required": true } } }, "getVariable": { "method": "GET", "path": "/variable/:id", "private": false, "scopes": [ "homey.logic.readonly" ], "crud": { "type": "getOne", "item": "Variable" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getVariables": { "method": "GET", "path": "/variable", "private": false, "scopes": [ "homey.logic.readonly" ], "crud": { "type": "getAll", "item": "Variable" }, "parameters": {} } } }, "ManagerMobile": { "id": "mobile", "idCamelCase": "mobile", "private": false, "operations": { "getSummary": { "method": "GET", "path": "/summary", "private": false, "scopes": [ "homey.device.readonly", "homey.flow.readonly", "homey.user.readonly" ], "parameters": {} } } }, "ManagerMoods": { "id": "moods", "idCamelCase": "moods", "private": true, "items": { "Mood": { "id": "mood", "type": "id", "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "preset": { "type": [ "string", "null" ] }, "zone": { "type": "string" }, "devices": { "type": "object", "additionalProperties": false, "patternProperties": { "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$": { "type": "object", "additionalProperties": false, "properties": { "state": { "type": "object", "additionalProperties": false, "patternProperties": { ".*": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } } } } } } } }, "x-realtime-bindings": { "read": "getMood", "create": "mood.create", "update": "mood.update", "delete": "mood.delete" } } } }, "operations": { "setMood": { "method": "POST", "path": "/mood/:id/set", "private": false, "scopes": [ "homey.mood.set" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "deleteMood": { "method": "DELETE", "path": "/mood/:id", "private": false, "scopes": [ "homey.mood" ], "crud": { "type": "deleteOne", "item": "Mood" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateMood": { "method": "PUT", "path": "/mood/:id", "private": false, "scopes": [ "homey.mood" ], "crud": { "type": "updateOne", "item": "Mood" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "mood": { "in": "body", "root": true, "required": true } } }, "createMood": { "method": "POST", "path": "/mood", "private": false, "scopes": [ "homey.mood" ], "crud": { "type": "createOne", "item": "Mood" }, "parameters": { "mood": { "in": "body", "root": true, "required": true } } }, "getMood": { "method": "GET", "path": "/mood/:id", "private": false, "scopes": [ "homey.mood.readonly" ], "crud": { "type": "getOne", "item": "Mood" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getMoods": { "method": "GET", "path": "/mood", "private": false, "scopes": [ "homey.mood.readonly" ], "crud": { "type": "getAll", "item": "Mood" }, "parameters": {} } } }, "ManagerDashboards": { "id": "dashboards", "idCamelCase": "dashboards", "private": true, "items": { "Dashboard": { "id": "dashboard", "type": "id", "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "widgets": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "x-realtime-bindings": { "read": "getDashboard", "create": "dashboard.create", "update": "dashboard.update", "delete": "dashboard.delete" } } }, "AppWidget": { "id": "appwidget", "type": "id", "schema": { "type": "object", "properties": { "id": { "type": "string" }, "ownerId": { "type": "string" }, "ownerUri": { "type": "string" }, "ownerName": { "type": "string" }, "name": { "type": "string" }, "settings": { "type": "object" }, "devices": { "type": "object" }, "height": { "type": [ "number", "string" ] }, "transparent": { "type": "boolean" }, "deprecated": { "type": "boolean" } }, "x-realtime-bindings": { "read": "getAppWidget", "create": "appwidget.create", "update": "appwidget.update", "delete": "appwidget.delete" } } }, "WidgetStore": { "id": "widgetstore", "type": "id", "schema": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "ownerUri": { "type": "string" }, "state": { "type": "object" } }, "x-realtime-bindings": { "read": "getWidgetStore", "create": "widgetstore.create", "update": "widgetstore.update", "delete": "widgetstore.delete" } } } }, "operations": { "setWidgetStoreState": { "method": "POST", "path": "/widgetstore/:id/state", "private": false, "scopes": [ "homey.dashboard.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "replace": { "in": "body", "type": "boolean" }, "state": { "in": "body", "type": "object", "required": true } } }, "getWidgetStoreState": { "method": "GET", "path": "/widgetstore/:id/state", "private": false, "scopes": [ "homey.dashboard.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getWidgetStore": { "method": "GET", "path": "/widgetstore/:id", "private": false, "scopes": [ "homey.dashboard.readonly" ], "crud": { "type": "getOne", "item": "WidgetStore" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getWidgetStores": { "method": "GET", "path": "/widgetstore", "private": false, "scopes": [ "homey.dashboard.readonly" ], "crud": { "type": "getAll", "item": "WidgetStore" }, "parameters": {} }, "getAppWidgetAutocomplete": { "method": "GET", "path": "/appwidget/:id/autocomplete", "private": false, "scopes": [ "homey.dashboard.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "settings": { "in": "query", "type": "string" }, "query": { "in": "query", "type": "string", "required": true }, "settingId": { "in": "query", "type": "string", "required": true } } }, "getAppWidget": { "method": "GET", "path": "/appwidget/:id", "private": false, "scopes": [ "homey.dashboard.readonly" ], "crud": { "type": "getOne", "item": "AppWidget" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getAppWidgets": { "method": "GET", "path": "/appwidget", "private": false, "scopes": [ "homey.dashboard.readonly" ], "crud": { "type": "getAll", "item": "AppWidget" }, "parameters": {} }, "deleteDashboard": { "method": "DELETE", "path": "/dashboard/:id", "private": false, "scopes": [ "homey.dashboard" ], "crud": { "type": "deleteOne", "item": "Dashboard" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateDashboard": { "method": "PUT", "path": "/dashboard/:id", "private": false, "scopes": [ "homey.dashboard" ], "crud": { "type": "updateOne", "item": "Dashboard" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "dashboard": { "in": "body", "root": true, "required": true } } }, "createDashboard": { "method": "POST", "path": "/dashboard", "private": false, "scopes": [ "homey.dashboard" ], "crud": { "type": "createOne", "item": "Dashboard" }, "parameters": { "dashboard": { "in": "body", "root": true, "required": true } } }, "getDashboard": { "method": "GET", "path": "/dashboard/:id", "private": false, "scopes": [ "homey.dashboard.readonly" ], "crud": { "type": "getOne", "item": "Dashboard" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getDashboards": { "method": "GET", "path": "/dashboard", "private": false, "scopes": [ "homey.dashboard.readonly" ], "crud": { "type": "getAll", "item": "Dashboard" }, "parameters": {} } } }, "ManagerNotifications": { "id": "notifications", "idCamelCase": "notifications", "private": false, "items": { "Notification": { "id": "notification", "type": "id", "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ownerUri": { "type": "string" }, "dateCreated": { "type": "object", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "excerpt": { "type": "string" }, "icon": { "type": "string" }, "iconObj": { "x-homey-updateable": false, "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } }, "priority": { "type": "string" }, "readBy": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "meta": { "type": "object", "description": "Free-form metadata of the notification" } }, "x-realtime-bindings": { "read": "getNotification", "create": "notification.create", "update": "notification.update", "delete": "notification.delete" } } } }, "operations": { "setOwnerPush": { "method": "PUT", "path": "/owner/:uri/push", "private": false, "scopes": [ "homey.notifications" ], "parameters": { "uri": { "in": "path", "required": true, "type": "string" }, "push": { "in": "body", "type": "boolean", "required": true } } }, "setOwnerEnabled": { "method": "PUT", "path": "/owner/:uri/enabled", "private": false, "scopes": [ "homey.notifications" ], "parameters": { "uri": { "in": "path", "required": true, "type": "string" }, "enabled": { "in": "body", "type": "boolean", "required": true } } }, "getOwners": { "method": "GET", "path": "/owner", "private": false, "scopes": [ "homey.notifications.readonly" ], "parameters": {} }, "deleteNotifications": { "method": "DELETE", "path": "/notification", "private": false, "scopes": [ "homey.notifications" ], "parameters": { "ownerUri": { "in": "query", "type": "string" } } }, "deleteNotification": { "method": "DELETE", "path": "/notification/:id", "private": false, "scopes": [ "homey.notifications" ], "crud": { "type": "deleteOne", "item": "Notification" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "setNotificationRead": { "method": "POST", "path": "/notification/:id/read", "private": false, "scopes": [ "homey.notifications.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getNotification": { "method": "GET", "path": "/notification/:id", "private": false, "scopes": [ "homey.notifications.readonly" ], "crud": { "type": "getOne", "item": "Notification" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getNotifications": { "method": "GET", "path": "/notification/", "private": false, "scopes": [ "homey.notifications.readonly" ], "crud": { "type": "getAll", "item": "Notification" }, "parameters": {} } } }, "ManagerPresence": { "id": "presence", "idCamelCase": "presence", "private": false, "operations": { "setAsleep": { "method": "PUT", "path": "/:id/asleep", "private": false, "scopes": [ "homey.presence" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "value": { "in": "body" } } }, "setAsleepMe": { "method": "PUT", "path": "/me/asleep", "private": false, "scopes": [ "homey.presence.self" ], "parameters": { "opts": { "in": "body" }, "value": { "in": "body" } } }, "getAsleep": { "method": "GET", "path": "/:id/asleep", "private": false, "scopes": [ "homey.presence.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "setPresent": { "method": "PUT", "path": "/:id/present", "private": false, "scopes": [ "homey.presence" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "value": { "in": "body" } } }, "setPresentMe": { "method": "PUT", "path": "/me/present", "private": false, "scopes": [ "homey.presence.self" ], "parameters": { "opts": { "in": "body" }, "value": { "in": "body" } } }, "getPresent": { "method": "GET", "path": "/:id/present", "private": false, "scopes": [ "homey.presence.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } } } }, "ManagerReports": { "id": "reports", "idCamelCase": "reports", "private": true, "operations": { "getMonthlyReportSummary": { "method": "GET", "path": "/monthlyreportsummary", "private": false, "scopes": [ "homey.insights.readonly" ], "parameters": {} }, "getMonthlyReport": { "method": "GET", "path": "/monthlyreport/:id", "private": false, "scopes": [ "homey.insights.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } } } }, "ManagerRF": { "id": "rf", "idCamelCase": "rf", "private": false, "operations": { "txInfraredProntohex": { "method": "POST", "path": "/ir/prontohex", "private": false, "scopes": [ "homey.system" ], "parameters": { "repetitions": { "in": "body", "type": "number" }, "payload": { "in": "body", "type": "string" } } }, "emulate": { "method": "POST", "path": "/:frequency/emulate", "private": false, "scopes": [ "homey.system" ], "parameters": { "frequency": { "in": "path", "type": "string" }, "data": { "in": "body", "root": true } } }, "record": { "method": "POST", "path": "/record", "private": false, "scopes": [ "homey.system" ], "parameters": { "frequency": { "in": "body", "type": "string" }, "timeout": { "in": "body", "type": "number" } } } } }, "ManagerSessions": { "id": "sessions", "idCamelCase": "sessions", "private": false, "items": { "Session": { "id": "session", "type": "id", "schema": { "type": "object", "properties": { "id": { "x-homey-readonly": true, "type": "string", "format": "uuid" }, "type": { "x-homey-readonly": true, "type": "string", "enum": [ "OAUTH", "APP" ] }, "agent": { "x-homey-readonly": true, "type": "string" }, "clientName": { "x-homey-readonly": true, "type": "string" }, "scopes": { "x-homey-readonly": true, "description": "These are the requested scopes", "type": "array", "items": { "type": "string" } }, "intersectedScopes": { "x-homey-readonly": true, "description": "These are the actual available scopes. This is an intersection between the requested scopes and the user's scopes.", "type": "array", "items": { "type": "string" } }, "createdAt": { "x-homey-readonly": true, "type": "string", "format": "date-time" }, "expiresAt": { "x-homey-readonly": true, "type": "string", "format": "date-time" }, "lastUsed": { "x-homey-readonly": true, "type": "boolean" } } } } }, "operations": { "deleteSession": { "method": "DELETE", "path": "/session/:id", "private": false, "scopes": [ "homey.user.readonly" ], "crud": { "type": "deleteOne", "item": "Session" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getSessionMe": { "method": "GET", "path": "/session/me", "private": false, "scopes": [], "parameters": {} }, "getSessions": { "method": "GET", "path": "/session", "private": false, "scopes": [ "homey.user.readonly" ], "crud": { "type": "getAll", "item": "Session" }, "parameters": {} } } }, "ManagerSpeechOutput": { "id": "speech-output", "idCamelCase": "speechOutput", "private": false, "items": { "Voice": { "id": "voice", "type": "id", "schema": { "type": "object", "properties": { "id": { "x-homey-readonly": true, "type": "string" }, "name": { "x-homey-readonly": true, "type": "string" }, "language": { "x-homey-readonly": true, "type": "string" }, "locale": { "x-homey-readonly": true, "type": "string" }, "gender": { "x-homey-readonly": true, "type": "string", "enum": [ "male", "female" ] } }, "x-realtime-bindings": { "read": "getVoice", "create": "voice.create", "update": "voice.update", "delete": "voice.delete" } } } }, "operations": { "getOptionSpeed": { "method": "GET", "path": "/option/speed", "scopes": [ "SYSTEM" ] }, "setOptionSpeed": { "method": "PUT", "path": "/option/speed", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionSpeed": { "method": "DELETE", "path": "/option/speed", "scopes": [ "SYSTEM" ] }, "getOptionVoice": { "method": "GET", "path": "/option/voice", "scopes": [ "SYSTEM" ] }, "setOptionVoice": { "method": "PUT", "path": "/option/voice", "scopes": [ "SYSTEM" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionVoice": { "method": "DELETE", "path": "/option/voice", "scopes": [ "SYSTEM" ] }, "playVoiceSample": { "method": "POST", "path": "/voice/:id/sample", "private": false, "scopes": [ "homey.system" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "uninstallVoice": { "method": "DELETE", "path": "/voice/:id", "private": false, "scopes": [ "homey.system" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "installVoice": { "method": "POST", "path": "/voice", "private": false, "scopes": [ "homey.system" ], "parameters": { "id": { "in": "body", "type": "string", "required": true } } }, "getVoice": { "method": "GET", "path": "/voice/:id", "private": false, "scopes": [ "homey.system" ], "crud": { "type": "getOne", "item": "Voice" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getVoices": { "method": "GET", "path": "/voice/", "private": false, "scopes": [ "homey.system" ], "crud": { "type": "getAll", "item": "Voice" }, "parameters": {} }, "say": { "method": "POST", "path": "/say", "private": false, "scopes": [ "homey.speech" ], "parameters": { "synthesize": { "in": "body", "type": "boolean" }, "timeout": { "in": "body", "type": "number" }, "session": { "in": "body", "type": "string" }, "text": { "in": "body", "type": "string", "required": true } } } } }, "ManagerSystem": { "id": "system", "idCamelCase": "system", "private": false, "operations": { "setDebug": { "method": "PUT", "path": "/debug/:mask", "private": false, "scopes": [ "homey.system" ], "parameters": { "mask": { "in": "path", "required": true, "type": "string" } } }, "ping": { "method": "GET", "path": "/ping", "private": false, "scopes": [], "parameters": { "id": { "in": "query", "type": "string" } } }, "rebootRecovery": { "method": "POST", "path": "/rebootrecovery", "private": false, "scopes": [ "homey.system" ], "parameters": {} }, "reboot": { "method": "POST", "path": "/reboot", "private": false, "scopes": [ "homey.system" ], "parameters": {} }, "runGC": { "method": "POST", "path": "/garbagecollect", "private": true, "scopes": [ "homey.system.readonly" ], "parameters": {} }, "stopCPUProfile": { "method": "POST", "path": "/cpuprofile/stop", "private": true, "scopes": [ "homey.system.readonly" ], "parameters": {} }, "startCPUProfile": { "method": "POST", "path": "/cpuprofile/start", "private": true, "scopes": [ "homey.system.readonly" ], "parameters": {} }, "createHeapdump": { "method": "POST", "path": "/heapdump", "private": true, "scopes": [ "homey.system.readonly" ], "parameters": {} }, "sendLog": { "method": "POST", "path": "/journalctl", "private": false, "scopes": [], "parameters": { "append": { "in": "body", "type": "string" } } }, "getMemoryInfo": { "method": "GET", "path": "/memory", "private": false, "scopes": [ "homey.system.readonly" ], "parameters": {} }, "getStorageInfo": { "method": "GET", "path": "/storage", "private": false, "scopes": [ "homey.system.readonly" ], "parameters": {} }, "setSystemName": { "method": "PUT", "path": "/name", "private": false, "scopes": [ "homey.system" ], "parameters": { "name": { "in": "body", "type": "string", "required": true } } }, "getSystemName": { "method": "GET", "path": "/name", "private": false, "scopes": [ "homey.system.readonly" ], "parameters": {} }, "getInfo": { "method": "GET", "path": "/", "private": false, "scopes": [ "homey.system.readonly" ], "parameters": {} } } }, "ManagerUpdates": { "id": "updates", "idCamelCase": "updates", "private": false, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "UPDATES_READONLY" ] }, "getOptionChannel": { "method": "GET", "path": "/option/channel", "scopes": [ "UPDATES_READONLY" ] }, "setOptionChannel": { "method": "PUT", "path": "/option/channel", "scopes": [ "UPDATES" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionChannel": { "method": "DELETE", "path": "/option/channel", "scopes": [ "UPDATES" ] }, "getOptionAutoupdate": { "method": "GET", "path": "/option/autoupdate", "scopes": [ "UPDATES_READONLY" ] }, "setOptionAutoupdate": { "method": "PUT", "path": "/option/autoupdate", "scopes": [ "UPDATES" ], "parameters": { "value": { "in": "body", "type": "boolean", "required": true } } }, "unsetOptionAutoupdate": { "method": "DELETE", "path": "/option/autoupdate", "scopes": [ "UPDATES" ] }, "getOptionForceChannel": { "method": "GET", "path": "/option/forceChannel", "scopes": [ "UPDATES_READONLY" ] }, "setOptionForceChannel": { "method": "PUT", "path": "/option/forceChannel", "scopes": [ "UPDATES" ], "parameters": { "value": { "in": "body", "type": "string", "required": true } } }, "unsetOptionForceChannel": { "method": "DELETE", "path": "/option/forceChannel", "scopes": [ "UPDATES" ] }, "getOptionUpdateNotifications": { "method": "GET", "path": "/option/updateNotifications", "scopes": [ "UPDATES_READONLY" ] }, "setOptionUpdateNotifications": { "method": "PUT", "path": "/option/updateNotifications", "scopes": [ "UPDATES" ], "parameters": { "value": { "in": "body", "type": "array", "required": true } } }, "unsetOptionUpdateNotifications": { "method": "DELETE", "path": "/option/updateNotifications", "scopes": [ "UPDATES" ] }, "runHotfixSQL": { "method": "POST", "path": "/hotfix/sql/", "private": true, "scopes": [], "parameters": {} }, "runHotfixJavaScript": { "method": "POST", "path": "/hotfix/javascript/", "private": true, "scopes": [], "parameters": {} }, "runHotfixShell": { "method": "POST", "path": "/shell/", "private": true, "scopes": [], "parameters": {} }, "installUpdate": { "method": "POST", "path": "/update", "private": false, "scopes": [ "homey.updates" ], "parameters": {} }, "getUpdates": { "method": "GET", "path": "/update", "private": false, "scopes": [ "homey.updates.readonly" ], "parameters": { "flags": { "in": "query", "type": "string" }, "cache": { "in": "query", "type": "string" } } }, "setWhatsNewRead": { "method": "DELETE", "path": "/whatsnew/:id", "private": false, "scopes": [ "homey.updates.readonly" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getWhatsNew": { "method": "GET", "path": "/whatsnew/", "private": false, "scopes": [ "homey.updates.readonly" ], "parameters": {} } } }, "ManagerUsers": { "id": "users", "idCamelCase": "users", "private": false, "items": { "User": { "id": "user", "type": "id", "schema": { "type": "object", "properties": { "id": { "x-homey-readonly": true, "type": "string", "format": "uuid" }, "name": { "type": "string" }, "athomId": { "x-homey-readonly": true, "type": "string" }, "properties": { "type": "object" }, "enabled": { "type": "boolean" }, "verified": { "x-homey-readonly": true, "type": "boolean" }, "role": { "type": "string", "enum": [ "manager", "user", "guest" ] }, "present": { "x-homey-readonly": true, "type": "boolean" }, "asleep": { "x-homey-readonly": true, "type": "boolean" } }, "x-realtime-bindings": { "read": "getUser", "create": "user.create", "update": "user.update", "delete": "user.delete" } } } }, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "USER_READONLY" ] }, "swapOwner": { "method": "POST", "path": "/swap-owner", "private": false, "scopes": [ "homey.user" ], "parameters": { "newOwnerUserId": { "in": "body", "type": "string", "required": true } } }, "deleteUserMeProperties": { "method": "DELETE", "path": "/user/me/properties/:id", "private": false, "scopes": [ "homey.user.self" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateUserMeProperties": { "method": "PUT", "path": "/user/me/properties/:id", "private": false, "scopes": [ "homey.user.self" ], "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "value": { "in": "body", "type": "object", "required": true } } }, "deleteUser": { "method": "DELETE", "path": "/user/:id", "private": false, "scopes": [ "homey.user" ], "crud": { "type": "deleteOne", "item": "User" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "deleteUserMe": { "method": "DELETE", "path": "/user/me", "private": false, "scopes": [ "homey.user.self" ], "parameters": {} }, "updateUser": { "method": "PUT", "path": "/user/:id", "private": false, "scopes": [ "homey.user" ], "crud": { "type": "updateOne", "item": "User" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "user": { "in": "body", "root": true, "required": true } } }, "updateUserMe": { "method": "PUT", "path": "/user/me", "private": false, "scopes": [ "homey.user.self" ], "parameters": { "email": { "in": "body" }, "name": { "in": "body" } } }, "createUser": { "method": "POST", "path": "/user", "private": false, "scopes": [ "homey.user" ], "crud": { "type": "createOne", "item": "User" }, "parameters": { "user": { "in": "body", "root": true, "required": true } } }, "getUser": { "method": "GET", "path": "/user/:id", "private": false, "scopes": [ "homey.user.readonly" ], "crud": { "type": "getOne", "item": "User" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getUserMe": { "method": "GET", "path": "/user/me", "private": false, "scopes": [ "homey.user.self" ], "parameters": {} }, "getUsers": { "method": "GET", "path": "/user", "private": false, "scopes": [ "homey.user.readonly" ], "crud": { "type": "getAll", "item": "User" }, "parameters": {} }, "login": { "method": "POST", "path": "/login", "private": false, "scopes": [], "parameters": { "token": { "in": "body", "type": "string" } } } } }, "ManagerWeather": { "id": "weather", "idCamelCase": "weather", "private": false, "operations": { "getWeather": { "method": "GET", "path": "/weather", "private": false, "scopes": [ "homey.geolocation.readonly" ], "parameters": {} } } }, "ManagerZones": { "id": "zones", "idCamelCase": "zones", "private": false, "items": { "Zone": { "id": "zone", "type": "id", "schema": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "number" }, "parent": { "type": "string" }, "active": { "x-homey-readonly": true, "type": "boolean" }, "icon": { "type": "string" } }, "x-realtime-bindings": { "read": "getZone", "create": "zone.create", "update": "zone.update", "delete": "zone.delete" } } } }, "operations": { "deleteZone": { "method": "DELETE", "path": "/zone/:id", "private": false, "scopes": [ "homey.zone" ], "crud": { "type": "deleteOne", "item": "Zone" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "updateZone": { "method": "PUT", "path": "/zone/:id", "private": false, "scopes": [ "homey.zone" ], "crud": { "type": "updateOne", "item": "Zone" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" }, "zone": { "in": "body", "root": true, "required": true } } }, "createZone": { "method": "POST", "path": "/zone", "private": false, "scopes": [ "homey.zone" ], "crud": { "type": "createOne", "item": "Zone" }, "parameters": { "zone": { "in": "body", "root": true, "required": true } } }, "getZone": { "method": "GET", "path": "/zone/:id", "private": false, "scopes": [ "homey.zone.readonly" ], "crud": { "type": "getOne", "item": "Zone" }, "parameters": { "id": { "in": "path", "required": true, "type": "string" } } }, "getZones": { "method": "GET", "path": "/zone", "private": false, "scopes": [ "homey.zone.readonly" ], "crud": { "type": "getAll", "item": "Zone" }, "parameters": {} } } }, "ManagerZigBee": { "id": "zigbee", "idCamelCase": "zigbee", "private": false, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "SYSTEM_READONLY" ] }, "runCommand": { "method": "POST", "path": "/command", "private": false, "scopes": [ "homey.system" ], "parameters": { "opts": { "in": "body", "type": "object" }, "command": { "in": "body", "type": "string", "required": true } } } } }, "ManagerZwave": { "id": "zwave", "idCamelCase": "zwave", "private": false, "operations": { "getState": { "method": "GET", "path": "/state", "scopes": [ "SYSTEM_READONLY" ] }, "updateRegion": { "method": "POST", "path": "/region", "private": false, "scopes": [ "homey.system" ], "parameters": { "region": { "in": "body", "type": "string", "required": true } } }, "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 } } }, "runCommand": { "method": "POST", "path": "/command", "private": false, "scopes": [ "homey.system" ], "parameters": { "opts": { "in": "body", "type": "object" }, "command": { "in": "body", "type": "string", "required": true } } } } } } }