@kohost/api-client 4.6.3 → 4.6.4

package/dist/models/automation.d.cts

@@ -7,15 +7,19 @@ import { Entity } from './entity.cjs';
  * @property {string} [name] - The friendly name of the automation
  * @property {"automation"} type - Default: "automation"
  * @property {boolean} [isEnabled] - Whether the automation is currently enabled. Default: true
- * @property {{discriminator: ("time"|"event"), schedule: {days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}}} trigger - The trigger that initiates the automation
- * @property {("time"|"event")} trigger.discriminator - Type of trigger
- * @property {{days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}} trigger.schedule - Schedule for time-based triggers
+ * @property {{discriminator: ("schedule"|"event"), schedule?: {days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}, event?: {eventName: string, eventProperties: {property: string, value: string, operator: ("=="|"!="|">"|">="|"<"|"<=")}[], match: ("any"|"all")}}} trigger - The trigger that initiates the automation
+ * @property {("schedule"|"event")} trigger.discriminator - Type of trigger
+ * @property {{days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}} [trigger.schedule] - Schedule for time-based triggers
  * @property {number[]} trigger.schedule.days - Days of the week (0 = Sunday, 6 = Saturday)
  * @property {string} trigger.schedule.time - Time of day to trigger the automation
  * @property {number} [trigger.schedule.timeOffsetSeconds] - Offset in seconds from the scheduled time. Default: 0
  * @property {boolean} [trigger.schedule.repeat] - Whether the schedule repeats. Default: true
  * @property {string} trigger.schedule.timezone - Timezone for the schedule (IANA timezone format)
- * @property {{entityId?: string, entityType?: "switch", deviceId: string, roomId: string, discriminator: string, duration?: number, state: {property: string, value: (string|number|boolean)}[]}[]} actions - Actions to perform when the trigger conditions are met
+ * @property {{eventName: string, eventProperties: {property: string, value: string, operator: ("=="|"!="|">"|">="|"<"|"<=")}[], match: ("any"|"all")}} [trigger.event]
+ * @property {string} trigger.event.eventName - Name of the event that triggers the automation actions
+ * @property {{property: string, value: string, operator: ("=="|"!="|">"|">="|"<"|"<=")}[]} trigger.event.eventProperties - Properties of the event that triggers the automation actions
+ * @property {("any"|"all")} trigger.event.match - Match criteria for the event to trigger the automation actions
+ * @property {{useCase: string, useCaseParams: {data?: (object|array)}}[]} actions - Actions to perform when the trigger conditions are met
  * @property {(string|object)} [createdAt]
  * @property {(string|object)} [updatedAt]
  * @property {(string|object)} [lastTriggeredAt] - When the automation was last triggered
@@ -36,26 +40,29 @@ declare class Automation extends Entity {
     type: "automation";
     isEnabled: boolean | undefined;
     trigger: {
-        discriminator: ("time" | "event");
-        schedule: {
+        discriminator: ("schedule" | "event");
+        schedule?: {
             days: number[];
             time: string;
             timeOffsetSeconds?: number;
             repeat?: boolean;
             timezone: string;
         };
+        event?: {
+            eventName: string;
+            eventProperties: {
+                property: string;
+                value: string;
+                operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+            }[];
+            match: ("any" | "all");
+        };
     };
     actions: {
-        entityId?: string;
-        entityType?: "switch";
-        deviceId: string;
-        roomId: string;
-        discriminator: string;
-        duration?: number;
-        state: {
-            property: string;
-            value: (string | number | boolean);
-        }[];
+        useCase: string;
+        useCaseParams: {
+            data?: (object | any[]);
+        };
     }[];
     createdAt: any;
     updatedAt: any;
@@ -129,6 +136,44 @@ declare class Automation extends Entity {
                             };
                         };
                     };
+                    event: {
+                        type: string;
+                        required: string[];
+                        properties: {
+                            eventName: {
+                                type: string;
+                                description: string;
+                            };
+                            eventProperties: {
+                                type: string;
+                                description: string;
+                                items: {
+                                    type: string;
+                                    required: string[];
+                                    properties: {
+                                        property: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        value: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        operator: {
+                                            type: string;
+                                            description: string;
+                                            enum: string[];
+                                        };
+                                    };
+                                };
+                            };
+                            match: {
+                                type: string;
+                                description: string;
+                                enum: string[];
+                            };
+                        };
+                    };
                 };
             };
             actions: {
@@ -138,52 +183,23 @@ declare class Automation extends Entity {
                     type: string;
                     required: string[];
                     properties: {
-                        entityId: {
-                            type: string;
-                            description: string;
-                        };
-                        entityType: {
+                        useCase: {
                             type: string;
                             description: string;
-                            enum: string[];
                         };
-                        deviceId: {
+                        useCaseParams: {
                             type: string;
                             description: string;
-                        };
-                        roomId: {
-                            type: string;
-                            description: string;
-                        };
-                        discriminator: {
-                            type: string;
-                            description: string;
-                        };
-                        duration: {
-                            type: string;
-                            description: string;
-                            minimum: number;
-                        };
-                        state: {
-                            type: string;
-                            items: {
-                                type: string;
-                                required: string[];
-                                properties: {
-                                    property: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                    value: {
-                                        type: string[];
-                                        description: string;
-                                    };
+                            properties: {
+                                data: {
+                                    type: string[];
+                                    description: string;
                                 };
                             };
                         };
                     };
+                    minItems: number;
                 };
-                minItems: number;
             };
             createdAt: {
                 $ref: string;
@@ -226,29 +242,38 @@ type AutomationData = {
      * - The trigger that initiates the automation
      */
     trigger: {
-        discriminator: ("time" | "event");
-        schedule: {
+        discriminator: ("schedule" | "event");
+        schedule?: {
             days: number[];
             time: string;
             timeOffsetSeconds?: number;
             repeat?: boolean;
             timezone: string;
         };
+        event?: {
+            eventName: string;
+            eventProperties: {
+                property: string;
+                value: string;
+                operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+            }[];
+            match: ("any" | "all");
+        };
     };
     /**
      * - Type of trigger
      */
-    discriminator: ("time" | "event");
+    discriminator: ("schedule" | "event");
     /**
      * - Schedule for time-based triggers
      */
-    schedule: {
+    schedule?: {
         days: number[];
         time: string;
         timeOffsetSeconds?: number;
         repeat?: boolean;
         timezone: string;
-    };
+    } | undefined;
     /**
      * - Days of the week (0 = Sunday, 6 = Saturday)
      */
@@ -269,20 +294,39 @@ type AutomationData = {
      * - Timezone for the schedule (IANA timezone format)
      */
     timezone: string;
+    event?: {
+        eventName: string;
+        eventProperties: {
+            property: string;
+            value: string;
+            operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+        }[];
+        match: ("any" | "all");
+    } | undefined;
+    /**
+     * - Name of the event that triggers the automation actions
+     */
+    eventName: string;
+    /**
+     * - Properties of the event that triggers the automation actions
+     */
+    eventProperties: {
+        property: string;
+        value: string;
+        operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+    }[];
+    /**
+     * - Match criteria for the event to trigger the automation actions
+     */
+    match: ("any" | "all");
     /**
      * - Actions to perform when the trigger conditions are met
      */
     actions: {
-        entityId?: string;
-        entityType?: "switch";
-        deviceId: string;
-        roomId: string;
-        discriminator: string;
-        duration?: number;
-        state: {
-            property: string;
-            value: (string | number | boolean);
-        }[];
+        useCase: string;
+        useCaseParams: {
+            data?: (object | any[]);
+        };
     }[];
     createdAt?: (string | object);
     updatedAt?: (string | object);

package/dist/models/automation.d.ts

@@ -7,15 +7,19 @@ import { Entity } from './entity.js';
  * @property {string} [name] - The friendly name of the automation
  * @property {"automation"} type - Default: "automation"
  * @property {boolean} [isEnabled] - Whether the automation is currently enabled. Default: true
- * @property {{discriminator: ("time"|"event"), schedule: {days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}}} trigger - The trigger that initiates the automation
- * @property {("time"|"event")} trigger.discriminator - Type of trigger
- * @property {{days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}} trigger.schedule - Schedule for time-based triggers
+ * @property {{discriminator: ("schedule"|"event"), schedule?: {days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}, event?: {eventName: string, eventProperties: {property: string, value: string, operator: ("=="|"!="|">"|">="|"<"|"<=")}[], match: ("any"|"all")}}} trigger - The trigger that initiates the automation
+ * @property {("schedule"|"event")} trigger.discriminator - Type of trigger
+ * @property {{days: number[], time: string, timeOffsetSeconds?: number, repeat?: boolean, timezone: string}} [trigger.schedule] - Schedule for time-based triggers
  * @property {number[]} trigger.schedule.days - Days of the week (0 = Sunday, 6 = Saturday)
  * @property {string} trigger.schedule.time - Time of day to trigger the automation
  * @property {number} [trigger.schedule.timeOffsetSeconds] - Offset in seconds from the scheduled time. Default: 0
  * @property {boolean} [trigger.schedule.repeat] - Whether the schedule repeats. Default: true
  * @property {string} trigger.schedule.timezone - Timezone for the schedule (IANA timezone format)
- * @property {{entityId?: string, entityType?: "switch", deviceId: string, roomId: string, discriminator: string, duration?: number, state: {property: string, value: (string|number|boolean)}[]}[]} actions - Actions to perform when the trigger conditions are met
+ * @property {{eventName: string, eventProperties: {property: string, value: string, operator: ("=="|"!="|">"|">="|"<"|"<=")}[], match: ("any"|"all")}} [trigger.event]
+ * @property {string} trigger.event.eventName - Name of the event that triggers the automation actions
+ * @property {{property: string, value: string, operator: ("=="|"!="|">"|">="|"<"|"<=")}[]} trigger.event.eventProperties - Properties of the event that triggers the automation actions
+ * @property {("any"|"all")} trigger.event.match - Match criteria for the event to trigger the automation actions
+ * @property {{useCase: string, useCaseParams: {data?: (object|array)}}[]} actions - Actions to perform when the trigger conditions are met
  * @property {(string|object)} [createdAt]
  * @property {(string|object)} [updatedAt]
  * @property {(string|object)} [lastTriggeredAt] - When the automation was last triggered
@@ -36,26 +40,29 @@ declare class Automation extends Entity {
     type: "automation";
     isEnabled: boolean | undefined;
     trigger: {
-        discriminator: ("time" | "event");
-        schedule: {
+        discriminator: ("schedule" | "event");
+        schedule?: {
             days: number[];
             time: string;
             timeOffsetSeconds?: number;
             repeat?: boolean;
             timezone: string;
         };
+        event?: {
+            eventName: string;
+            eventProperties: {
+                property: string;
+                value: string;
+                operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+            }[];
+            match: ("any" | "all");
+        };
     };
     actions: {
-        entityId?: string;
-        entityType?: "switch";
-        deviceId: string;
-        roomId: string;
-        discriminator: string;
-        duration?: number;
-        state: {
-            property: string;
-            value: (string | number | boolean);
-        }[];
+        useCase: string;
+        useCaseParams: {
+            data?: (object | any[]);
+        };
     }[];
     createdAt: any;
     updatedAt: any;
@@ -129,6 +136,44 @@ declare class Automation extends Entity {
                             };
                         };
                     };
+                    event: {
+                        type: string;
+                        required: string[];
+                        properties: {
+                            eventName: {
+                                type: string;
+                                description: string;
+                            };
+                            eventProperties: {
+                                type: string;
+                                description: string;
+                                items: {
+                                    type: string;
+                                    required: string[];
+                                    properties: {
+                                        property: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        value: {
+                                            type: string;
+                                            description: string;
+                                        };
+                                        operator: {
+                                            type: string;
+                                            description: string;
+                                            enum: string[];
+                                        };
+                                    };
+                                };
+                            };
+                            match: {
+                                type: string;
+                                description: string;
+                                enum: string[];
+                            };
+                        };
+                    };
                 };
             };
             actions: {
@@ -138,52 +183,23 @@ declare class Automation extends Entity {
                     type: string;
                     required: string[];
                     properties: {
-                        entityId: {
-                            type: string;
-                            description: string;
-                        };
-                        entityType: {
+                        useCase: {
                             type: string;
                             description: string;
-                            enum: string[];
                         };
-                        deviceId: {
+                        useCaseParams: {
                             type: string;
                             description: string;
-                        };
-                        roomId: {
-                            type: string;
-                            description: string;
-                        };
-                        discriminator: {
-                            type: string;
-                            description: string;
-                        };
-                        duration: {
-                            type: string;
-                            description: string;
-                            minimum: number;
-                        };
-                        state: {
-                            type: string;
-                            items: {
-                                type: string;
-                                required: string[];
-                                properties: {
-                                    property: {
-                                        type: string;
-                                        description: string;
-                                    };
-                                    value: {
-                                        type: string[];
-                                        description: string;
-                                    };
+                            properties: {
+                                data: {
+                                    type: string[];
+                                    description: string;
                                 };
                             };
                         };
                     };
+                    minItems: number;
                 };
-                minItems: number;
             };
             createdAt: {
                 $ref: string;
@@ -226,29 +242,38 @@ type AutomationData = {
      * - The trigger that initiates the automation
      */
     trigger: {
-        discriminator: ("time" | "event");
-        schedule: {
+        discriminator: ("schedule" | "event");
+        schedule?: {
             days: number[];
             time: string;
             timeOffsetSeconds?: number;
             repeat?: boolean;
             timezone: string;
         };
+        event?: {
+            eventName: string;
+            eventProperties: {
+                property: string;
+                value: string;
+                operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+            }[];
+            match: ("any" | "all");
+        };
     };
     /**
      * - Type of trigger
      */
-    discriminator: ("time" | "event");
+    discriminator: ("schedule" | "event");
     /**
      * - Schedule for time-based triggers
      */
-    schedule: {
+    schedule?: {
         days: number[];
         time: string;
         timeOffsetSeconds?: number;
         repeat?: boolean;
         timezone: string;
-    };
+    } | undefined;
     /**
      * - Days of the week (0 = Sunday, 6 = Saturday)
      */
@@ -269,20 +294,39 @@ type AutomationData = {
      * - Timezone for the schedule (IANA timezone format)
      */
     timezone: string;
+    event?: {
+        eventName: string;
+        eventProperties: {
+            property: string;
+            value: string;
+            operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+        }[];
+        match: ("any" | "all");
+    } | undefined;
+    /**
+     * - Name of the event that triggers the automation actions
+     */
+    eventName: string;
+    /**
+     * - Properties of the event that triggers the automation actions
+     */
+    eventProperties: {
+        property: string;
+        value: string;
+        operator: ("==" | "!=" | ">" | ">=" | "<" | "<=");
+    }[];
+    /**
+     * - Match criteria for the event to trigger the automation actions
+     */
+    match: ("any" | "all");
     /**
      * - Actions to perform when the trigger conditions are met
      */
     actions: {
-        entityId?: string;
-        entityType?: "switch";
-        deviceId: string;
-        roomId: string;
-        discriminator: string;
-        duration?: number;
-        state: {
-            property: string;
-            value: (string | number | boolean);
-        }[];
+        useCase: string;
+        useCaseParams: {
+            data?: (object | any[]);
+        };
     }[];
     createdAt?: (string | object);
     updatedAt?: (string | object);

package/dist/models/automation.js

@@ -1 +1 @@
-import{Automation}from"../chunk-MOGXYZHC.js";import"../chunk-IL3ICDGN.js";import"../chunk-YPJMXYGL.js";import"../chunk-5FSWHSBF.js";import"../chunk-P3ZPJTJ2.js";import"../chunk-XE4OXN2W.js";export{Automation};//# sourceMappingURL=automation.js.map
+import{Automation}from"../chunk-SCQ56FY5.js";import"../chunk-RM6XS6VX.js";import"../chunk-YPJMXYGL.js";import"../chunk-5FSWHSBF.js";import"../chunk-P3ZPJTJ2.js";import"../chunk-XE4OXN2W.js";export{Automation};//# sourceMappingURL=automation.js.map