homey-api 3.11.2 → 3.12.0

package/assets/specifications/AthomAppsAPI.json

@@ -106,7 +106,7 @@
           "type": "string",
           "in": "body"
         },
-        "payload": {
+        "recordings": {
           "type": "array",
           "in": "body"
         }

package/assets/specifications/AthomCloudAPI.json

@@ -622,7 +622,13 @@
     "getInstallerInformation": {
       "path": "/user/{userId}/installer-information",
       "method": "get",
-      "parameters": {}
+      "parameters": {
+        "userId": {
+          "in": "path",
+          "type": "string",
+          "required": true
+        }
+      }
     },
     "getBridges": {
       "path": "/bridge/",

package/assets/specifications/AthomEnergyAPI.json

@@ -0,0 +1,74 @@
+{
+  "host": "energy-api.athom.com",
+  "basePath": "/api/v1/",
+  "operations": {
+    "getZone": {
+      "path": "/zone",
+      "method": "get",
+      "parameters": {
+        "latitude": {
+          "in": "query",
+          "type": "string",
+          "required": true
+        },
+        "longitude": {
+          "in": "query",
+          "type": "string",
+          "required": true
+        },
+        "secret": {
+          "in": "query",
+          "type": "string"
+        }
+      }
+    },
+    "getZones": {
+      "path": "/zones",
+      "method": "get",
+      "parameters": {
+        "secret": {
+          "in": "query",
+          "type": "string"
+        }
+      }
+    },
+    "getDayAheadPricesElectricity": {
+      "path": "/day-ahead-prices/electricity",
+      "method": "get",
+      "parameters": {
+        "zoneId": {
+          "in": "query",
+          "type": "string",
+          "required": true
+        },
+        "zoneVersion": {
+          "in": "query",
+          "type": "string",
+          "required": true
+        },
+        "date": {
+          "in": "query",
+          "type": "string",
+          "required": true
+        },
+        "timezone": {
+          "in": "query",
+          "type": "string",
+          "required": true
+        },
+        "currency": {
+          "in": "query",
+          "type": "string"
+        },
+        "interval": {
+          "in": "query",
+          "type": "string"
+        },
+        "secret": {
+          "in": "query",
+          "type": "string"
+        }
+      }
+    }
+  }
+}

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

@@ -1585,7 +1585,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   isLoggedIn(): Promise<boolean>;
 
@@ -1617,7 +1617,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   isLoggedIn(): Promise<boolean>;
 
@@ -1769,7 +1769,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   isLoggedIn(): Promise<boolean>;
 
@@ -1801,7 +1801,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   isLoggedIn(): Promise<boolean>;
 

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

@@ -1727,7 +1727,7 @@ export class AthomAppsAPI {
 
     homeyPlatform?: string;
 
-    payload?: Array<any>;
+    recordings?: Array<any>;
   }): Promise<any>;
 
   searchZigbeeDriver(opts: {
@@ -2061,7 +2061,7 @@ export class AthomAppsAPI {
 
     homeyPlatform?: string;
 
-    payload?: Array<any>;
+    recordings?: Array<any>;
   }): Promise<any>;
 
   searchZigbeeDriver(opts: {
@@ -2762,7 +2762,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   getBridges(opts: {
     serial?: string;
@@ -3348,7 +3348,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   getBridges(opts: {
     serial?: string;
@@ -3803,6 +3803,68 @@ export class AthomDNSAPI {
   getHomeyCertificate(opts: { secret: string }): Promise<any>;
 }
 
+export class AthomEnergyAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getZone(opts: {
+    latitude: string;
+
+    longitude: string;
+
+    secret?: string;
+  }): Promise<any>;
+
+  getZones(opts: { secret?: string }): Promise<any>;
+
+  getDayAheadPricesElectricity(opts: {
+    zoneId: string;
+
+    zoneVersion: string;
+
+    date: string;
+
+    timezone: string;
+
+    currency?: string;
+
+    interval?: string;
+
+    secret?: string;
+  }): Promise<any>;
+
+  getZone(opts: {
+    latitude: string;
+
+    longitude: string;
+
+    secret?: string;
+  }): Promise<any>;
+
+  getZones(opts: { secret?: string }): Promise<any>;
+
+  getDayAheadPricesElectricity(opts: {
+    zoneId: string;
+
+    zoneVersion: string;
+
+    date: string;
+
+    timezone: string;
+
+    currency?: string;
+
+    interval?: string;
+
+    secret?: string;
+  }): Promise<any>;
+}
+
 export class AthomFirmwareAPI {
   constructor(opts?: {
     baseUrl?: string;
@@ -5099,7 +5161,7 @@ export class AthomAppsAPI {
 
     homeyPlatform?: string;
 
-    payload?: Array<any>;
+    recordings?: Array<any>;
   }): Promise<any>;
 
   searchZigbeeDriver(opts: {
@@ -5433,7 +5495,7 @@ export class AthomAppsAPI {
 
     homeyPlatform?: string;
 
-    payload?: Array<any>;
+    recordings?: Array<any>;
   }): Promise<any>;
 
   searchZigbeeDriver(opts: {
@@ -6134,7 +6196,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   getBridges(opts: {
     serial?: string;
@@ -6720,7 +6782,7 @@ export class AthomCloudAPI {
 
   unsubscribeAuthenticatedUserFromNewsletter(): Promise<any>;
 
-  getInstallerInformation(): Promise<any>;
+  getInstallerInformation(opts: { userId: string }): Promise<any>;
 
   getBridges(opts: {
     serial?: string;
@@ -7175,6 +7237,68 @@ export class AthomDNSAPI {
   getHomeyCertificate(opts: { secret: string }): Promise<any>;
 }
 
+export class AthomEnergyAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getZone(opts: {
+    latitude: string;
+
+    longitude: string;
+
+    secret?: string;
+  }): Promise<any>;
+
+  getZones(opts: { secret?: string }): Promise<any>;
+
+  getDayAheadPricesElectricity(opts: {
+    zoneId: string;
+
+    zoneVersion: string;
+
+    date: string;
+
+    timezone: string;
+
+    currency?: string;
+
+    interval?: string;
+
+    secret?: string;
+  }): Promise<any>;
+
+  getZone(opts: {
+    latitude: string;
+
+    longitude: string;
+
+    secret?: string;
+  }): Promise<any>;
+
+  getZones(opts: { secret?: string }): Promise<any>;
+
+  getDayAheadPricesElectricity(opts: {
+    zoneId: string;
+
+    zoneVersion: string;
+
+    date: string;
+
+    timezone: string;
+
+    currency?: string;
+
+    interval?: string;
+
+    secret?: string;
+  }): Promise<any>;
+}
+
 export class AthomFirmwareAPI {
   constructor(opts?: {
     baseUrl?: string;

package/index.js

@@ -19,6 +19,7 @@ module.exports.AthomSetupAPI = require('./lib/AthomSetupAPI');
 module.exports.AthomStoreAPI = require('./lib/AthomStoreAPI');
 module.exports.AthomWeatherAPI = require('./lib/AthomWeatherAPI');
 module.exports.AthomWebhooksAPI = require('./lib/AthomWebhooksAPI');
+module.exports.AthomEnergyAPI = require('./lib/AthomEnergyAPI');
 
 // Homey Cloud
 module.exports.HomeyCloudAPI = require('./lib/HomeyCloudAPI');

package/lib/AthomEnergyAPI.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const API = require('./API');
+
+class AthomEnergyAPI extends API {
+
+  static SPECIFICATION = require('../assets/specifications/AthomEnergyAPI.json');
+  static SPECIFICATION_URL = 'https://energy-api.athom.com/api/v1/specification.json';
+  static JSDOC_PRIVATE = true;
+
+}
+
+module.exports = AthomEnergyAPI;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.11.2",
+  "version": "3.12.0",
   "description": "Homey API",
   "main": "index.js",
   "files": [