@uug-ai/models 1.7.72 → 1.7.73

package/dist/types.d.ts

@@ -7413,6 +7413,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/deviceagent": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get DeviceAgent (schema generation only)
+         * @description Internal endpoint used only to ensure DeviceAgent 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.DeviceAgent"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/deviceatruntimemetadata": {
         parameters: {
             query?: never;
@@ -7608,6 +7647,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/devicemediaref": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get DeviceMediaRef (schema generation only)
+         * @description Internal endpoint used only to ensure DeviceMediaRef 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.DeviceMediaRef"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/devicemetadata": {
         parameters: {
             query?: never;
@@ -7803,6 +7881,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/devicethresholds": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get DeviceThresholds (schema generation only)
+         * @description Internal endpoint used only to ensure DeviceThresholds 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.DeviceThresholds"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/devicevlmmetadata": {
         parameters: {
             query?: never;
@@ -18489,6 +18606,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/gpsfix": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get GPSFix (schema generation only)
+         * @description Internal endpoint used only to ensure GPSFix 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.GPSFix"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/gpsmetadata": {
         parameters: {
             query?: never;
@@ -36894,7 +37050,7 @@ export interface components {
             userId?: string;
         };
         /** @enum {string} */
-        "models.AccessTokenScope": "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "markers.read" | "markers.write" | "markers.all" | "application" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "days.read" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete";
+        "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.Account": {
             account?: components["schemas"]["models.AccountBody"];
         };
@@ -37212,33 +37368,30 @@ export interface components {
         /** @enum {string} */
         "models.BaseRole": "guest" | "editor" | "admin" | "owner" | "application";
         "models.CameraMetadata": {
-            /** @description Bitrate in kbps */
+            /** @description kbps */
             bitrate?: number;
-            /** @description e.g. "H.264", "H.265" */
+            /** @description e.g. "H.264" */
             codec?: string;
+            /** @description State, reported by the agent */
+            connected?: boolean;
+            continuousRecording?: boolean;
+            /** @description Saved configuration, edited by users */
             fieldOfView?: number;
-            /** @description Frame rate in fps */
+            /** @description fps */
             frameRate?: number;
-            /** @description Indicates if the camera supports audio */
             hasAudio?: boolean;
-            /** @description Indicates if the camera supports backchannel audio */
             hasBackChannel?: boolean;
-            /** @description Indicates if the camera has input/output capabilities */
-            hasIO?: boolean;
-            /** @description Camera ONVIF and PTZ capabilities */
+            /** @description Capabilities, reported by the agent */
             hasOnvif?: boolean;
-            /** @description Indicates if the camera supports pan and tilt functionality */
             hasPanTilt?: boolean;
-            /** @description Indicates if the camera supports presets */
-            hasPresets?: boolean;
-            /** @description Indicates if the camera supports zoom functionality */
             hasZoom?: boolean;
+            /** @description Digital inputs and relay outputs (agent) */
             ios?: components["schemas"]["models.IO"][];
-            /** @description Presets for the camera, used for quick positioning */
+            /** @description Presets stored on the camera (agent) */
+            onvifPresets?: components["schemas"]["models.CameraPreset"][];
             presets?: components["schemas"]["models.CameraPreset"][];
-            /** @description e.g. "1920x1080", "1280x720" */
+            /** @description Stream, reported by the agent */
             resolution?: string;
-            /** @description Tours for the camera, used for automated movements through presets */
             tours?: components["schemas"]["models.CameraTour"][];
         };
         "models.CameraPreset": {
@@ -37954,88 +38107,96 @@ export interface components {
             timeRange2Min?: number;
         };
         "models.Device": {
-            /** @description last time the agent reported being online (timestamp in milliseconds) */
+            agent?: components["schemas"]["models.DeviceAgent"];
+            /** @description Last heartbeat from the agent */
             agentLastSeen?: number;
-            /** @description Deprecated - to be removed */
             analytics?: components["schemas"]["models.DeprecatedHeartbeat"][];
-            /** @description AtRuntimeMetadata contains metadata that is generated at runtime, which can include
-             *     more verbose information about the device's current state, capabilities, or configuration.
-             *     for example the linked sites details, etc. */
+            /** @description AtRuntimeMetadata is computed when the device is read and never stored. */
             atRuntimeMetadata?: components["schemas"]["models.DeviceAtRuntimeMetadata"];
-            /** @description Audit information */
             audit?: components["schemas"]["models.Audit"];
-            /** @description Device Specific Metadata */
-            cameraMetadata?: components["schemas"]["models.CameraMetadata"];
-            /** @description Device status
-             *     Note: Status is used to identify the status of the device, such as online, offline, maintenance, etc."
-             *     LastSeenTimestamp is used to identify the last time the device was seen online. */
+            /** @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 Type of deployment used e.g. "factory", "docker", "docker compose", "kubernetes" */
-            deployment?: string;
-            /** @description last time the device itself reported being online (timestamp in milliseconds) */
+            /** @description Last time the agent could reach the device itself */
             deviceLastSeen?: number;
-            /** @description threshold in milliseconds to consider a device offline, based on agentLastSeen */
-            disconnectedThreshold?: number;
-            /** @description FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc.
-             *     It is a map of feature names to permissions.
-             *     For example, "camera" can have permissions like "read", "write", "delete", etc.
-             *     This allows for fine-grained control over what features are accessible by users or groups.
-             *     FeaturePermissions can be used to implement Role-Based Access Control (RBAC) for devices. */
+            /** @description Licence concept; moves to the organisation */
+            enterprise?: boolean;
             featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
-            gpsMetadata?: components["schemas"]["models.GPSMetadata"];
+            gps?: components["schemas"]["models.GPSMetadata"];
             groupIds?: string[];
-            /** @description threshold in milliseconds to consider a device healthy, based on agentLastSeen */
-            healthyThreshold?: number;
-            humiditySensorMetadata?: components["schemas"]["models.HumiditySensorMetadata"];
+            humiditySensor?: components["schemas"]["models.HumiditySensorMetadata"];
             id?: string;
-            /** @description threshold in milliseconds to consider a device idle, based on deviceLastSeen */
-            idleThreshold?: number;
-            /** @description Device information
-             *     Note: DeviceId is a unique identifier for the device, it can be used to identify the device in the system.
-             *     DeviceType is used to identify the type of device, such as camera, sensor, access control, etc. */
+            /** @description No defined meaning; never set true for devices */
+            isActive?: boolean;
+            /** @description Device key reported by the agent, unique within its project */
             key?: string;
-            /** @description Latest Media information */
-            latestMedia?: components["schemas"]["models.Media"];
-            /** @description Timestamp of the latest media captured by the device (milliseconds since epoch) */
+            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. */
             latestMediaTimestamp?: number;
-            lightSensorMetadata?: components["schemas"]["models.LightSensorMetadata"];
-            /** @description Location of the device, not real time postion. e.g. "Office 1st Floor", "Lobby", "Kilian's Car", etc. */
+            lightSensor?: components["schemas"]["models.LightSensorMetadata"];
+            /** @description Fixed placement, not a real-time position */
             location?: components["schemas"]["models.Location"];
-            /** @description Metadata */
             metadata?: components["schemas"]["models.DeviceMetadata"];
+            /** @description Lifecycle */
+            mute?: number;
             /** @description e.g. "Front Door Camera" */
             name?: string;
-            /** @description RBAC information
-             *     Note: SiteId is used to identify the site where the device is located.
-             *     GroupId is used to identify the group of devices.
-             *     OrganisationId is used to identify the organisation that owns the device.
-             *     FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc. */
+            /** @description Tenancy. Heartbeat credentials live on the project: the cloud key resolves
+             *     to an organisation and project, which must match these fields. */
             organisationId?: string;
-            /** @description ProjectId places the device in exactly one project within its organisation.
-             *     A nil or zero legacy value resolves to that organisation's default project;
-             *     it does not make the device organisation-wide. */
+            /** @description nil or zero resolves to the organisation's default project */
             projectId?: string;
-            /** @description Versioning information
-             *     Note: Version is used to identify the version of the device software.
-             *     ReleaseHash is used to identify the release hash of the device software, it can be used to identify the specific build of the device software.
-             *     Deployment is used to identify the deployment type of the device, such as factory, docker, docker compose, kubernetes, etc. */
-            repository?: string;
+            schemaVersion?: number;
             siteIds?: string[];
-            /** @description Type of device e.g. "camera", "sensor", "access_control" */
-            type?: string;
-            /** @description @LEGACY FIELDS - to be removed in future versions */
+            /** @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;
-            /** @description Version of the agent, injected on build. Reflects the release tag of the agent. */
+        };
+        "models.DeviceAgent": {
+            architecture?: string;
+            /** @description milliseconds since epoch */
+            bootTime?: number;
+            /** @description e.g. "factory", "docker", "kubernetes" */
+            deployment?: string;
+            e2eEncryption?: boolean;
+            hostname?: string;
+            hubEncryption?: boolean;
+            ipAddresses?: string[];
+            macAddresses?: string[];
+            /** @description bytes */
+            memoryFree?: number;
+            /** @description bytes */
+            memoryProcess?: number;
+            /** @description bytes */
+            memoryTotal?: number;
+            /** @description bytes */
+            memoryUsed?: number;
+            /** @description Build hash of the agent */
+            releaseHash?: string;
+            repository?: string;
+            uptimeSeconds?: number;
+            /** @description Release tag of the agent */
             version?: string;
         };
         "models.DeviceAtRuntimeMetadata": {
-            /** @description Groups contains details about the groups that the device is linked to. */
+            capabilities?: components["schemas"]["models.DeviceCapability"][];
             groups?: components["schemas"]["models.GroupOption"][];
-            /** @description Sites contains details about the sites that the device is linked to. */
             sites?: components["schemas"]["models.SiteOption"][];
-            /** @description Status is derived from the last seen timestamps and thresholds. */
-            status?: string;
+            status?: components["schemas"]["models.DeviceConnectionStatus"];
         };
+        /** @enum {string} */
+        "models.DeviceCapability": "camera" | "lightSensor" | "humiditySensor" | "gps";
+        /** @enum {string} */
+        "models.DeviceConnectionStatus": "connected" | "healthy" | "idle" | "disconnected";
         "models.DeviceData": {
             activeDevices?: number;
             totalDevices?: number;
@@ -38051,38 +38212,32 @@ export interface components {
             key?: string;
             name?: string;
         };
+        "models.DeviceMediaRef": {
+            /** @description AtRuntimeMetadata carries the signed URLs and display time filled when
+             *     the device is read; never stored. */
+            atRuntimeMetadata?: components["schemas"]["models.MediaAtRuntimeMetadata"];
+            duration?: number;
+            id?: string;
+            spriteFile?: string;
+            spriteProvider?: string;
+            storageSolution?: string;
+            thumbnailFile?: string;
+            thumbnailProvider?: string;
+            videoFile?: string;
+            videoProvider?: string;
+        };
         "models.DeviceMetadata": {
-            architecture?: string;
-            bootTime?: string;
-            /** @description e.g. "Nest", "Ring" */
             brand?: string;
-            /** @description e.g. "#FF5733" (hex color code) */
+            /** @description hex, e.g. "#FF5733" */
             color?: string;
-            /** @description e.g. "Outdoor camera with night vision" */
             description?: string;
-            e2eEncryption?: string;
-            encrypted?: boolean;
-            encryptedData?: number[];
-            freeMemory?: string;
-            /** @description Indicates if the device is hidden from UI */
             hidden?: boolean;
-            hostname?: string;
-            hubEncryption?: string;
-            /** @description Installation date in milliseconds since epoch */
+            /** @description milliseconds since epoch */
             installationDate?: number;
-            /** @description e.g. "192.168.1.1" */
-            ipAddress?: string;
-            /** @description Last maintenance date in milliseconds since epoch */
+            /** @description milliseconds since epoch */
             lastMaintenance?: number;
-            /** @description e.g. "00:1A:2B:3C:4D:5E" */
-            macAddress?: string;
-            /** @description e.g. "Nest Cam", "Ring Doorbell" */
             model?: string;
-            /** @description Floor plans this device is associated with */
             onFloorPlans?: string[];
-            processMemory?: string;
-            totalMemory?: string;
-            usedMemory?: string;
             /** @description VLM holds the stable ("normal") scenes used as context for VLM analysis. */
             vlm?: components["schemas"]["models.DeviceVLMMetadata"];
         };
@@ -38097,6 +38252,7 @@ export interface components {
             description?: string;
             featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
             fieldOfView?: number;
+            hidden?: boolean;
             installationDate?: string;
             lastMaintenance?: string;
             model?: string;
@@ -38133,6 +38289,13 @@ export interface components {
             /** @description Absolute Y coordinate */
             y?: number;
         };
+        "models.DeviceThresholds": {
+            disconnected?: number;
+            healthy?: number;
+            idle?: number;
+        };
+        /** @enum {string} */
+        "models.DeviceType": "camera" | "sensor" | "access_control" | "gateway";
         "models.DeviceVLMMetadata": {
             schemaVersion?: number;
             stableStates?: components["schemas"]["models.VLMStableState"][];
@@ -38278,22 +38441,21 @@ export interface components {
             range?: string;
             time?: string;
         };
-        "models.GPSMetadata": {
-            /** @description Accuracy is the accuracy of the GPS reading in meters. */
-            accuracy?: number;
-            /** @description Altitude is the current altitude of the device in meters. */
-            altitude?: number;
-            /** @description Heading is the direction of movement in degrees. */
-            heading?: number;
-            /** @description Latitude is the current latitude of the device. */
+        "models.GPSFix": {
             latitude?: number;
-            /** @description Longitude is the current longitude of the device. */
             longitude?: number;
-            /** @description Speed is the current speed of the device in meters per second. */
-            speed?: number;
-            /** @description Timestamp is the time when the GPS data was recorded (milliseconds since epoch). */
+            /** @description milliseconds since epoch */
             timestamp?: number;
         };
+        "models.GPSMetadata": {
+            /** @description Rated accuracy in meters */
+            accuracy?: number;
+            /** @description LastFix is a single overwritten snapshot so lists can show a position
+             *     without querying the time series. */
+            lastFix?: components["schemas"]["models.GPSFix"];
+            /** @description Fix rate */
+            updateHz?: number;
+        };
         "models.GetAlertsInput": {
             user?: components["schemas"]["models.User"];
         };
@@ -38496,14 +38658,9 @@ export interface components {
             region?: string;
         };
         "models.HumiditySensorMetadata": {
-            /** @description CurrentHumidity is the latest measured humidity level in percentage */
-            currentHumidity?: number;
-            /** @description HumidityRange specifies the measurable range in percentage (e.g. "0-100") */
-            humidityRange?: string;
-            /** @description Sensitivity indicates the sensitivity level of the humidity sensor (e.g. 1-100) */
-            sensitivity?: number;
-            /** @description Unit is the measurement unit, typically "%" */
-            unit?: string;
+            maxHumidity?: number;
+            /** @description Measurable range, percent */
+            minHumidity?: number;
         };
         "models.IO": {
             /** @description Audit information */
@@ -38555,14 +38712,9 @@ export interface components {
             label?: components["schemas"]["models.Label"];
         };
         "models.LightSensorMetadata": {
-            /** @description CurrentLux is the latest measured light level in lux */
-            currentLux?: number;
-            /** @description LuxRange specifies the measurable range in lux (e.g. "0-10000") */
-            luxRange?: string;
-            /** @description Sensitivity indicates the sensitivity level of the light sensor (e.g. 1-100) */
-            sensitivity?: number;
-            /** @description Unit is the measurement unit, typically "lux" */
-            unit?: string;
+            maxLux?: number;
+            /** @description Measurable range */
+            minLux?: number;
         };
         "models.Livestream": {
             speech?: boolean;
@@ -39350,7 +39502,7 @@ export interface components {
             videowall?: components["schemas"]["models.Videowall"];
         };
         /** @enum {string} */
-        "models.Permission": "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "markers.read" | "markers.write" | "markers.all" | "application" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "days.read" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete";
+        "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";
         /** @enum {integer} */
         "models.PermissionLevel": 1 | 2 | 3 | 4 | 2 | 3 | 4 | 5 | 2 | 3 | 2 | 2 | 3 | 2 | 3 | 4;
         "models.Permissions": {
@@ -41384,14 +41536,17 @@ export declare namespace models {
     type DetectionSource = components['schemas']['models.DetectionSource'];
     type Detections = components['schemas']['models.Detections'];
     type Device = components['schemas']['models.Device'];
+    type DeviceAgent = components['schemas']['models.DeviceAgent'];
     type DeviceAtRuntimeMetadata = components['schemas']['models.DeviceAtRuntimeMetadata'];
     type DeviceData = components['schemas']['models.DeviceData'];
     type DeviceFeaturePermissions = components['schemas']['models.DeviceFeaturePermissions'];
     type DeviceKey = components['schemas']['models.DeviceKey'];
+    type DeviceMediaRef = components['schemas']['models.DeviceMediaRef'];
     type DeviceMetadata = components['schemas']['models.DeviceMetadata'];
     type DeviceOption = components['schemas']['models.DeviceOption'];
     type DevicePatch = components['schemas']['models.DevicePatch'];
     type DevicePlacement = components['schemas']['models.DevicePlacement'];
+    type DeviceThresholds = components['schemas']['models.DeviceThresholds'];
     type DeviceVLMMetadata = components['schemas']['models.DeviceVLMMetadata'];
     type Devices = components['schemas']['models.Devices'];
     type DirectionalTimeSeriesChart = components['schemas']['models.DirectionalTimeSeriesChart'];
@@ -41405,6 +41560,7 @@ export declare namespace models {
     type FeaturePermissions = components['schemas']['models.FeaturePermissions'];
     type FloorPlan = components['schemas']['models.FloorPlan'];
     type FragmentedBytesRangeOnTime = components['schemas']['models.FragmentedBytesRangeOnTime'];
+    type GPSFix = components['schemas']['models.GPSFix'];
     type GPSMetadata = components['schemas']['models.GPSMetadata'];
     type GetAlertsInput = components['schemas']['models.GetAlertsInput'];
     type GetAlertsOutput = components['schemas']['models.GetAlertsOutput'];

package/package.json

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