homey-api 3.14.21 → 3.14.23

package/LICENSE

@@ -0,0 +1,3 @@
+- Package may be used freely with Homey products
+- Source code is proprietary to Athom B.V.
+- No warranty provided

package/assets/specifications/AthomCloudAPI.json

@@ -1274,6 +1274,10 @@
         "expiresAt": {
           "type": "string",
           "in": "body"
+        },
+        "shopifyContractId": {
+          "type": "string",
+          "in": "body"
         }
       }
     },
@@ -1376,6 +1380,29 @@
         "userId": {
           "type": "string",
           "in": "body"
+        },
+        "tags": {
+          "type": "array",
+          "in": "body"
+        }
+      }
+    },
+    "upsertUserToMailChimp": {
+      "path": "/mail/mailchimp",
+      "method": "put",
+      "private": true,
+      "parameters": {
+        "listId": {
+          "type": "string",
+          "in": "body"
+        },
+        "userId": {
+          "type": "string",
+          "in": "body"
+        },
+        "tags": {
+          "type": "array",
+          "in": "body"
         }
       }
     },

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

@@ -2291,6 +2291,18 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
+  statusCode: number;
+
+  message: string;
+
+  message: string;
+}
+
+export class APIErrorHomeyInvalidSerialNumber extends APIError {
+  statusCode: number;
+
   statusCode: number;
 
   message: string;
@@ -2551,6 +2563,18 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
+  statusCode: number;
+
+  message: string;
+
+  message: string;
+}
+
+export class APIErrorHomeyInvalidSerialNumber extends APIError {
+  statusCode: number;
+
   statusCode: number;
 
   message: string;

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

@@ -2356,6 +2356,18 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
+  statusCode: number;
+
+  message: string;
+
+  message: string;
+}
+
+export class APIErrorHomeyInvalidSerialNumber extends APIError {
+  statusCode: number;
+
   statusCode: number;
 
   message: string;
@@ -3758,6 +3770,8 @@ export class AthomCloudAPI {
     type?: string;
 
     expiresAt?: string;
+
+    shopifyContractId?: string;
   }): Promise<any>;
 
   transferHomeySelfHostedServerLifetimeLicense(opts: {
@@ -3800,6 +3814,16 @@ export class AthomCloudAPI {
     listId?: string;
 
     userId?: string;
+
+    tags?: Array<any>;
+  }): Promise<any>;
+
+  upsertUserToMailChimp(opts: {
+    listId?: string;
+
+    userId?: string;
+
+    tags?: Array<any>;
   }): Promise<any>;
 
   addTagToMailChimpUser(opts: {
@@ -4448,6 +4472,8 @@ export class AthomCloudAPI {
     type?: string;
 
     expiresAt?: string;
+
+    shopifyContractId?: string;
   }): Promise<any>;
 
   transferHomeySelfHostedServerLifetimeLicense(opts: {
@@ -4490,6 +4516,16 @@ export class AthomCloudAPI {
     listId?: string;
 
     userId?: string;
+
+    tags?: Array<any>;
+  }): Promise<any>;
+
+  upsertUserToMailChimp(opts: {
+    listId?: string;
+
+    userId?: string;
+
+    tags?: Array<any>;
   }): Promise<any>;
 
   addTagToMailChimpUser(opts: {
@@ -6030,6 +6066,18 @@ export class APIError extends Error {
 
   message: string;
 
+  message: string;
+
+  statusCode: number;
+
+  message: string;
+
+  message: string;
+}
+
+export class APIErrorHomeyInvalidSerialNumber extends APIError {
+  statusCode: number;
+
   statusCode: number;
 
   message: string;
@@ -7432,6 +7480,8 @@ export class AthomCloudAPI {
     type?: string;
 
     expiresAt?: string;
+
+    shopifyContractId?: string;
   }): Promise<any>;
 
   transferHomeySelfHostedServerLifetimeLicense(opts: {
@@ -7474,6 +7524,16 @@ export class AthomCloudAPI {
     listId?: string;
 
     userId?: string;
+
+    tags?: Array<any>;
+  }): Promise<any>;
+
+  upsertUserToMailChimp(opts: {
+    listId?: string;
+
+    userId?: string;
+
+    tags?: Array<any>;
   }): Promise<any>;
 
   addTagToMailChimpUser(opts: {
@@ -8122,6 +8182,8 @@ export class AthomCloudAPI {
     type?: string;
 
     expiresAt?: string;
+
+    shopifyContractId?: string;
   }): Promise<any>;
 
   transferHomeySelfHostedServerLifetimeLicense(opts: {
@@ -8164,6 +8226,16 @@ export class AthomCloudAPI {
     listId?: string;
 
     userId?: string;
+
+    tags?: Array<any>;
+  }): Promise<any>;
+
+  upsertUserToMailChimp(opts: {
+    listId?: string;
+
+    userId?: string;
+
+    tags?: Array<any>;
   }): Promise<any>;
 
   addTagToMailChimpUser(opts: {

package/lib/APIErrorHomeyInvalidSerialNumber.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const APIError = require('./APIError');
+
+/**
+ * Thrown when Homey serial number is invalid.
+ * @class
+ * @hideconstructor
+ * @extends APIError
+ */
+class APIErrorHomeyInvalidSerialNumber extends APIError {
+  /**
+   *
+   * @param {string} message
+   * @param {number} statusCode
+   */
+  constructor(message, statusCode) {
+    super(message);
+
+    /**
+     * Error message
+     * @var {string} APIError#message
+     */
+
+    /**
+     * HTTP Status Code
+     * @type {number}
+     */
+    this.statusCode = statusCode;
+  }
+}
+
+module.exports = APIErrorHomeyInvalidSerialNumber;

package/lib/HomeyAPI/HomeyAPIV3.js

@@ -3,6 +3,7 @@
 const SocketIOClient = require('socket.io-client');
 const APIErrorHomeyOffline = require('../APIErrorHomeyOffline');
 const APIErrorHomeySubscriptionInactive = require('../APIErrorHomeySubscriptionInactive');
+const APIErrorHomeyInvalidSerialNumber = require('../APIErrorHomeyInvalidSerialNumber');
 const Util = require('../Util');
 const HomeyAPI = require('./HomeyAPI');
 const HomeyAPIError = require('./HomeyAPIError');
@@ -293,6 +294,12 @@ class HomeyAPIV3 extends HomeyAPI {
             parsed.statusCode === 403
           ) {
             throw new APIErrorHomeySubscriptionInactive(parsed.error, parsed.statusCode);
+          } else if (
+            parsed.error &&
+            parsed.error === 'Invalid Serial Number' &&
+            parsed.statusCode === 403
+          ) {
+            throw new APIErrorHomeyInvalidSerialNumber(parsed.error, parsed.statusCode);
           }
         }
 
@@ -401,7 +408,10 @@ class HomeyAPIV3 extends HomeyAPI {
             promises.push(pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]);
           }
 
-          if (error instanceof APIErrorHomeySubscriptionInactive) {
+          if (
+            error instanceof APIErrorHomeySubscriptionInactive ||
+            error instanceof APIErrorHomeyInvalidSerialNumber
+          ) {
             throw error;
           }
 
@@ -415,14 +425,20 @@ class HomeyAPIV3 extends HomeyAPI {
         .catch((error) => {
           if (error instanceof AggregateError) {
             for (const err of error.errors) {
-              if (err instanceof APIErrorHomeySubscriptionInactive) {
+              if (
+                err instanceof APIErrorHomeySubscriptionInactive ||
+                err instanceof APIErrorHomeyInvalidSerialNumber
+              ) {
                 reject(err);
                 return;
               }
             }
           }
 
-          if (error instanceof APIErrorHomeySubscriptionInactive) {
+          if (
+            error instanceof APIErrorHomeySubscriptionInactive ||
+            error instanceof APIErrorHomeyInvalidSerialNumber
+          ) {
             reject(error);
             return;
           }
@@ -437,7 +453,10 @@ class HomeyAPIV3 extends HomeyAPI {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
               .catch((err) => {
-                if (err instanceof APIErrorHomeySubscriptionInactive) {
+                if (
+                  err instanceof APIErrorHomeySubscriptionInactive ||
+                  err instanceof APIErrorHomeyInvalidSerialNumber
+                ) {
                   reject(err);
                   return;
                 }
@@ -454,7 +473,10 @@ class HomeyAPIV3 extends HomeyAPI {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
               .catch((err) => {
-                if (err instanceof APIErrorHomeySubscriptionInactive) {
+                if (
+                  err instanceof APIErrorHomeySubscriptionInactive ||
+                  err instanceof APIErrorHomeyInvalidSerialNumber
+                ) {
                   reject(err);
                   return;
                 }
@@ -471,7 +493,10 @@ class HomeyAPIV3 extends HomeyAPI {
             pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
               .then((result) => resolve(result))
               .catch((err) => {
-                if (err instanceof APIErrorHomeySubscriptionInactive) {
+                if (
+                  err instanceof APIErrorHomeySubscriptionInactive ||
+                  err instanceof APIErrorHomeyInvalidSerialNumber
+                ) {
                   reject(err);
                   return;
                 }
@@ -484,7 +509,10 @@ class HomeyAPIV3 extends HomeyAPI {
       pings[HomeyAPI.DISCOVERY_STRATEGIES.CLOUD]
         .then((result) => resolve(result))
         .catch((err) => {
-          if (err instanceof APIErrorHomeySubscriptionInactive) {
+          if (
+            err instanceof APIErrorHomeySubscriptionInactive ||
+            err instanceof APIErrorHomeyInvalidSerialNumber
+          ) {
             reject(err);
             return;
           }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "homey-api",
-  "version": "3.14.21",
+  "version": "3.14.23",
   "description": "Homey API",
   "main": "index.js",
+  "license": "SEE LICENSE",
   "files": [
     "/lib",
     "/assets/specifications",