homey-api 3.17.12 → 3.18.0

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

@@ -4761,6 +4761,40 @@ export class AthomConnectAPI {
   }): Promise<any>;
 }
 
+export class AthomDeviceFirmwareAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+}
+
 export class AthomDNSAPI {
   constructor(opts?: {
     baseUrl?: string;
@@ -8261,6 +8295,40 @@ export class AthomDNSAPI {
   getHomeyCertificate(opts: { secret: string }): Promise<any>;
 }
 
+export class AthomDeviceFirmwareAPI {
+  constructor(opts?: {
+    baseUrl?: string;
+
+    debug?: boolean;
+
+    secret?: string;
+  });
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+
+  getFirmwareURL(opts: {
+    integrity: string;
+
+    noCache?: boolean;
+
+    sourceUrl?: string;
+
+    homeyTag?: string;
+
+    $timeout?: number;
+  }): Promise<{ url: string; cache: string }>;
+}
+
 export class AthomEnergyAPI {
   constructor(opts?: {
     baseUrl?: string;

package/index.js

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

package/lib/AthomDeviceFirmwareAPI.js

@@ -0,0 +1,55 @@
+'use strict';
+
+const API = require('./API');
+
+class AthomDeviceFirmwareAPI extends API {
+
+  static SPECIFICATION = {
+    host: 'device-firmware.athom.com',
+    basePath: '/',
+    operations: {},
+  };
+
+  static JSDOC_PRIVATE = true;
+
+  /**
+   * Get the location of a firmware update file.
+   *
+   * @param {Object} opts
+   * @param {string} opts.integrity - The integrity hash (i.e unique key) of the firmware file, e.g. "sha256:abcdef1234567890..."
+   * @param {boolean} [opts.noCache] - Whether to bypass the cache and fetch the firmware fresh from sourceUrl. Default: false.
+   * @param {string} [opts.sourceUrl] - The original URL of the firmware file, if the cache is bypassed or missed the server can attempt to fetch the file from this URL.
+   * @param {string} [opts.homeyTag] - How to tag the file in the cache (requires sourceUrl to be set, and the cache to be bypassed or missed).
+   * @param {number} [opts.$timeout] - Optional timeout in milliseconds for this API call.
+   * @returns {Promise<{ url: string, cache: string }>}
+   */
+  async getFirmwareURL({ integrity, noCache, sourceUrl, homeyTag, $timeout }) {
+    const query = {};
+
+    if (typeof this.__secret === 'string') {
+      query.secret = this.__secret;
+    }
+
+    if (noCache !== undefined) {
+      query.noCache = noCache;
+    }
+
+    if (sourceUrl !== undefined) {
+      query.sourceUrl = sourceUrl;
+    }
+
+    if (homeyTag !== undefined) {
+      query.homeyTag = homeyTag;
+    }
+
+    return this.call({
+      method: 'get',
+      path: `/firmware/${integrity}`,
+      query,
+      timeout: $timeout,
+    });
+  }
+
+}
+
+module.exports = AthomDeviceFirmwareAPI;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-api",
-  "version": "3.17.12",
+  "version": "3.18.0",
   "description": "Homey API",
   "main": "index.js",
   "license": "SEE LICENSE",