@awarevue/api-types 1.0.68 → 1.0.70

package/dist/access-control/access-rule.d.ts

@@ -85,8 +85,6 @@ export declare const sAccessRuleDto: z.ZodObject<{
     id: string;
     version: number;
     displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
     appliedTo: {
         id: string;
         firstName: string;
@@ -101,13 +99,13 @@ export declare const sAccessRuleDto: z.ZodObject<{
         scheduleId: string;
         groupId: string;
     }[];
+    createdOn: string;
+    lastModifiedOn: string;
     refs: Record<string, string | string[]>;
 }, {
     id: string;
     version: number;
     displayName: string;
-    createdOn: string;
-    lastModifiedOn: string;
     appliedTo: {
         id: string;
         firstName: string;
@@ -122,6 +120,8 @@ export declare const sAccessRuleDto: z.ZodObject<{
         scheduleId: string;
         groupId: string;
     }[];
+    createdOn: string;
+    lastModifiedOn: string;
     refs: Record<string, string | string[]>;
 }>;
 export type AccessRuleDto = z.infer<typeof sAccessRuleDto>;

package/dist/access-control/person-presence.d.ts

@@ -149,6 +149,7 @@ export declare const sPersonPresenceActionDto: z.ZodObject<{
     checkCompleted: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     id: string;
+    timestamp: number;
     person: string | {
         id: string;
         firstName: string;
@@ -161,12 +162,12 @@ export declare const sPersonPresenceActionDto: z.ZodObject<{
         displayName: string;
         isGlobal: boolean;
     };
-    timestamp: number;
-    checkInOrOut: boolean;
     isLeave: boolean;
+    checkInOrOut: boolean;
     checkCompleted: boolean;
 }, {
     id: string;
+    timestamp: number;
     person: string | {
         id: string;
         firstName: string;
@@ -179,9 +180,8 @@ export declare const sPersonPresenceActionDto: z.ZodObject<{
         displayName: string;
         isGlobal: boolean;
     };
-    timestamp: number;
-    checkInOrOut: boolean;
     isLeave: boolean;
+    checkInOrOut: boolean;
     checkCompleted: boolean;
 }>;
 export type PersonPresenceActionDto = z.infer<typeof sPersonPresenceActionDto>;

package/dist/access-control/person.d.ts

@@ -52,11 +52,11 @@ export declare const sPersonDto: z.ZodObject<{
     id: string;
     position: string | null;
     version: number;
-    createdOn: string;
-    lastModifiedOn: string;
     firstName: string;
     lastName: string;
     avatarId: string | null;
+    createdOn: string;
+    lastModifiedOn: string;
     refs: Record<string, string | string[]>;
     validFrom: string | null;
     validTo: string | null;
@@ -77,11 +77,11 @@ export declare const sPersonDto: z.ZodObject<{
     id: string;
     position: string | null;
     version: number;
-    createdOn: string;
-    lastModifiedOn: string;
     firstName: string;
     lastName: string;
     avatarId: string | null;
+    createdOn: string;
+    lastModifiedOn: string;
     refs: Record<string, string | string[]>;
     validFrom: string | null;
     validTo: string | null;

package/dist/agent-communication/protocol.d.ts

@@ -235,7 +235,7 @@ export declare const sAccessControlCapabilityReport: z.ZodObject<{
         formatDescription?: string | undefined;
         maxPerPerson?: number | undefined;
     }[];
-    accessObjects: ("person" | "zone" | "device" | "schedule" | "accessRule")[];
+    accessObjects: ("accessRule" | "schedule" | "person" | "device" | "zone")[];
     oneSchedulePerDoor: boolean;
 }, {
     tokens: {
@@ -244,7 +244,7 @@ export declare const sAccessControlCapabilityReport: z.ZodObject<{
         formatDescription?: string | undefined;
         maxPerPerson?: number | undefined;
     }[];
-    accessObjects: ("person" | "zone" | "device" | "schedule" | "accessRule")[];
+    accessObjects: ("accessRule" | "schedule" | "person" | "device" | "zone")[];
     oneSchedulePerDoor: boolean;
 }>;
 export declare const sRegisterRq: z.ZodObject<{
@@ -341,7 +341,7 @@ export declare const sRegisterRq: z.ZodObject<{
             formatDescription?: string | undefined;
             maxPerPerson?: number | undefined;
         }[];
-        accessObjects: ("person" | "zone" | "device" | "schedule" | "accessRule")[];
+        accessObjects: ("accessRule" | "schedule" | "person" | "device" | "zone")[];
         oneSchedulePerDoor: boolean;
     }, {
         tokens: {
@@ -350,7 +350,7 @@ export declare const sRegisterRq: z.ZodObject<{
             formatDescription?: string | undefined;
             maxPerPerson?: number | undefined;
         }[];
-        accessObjects: ("person" | "zone" | "device" | "schedule" | "accessRule")[];
+        accessObjects: ("accessRule" | "schedule" | "person" | "device" | "zone")[];
         oneSchedulePerDoor: boolean;
     }>>>;
 }, "strip", z.ZodTypeAny, {
@@ -378,7 +378,7 @@ export declare const sRegisterRq: z.ZodObject<{
             formatDescription?: string | undefined;
             maxPerPerson?: number | undefined;
         }[];
-        accessObjects: ("person" | "zone" | "device" | "schedule" | "accessRule")[];
+        accessObjects: ("accessRule" | "schedule" | "person" | "device" | "zone")[];
         oneSchedulePerDoor: boolean;
     }> | undefined;
 }, {
@@ -406,7 +406,7 @@ export declare const sRegisterRq: z.ZodObject<{
             formatDescription?: string | undefined;
             maxPerPerson?: number | undefined;
         }[];
-        accessObjects: ("person" | "zone" | "device" | "schedule" | "accessRule")[];
+        accessObjects: ("accessRule" | "schedule" | "person" | "device" | "zone")[];
         oneSchedulePerDoor: boolean;
     }> | undefined;
 }>;
@@ -559,7 +559,6 @@ export declare const sRunCommandRq: z.ZodObject<{
     batchId: z.ZodOptional<z.ZodString>;
     params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
-    command: string;
     kind: "command";
     device: {
         name: string;
@@ -569,10 +568,10 @@ export declare const sRunCommandRq: z.ZodObject<{
             [k: string]: unknown;
         };
     };
+    command: string;
     params?: Record<string, unknown> | undefined;
     batchId?: string | undefined;
 }, {
-    command: string;
     kind: "command";
     device: {
         name: string;
@@ -582,6 +581,7 @@ export declare const sRunCommandRq: z.ZodObject<{
             [k: string]: unknown;
         };
     };
+    command: string;
     params?: Record<string, unknown> | undefined;
     batchId?: string | undefined;
 }>;
@@ -6301,14 +6301,14 @@ export declare const sChangeIssue: z.ZodObject<{
     code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
     message?: string | undefined;
     path?: string | undefined;
-    objectKind?: "person" | "zone" | "device" | "schedule" | "accessRule" | undefined;
+    objectKind?: "accessRule" | "schedule" | "person" | "device" | "zone" | undefined;
     objectId?: string | undefined;
 }, {
     index?: number | undefined;
     code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
     message?: string | undefined;
     path?: string | undefined;
-    objectKind?: "person" | "zone" | "device" | "schedule" | "accessRule" | undefined;
+    objectKind?: "accessRule" | "schedule" | "person" | "device" | "zone" | undefined;
     objectId?: string | undefined;
 }>;
 export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
@@ -6333,14 +6333,14 @@ export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
         code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
         message?: string | undefined;
         path?: string | undefined;
-        objectKind?: "person" | "zone" | "device" | "schedule" | "accessRule" | undefined;
+        objectKind?: "accessRule" | "schedule" | "person" | "device" | "zone" | undefined;
         objectId?: string | undefined;
     }, {
         index?: number | undefined;
         code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
         message?: string | undefined;
         path?: string | undefined;
-        objectKind?: "person" | "zone" | "device" | "schedule" | "accessRule" | undefined;
+        objectKind?: "accessRule" | "schedule" | "person" | "device" | "zone" | undefined;
         objectId?: string | undefined;
     }>, "many">;
 }, z.UnknownKeysParam, z.ZodTypeAny, {
@@ -6349,7 +6349,7 @@ export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
         code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
         message?: string | undefined;
         path?: string | undefined;
-        objectKind?: "person" | "zone" | "device" | "schedule" | "accessRule" | undefined;
+        objectKind?: "accessRule" | "schedule" | "person" | "device" | "zone" | undefined;
         objectId?: string | undefined;
     }[];
 }, {
@@ -6358,7 +6358,7 @@ export declare const sValidateChangeRs: z.ZodIntersection<z.ZodObject<{
         code?: "BAD_REFERENCE" | "NOT_FOUND" | "NOT_UNIQUE" | "INVALID" | "NOT_SUPPORTED" | undefined;
         message?: string | undefined;
         path?: string | undefined;
-        objectKind?: "person" | "zone" | "device" | "schedule" | "accessRule" | undefined;
+        objectKind?: "accessRule" | "schedule" | "person" | "device" | "zone" | undefined;
         objectId?: string | undefined;
     }[];
 }>>;

package/dist/agent-communication/queries.d.ts

@@ -112,18 +112,18 @@ export declare const sMediaSearchMatch: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     endTime: number | null;
     startTime: number;
+    providerAssignedRef: string;
     objectKind: string;
     probability: number;
-    providerAssignedRef: string;
     foreignRef: string;
     provider: string;
     relevance: number;
 }, {
     endTime: number | null;
     startTime: number;
+    providerAssignedRef: string;
     objectKind: string;
     probability: number;
-    providerAssignedRef: string;
     foreignRef: string;
     provider: string;
     relevance: number;
@@ -140,18 +140,18 @@ export declare const sMediaSearchResponse: z.ZodArray<z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     endTime: number | null;
     startTime: number;
+    providerAssignedRef: string;
     objectKind: string;
     probability: number;
-    providerAssignedRef: string;
     foreignRef: string;
     provider: string;
     relevance: number;
 }, {
     endTime: number | null;
     startTime: number;
+    providerAssignedRef: string;
     objectKind: string;
     probability: number;
-    providerAssignedRef: string;
     foreignRef: string;
     provider: string;
     relevance: number;
@@ -317,18 +317,18 @@ export declare const responseSchemasByType: {
     }, "strip", z.ZodTypeAny, {
         endTime: number | null;
         startTime: number;
+        providerAssignedRef: string;
         objectKind: string;
         probability: number;
-        providerAssignedRef: string;
         foreignRef: string;
         provider: string;
         relevance: number;
     }, {
         endTime: number | null;
         startTime: number;
+        providerAssignedRef: string;
         objectKind: string;
         probability: number;
-        providerAssignedRef: string;
         foreignRef: string;
         provider: string;
         relevance: number;

package/dist/alarm-automation.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+import { DeviceEvent } from './device-event';
+import { DeviceType } from './device';
+import { AutomationRuleBody } from './automation';
+export declare const sAlarmBehavior: z.ZodEnum<["ignore", "trigger-always", "trigger-when-armed"]>;
+export declare const sAlarmAutomationLevel: z.ZodEnum<["by-device", "by-type"]>;
+export declare const sAlarmAutomationCriteria: z.ZodObject<{
+    field: z.ZodString;
+    value: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    field: string;
+    value?: unknown;
+}, {
+    field: string;
+    value?: unknown;
+}>;
+export declare const sAlarmAutomationMetadata: z.ZodObject<{
+    behavior: z.ZodEnum<["ignore", "trigger-always", "trigger-when-armed"]>;
+    level: z.ZodEnum<["by-device", "by-type"]>;
+    eventKind: z.ZodOptional<z.ZodString>;
+    eventCriteria: z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        value: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        field: string;
+        value?: unknown;
+    }, {
+        field: string;
+        value?: unknown;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    behavior: "ignore" | "trigger-always" | "trigger-when-armed";
+    level: "by-device" | "by-type";
+    eventCriteria: {
+        field: string;
+        value?: unknown;
+    }[];
+    eventKind?: string | undefined;
+}, {
+    behavior: "ignore" | "trigger-always" | "trigger-when-armed";
+    level: "by-device" | "by-type";
+    eventCriteria: {
+        field: string;
+        value?: unknown;
+    }[];
+    eventKind?: string | undefined;
+}>;
+export type AlarmBehavior = z.infer<typeof sAlarmBehavior>;
+export type AlarmAutomationLevel = z.infer<typeof sAlarmAutomationLevel>;
+export type AlarmAutomationMetadata = z.infer<typeof sAlarmAutomationMetadata>;
+export declare const isAlarmAutomationMetadata: (metadata: unknown) => metadata is AlarmAutomationMetadata;
+export declare const formatByDeviceAutomationCode: (deviceId: string) => string;
+export declare const formatByTypeAutomationCode: (eventKind: DeviceEvent["kind"]) => string;
+export declare const isByDeviceAutomationCode: (code: string) => boolean;
+export declare const isByTypeAutomationCode: (code: string) => boolean;
+export type ParsedByDeviceAutomationCode = {
+    type: 'by-device';
+    value: string;
+};
+export type ParsedByTypeAutomationCode = {
+    type: 'by-type';
+    value: DeviceEvent['kind'];
+};
+export type ParsedAlarmAutomationCode = ParsedByDeviceAutomationCode | ParsedByTypeAutomationCode;
+export declare const parseAlarmAutomationCode: (code: string) => ParsedAlarmAutomationCode | null;
+export declare const createAlarmRuleBody: (eventKind: DeviceEvent["kind"], behavior: AlarmBehavior, deviceType: DeviceType, eventCriteria: AlarmAutomationMetadata["eventCriteria"], deviceId?: string) => AutomationRuleBody;
+export declare const resolveAlarmExclusivityGroup: (deviceType: DeviceType) => string;

package/dist/alarm-automation.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveAlarmExclusivityGroup = exports.createAlarmRuleBody = exports.parseAlarmAutomationCode = exports.isByTypeAutomationCode = exports.isByDeviceAutomationCode = exports.formatByTypeAutomationCode = exports.formatByDeviceAutomationCode = exports.isAlarmAutomationMetadata = exports.sAlarmAutomationMetadata = exports.sAlarmAutomationCriteria = exports.sAlarmAutomationLevel = exports.sAlarmBehavior = void 0;
+const zod_1 = require("zod");
+exports.sAlarmBehavior = zod_1.z.enum([
+    'ignore',
+    'trigger-always',
+    'trigger-when-armed',
+]);
+exports.sAlarmAutomationLevel = zod_1.z.enum(['by-device', 'by-type']);
+exports.sAlarmAutomationCriteria = zod_1.z.object({
+    field: zod_1.z.string().describe('The field to match'),
+    value: zod_1.z.unknown().describe('The value to match'),
+});
+exports.sAlarmAutomationMetadata = zod_1.z.object({
+    behavior: exports.sAlarmBehavior,
+    level: exports.sAlarmAutomationLevel,
+    eventKind: zod_1.z.string().optional().describe('The kind of event to match'),
+    eventCriteria: zod_1.z.array(exports.sAlarmAutomationCriteria),
+});
+const isAlarmAutomationMetadata = (metadata) => {
+    if (typeof metadata !== 'object' || metadata === null) {
+        return false;
+    }
+    const parsed = exports.sAlarmAutomationMetadata.safeParse(metadata);
+    return parsed.success;
+};
+exports.isAlarmAutomationMetadata = isAlarmAutomationMetadata;
+// Alarm assigns automation rules with code that is either:
+// [by-event]:[event-kind]
+// [by-device]:[device-id]
+const formatByDeviceAutomationCode = (deviceId) => {
+    return `by-device:${deviceId}`;
+};
+exports.formatByDeviceAutomationCode = formatByDeviceAutomationCode;
+const formatByTypeAutomationCode = (eventKind) => {
+    return `by-Type:${eventKind}`;
+};
+exports.formatByTypeAutomationCode = formatByTypeAutomationCode;
+const isByDeviceAutomationCode = (code) => {
+    return code.startsWith('by-device:');
+};
+exports.isByDeviceAutomationCode = isByDeviceAutomationCode;
+const isByTypeAutomationCode = (code) => {
+    return code.startsWith('by-type:');
+};
+exports.isByTypeAutomationCode = isByTypeAutomationCode;
+const parseAlarmAutomationCode = (code) => {
+    if ((0, exports.isByDeviceAutomationCode)(code)) {
+        return {
+            type: 'by-device',
+            value: code.replace('by-device:', ''),
+        };
+    }
+    if ((0, exports.isByTypeAutomationCode)(code)) {
+        return {
+            type: 'by-type',
+            value: code.replace('by-type:', ''),
+        };
+    }
+    return null;
+};
+exports.parseAlarmAutomationCode = parseAlarmAutomationCode;
+// {
+//     "displayName": "Trigger alarm on force-open door events",
+//     "enabled": true,
+//     "body": {
+//         "onEvent": "door-force",
+//         "commands": [
+//             {
+//                 "command": "alarm.set-trigger",
+//                 "target": "target.type ==\"alarm\"",
+//                 "params": {
+//                     "event": "{{event}}",
+//                     "onlyIfArmed": "{{device.provider ==\"paxton\"}}"
+//                 }
+//             }
+//         ]
+//     }
+// }
+const encodeComparison = (value) => {
+    if (typeof value === 'string') {
+        return `== ${JSON.stringify(value)}`;
+    }
+    if (typeof value === 'number' || typeof value === 'boolean') {
+        return `== ${String(value)}`;
+    }
+    if (Array.isArray(value)) {
+        return `in (${value.map(encodeComparison).join(', ')})`;
+    }
+    if (value === null) {
+        return '== null';
+    }
+    throw new Error(`Unsupported value type for comparison: ${typeof value}`);
+};
+const createAlarmRuleBody = (eventKind, behavior, deviceType, eventCriteria, deviceId) => {
+    let runIf = 'device.type == "' + deviceType + '"';
+    if (deviceId) {
+        runIf += ` && device.id == "${deviceId}"`;
+    }
+    for (const criterion of eventCriteria) {
+        runIf += ` && event.${criterion.field} ${encodeComparison(criterion.value)}`;
+    }
+    return {
+        onEvent: eventKind,
+        runIf,
+        commands: behavior === 'ignore'
+            ? []
+            : [
+                {
+                    command: 'alarm.set-trigger',
+                    target: 'target.type =="alarm"',
+                    params: {
+                        event: '{{event}}',
+                        onlyIfArmed: behavior === 'trigger-when-armed',
+                    },
+                },
+            ],
+    };
+};
+exports.createAlarmRuleBody = createAlarmRuleBody;
+const resolveAlarmExclusivityGroup = (deviceType) => `alarm-${deviceType}`;
+exports.resolveAlarmExclusivityGroup = resolveAlarmExclusivityGroup;

package/dist/api/media.d.ts

@@ -80,11 +80,11 @@ export declare const sGetScenePreviewClipRequest: z.ZodObject<{
     deviceId: z.ZodString;
     providerAssignedRef: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    providerAssignedRef: string;
     deviceId: string;
-}, {
     providerAssignedRef: string;
+}, {
     deviceId: string;
+    providerAssignedRef: string;
 }>;
 export declare const sGetObjectSnapshotRequest: z.ZodObject<{
     deviceId: z.ZodString;
@@ -94,15 +94,15 @@ export declare const sGetObjectSnapshotRequest: z.ZodObject<{
     height: z.ZodOptional<z.ZodNumber>;
     quality: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    providerAssignedRef: string;
     deviceId: string;
+    providerAssignedRef: string;
     crop: boolean;
     boxes: boolean;
     height?: number | undefined;
     quality?: number | undefined;
 }, {
-    providerAssignedRef: string;
     deviceId: string;
+    providerAssignedRef: string;
     crop: boolean;
     boxes: boolean;
     height?: number | undefined;
@@ -112,11 +112,11 @@ export declare const sGetObjectThumbnailRequest: z.ZodObject<{
     deviceId: z.ZodString;
     providerAssignedRef: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    providerAssignedRef: string;
     deviceId: string;
-}, {
     providerAssignedRef: string;
+}, {
     deviceId: string;
+    providerAssignedRef: string;
 }>;
 export declare const sGetExportLinkResponse: z.ZodObject<{
     relativeUrl: z.ZodString;

package/dist/automation.d.ts

@@ -86,6 +86,7 @@ export declare const sAutomationRuleProps: z.ZodObject<{
     exclusivityGroup: z.ZodNullable<z.ZodString>;
     score: z.ZodNullable<z.ZodNumber>;
     module: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 }, "strip", z.ZodTypeAny, {
     code: string | null;
     module: string | null;
@@ -98,6 +99,7 @@ export declare const sAutomationRuleProps: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     };
+    metadata: Record<string, unknown>;
     displayName: string;
     enabled: boolean;
     exclusivityGroup: string | null;
@@ -115,6 +117,7 @@ export declare const sAutomationRuleProps: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     };
+    metadata: Record<string, unknown>;
     displayName: string;
     enabled: boolean;
     exclusivityGroup: string | null;
@@ -162,6 +165,7 @@ export declare const sAddAutomationRuleRequest: z.ZodObject<{
     exclusivityGroup: z.ZodNullable<z.ZodString>;
     score: z.ZodNullable<z.ZodNumber>;
     module: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 }, "strip", z.ZodTypeAny, {
     code: string | null;
     module: string | null;
@@ -174,6 +178,7 @@ export declare const sAddAutomationRuleRequest: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     };
+    metadata: Record<string, unknown>;
     displayName: string;
     enabled: boolean;
     exclusivityGroup: string | null;
@@ -191,6 +196,7 @@ export declare const sAddAutomationRuleRequest: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     };
+    metadata: Record<string, unknown>;
     displayName: string;
     enabled: boolean;
     exclusivityGroup: string | null;
@@ -238,6 +244,7 @@ export declare const sUpdateAutomationRule: z.ZodObject<{
     exclusivityGroup: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     score: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     module: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 } & {
     id: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -253,6 +260,7 @@ export declare const sUpdateAutomationRule: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     } | undefined;
+    metadata?: Record<string, unknown> | undefined;
     description?: string | undefined;
     displayName?: string | undefined;
     enabled?: boolean | undefined;
@@ -271,6 +279,7 @@ export declare const sUpdateAutomationRule: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     } | undefined;
+    metadata?: Record<string, unknown> | undefined;
     description?: string | undefined;
     displayName?: string | undefined;
     enabled?: boolean | undefined;
@@ -318,6 +327,7 @@ export declare const sAutomationRuleDto: z.ZodObject<{
     exclusivityGroup: z.ZodNullable<z.ZodString>;
     score: z.ZodNullable<z.ZodNumber>;
     module: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 } & {
     id: z.ZodString;
     createdOn: z.ZodString;
@@ -335,12 +345,13 @@ export declare const sAutomationRuleDto: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     };
+    metadata: Record<string, unknown>;
     displayName: string;
+    createdOn: string;
+    lastModifiedOn: string;
     enabled: boolean;
     exclusivityGroup: string | null;
     score: number | null;
-    createdOn: string;
-    lastModifiedOn: string;
     description?: string | undefined;
 }, {
     code: string | null;
@@ -355,12 +366,13 @@ export declare const sAutomationRuleDto: z.ZodObject<{
         }[];
         runIf?: string | undefined;
     };
+    metadata: Record<string, unknown>;
     displayName: string;
+    createdOn: string;
+    lastModifiedOn: string;
     enabled: boolean;
     exclusivityGroup: string | null;
     score: number | null;
-    createdOn: string;
-    lastModifiedOn: string;
     description?: string | undefined;
 }>;
 export type AutomationRuleBody = z.infer<typeof sAutomationRuleBody>;

package/dist/automation.js

@@ -43,6 +43,7 @@ exports.sAutomationRuleProps = zod_1.z.object({
         .string()
         .nullable()
         .describe('The module the automation rule belongs to'),
+    metadata: zod_1.z.record(zod_1.z.unknown()),
 });
 exports.sAddAutomationRuleRequest = exports.sAutomationRuleProps;
 exports.sUpdateAutomationRule = exports.sAutomationRuleProps.partial().merge(zod_1.z.object({