@uug-ai/models 1.7.73 → 1.7.74

package/dist/types.d.ts

@@ -7608,6 +7608,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/deviceheartbeat": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get DeviceHeartbeat (schema generation only)
+         * @description Internal endpoint used only to ensure DeviceHeartbeat schema is generated in OpenAPI spec
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["models.DeviceHeartbeat"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/devicekey": {
         parameters: {
             query?: never;
@@ -7725,6 +7764,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/devicemonitor": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get DeviceMonitor (schema generation only)
+         * @description Internal endpoint used only to ensure DeviceMonitor schema is generated in OpenAPI spec
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description OK */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["models.DeviceMonitor"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/deviceoption": {
         parameters: {
             query?: never;
@@ -37050,7 +37128,7 @@ export interface components {
             userId?: string;
         };
         /** @enum {string} */
-        "models.AccessTokenScope": "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "markers.read" | "markers.write" | "markers.all" | "application" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "days.read";
+        "models.AccessTokenScope": "application" | "markers.read" | "markers.write" | "markers.all" | "days.read" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete";
         "models.Account": {
             account?: components["schemas"]["models.AccountBody"];
         };
@@ -38108,23 +38186,22 @@ export interface components {
         };
         "models.Device": {
             agent?: components["schemas"]["models.DeviceAgent"];
-            /** @description Last heartbeat from the agent */
+            /** @description Liveness: the inputs the connection status is derived from, kept together.
+             *     Timestamps are points in time on the hub's clock (milliseconds since
+             *     epoch), written by every heartbeat; readers derive durations and status. */
             agentLastSeen?: number;
             analytics?: components["schemas"]["models.DeprecatedHeartbeat"][];
             /** @description AtRuntimeMetadata is computed when the device is read and never stored. */
             atRuntimeMetadata?: components["schemas"]["models.DeviceAtRuntimeMetadata"];
+            /** @description Provisioning sets CreatedAt (first heartbeat) */
             audit?: components["schemas"]["models.Audit"];
             /** @description Capabilities. Each is optional and any combination is valid, e.g. a camera
              *     with a built-in humidity sensor sets both Camera and HumiditySensor.
              *     Capability sub-documents hold capabilities and configuration only; live
              *     readings go to a time-series collection. */
             camera?: components["schemas"]["models.CameraMetadata"];
-            /** @description Liveness (milliseconds since epoch) */
-            connectionStart?: number;
-            /** @description Last time the agent could reach the device itself */
+            /** @description Last heartbeat in which the agent could reach the device itself */
             deviceLastSeen?: number;
-            /** @description Licence concept; moves to the organisation */
-            enterprise?: boolean;
             featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
             gps?: components["schemas"]["models.GPSMetadata"];
             groupIds?: string[];
@@ -38137,16 +38214,19 @@ export interface components {
             latestMedia?: components["schemas"]["models.DeviceMediaRef"];
             /** @description Latest media uploaded by the device, from any capability. Kept at the top
              *     level: device lists sort on LatestMediaTimestamp. LatestMedia is a value,
-             *     not a pointer, so readers never need a nil check; an empty Id means the
-             *     device has no media yet. */
+             *     not a pointer, so readers never need a nil check; an empty VideoFile means
+             *     the device has no media yet (the media pipeline does not store the Id). */
             latestMediaTimestamp?: number;
             lightSensor?: components["schemas"]["models.LightSensorMetadata"];
-            /** @description Fixed placement, not a real-time position */
+            /** @description Location is the fixed placement owners set (DevicePatch), e.g. an
+             *     address picked on a map. It is not a real-time position. */
             location?: components["schemas"]["models.Location"];
             metadata?: components["schemas"]["models.DeviceMetadata"];
+            /** @description Last notified state, owned by hub-monitor-device */
+            monitor?: components["schemas"]["models.DeviceMonitor"];
             /** @description Lifecycle */
             mute?: number;
-            /** @description e.g. "Front Door Camera" */
+            /** @description Set by users or at provisioning; display falls back to Agent.CameraName */
             name?: string;
             /** @description Tenancy. Heartbeat credentials live on the project: the cloud key resolves
              *     to an organisation and project, which must match these fields. */
@@ -38155,17 +38235,25 @@ export interface components {
             projectId?: string;
             schemaVersion?: number;
             siteIds?: string[];
-            /** @description Optional override; nil uses project defaults */
-            thresholds?: components["schemas"]["models.DeviceThresholds"];
             type?: components["schemas"]["models.DeviceType"];
             /** @description @LEGACY - removed once all readers use the fields above. */
             user_id?: string;
         };
         "models.DeviceAgent": {
             architecture?: string;
-            /** @description milliseconds since epoch */
             bootTime?: number;
-            /** @description e.g. "factory", "docker", "kubernetes" */
+            /** @description Name configured on the agent */
+            cameraName?: string;
+            /** @description CloudPublicKey is the public key the agent presented in its last
+             *     heartbeat. Agents within a project can be on different keys (e.g. a
+             *     legacy user key after the project credentials were regenerated), so it
+             *     is recorded per device for routing and key status. Authentication still
+             *     resolves key -> project; private and symmetric keys never live on the
+             *     device. */
+            cloudPublicKey?: string;
+            /** @description Deployment is how the agent runs: "factory", "kubernetes", "docker",
+             *     "kios" or "raspberrypi". It replaces the agent's legacy enterprise flag,
+             *     which only meant running under Kerberos Factory or Kubernetes. */
             deployment?: string;
             e2eEncryption?: boolean;
             hostname?: string;
@@ -38183,7 +38271,13 @@ export interface components {
             /** @description Build hash of the agent */
             releaseHash?: string;
             repository?: string;
-            uptimeSeconds?: number;
+            /** @description StartedAt (agent process start) and BootTime (host boot) are points in
+             *     time on the hub's clock (milliseconds since epoch), displayed as agent and
+             *     host uptime (now - StartedAt, now - BootTime). Durations are never
+             *     stored: they are stale as soon as they are written. Agents report both as
+             *     human-readable durations ("10 hours"), so the hub derives them on a
+             *     detected restart or reboot; they are approximate until the next one. */
+            startedAt?: number;
             /** @description Release tag of the agent */
             version?: string;
         };
@@ -38196,18 +38290,35 @@ export interface components {
         /** @enum {string} */
         "models.DeviceCapability": "camera" | "lightSensor" | "humiditySensor" | "gps";
         /** @enum {string} */
-        "models.DeviceConnectionStatus": "connected" | "healthy" | "idle" | "disconnected";
+        "models.DeviceConnectionStatus": "connected" | "idle" | "disconnected";
         "models.DeviceData": {
             activeDevices?: number;
             totalDevices?: number;
         };
         "models.DeviceFeaturePermissions": {
+            downloadRecordings?: components["schemas"]["models.PermissionLevel"];
             floorPlans?: components["schemas"]["models.PermissionLevel"];
             io?: components["schemas"]["models.PermissionLevel"];
             liveview?: components["schemas"]["models.PermissionLevel"];
             ptz?: components["schemas"]["models.PermissionLevel"];
             remoteConfig?: components["schemas"]["models.PermissionLevel"];
         };
+        "models.DeviceHeartbeat": {
+            /** @description Agent holds the agent-reported fields. StartedAt and BootTime are only
+             *     set when the receiver detected a restart or reboot; 0 keeps the stored
+             *     value. */
+            agent?: components["schemas"]["models.DeviceAgent"];
+            /** @description Camera holds the agent-reported camera fields; the user-owned ones
+             *     (FieldOfView, Presets, Tours) are ignored. Nil for devices without the
+             *     camera capability. */
+            camera?: components["schemas"]["models.CameraMetadata"];
+            /** @description ReceivedAt is when the hub received the heartbeat, on the hub's clock
+             *     (milliseconds since epoch). Agent clocks are not trusted. */
+            receivedAt?: number;
+            /** @description Type is the device's primary kind as known to the agent; empty keeps the
+             *     stored type. */
+            type?: components["schemas"]["models.DeviceType"];
+        };
         "models.DeviceKey": {
             key?: string;
             name?: string;
@@ -38241,6 +38352,12 @@ export interface components {
             /** @description VLM holds the stable ("normal") scenes used as context for VLM analysis. */
             vlm?: components["schemas"]["models.DeviceVLMMetadata"];
         };
+        "models.DeviceMonitor": {
+            /** @description milliseconds since epoch */
+            changedAt?: number;
+            /** @description "active" or "inactive" */
+            status?: string;
+        };
         "models.DeviceOption": {
             id?: string;
             text?: string;
@@ -38255,6 +38372,8 @@ export interface components {
             hidden?: boolean;
             installationDate?: string;
             lastMaintenance?: string;
+            /** @description Replaces the whole location */
+            location?: components["schemas"]["models.Location"];
             model?: string;
             name?: string;
             onFloorPlans?: string[];
@@ -38291,7 +38410,6 @@ export interface components {
         };
         "models.DeviceThresholds": {
             disconnected?: number;
-            healthy?: number;
             idle?: number;
         };
         /** @enum {string} */
@@ -39502,7 +39620,7 @@ export interface components {
             videowall?: components["schemas"]["models.Videowall"];
         };
         /** @enum {string} */
-        "models.Permission": "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "markers.read" | "markers.write" | "markers.all" | "application" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "days.read";
+        "models.Permission": "application" | "markers.read" | "markers.write" | "markers.all" | "days.read" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete";
         /** @enum {integer} */
         "models.PermissionLevel": 1 | 2 | 3 | 4 | 2 | 3 | 4 | 5 | 2 | 3 | 2 | 2 | 3 | 2 | 3 | 4;
         "models.Permissions": {
@@ -41540,9 +41658,11 @@ export declare namespace models {
     type DeviceAtRuntimeMetadata = components['schemas']['models.DeviceAtRuntimeMetadata'];
     type DeviceData = components['schemas']['models.DeviceData'];
     type DeviceFeaturePermissions = components['schemas']['models.DeviceFeaturePermissions'];
+    type DeviceHeartbeat = components['schemas']['models.DeviceHeartbeat'];
     type DeviceKey = components['schemas']['models.DeviceKey'];
     type DeviceMediaRef = components['schemas']['models.DeviceMediaRef'];
     type DeviceMetadata = components['schemas']['models.DeviceMetadata'];
+    type DeviceMonitor = components['schemas']['models.DeviceMonitor'];
     type DeviceOption = components['schemas']['models.DeviceOption'];
     type DevicePatch = components['schemas']['models.DevicePatch'];
     type DevicePlacement = components['schemas']['models.DevicePlacement'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uug-ai/models",
-  "version": "1.7.73",
+  "version": "1.7.74",
   "description": "TypeScript type definitions for Go models",
   "main": "dist/types.js",
   "types": "dist/types.d.ts",