homey-api 3.18.3 → 3.19.1

package/assets/specifications/AthomBackupAPI.json

@@ -113,6 +113,10 @@
           "type": "number",
           "in": "body"
         },
+        "homeyModel": {
+          "type": "string",
+          "in": "body"
+        },
         "version": {
           "type": "string",
           "in": "body"

package/assets/specifications/AthomSolarForecastAPI.json

@@ -0,0 +1,36 @@
+{
+  "host": "solar-forecast-api.athom.com",
+  "basePath": "/api/v1/",
+  "operations": {
+    "getSolarForecast": {
+      "path": "/forecast/solar",
+      "method": "get",
+      "private": true,
+      "parameters": {
+        "secret": {
+          "in": "query",
+          "type": "string",
+          "required": true
+        },
+        "lat": {
+          "in": "query",
+          "type": "number",
+          "required": true
+        },
+        "lng": {
+          "in": "query",
+          "type": "number",
+          "required": true
+        },
+        "strategy": {
+          "in": "query",
+          "type": "string"
+        },
+        "panels": {
+          "in": "query",
+          "type": "array"
+        }
+      }
+    }
+  }
+}

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

@@ -3137,6 +3137,8 @@ export class AthomBackupAPI {
 
     homeyPlatformVersion?: number;
 
+    homeyModel?: string;
+
     version?: string;
 
     channel?: string;
@@ -3197,6 +3199,8 @@ export class AthomBackupAPI {
 
     homeyPlatformVersion?: number;
 
+    homeyModel?: string;
+
     version?: string;
 
     channel?: string;
@@ -5209,6 +5213,40 @@ export class AthomSetupAPI {
   getTimezone(): Promise<any>;
 }
 
+export class AthomSolarForecastAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getSolarForecast(opts: {
+    secret: string;
+
+    lat: number;
+
+    lng: number;
+
+    strategy?: string;
+
+    panels?: Array<any>;
+  }): Promise<any>;
+
+  getSolarForecast(opts: {
+    secret: string;
+
+    lat: number;
+
+    lng: number;
+
+    strategy?: string;
+
+    panels?: Array<any>;
+  }): Promise<any>;
+}
+
 export class AthomStoreAPI {
   constructor(opts?: {
     baseUrl?: string;
@@ -6657,6 +6695,8 @@ export class AthomBackupAPI {
 
     homeyPlatformVersion?: number;
 
+    homeyModel?: string;
+
     version?: string;
 
     channel?: string;
@@ -6717,6 +6757,8 @@ export class AthomBackupAPI {
 
     homeyPlatformVersion?: number;
 
+    homeyModel?: string;
+
     version?: string;
 
     channel?: string;
@@ -8729,6 +8771,40 @@ export class AthomSetupAPI {
   getTimezone(): Promise<any>;
 }
 
+export class AthomSolarForecastAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getSolarForecast(opts: {
+    secret: string;
+
+    lat: number;
+
+    lng: number;
+
+    strategy?: string;
+
+    panels?: Array<any>;
+  }): Promise<any>;
+
+  getSolarForecast(opts: {
+    secret: string;
+
+    lat: number;
+
+    lng: number;
+
+    strategy?: string;
+
+    panels?: Array<any>;
+  }): Promise<any>;
+}
+
 export class AthomStoreAPI {
   constructor(opts?: {
     baseUrl?: string;

package/index.js

@@ -21,6 +21,7 @@ module.exports.AthomWeatherAPI = require('./lib/AthomWeatherAPI');
 module.exports.AthomWebhooksAPI = require('./lib/AthomWebhooksAPI');
 module.exports.AthomEnergyAPI = require('./lib/AthomEnergyAPI');
 module.exports.AthomDeviceFirmwareAPI = require('./lib/AthomDeviceFirmwareAPI');
+module.exports.AthomSolarForecastAPI = require('./lib/AthomSolarForecastAPI');
 
 // Homey Cloud
 module.exports.HomeyCloudAPI = require('./lib/HomeyCloudAPI');

package/lib/AthomSolarForecastAPI.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.18.3",
+  "version": "3.19.1",
   "description": "Homey API",
   "main": "index.js",
   "license": "SEE LICENSE",
@@ -61,7 +61,7 @@
     "socket.io-client": "^2.5.0"
   },
   "devDependencies": {
-    "@athombv/jsdoc-template": "^1.6.2",
+    "@athombv/jsdoc-template": "^1.7.0",
     "@babel/core": "^7.16.0",
     "@babel/plugin-proposal-class-properties": "^7.16.0",
     "@babel/preset-env": "^7.16.0",