homey-api 3.8.0 → 3.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -599,6 +599,32 @@
599
599
  }
600
600
  }
601
601
  },
602
+ "getAuthenticatedUserNewsletterStatus": {
603
+ "path": "/user/me/newsletter",
604
+ "method": "get",
605
+ "parameters": {}
606
+ },
607
+ "subscribeAuthenticatedUserToNewsletter": {
608
+ "path": "/user/me/newsletter",
609
+ "method": "post",
610
+ "parameters": {
611
+ "data": {
612
+ "in": "body",
613
+ "type": "object",
614
+ "unpack": true,
615
+ "properties": {
616
+ "language": {
617
+ "type": "string"
618
+ }
619
+ }
620
+ }
621
+ }
622
+ },
623
+ "unsubscribeAuthenticatedUserFromNewsletter": {
624
+ "path": "/user/me/newsletter",
625
+ "method": "delete",
626
+ "parameters": {}
627
+ },
602
628
  "getBridges": {
603
629
  "path": "/bridge/",
604
630
  "method": "get",
@@ -1313,8 +1313,145 @@
1313
1313
  "ManagerEnergy": {
1314
1314
  "id": "energy",
1315
1315
  "idCamelCase": "energy",
1316
- "items": {},
1316
+ "items": {
1317
+ "EnergyReportHour": {
1318
+ "id": "energyreporthour",
1319
+ "schema": {
1320
+ "type": "object",
1321
+ "properties": {
1322
+ "id": {
1323
+ "type": "string"
1324
+ }
1325
+ }
1326
+ }
1327
+ },
1328
+ "EnergyReportDay": {
1329
+ "id": "energyreportday",
1330
+ "schema": {
1331
+ "type": "object",
1332
+ "properties": {
1333
+ "id": {
1334
+ "type": "string"
1335
+ }
1336
+ }
1337
+ }
1338
+ },
1339
+ "EnergyReportWeek": {
1340
+ "id": "energyreportweek",
1341
+ "schema": {
1342
+ "type": "object",
1343
+ "properties": {
1344
+ "id": {
1345
+ "type": "string"
1346
+ }
1347
+ }
1348
+ }
1349
+ },
1350
+ "EnergyReportMonth": {
1351
+ "id": "energyreportmonth",
1352
+ "schema": {
1353
+ "type": "object",
1354
+ "properties": {
1355
+ "id": {
1356
+ "type": "string"
1357
+ }
1358
+ }
1359
+ }
1360
+ },
1361
+ "EnergyReportYear": {
1362
+ "id": "energyreportyear",
1363
+ "schema": {
1364
+ "type": "object",
1365
+ "properties": {
1366
+ "id": {
1367
+ "type": "string"
1368
+ }
1369
+ }
1370
+ }
1371
+ }
1372
+ },
1317
1373
  "operations": {
1374
+ "getOptionElectricityPriceFixed": {
1375
+ "method": "GET",
1376
+ "path": "/option/electricityPriceFixed",
1377
+ "scopes": [
1378
+ "homey.energy.readonly"
1379
+ ]
1380
+ },
1381
+ "setOptionElectricityPriceFixed": {
1382
+ "method": "PUT",
1383
+ "path": "/option/electricityPriceFixed",
1384
+ "scopes": [
1385
+ "homey.energy"
1386
+ ],
1387
+ "parameters": {
1388
+ "value": {
1389
+ "in": "body",
1390
+ "required": true
1391
+ }
1392
+ }
1393
+ },
1394
+ "unsetOptionElectricityPriceFixed": {
1395
+ "method": "DELETE",
1396
+ "path": "/option/electricityPriceFixed",
1397
+ "scopes": [
1398
+ "homey.energy"
1399
+ ]
1400
+ },
1401
+ "getOptionGasPriceFixed": {
1402
+ "method": "GET",
1403
+ "path": "/option/gasPriceFixed",
1404
+ "scopes": [
1405
+ "homey.energy.readonly"
1406
+ ]
1407
+ },
1408
+ "setOptionGasPriceFixed": {
1409
+ "method": "PUT",
1410
+ "path": "/option/gasPriceFixed",
1411
+ "scopes": [
1412
+ "homey.energy"
1413
+ ],
1414
+ "parameters": {
1415
+ "value": {
1416
+ "in": "body",
1417
+ "required": true
1418
+ }
1419
+ }
1420
+ },
1421
+ "unsetOptionGasPriceFixed": {
1422
+ "method": "DELETE",
1423
+ "path": "/option/gasPriceFixed",
1424
+ "scopes": [
1425
+ "homey.energy"
1426
+ ]
1427
+ },
1428
+ "getOptionWaterPriceFixed": {
1429
+ "method": "GET",
1430
+ "path": "/option/waterPriceFixed",
1431
+ "scopes": [
1432
+ "homey.energy.readonly"
1433
+ ]
1434
+ },
1435
+ "setOptionWaterPriceFixed": {
1436
+ "method": "PUT",
1437
+ "path": "/option/waterPriceFixed",
1438
+ "scopes": [
1439
+ "homey.energy"
1440
+ ],
1441
+ "parameters": {
1442
+ "value": {
1443
+ "in": "body",
1444
+ "required": true
1445
+ }
1446
+ }
1447
+ },
1448
+ "unsetOptionWaterPriceFixed": {
1449
+ "method": "DELETE",
1450
+ "path": "/option/waterPriceFixed",
1451
+ "scopes": [
1452
+ "homey.energy"
1453
+ ]
1454
+ },
1318
1455
  "getState": {
1319
1456
  "method": "get",
1320
1457
  "path": "/state",
@@ -1329,7 +1466,7 @@
1329
1466
  "path": "/live",
1330
1467
  "private": false,
1331
1468
  "scopes": [
1332
- "homey.insights.readonly"
1469
+ "homey.energy.readonly"
1333
1470
  ],
1334
1471
  "parameters": {
1335
1472
  "zone": {
@@ -1337,6 +1474,150 @@
1337
1474
  "type": "string"
1338
1475
  }
1339
1476
  }
1477
+ },
1478
+ "getReportDay": {
1479
+ "method": "get",
1480
+ "path": "/report/day",
1481
+ "private": false,
1482
+ "scopes": [
1483
+ "homey.energy.readonly"
1484
+ ],
1485
+ "parameters": {
1486
+ "date": {
1487
+ "in": "query",
1488
+ "type": "string"
1489
+ }
1490
+ }
1491
+ },
1492
+ "getReportWeek": {
1493
+ "method": "get",
1494
+ "path": "/report/week",
1495
+ "private": false,
1496
+ "scopes": [
1497
+ "homey.energy.readonly"
1498
+ ],
1499
+ "parameters": {
1500
+ "isoWeek": {
1501
+ "in": "query",
1502
+ "type": "string"
1503
+ }
1504
+ }
1505
+ },
1506
+ "getReportMonth": {
1507
+ "method": "get",
1508
+ "path": "/report/month",
1509
+ "private": false,
1510
+ "scopes": [
1511
+ "homey.energy.readonly"
1512
+ ],
1513
+ "parameters": {
1514
+ "yearMonth": {
1515
+ "in": "query",
1516
+ "type": "string"
1517
+ }
1518
+ }
1519
+ },
1520
+ "getReportYear": {
1521
+ "method": "get",
1522
+ "path": "/report/year",
1523
+ "private": false,
1524
+ "scopes": [
1525
+ "homey.energy.readonly"
1526
+ ],
1527
+ "parameters": {
1528
+ "year": {
1529
+ "in": "query",
1530
+ "type": "string"
1531
+ }
1532
+ }
1533
+ },
1534
+ "getReportsAvailable": {
1535
+ "method": "get",
1536
+ "path": "/reports/available",
1537
+ "private": false,
1538
+ "scopes": [
1539
+ "homey.energy.readonly"
1540
+ ],
1541
+ "parameters": {}
1542
+ },
1543
+ "getCurrency": {
1544
+ "method": "get",
1545
+ "path": "/currency",
1546
+ "private": false,
1547
+ "scopes": [
1548
+ "homey.energy.readonly"
1549
+ ],
1550
+ "parameters": {}
1551
+ },
1552
+ "deleteReports": {
1553
+ "method": "delete",
1554
+ "path": "/reports",
1555
+ "private": false,
1556
+ "scopes": [
1557
+ "homey.energy"
1558
+ ],
1559
+ "parameters": {}
1560
+ },
1561
+ "resetReportDayCategories": {
1562
+ "method": "put",
1563
+ "path": "/report/day/reset/categories",
1564
+ "private": false,
1565
+ "scopes": [
1566
+ "homey.energy"
1567
+ ],
1568
+ "parameters": {
1569
+ "options": {
1570
+ "in": "body",
1571
+ "type": "object",
1572
+ "required": true,
1573
+ "properties": {
1574
+ "date": {
1575
+ "type": "string"
1576
+ },
1577
+ "categories": {
1578
+ "type": "array"
1579
+ },
1580
+ "deviceIds": {
1581
+ "type": "array"
1582
+ }
1583
+ }
1584
+ }
1585
+ }
1586
+ },
1587
+ "enableDummyEnergyReports": {
1588
+ "method": "post",
1589
+ "path": "/reports/dummy/enable",
1590
+ "private": true,
1591
+ "scopes": [
1592
+ "homey.energy"
1593
+ ],
1594
+ "parameters": {
1595
+ "fromDate": {
1596
+ "in": "query",
1597
+ "type": "string"
1598
+ },
1599
+ "toDate": {
1600
+ "in": "query",
1601
+ "type": "string"
1602
+ },
1603
+ "randomness": {
1604
+ "in": "query",
1605
+ "type": "string"
1606
+ },
1607
+ "numTopConsumers": {
1608
+ "in": "query",
1609
+ "type": "string"
1610
+ }
1611
+ }
1612
+ },
1613
+ "disableDummyEnergyReports": {
1614
+ "method": "post",
1615
+ "path": "/reports/dummy/disable",
1616
+ "private": true,
1617
+ "scopes": [
1618
+ "homey.energy"
1619
+ ],
1620
+ "parameters": {}
1340
1621
  }
1341
1622
  }
1342
1623
  },
@@ -1479,6 +1760,10 @@
1479
1760
  "persistent": {
1480
1761
  "in": "body",
1481
1762
  "type": "boolean"
1763
+ },
1764
+ "dataRequestActiveState": {
1765
+ "in": "body",
1766
+ "type": "string"
1482
1767
  }
1483
1768
  }
1484
1769
  },
@@ -4456,6 +4741,30 @@
4456
4741
  "type": "object"
4457
4742
  }
4458
4743
  }
4744
+ },
4745
+ "getLog": {
4746
+ "method": "get",
4747
+ "path": "/log",
4748
+ "private": false,
4749
+ "scopes": [
4750
+ "homey.system"
4751
+ ],
4752
+ "parameters": {}
4753
+ },
4754
+ "setLogEnabled": {
4755
+ "method": "put",
4756
+ "path": "/log",
4757
+ "private": false,
4758
+ "scopes": [
4759
+ "homey.system"
4760
+ ],
4761
+ "parameters": {
4762
+ "enabled": {
4763
+ "in": "body",
4764
+ "type": "boolean",
4765
+ "required": true
4766
+ }
4767
+ }
4459
4768
  }
4460
4769
  }
4461
4770
  },
@@ -4537,4 +4846,4 @@
4537
4846
  }
4538
4847
  }
4539
4848
  }
4540
- }
4849
+ }
@@ -1734,8 +1734,145 @@
1734
1734
  "ManagerEnergy": {
1735
1735
  "id": "energy",
1736
1736
  "idCamelCase": "energy",
1737
- "items": {},
1737
+ "items": {
1738
+ "EnergyReportHour": {
1739
+ "id": "energyreporthour",
1740
+ "schema": {
1741
+ "type": "object",
1742
+ "properties": {
1743
+ "id": {
1744
+ "type": "string"
1745
+ }
1746
+ }
1747
+ }
1748
+ },
1749
+ "EnergyReportDay": {
1750
+ "id": "energyreportday",
1751
+ "schema": {
1752
+ "type": "object",
1753
+ "properties": {
1754
+ "id": {
1755
+ "type": "string"
1756
+ }
1757
+ }
1758
+ }
1759
+ },
1760
+ "EnergyReportWeek": {
1761
+ "id": "energyreportweek",
1762
+ "schema": {
1763
+ "type": "object",
1764
+ "properties": {
1765
+ "id": {
1766
+ "type": "string"
1767
+ }
1768
+ }
1769
+ }
1770
+ },
1771
+ "EnergyReportMonth": {
1772
+ "id": "energyreportmonth",
1773
+ "schema": {
1774
+ "type": "object",
1775
+ "properties": {
1776
+ "id": {
1777
+ "type": "string"
1778
+ }
1779
+ }
1780
+ }
1781
+ },
1782
+ "EnergyReportYear": {
1783
+ "id": "energyreportyear",
1784
+ "schema": {
1785
+ "type": "object",
1786
+ "properties": {
1787
+ "id": {
1788
+ "type": "string"
1789
+ }
1790
+ }
1791
+ }
1792
+ }
1793
+ },
1738
1794
  "operations": {
1795
+ "getOptionElectricityPriceFixed": {
1796
+ "method": "GET",
1797
+ "path": "/option/electricityPriceFixed",
1798
+ "scopes": [
1799
+ "homey.energy.readonly"
1800
+ ]
1801
+ },
1802
+ "setOptionElectricityPriceFixed": {
1803
+ "method": "PUT",
1804
+ "path": "/option/electricityPriceFixed",
1805
+ "scopes": [
1806
+ "homey.energy"
1807
+ ],
1808
+ "parameters": {
1809
+ "value": {
1810
+ "in": "body",
1811
+ "required": true
1812
+ }
1813
+ }
1814
+ },
1815
+ "unsetOptionElectricityPriceFixed": {
1816
+ "method": "DELETE",
1817
+ "path": "/option/electricityPriceFixed",
1818
+ "scopes": [
1819
+ "homey.energy"
1820
+ ]
1821
+ },
1822
+ "getOptionGasPriceFixed": {
1823
+ "method": "GET",
1824
+ "path": "/option/gasPriceFixed",
1825
+ "scopes": [
1826
+ "homey.energy.readonly"
1827
+ ]
1828
+ },
1829
+ "setOptionGasPriceFixed": {
1830
+ "method": "PUT",
1831
+ "path": "/option/gasPriceFixed",
1832
+ "scopes": [
1833
+ "homey.energy"
1834
+ ],
1835
+ "parameters": {
1836
+ "value": {
1837
+ "in": "body",
1838
+ "required": true
1839
+ }
1840
+ }
1841
+ },
1842
+ "unsetOptionGasPriceFixed": {
1843
+ "method": "DELETE",
1844
+ "path": "/option/gasPriceFixed",
1845
+ "scopes": [
1846
+ "homey.energy"
1847
+ ]
1848
+ },
1849
+ "getOptionWaterPriceFixed": {
1850
+ "method": "GET",
1851
+ "path": "/option/waterPriceFixed",
1852
+ "scopes": [
1853
+ "homey.energy.readonly"
1854
+ ]
1855
+ },
1856
+ "setOptionWaterPriceFixed": {
1857
+ "method": "PUT",
1858
+ "path": "/option/waterPriceFixed",
1859
+ "scopes": [
1860
+ "homey.energy"
1861
+ ],
1862
+ "parameters": {
1863
+ "value": {
1864
+ "in": "body",
1865
+ "required": true
1866
+ }
1867
+ }
1868
+ },
1869
+ "unsetOptionWaterPriceFixed": {
1870
+ "method": "DELETE",
1871
+ "path": "/option/waterPriceFixed",
1872
+ "scopes": [
1873
+ "homey.energy"
1874
+ ]
1875
+ },
1739
1876
  "getState": {
1740
1877
  "method": "get",
1741
1878
  "path": "/state",
@@ -1750,7 +1887,7 @@
1750
1887
  "path": "/live",
1751
1888
  "private": false,
1752
1889
  "scopes": [
1753
- "homey.insights.readonly"
1890
+ "homey.energy.readonly"
1754
1891
  ],
1755
1892
  "parameters": {
1756
1893
  "zone": {
@@ -1758,6 +1895,150 @@
1758
1895
  "type": "string"
1759
1896
  }
1760
1897
  }
1898
+ },
1899
+ "getReportDay": {
1900
+ "method": "get",
1901
+ "path": "/report/day",
1902
+ "private": false,
1903
+ "scopes": [
1904
+ "homey.energy.readonly"
1905
+ ],
1906
+ "parameters": {
1907
+ "date": {
1908
+ "in": "query",
1909
+ "type": "string"
1910
+ }
1911
+ }
1912
+ },
1913
+ "getReportWeek": {
1914
+ "method": "get",
1915
+ "path": "/report/week",
1916
+ "private": false,
1917
+ "scopes": [
1918
+ "homey.energy.readonly"
1919
+ ],
1920
+ "parameters": {
1921
+ "isoWeek": {
1922
+ "in": "query",
1923
+ "type": "string"
1924
+ }
1925
+ }
1926
+ },
1927
+ "getReportMonth": {
1928
+ "method": "get",
1929
+ "path": "/report/month",
1930
+ "private": false,
1931
+ "scopes": [
1932
+ "homey.energy.readonly"
1933
+ ],
1934
+ "parameters": {
1935
+ "yearMonth": {
1936
+ "in": "query",
1937
+ "type": "string"
1938
+ }
1939
+ }
1940
+ },
1941
+ "getReportYear": {
1942
+ "method": "get",
1943
+ "path": "/report/year",
1944
+ "private": false,
1945
+ "scopes": [
1946
+ "homey.energy.readonly"
1947
+ ],
1948
+ "parameters": {
1949
+ "year": {
1950
+ "in": "query",
1951
+ "type": "string"
1952
+ }
1953
+ }
1954
+ },
1955
+ "getReportsAvailable": {
1956
+ "method": "get",
1957
+ "path": "/reports/available",
1958
+ "private": false,
1959
+ "scopes": [
1960
+ "homey.energy.readonly"
1961
+ ],
1962
+ "parameters": {}
1963
+ },
1964
+ "getCurrency": {
1965
+ "method": "get",
1966
+ "path": "/currency",
1967
+ "private": false,
1968
+ "scopes": [
1969
+ "homey.energy.readonly"
1970
+ ],
1971
+ "parameters": {}
1972
+ },
1973
+ "deleteReports": {
1974
+ "method": "delete",
1975
+ "path": "/reports",
1976
+ "private": false,
1977
+ "scopes": [
1978
+ "homey.energy"
1979
+ ],
1980
+ "parameters": {}
1981
+ },
1982
+ "resetReportDayCategories": {
1983
+ "method": "put",
1984
+ "path": "/report/day/reset/categories",
1985
+ "private": false,
1986
+ "scopes": [
1987
+ "homey.energy"
1988
+ ],
1989
+ "parameters": {
1990
+ "options": {
1991
+ "in": "body",
1992
+ "type": "object",
1993
+ "required": true,
1994
+ "properties": {
1995
+ "date": {
1996
+ "type": "string"
1997
+ },
1998
+ "categories": {
1999
+ "type": "array"
2000
+ },
2001
+ "deviceIds": {
2002
+ "type": "array"
2003
+ }
2004
+ }
2005
+ }
2006
+ }
2007
+ },
2008
+ "enableDummyEnergyReports": {
2009
+ "method": "post",
2010
+ "path": "/reports/dummy/enable",
2011
+ "private": true,
2012
+ "scopes": [
2013
+ "homey.energy"
2014
+ ],
2015
+ "parameters": {
2016
+ "fromDate": {
2017
+ "in": "query",
2018
+ "type": "string"
2019
+ },
2020
+ "toDate": {
2021
+ "in": "query",
2022
+ "type": "string"
2023
+ },
2024
+ "randomness": {
2025
+ "in": "query",
2026
+ "type": "string"
2027
+ },
2028
+ "numTopConsumers": {
2029
+ "in": "query",
2030
+ "type": "string"
2031
+ }
2032
+ }
2033
+ },
2034
+ "disableDummyEnergyReports": {
2035
+ "method": "post",
2036
+ "path": "/reports/dummy/disable",
2037
+ "private": true,
2038
+ "scopes": [
2039
+ "homey.energy"
2040
+ ],
2041
+ "parameters": {}
1761
2042
  }
1762
2043
  }
1763
2044
  },
@@ -1900,6 +2181,10 @@
1900
2181
  "persistent": {
1901
2182
  "in": "body",
1902
2183
  "type": "boolean"
2184
+ },
2185
+ "dataRequestActiveState": {
2186
+ "in": "body",
2187
+ "type": "string"
1903
2188
  }
1904
2189
  }
1905
2190
  },
@@ -5669,4 +5954,4 @@
5669
5954
  }
5670
5955
  }
5671
5956
  }
5672
- }
5957
+ }
@@ -768,6 +768,28 @@ export namespace HomeyAPIV3Cloud.ManagerDrivers {
768
768
  }
769
769
  }
770
770
 
771
+ export namespace HomeyAPIV3Cloud.ManagerEnergy {
772
+ export class EnergyReportDay {
773
+ id: string;
774
+ }
775
+
776
+ export class EnergyReportHour {
777
+ id: string;
778
+ }
779
+
780
+ export class EnergyReportMonth {
781
+ id: string;
782
+ }
783
+
784
+ export class EnergyReportWeek {
785
+ id: string;
786
+ }
787
+
788
+ export class EnergyReportYear {
789
+ id: string;
790
+ }
791
+ }
792
+
771
793
  export namespace HomeyAPIV3Cloud.ManagerFlow {
772
794
  export class AdvancedFlow extends HomeyAPIV3.ManagerFlow.AdvancedFlow {
773
795
  id: string;
@@ -1181,6 +1203,28 @@ export namespace HomeyAPIV3Local.ManagerDrivers {
1181
1203
  }
1182
1204
  }
1183
1205
 
1206
+ export namespace HomeyAPIV3Local.ManagerEnergy {
1207
+ export class EnergyReportDay {
1208
+ id: string;
1209
+ }
1210
+
1211
+ export class EnergyReportHour {
1212
+ id: string;
1213
+ }
1214
+
1215
+ export class EnergyReportMonth {
1216
+ id: string;
1217
+ }
1218
+
1219
+ export class EnergyReportWeek {
1220
+ id: string;
1221
+ }
1222
+
1223
+ export class EnergyReportYear {
1224
+ id: string;
1225
+ }
1226
+ }
1227
+
1184
1228
  export namespace HomeyAPIV3Local.ManagerExperiments {
1185
1229
  export class ExperimentHomeKit {
1186
1230
  id: string;
@@ -1533,6 +1577,16 @@ export class AthomCloudAPI {
1533
1577
 
1534
1578
  getAuthenticatedUser(opts: { additionalScopes?: string }): Promise<any>;
1535
1579
 
1580
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
1581
+
1582
+ subscribeAuthenticatedUserToNewsletter(opts: {
1583
+ data?: {
1584
+ language: string;
1585
+ };
1586
+ }): Promise<any>;
1587
+
1588
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
1589
+
1536
1590
  isLoggedIn(): Promise<boolean>;
1537
1591
 
1538
1592
  getAuthenticatedUser(opts?: { $cache?: object }): Promise<AthomCloudAPI.User>;
@@ -1555,6 +1609,16 @@ export class AthomCloudAPI {
1555
1609
 
1556
1610
  getAuthenticatedUser(opts: { additionalScopes?: string }): Promise<any>;
1557
1611
 
1612
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
1613
+
1614
+ subscribeAuthenticatedUserToNewsletter(opts: {
1615
+ data?: {
1616
+ language: string;
1617
+ };
1618
+ }): Promise<any>;
1619
+
1620
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
1621
+
1558
1622
  isLoggedIn(): Promise<boolean>;
1559
1623
 
1560
1624
  getAuthenticatedUser(opts?: { $cache?: object }): Promise<AthomCloudAPI.User>;
@@ -1697,6 +1761,16 @@ export class AthomCloudAPI {
1697
1761
 
1698
1762
  getAuthenticatedUser(opts: { additionalScopes?: string }): Promise<any>;
1699
1763
 
1764
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
1765
+
1766
+ subscribeAuthenticatedUserToNewsletter(opts: {
1767
+ data?: {
1768
+ language: string;
1769
+ };
1770
+ }): Promise<any>;
1771
+
1772
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
1773
+
1700
1774
  isLoggedIn(): Promise<boolean>;
1701
1775
 
1702
1776
  getAuthenticatedUser(opts?: { $cache?: object }): Promise<AthomCloudAPI.User>;
@@ -1719,6 +1793,16 @@ export class AthomCloudAPI {
1719
1793
 
1720
1794
  getAuthenticatedUser(opts: { additionalScopes?: string }): Promise<any>;
1721
1795
 
1796
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
1797
+
1798
+ subscribeAuthenticatedUserToNewsletter(opts: {
1799
+ data?: {
1800
+ language: string;
1801
+ };
1802
+ }): Promise<any>;
1803
+
1804
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
1805
+
1722
1806
  isLoggedIn(): Promise<boolean>;
1723
1807
 
1724
1808
  getAuthenticatedUser(opts?: { $cache?: object }): Promise<AthomCloudAPI.User>;
@@ -2102,9 +2186,51 @@ export namespace HomeyAPIV3Cloud {
2102
2186
  }
2103
2187
 
2104
2188
  export class ManagerEnergy extends HomeyAPIV3.ManagerEnergy {
2189
+ getOptionElectricityPriceFixed(): Promise<any>;
2190
+
2191
+ setOptionElectricityPriceFixed(opts: { value: any }): Promise<any>;
2192
+
2193
+ unsetOptionElectricityPriceFixed(): Promise<any>;
2194
+
2195
+ getOptionGasPriceFixed(): Promise<any>;
2196
+
2197
+ setOptionGasPriceFixed(opts: { value: any }): Promise<any>;
2198
+
2199
+ unsetOptionGasPriceFixed(): Promise<any>;
2200
+
2201
+ getOptionWaterPriceFixed(): Promise<any>;
2202
+
2203
+ setOptionWaterPriceFixed(opts: { value: any }): Promise<any>;
2204
+
2205
+ unsetOptionWaterPriceFixed(): Promise<any>;
2206
+
2105
2207
  getState(): Promise<any>;
2106
2208
 
2107
2209
  getLiveReport(opts: { zone?: string }): Promise<any>;
2210
+
2211
+ getReportDay(opts: { date?: string }): Promise<any>;
2212
+
2213
+ getReportWeek(opts: { isoWeek?: string }): Promise<any>;
2214
+
2215
+ getReportMonth(opts: { yearMonth?: string }): Promise<any>;
2216
+
2217
+ getReportYear(opts: { year?: string }): Promise<any>;
2218
+
2219
+ getReportsAvailable(): Promise<any>;
2220
+
2221
+ getCurrency(): Promise<any>;
2222
+
2223
+ deleteReports(): Promise<any>;
2224
+
2225
+ resetReportDayCategories(opts: {
2226
+ options: {
2227
+ date?: string;
2228
+
2229
+ categories?: Array<any>;
2230
+
2231
+ deviceIds?: Array<any>;
2232
+ };
2233
+ }): Promise<any>;
2108
2234
  }
2109
2235
 
2110
2236
  export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
@@ -2715,6 +2841,10 @@ export namespace HomeyAPIV3Cloud {
2715
2841
 
2716
2842
  opts?: object;
2717
2843
  }): Promise<any>;
2844
+
2845
+ getLog(): Promise<any>;
2846
+
2847
+ setLogEnabled(opts: { enabled: boolean }): Promise<any>;
2718
2848
  }
2719
2849
  }
2720
2850
 
@@ -3592,9 +3722,51 @@ export namespace HomeyAPIV3Local {
3592
3722
  }
3593
3723
 
3594
3724
  export class ManagerEnergy extends HomeyAPIV3.ManagerEnergy {
3725
+ getOptionElectricityPriceFixed(): Promise<any>;
3726
+
3727
+ setOptionElectricityPriceFixed(opts: { value: any }): Promise<any>;
3728
+
3729
+ unsetOptionElectricityPriceFixed(): Promise<any>;
3730
+
3731
+ getOptionGasPriceFixed(): Promise<any>;
3732
+
3733
+ setOptionGasPriceFixed(opts: { value: any }): Promise<any>;
3734
+
3735
+ unsetOptionGasPriceFixed(): Promise<any>;
3736
+
3737
+ getOptionWaterPriceFixed(): Promise<any>;
3738
+
3739
+ setOptionWaterPriceFixed(opts: { value: any }): Promise<any>;
3740
+
3741
+ unsetOptionWaterPriceFixed(): Promise<any>;
3742
+
3595
3743
  getState(): Promise<any>;
3596
3744
 
3597
3745
  getLiveReport(opts: { zone?: string }): Promise<any>;
3746
+
3747
+ getReportDay(opts: { date?: string }): Promise<any>;
3748
+
3749
+ getReportWeek(opts: { isoWeek?: string }): Promise<any>;
3750
+
3751
+ getReportMonth(opts: { yearMonth?: string }): Promise<any>;
3752
+
3753
+ getReportYear(opts: { year?: string }): Promise<any>;
3754
+
3755
+ getReportsAvailable(): Promise<any>;
3756
+
3757
+ getCurrency(): Promise<any>;
3758
+
3759
+ deleteReports(): Promise<any>;
3760
+
3761
+ resetReportDayCategories(opts: {
3762
+ options: {
3763
+ date?: string;
3764
+
3765
+ categories?: Array<any>;
3766
+
3767
+ deviceIds?: Array<any>;
3768
+ };
3769
+ }): Promise<any>;
3598
3770
  }
3599
3771
 
3600
3772
  export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
@@ -837,6 +837,28 @@ export namespace HomeyAPIV3Cloud.ManagerDrivers {
837
837
  }
838
838
  }
839
839
 
840
+ export namespace HomeyAPIV3Cloud.ManagerEnergy {
841
+ export class EnergyReportDay {
842
+ id: string;
843
+ }
844
+
845
+ export class EnergyReportHour {
846
+ id: string;
847
+ }
848
+
849
+ export class EnergyReportMonth {
850
+ id: string;
851
+ }
852
+
853
+ export class EnergyReportWeek {
854
+ id: string;
855
+ }
856
+
857
+ export class EnergyReportYear {
858
+ id: string;
859
+ }
860
+ }
861
+
840
862
  export namespace HomeyAPIV3Cloud.ManagerFlow {
841
863
  export class AdvancedFlow extends HomeyAPIV3.ManagerFlow.AdvancedFlow {
842
864
  id: string;
@@ -1282,6 +1304,28 @@ export namespace HomeyAPIV3Local.ManagerDrivers {
1282
1304
  }
1283
1305
  }
1284
1306
 
1307
+ export namespace HomeyAPIV3Local.ManagerEnergy {
1308
+ export class EnergyReportDay {
1309
+ id: string;
1310
+ }
1311
+
1312
+ export class EnergyReportHour {
1313
+ id: string;
1314
+ }
1315
+
1316
+ export class EnergyReportMonth {
1317
+ id: string;
1318
+ }
1319
+
1320
+ export class EnergyReportWeek {
1321
+ id: string;
1322
+ }
1323
+
1324
+ export class EnergyReportYear {
1325
+ id: string;
1326
+ }
1327
+ }
1328
+
1285
1329
  export namespace HomeyAPIV3Local.ManagerExperiments {
1286
1330
  export class ExperimentHomeKit {
1287
1331
  id: string;
@@ -2710,6 +2754,16 @@ export class AthomCloudAPI {
2710
2754
  inviterId: string;
2711
2755
  }): Promise<any>;
2712
2756
 
2757
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
2758
+
2759
+ subscribeAuthenticatedUserToNewsletter(opts: {
2760
+ data?: {
2761
+ language: string;
2762
+ };
2763
+ }): Promise<any>;
2764
+
2765
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
2766
+
2713
2767
  getBridges(opts: {
2714
2768
  serial?: string;
2715
2769
 
@@ -3286,6 +3340,16 @@ export class AthomCloudAPI {
3286
3340
  inviterId: string;
3287
3341
  }): Promise<any>;
3288
3342
 
3343
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
3344
+
3345
+ subscribeAuthenticatedUserToNewsletter(opts: {
3346
+ data?: {
3347
+ language: string;
3348
+ };
3349
+ }): Promise<any>;
3350
+
3351
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
3352
+
3289
3353
  getBridges(opts: {
3290
3354
  serial?: string;
3291
3355
 
@@ -6062,6 +6126,16 @@ export class AthomCloudAPI {
6062
6126
  inviterId: string;
6063
6127
  }): Promise<any>;
6064
6128
 
6129
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
6130
+
6131
+ subscribeAuthenticatedUserToNewsletter(opts: {
6132
+ data?: {
6133
+ language: string;
6134
+ };
6135
+ }): Promise<any>;
6136
+
6137
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
6138
+
6065
6139
  getBridges(opts: {
6066
6140
  serial?: string;
6067
6141
 
@@ -6638,6 +6712,16 @@ export class AthomCloudAPI {
6638
6712
  inviterId: string;
6639
6713
  }): Promise<any>;
6640
6714
 
6715
+ getAuthenticatedUserNewsletterStatus(): Promise<any>;
6716
+
6717
+ subscribeAuthenticatedUserToNewsletter(opts: {
6718
+ data?: {
6719
+ language: string;
6720
+ };
6721
+ }): Promise<any>;
6722
+
6723
+ unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
6724
+
6641
6725
  getBridges(opts: {
6642
6726
  serial?: string;
6643
6727
 
@@ -8661,9 +8745,63 @@ export namespace HomeyAPIV3Cloud {
8661
8745
  }
8662
8746
 
8663
8747
  export class ManagerEnergy extends HomeyAPIV3.ManagerEnergy {
8748
+ getOptionElectricityPriceFixed(): Promise<any>;
8749
+
8750
+ setOptionElectricityPriceFixed(opts: { value: any }): Promise<any>;
8751
+
8752
+ unsetOptionElectricityPriceFixed(): Promise<any>;
8753
+
8754
+ getOptionGasPriceFixed(): Promise<any>;
8755
+
8756
+ setOptionGasPriceFixed(opts: { value: any }): Promise<any>;
8757
+
8758
+ unsetOptionGasPriceFixed(): Promise<any>;
8759
+
8760
+ getOptionWaterPriceFixed(): Promise<any>;
8761
+
8762
+ setOptionWaterPriceFixed(opts: { value: any }): Promise<any>;
8763
+
8764
+ unsetOptionWaterPriceFixed(): Promise<any>;
8765
+
8664
8766
  getState(): Promise<any>;
8665
8767
 
8666
8768
  getLiveReport(opts: { zone?: string }): Promise<any>;
8769
+
8770
+ getReportDay(opts: { date?: string }): Promise<any>;
8771
+
8772
+ getReportWeek(opts: { isoWeek?: string }): Promise<any>;
8773
+
8774
+ getReportMonth(opts: { yearMonth?: string }): Promise<any>;
8775
+
8776
+ getReportYear(opts: { year?: string }): Promise<any>;
8777
+
8778
+ getReportsAvailable(): Promise<any>;
8779
+
8780
+ getCurrency(): Promise<any>;
8781
+
8782
+ deleteReports(): Promise<any>;
8783
+
8784
+ resetReportDayCategories(opts: {
8785
+ options: {
8786
+ date?: string;
8787
+
8788
+ categories?: Array<any>;
8789
+
8790
+ deviceIds?: Array<any>;
8791
+ };
8792
+ }): Promise<any>;
8793
+
8794
+ enableDummyEnergyReports(opts: {
8795
+ fromDate?: string;
8796
+
8797
+ toDate?: string;
8798
+
8799
+ randomness?: string;
8800
+
8801
+ numTopConsumers?: string;
8802
+ }): Promise<any>;
8803
+
8804
+ disableDummyEnergyReports(): Promise<any>;
8667
8805
  }
8668
8806
 
8669
8807
  export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
@@ -8705,6 +8843,8 @@ export namespace HomeyAPIV3Cloud {
8705
8843
  dataTimeoutMs?: number;
8706
8844
 
8707
8845
  persistent?: boolean;
8846
+
8847
+ dataRequestActiveState?: string;
8708
8848
  }): Promise<any>;
8709
8849
 
8710
8850
  checkFirmwareUpdateAvailable(opts: { deviceId: string }): Promise<any>;
@@ -9370,6 +9510,10 @@ export namespace HomeyAPIV3Cloud {
9370
9510
 
9371
9511
  opts?: object;
9372
9512
  }): Promise<any>;
9513
+
9514
+ getLog(): Promise<any>;
9515
+
9516
+ setLogEnabled(opts: { enabled: boolean }): Promise<any>;
9373
9517
  }
9374
9518
  }
9375
9519
 
@@ -10345,9 +10489,63 @@ export namespace HomeyAPIV3Local {
10345
10489
  }
10346
10490
 
10347
10491
  export class ManagerEnergy extends HomeyAPIV3.ManagerEnergy {
10492
+ getOptionElectricityPriceFixed(): Promise<any>;
10493
+
10494
+ setOptionElectricityPriceFixed(opts: { value: any }): Promise<any>;
10495
+
10496
+ unsetOptionElectricityPriceFixed(): Promise<any>;
10497
+
10498
+ getOptionGasPriceFixed(): Promise<any>;
10499
+
10500
+ setOptionGasPriceFixed(opts: { value: any }): Promise<any>;
10501
+
10502
+ unsetOptionGasPriceFixed(): Promise<any>;
10503
+
10504
+ getOptionWaterPriceFixed(): Promise<any>;
10505
+
10506
+ setOptionWaterPriceFixed(opts: { value: any }): Promise<any>;
10507
+
10508
+ unsetOptionWaterPriceFixed(): Promise<any>;
10509
+
10348
10510
  getState(): Promise<any>;
10349
10511
 
10350
10512
  getLiveReport(opts: { zone?: string }): Promise<any>;
10513
+
10514
+ getReportDay(opts: { date?: string }): Promise<any>;
10515
+
10516
+ getReportWeek(opts: { isoWeek?: string }): Promise<any>;
10517
+
10518
+ getReportMonth(opts: { yearMonth?: string }): Promise<any>;
10519
+
10520
+ getReportYear(opts: { year?: string }): Promise<any>;
10521
+
10522
+ getReportsAvailable(): Promise<any>;
10523
+
10524
+ getCurrency(): Promise<any>;
10525
+
10526
+ deleteReports(): Promise<any>;
10527
+
10528
+ resetReportDayCategories(opts: {
10529
+ options: {
10530
+ date?: string;
10531
+
10532
+ categories?: Array<any>;
10533
+
10534
+ deviceIds?: Array<any>;
10535
+ };
10536
+ }): Promise<any>;
10537
+
10538
+ enableDummyEnergyReports(opts: {
10539
+ fromDate?: string;
10540
+
10541
+ toDate?: string;
10542
+
10543
+ randomness?: string;
10544
+
10545
+ numTopConsumers?: string;
10546
+ }): Promise<any>;
10547
+
10548
+ disableDummyEnergyReports(): Promise<any>;
10351
10549
  }
10352
10550
 
10353
10551
  export class ManagerEnergyDongle extends HomeyAPIV3.ManagerEnergyDongle {
@@ -10389,6 +10587,8 @@ export namespace HomeyAPIV3Local {
10389
10587
  dataTimeoutMs?: number;
10390
10588
 
10391
10589
  persistent?: boolean;
10590
+
10591
+ dataRequestActiveState?: string;
10392
10592
  }): Promise<any>;
10393
10593
 
10394
10594
  checkFirmwareUpdateAvailable(opts: { deviceId: string }): Promise<any>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "homey-api",
3
- "version": "3.8.0",
3
+ "version": "3.10.0",
4
4
  "description": "Homey API",
5
5
  "main": "index.js",
6
6
  "files": [