@awarevue/api-types 2.0.13 → 2.0.15

package/dist/{device-command.d.ts → commands/all.d.ts}

@@ -1,18 +1,16 @@
-import { AlarmCommand } from './device/alarm';
-import { CameraCommand } from './device/camera';
-import { CameraLiftCommand } from './device/camera-lift';
-import { DeviceGatewayCommand } from './device/device-gateway';
-import { DisplayCommand } from './device/display';
-import { DoorCommand } from './device/door';
-import { IntercomTerminalCommand } from './device/intercom-terminal';
-import { IoBoardCommand } from './device/io-board';
-import { NvrExporterCommand } from './device/nvr-exporter';
-import { PbxCommand } from './device/pbx';
-import { PresenceTrackerCommand } from './device/presence-tracker';
-import { ReaderCommand } from './device/reader/index';
-import { ServerCommand } from './device/server';
-import { PermissionId } from './permissions';
-export type AnyDeviceCommand = ServerCommand | DeviceGatewayCommand | CameraCommand | DoorCommand | ReaderCommand | IoBoardCommand | CameraLiftCommand | AlarmCommand | IntercomTerminalCommand | PbxCommand | PresenceTrackerCommand | DisplayCommand | NvrExporterCommand;
+import { AlarmCommand } from './alarm';
+import { CameraCommand } from './camera';
+import { CameraLiftCommand } from './camera-lift';
+import { DisplayCommand } from './display';
+import { DoorCommand } from './door';
+import { IntercomTerminalCommand } from './intercom-terminal';
+import { IoBoardCommand } from './io-board';
+import { NvrExporterCommand } from './nvr-exporter';
+import { PbxCommand } from './pbx';
+import { PresenceTrackerCommand } from './presence-tracker';
+import { ServerCommand } from './server';
+import { PermissionId } from '../permissions';
+export type AnyDeviceCommand = ServerCommand | CameraCommand | DoorCommand | IoBoardCommand | CameraLiftCommand | AlarmCommand | IntercomTerminalCommand | PbxCommand | PresenceTrackerCommand | DisplayCommand | NvrExporterCommand;
 export type CommandRun<TCommand extends AnyDeviceCommand = AnyDeviceCommand> = {
     timestamp: number;
     requestId: string;
@@ -20,6 +18,639 @@ export type CommandRun<TCommand extends AnyDeviceCommand = AnyDeviceCommand> = {
     senderId?: number;
 } & TCommand;
 export declare const commandSchemas: {
+    readonly 'server.run-macro': import("zod").ZodObject<{
+        command: import("zod").ZodLiteral<"server.run-macro">;
+        params: import("zod").ZodObject<{
+            macroId: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            macroId: string;
+        }, {
+            macroId: string;
+        }>;
+    }, "strip", import("zod").ZodTypeAny, {
+        params: {
+            macroId: string;
+        };
+        command: "server.run-macro";
+    }, {
+        params: {
+            macroId: string;
+        };
+        command: "server.run-macro";
+    }>;
+    readonly 'server.notify': import("zod").ZodObject<{
+        command: import("zod").ZodLiteral<"server.notify">;
+        params: import("zod").ZodObject<{
+            source: import("zod").ZodUnion<[import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodIntersection<import("zod").ZodObject<{
+                name: import("zod").ZodString;
+                foreignRef: import("zod").ZodString;
+                provider: import("zod").ZodString;
+                providerMetadata: import("zod").ZodObject<{}, "strip", import("zod").ZodUnknown, import("zod").objectOutputType<{}, import("zod").ZodUnknown, "strip">, import("zod").objectInputType<{}, import("zod").ZodUnknown, "strip">>;
+            }, "strip", import("zod").ZodTypeAny, {
+                name: string;
+                foreignRef: string;
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
+            }, {
+                name: string;
+                foreignRef: string;
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
+            }>, import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"alarm">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "alarm";
+            }, {
+                type: "alarm";
+            }>, import("zod").ZodObject<{
+                lensType: import("zod").ZodEnum<["flat", "fisheye"]>;
+                mountPoint: import("zod").ZodEnum<["wall", "ceiling", "floor"]>;
+                ptzCapable: import("zod").ZodBoolean;
+                ptzPanSpeed: import("zod").ZodNumber;
+                ptzTiltSpeed: import("zod").ZodNumber;
+                ptzZoomSpeed: import("zod").ZodNumber;
+                panMin: import("zod").ZodNumber;
+                panMax: import("zod").ZodNumber;
+                tiltMin: import("zod").ZodNumber;
+                tiltMax: import("zod").ZodNumber;
+                zoomMin: import("zod").ZodNumber;
+                zoomMax: import("zod").ZodNumber;
+                recordingCapable: import("zod").ZodBoolean;
+                webrtcPlaybackSource: import("zod").ZodNullable<import("zod").ZodIntersection<import("zod").ZodObject<{
+                    kind: import("zod").ZodString;
+                }, "strip", import("zod").ZodTypeAny, {
+                    kind: string;
+                }, {
+                    kind: string;
+                }>, import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>>;
+                streams: import("zod").ZodArray<import("zod").ZodObject<{
+                    id: import("zod").ZodString;
+                    displayName: import("zod").ZodString;
+                    externalPlayerUrl: import("zod").ZodNullable<import("zod").ZodString>;
+                }, "strip", import("zod").ZodTypeAny, {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }, {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }>, "many">;
+                defaultStreamId: import("zod").ZodString;
+            } & {
+                type: import("zod").ZodLiteral<"camera">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "camera";
+                streams: {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }[];
+                lensType: "flat" | "fisheye";
+                mountPoint: "wall" | "ceiling" | "floor";
+                ptzCapable: boolean;
+                ptzPanSpeed: number;
+                ptzTiltSpeed: number;
+                ptzZoomSpeed: number;
+                panMin: number;
+                panMax: number;
+                tiltMin: number;
+                tiltMax: number;
+                zoomMin: number;
+                zoomMax: number;
+                recordingCapable: boolean;
+                webrtcPlaybackSource: ({
+                    kind: string;
+                } & Record<string, unknown>) | null;
+                defaultStreamId: string;
+            }, {
+                type: "camera";
+                streams: {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }[];
+                lensType: "flat" | "fisheye";
+                mountPoint: "wall" | "ceiling" | "floor";
+                ptzCapable: boolean;
+                ptzPanSpeed: number;
+                ptzTiltSpeed: number;
+                ptzZoomSpeed: number;
+                panMin: number;
+                panMax: number;
+                tiltMin: number;
+                tiltMax: number;
+                zoomMin: number;
+                zoomMax: number;
+                recordingCapable: boolean;
+                webrtcPlaybackSource: ({
+                    kind: string;
+                } & Record<string, unknown>) | null;
+                defaultStreamId: string;
+            }>, import("zod").ZodObject<{
+                canReportOpenState: import("zod").ZodBoolean;
+                canReportLockState: import("zod").ZodBoolean;
+                canControlLock: import("zod").ZodBoolean;
+                canRelease: import("zod").ZodBoolean;
+            } & {
+                type: import("zod").ZodLiteral<"door">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "door";
+                canReportOpenState: boolean;
+                canReportLockState: boolean;
+                canControlLock: boolean;
+                canRelease: boolean;
+            }, {
+                type: "door";
+                canReportOpenState: boolean;
+                canReportLockState: boolean;
+                canControlLock: boolean;
+                canRelease: boolean;
+            }>, import("zod").ZodObject<{
+                inputs: import("zod").ZodArray<import("zod").ZodString, "many">;
+                outputs: import("zod").ZodArray<import("zod").ZodString, "many">;
+            } & {
+                type: import("zod").ZodLiteral<"io-board">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "io-board";
+                inputs: string[];
+                outputs: string[];
+            }, {
+                type: "io-board";
+                inputs: string[];
+                outputs: string[];
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"camera-lift">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "camera-lift";
+            }, {
+                type: "camera-lift";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"motion-sensor">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "motion-sensor";
+            }, {
+                type: "motion-sensor";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"panic-button">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "panic-button";
+            }, {
+                type: "panic-button";
+            }>, import("zod").ZodObject<{
+                sipUri: import("zod").ZodString;
+                sipUser: import("zod").ZodString;
+                sipPassword: import("zod").ZodString;
+                sipRealm: import("zod").ZodString;
+                remoteExtension: import("zod").ZodString;
+            } & {
+                type: import("zod").ZodLiteral<"intercom-terminal">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "intercom-terminal";
+                sipUri: string;
+                sipUser: string;
+                sipPassword: string;
+                sipRealm: string;
+                remoteExtension: string;
+            }, {
+                type: "intercom-terminal";
+                sipUri: string;
+                sipUser: string;
+                sipPassword: string;
+                sipRealm: string;
+                remoteExtension: string;
+            }>, import("zod").ZodObject<{
+                sipWsUrl: import("zod").ZodString;
+            } & {
+                type: import("zod").ZodLiteral<"pbx">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "pbx";
+                sipWsUrl: string;
+            }, {
+                type: "pbx";
+                sipWsUrl: string;
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"server">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "server";
+            }, {
+                type: "server";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"intercom-operator">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "intercom-operator";
+            }, {
+                type: "intercom-operator";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"device-gateway">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "device-gateway";
+            }, {
+                type: "device-gateway";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"presence-tracker">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "presence-tracker";
+            }, {
+                type: "presence-tracker";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"reader">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "reader";
+            }, {
+                type: "reader";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"display">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "display";
+            }, {
+                type: "display";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"nvr-recorder">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "nvr-recorder";
+            }, {
+                type: "nvr-recorder";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"nvr-exporter">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "nvr-exporter";
+            }, {
+                type: "nvr-exporter";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"nvr-analytics-server">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "nvr-analytics-server";
+            }, {
+                type: "nvr-analytics-server";
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"system">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "system";
+            }, {
+                type: "system";
+            }>]>>]>, import("zod").ZodTuple<[import("zod").ZodString, import("zod").ZodString], null>]>;
+            message: import("zod").ZodString;
+            severity: import("zod").ZodEnum<["info", "warning", "critical"]>;
+            metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+            notificationRef: import("zod").ZodNullable<import("zod").ZodString>;
+            recipientId: import("zod").ZodNullable<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            message: string;
+            source: string | [string, string] | ({
+                name: string;
+                foreignRef: string;
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
+            } & ({
+                type: "alarm";
+            } | {
+                type: "camera";
+                streams: {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }[];
+                lensType: "flat" | "fisheye";
+                mountPoint: "wall" | "ceiling" | "floor";
+                ptzCapable: boolean;
+                ptzPanSpeed: number;
+                ptzTiltSpeed: number;
+                ptzZoomSpeed: number;
+                panMin: number;
+                panMax: number;
+                tiltMin: number;
+                tiltMax: number;
+                zoomMin: number;
+                zoomMax: number;
+                recordingCapable: boolean;
+                webrtcPlaybackSource: ({
+                    kind: string;
+                } & Record<string, unknown>) | null;
+                defaultStreamId: string;
+            } | {
+                type: "door";
+                canReportOpenState: boolean;
+                canReportLockState: boolean;
+                canControlLock: boolean;
+                canRelease: boolean;
+            } | {
+                type: "io-board";
+                inputs: string[];
+                outputs: string[];
+            } | {
+                type: "camera-lift";
+            } | {
+                type: "motion-sensor";
+            } | {
+                type: "panic-button";
+            } | {
+                type: "intercom-terminal";
+                sipUri: string;
+                sipUser: string;
+                sipPassword: string;
+                sipRealm: string;
+                remoteExtension: string;
+            } | {
+                type: "pbx";
+                sipWsUrl: string;
+            } | {
+                type: "server";
+            } | {
+                type: "intercom-operator";
+            } | {
+                type: "device-gateway";
+            } | {
+                type: "presence-tracker";
+            } | {
+                type: "reader";
+            } | {
+                type: "display";
+            } | {
+                type: "nvr-recorder";
+            } | {
+                type: "nvr-exporter";
+            } | {
+                type: "nvr-analytics-server";
+            } | {
+                type: "system";
+            }));
+            metadata: Record<string, unknown>;
+            severity: "info" | "warning" | "critical";
+            notificationRef: string | null;
+            recipientId: string | null;
+        }, {
+            message: string;
+            source: string | [string, string] | ({
+                name: string;
+                foreignRef: string;
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
+            } & ({
+                type: "alarm";
+            } | {
+                type: "camera";
+                streams: {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }[];
+                lensType: "flat" | "fisheye";
+                mountPoint: "wall" | "ceiling" | "floor";
+                ptzCapable: boolean;
+                ptzPanSpeed: number;
+                ptzTiltSpeed: number;
+                ptzZoomSpeed: number;
+                panMin: number;
+                panMax: number;
+                tiltMin: number;
+                tiltMax: number;
+                zoomMin: number;
+                zoomMax: number;
+                recordingCapable: boolean;
+                webrtcPlaybackSource: ({
+                    kind: string;
+                } & Record<string, unknown>) | null;
+                defaultStreamId: string;
+            } | {
+                type: "door";
+                canReportOpenState: boolean;
+                canReportLockState: boolean;
+                canControlLock: boolean;
+                canRelease: boolean;
+            } | {
+                type: "io-board";
+                inputs: string[];
+                outputs: string[];
+            } | {
+                type: "camera-lift";
+            } | {
+                type: "motion-sensor";
+            } | {
+                type: "panic-button";
+            } | {
+                type: "intercom-terminal";
+                sipUri: string;
+                sipUser: string;
+                sipPassword: string;
+                sipRealm: string;
+                remoteExtension: string;
+            } | {
+                type: "pbx";
+                sipWsUrl: string;
+            } | {
+                type: "server";
+            } | {
+                type: "intercom-operator";
+            } | {
+                type: "device-gateway";
+            } | {
+                type: "presence-tracker";
+            } | {
+                type: "reader";
+            } | {
+                type: "display";
+            } | {
+                type: "nvr-recorder";
+            } | {
+                type: "nvr-exporter";
+            } | {
+                type: "nvr-analytics-server";
+            } | {
+                type: "system";
+            }));
+            metadata: Record<string, unknown>;
+            severity: "info" | "warning" | "critical";
+            notificationRef: string | null;
+            recipientId: string | null;
+        }>;
+    }, "strip", import("zod").ZodTypeAny, {
+        params: {
+            message: string;
+            source: string | [string, string] | ({
+                name: string;
+                foreignRef: string;
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
+            } & ({
+                type: "alarm";
+            } | {
+                type: "camera";
+                streams: {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }[];
+                lensType: "flat" | "fisheye";
+                mountPoint: "wall" | "ceiling" | "floor";
+                ptzCapable: boolean;
+                ptzPanSpeed: number;
+                ptzTiltSpeed: number;
+                ptzZoomSpeed: number;
+                panMin: number;
+                panMax: number;
+                tiltMin: number;
+                tiltMax: number;
+                zoomMin: number;
+                zoomMax: number;
+                recordingCapable: boolean;
+                webrtcPlaybackSource: ({
+                    kind: string;
+                } & Record<string, unknown>) | null;
+                defaultStreamId: string;
+            } | {
+                type: "door";
+                canReportOpenState: boolean;
+                canReportLockState: boolean;
+                canControlLock: boolean;
+                canRelease: boolean;
+            } | {
+                type: "io-board";
+                inputs: string[];
+                outputs: string[];
+            } | {
+                type: "camera-lift";
+            } | {
+                type: "motion-sensor";
+            } | {
+                type: "panic-button";
+            } | {
+                type: "intercom-terminal";
+                sipUri: string;
+                sipUser: string;
+                sipPassword: string;
+                sipRealm: string;
+                remoteExtension: string;
+            } | {
+                type: "pbx";
+                sipWsUrl: string;
+            } | {
+                type: "server";
+            } | {
+                type: "intercom-operator";
+            } | {
+                type: "device-gateway";
+            } | {
+                type: "presence-tracker";
+            } | {
+                type: "reader";
+            } | {
+                type: "display";
+            } | {
+                type: "nvr-recorder";
+            } | {
+                type: "nvr-exporter";
+            } | {
+                type: "nvr-analytics-server";
+            } | {
+                type: "system";
+            }));
+            metadata: Record<string, unknown>;
+            severity: "info" | "warning" | "critical";
+            notificationRef: string | null;
+            recipientId: string | null;
+        };
+        command: "server.notify";
+    }, {
+        params: {
+            message: string;
+            source: string | [string, string] | ({
+                name: string;
+                foreignRef: string;
+                provider: string;
+                providerMetadata: {} & {
+                    [k: string]: unknown;
+                };
+            } & ({
+                type: "alarm";
+            } | {
+                type: "camera";
+                streams: {
+                    id: string;
+                    displayName: string;
+                    externalPlayerUrl: string | null;
+                }[];
+                lensType: "flat" | "fisheye";
+                mountPoint: "wall" | "ceiling" | "floor";
+                ptzCapable: boolean;
+                ptzPanSpeed: number;
+                ptzTiltSpeed: number;
+                ptzZoomSpeed: number;
+                panMin: number;
+                panMax: number;
+                tiltMin: number;
+                tiltMax: number;
+                zoomMin: number;
+                zoomMax: number;
+                recordingCapable: boolean;
+                webrtcPlaybackSource: ({
+                    kind: string;
+                } & Record<string, unknown>) | null;
+                defaultStreamId: string;
+            } | {
+                type: "door";
+                canReportOpenState: boolean;
+                canReportLockState: boolean;
+                canControlLock: boolean;
+                canRelease: boolean;
+            } | {
+                type: "io-board";
+                inputs: string[];
+                outputs: string[];
+            } | {
+                type: "camera-lift";
+            } | {
+                type: "motion-sensor";
+            } | {
+                type: "panic-button";
+            } | {
+                type: "intercom-terminal";
+                sipUri: string;
+                sipUser: string;
+                sipPassword: string;
+                sipRealm: string;
+                remoteExtension: string;
+            } | {
+                type: "pbx";
+                sipWsUrl: string;
+            } | {
+                type: "server";
+            } | {
+                type: "intercom-operator";
+            } | {
+                type: "device-gateway";
+            } | {
+                type: "presence-tracker";
+            } | {
+                type: "reader";
+            } | {
+                type: "display";
+            } | {
+                type: "nvr-recorder";
+            } | {
+                type: "nvr-exporter";
+            } | {
+                type: "nvr-analytics-server";
+            } | {
+                type: "system";
+            }));
+            metadata: Record<string, unknown>;
+            severity: "info" | "warning" | "critical";
+            notificationRef: string | null;
+            recipientId: string | null;
+        };
+        command: "server.notify";
+    }>;
     readonly 'nvr-exporter.start-export': import("zod").ZodObject<{
         command: import("zod").ZodLiteral<"nvr-exporter.start-export">;
         params: import("zod").ZodObject<{
@@ -1158,22 +1789,22 @@ export declare const commandSchemas: {
             presetId: import("zod").ZodString;
             assignedRef: import("zod").ZodNullable<import("zod").ZodString>;
         }, "strip", import("zod").ZodTypeAny, {
-            presetId: string;
             assignedRef: string | null;
-        }, {
             presetId: string;
+        }, {
             assignedRef: string | null;
+            presetId: string;
         }>;
     }, "strip", import("zod").ZodTypeAny, {
         params: {
-            presetId: string;
             assignedRef: string | null;
+            presetId: string;
         };
         command: "camera.preset-delete";
     }, {
         params: {
-            presetId: string;
             assignedRef: string | null;
+            presetId: string;
         };
         command: "camera.preset-delete";
     }>;