@uug-ai/models 1.1.0 → 1.1.3

package/dist/types.d.ts

@@ -627,6 +627,84 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/auditcreate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get AuditCreate (schema generation only)
+         * @description Internal endpoint used only to ensure AuditCreate 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.AuditCreate"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/internal/auditupdate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get AuditUpdate (schema generation only)
+         * @description Internal endpoint used only to ensure AuditUpdate 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.AuditUpdate"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/classify": {
         parameters: {
             query?: never;
@@ -2655,6 +2733,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/markerevent": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get MarkerEvent (schema generation only)
+         * @description Internal endpoint used only to ensure MarkerEvent 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.MarkerEvent"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/markermetadata": {
         parameters: {
             query?: never;
@@ -2928,6 +3045,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/model": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Model (schema generation only)
+         * @description Internal endpoint used only to ensure Model 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.Model"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/monitorstage": {
         parameters: {
             query?: never;
@@ -3552,45 +3708,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/internal/sitelocationmetadata": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get SiteLocationMetadata (schema generation only)
-         * @description Internal endpoint used only to ensure SiteLocationMetadata 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.SiteLocationMetadata"];
-                    };
-                };
-            };
-        };
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/internal/sitemetadata": {
         parameters: {
             query?: never;
@@ -4723,7 +4840,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.AddAccessTokenRequest": {
             token?: components["schemas"]["models.AccessToken"];
@@ -4742,7 +4859,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.AddMarkerErrorResponse": {
             /** @description Application-specific error code */
@@ -4754,7 +4871,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.AddMarkerRequest": {
             marker?: components["schemas"]["models.Marker"];
@@ -4773,7 +4890,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         /** @enum {string} */
         "api.AnalysisStatus": "analysis_face_redaction_binding_failed" | "analysis_save_redaction_success" | "analysis_save_redaction_failed" | "analysis_submit_redaction_success" | "analysis_submit_redaction_failed" | "analysis_file_name_missing" | "analysis_signed_url_missing" | "analysis_all_frame_coordinates_missing" | "analysis_not_found" | "analysis_found" | "analysisId_missing";
@@ -4787,7 +4904,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.DeleteAccessTokenRequest": Record<string, never>;
         "api.DeleteAccessTokenResponse": Record<string, never>;
@@ -4802,7 +4919,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.ErrorResponse": {
             /** @description Application-specific error code */
@@ -4814,7 +4931,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.FaceRedactionMessage": {
             data?: {
@@ -4833,7 +4950,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetAccessTokensRequest": Record<string, never>;
         "api.GetAccessTokensResponse": {
@@ -4850,7 +4967,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetAnalysisErrorResponse": {
             /** @description Application-specific error code */
@@ -4862,7 +4979,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetAnalysisRequest": {
             analysisId?: string;
@@ -4881,7 +4998,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetMarkersErrorResponse": {
             /** @description Application-specific error code */
@@ -4893,7 +5010,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetMarkersRequest": Record<string, never>;
         "api.GetMarkersResponse": {
@@ -4910,7 +5027,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetMediaErrorResponse": {
             /** @description Application-specific error code */
@@ -4922,7 +5039,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetMediaRequest": {
             filter?: components["schemas"]["api.MediaFilter"];
@@ -4941,7 +5058,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetTimelineErrorResponse": {
             /** @description Application-specific error code */
@@ -4953,7 +5070,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.GetTimelineRequest": {
             filter?: components["schemas"]["api.MediaFilter"];
@@ -4973,7 +5090,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.MarkerOptions": {
             names?: string[];
@@ -5005,7 +5122,6 @@ export interface components {
             startTimestamp?: number;
         };
         "api.Metadata": {
-            /** @description Additional data relevant to the request or response, this can be free-format */
             data?: {
                 [key: string]: unknown;
             };
@@ -5043,7 +5159,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.SaveFaceRedactionRequest": {
             analysisId?: string;
@@ -5064,7 +5180,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.SubmitFaceRedactionErrorResponse": {
             /** @description Application-specific error code */
@@ -5076,7 +5192,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.SubmitFaceRedactionRequest": {
             allFrameCoordinates?: {
@@ -5103,7 +5219,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.SuccessResponse": {
             /** @description Application-specific status code */
@@ -5115,7 +5231,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.UpdateAccessTokenErrorResponse": {
             /** @description Application-specific error code */
@@ -5127,7 +5243,7 @@ export interface components {
             /** @description Error message describing the issue */
             message?: string;
             /** @description Additional metadata about the error, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "api.UpdateAccessTokenRequest": {
             token?: components["schemas"]["models.AccessToken"];
@@ -5146,7 +5262,7 @@ export interface components {
             /** @description Success message describing the operation */
             message?: string;
             /** @description Additional metadata about the response, such as timestamps and request IDs */
-            metaData?: components["schemas"]["api.Metadata"];
+            metadata?: components["schemas"]["api.Metadata"];
         };
         "models.AccessToken": {
             /** @description Audit information */
@@ -5233,8 +5349,15 @@ export interface components {
             user_id?: string;
         };
         "models.Audit": {
+            create?: components["schemas"]["models.AuditCreate"];
+            /** @description UpdateHistory is a chronological list of updates, ordered by UpdatedAt. */
+            updateHistory?: components["schemas"]["models.AuditUpdate"][];
+        };
+        "models.AuditCreate": {
             createdAt?: number;
             createdBy?: string;
+        };
+        "models.AuditUpdate": {
             updatedAt?: number;
             updatedBy?: string;
         };
@@ -5572,6 +5695,8 @@ export interface components {
              * @example 1752482079
              */
             endTimestamp?: number;
+            /** @description Events associated with the marker, such as motion detected, sound detected, etc. */
+            events?: components["schemas"]["models.MarkerEvent"][];
             /**
              * @description GroupId is used to identify the group of markers
              * @example 686a906345c1df594pmt41w4
@@ -5591,7 +5716,7 @@ export interface components {
              */
             mediaIds?: string[];
             /** @description Additional metadata */
-            metaData?: components["schemas"]["models.MarkerMetadata"];
+            metadata?: components["schemas"]["models.MarkerMetadata"];
             /**
              * @description Name or identifier for the marker e.g., "a license plate (2-HCP-007), an unique identifier (transaction_id, point of sale), etc."
              * @example 2-HCP-007
@@ -5620,6 +5745,31 @@ export interface components {
              */
             type?: string;
         };
+        "models.MarkerEvent": {
+            /**
+             * @description Description of the event
+             * @example Motion detected in the lobby area
+             */
+            description?: string;
+            /**
+             * @description Name or identifier for the event e.g., "Motion Detected", "Sound Detected", etc.
+             * @example Motion Detected
+             */
+            name?: string;
+            /**
+             * @description Tags associated with the event for categorization
+             * @example [
+             *       "[\"urgent\"",
+             *       "\"review-needed\"]"
+             *     ]
+             */
+            tags?: string[];
+            /**
+             * @description Timestamp of the event in seconds since epoch
+             * @example 1752482070
+             */
+            timestamp?: number;
+        };
         "models.MarkerMetadata": {
             /** @description Additional comments or description of the marker */
             comments?: components["schemas"]["models.Comment"];
@@ -5671,7 +5821,7 @@ export interface components {
         };
         "models.MediaAtRuntimeMetadata": {
             /** @description Timestamp when the runtime metadata was cached. */
-            cacheTimestamp?: number;
+            cachedTimestamp?: number;
             redactionUrl?: string;
             spriteUrl?: string;
             thumbnailUrl?: string;
@@ -5701,6 +5851,34 @@ export interface components {
             /** @description Tags associated to give some context about the media file */
             tags?: string[];
         };
+        "models.Model": {
+            /**
+             * @description AtRuntimeMetadata are computed or dynamic information about the model that is relevant during its usage or processing.
+             *     This information is generated at run time and is not stored into the database. All other information of the model is persisted into the database.
+             *     and is not altered during runtime.
+             *     e.g.
+             *     Media model -> signed URLS for accessing the media, processing status, etc.
+             *     Device model -> current status (active, inactive), etc.
+             */
+            atRuntimeMetadata?: components["schemas"]["models.MediaAtRuntimeMetadata"];
+            /**
+             * @description Audit information: every model should have audit information to track its creation and modification history.
+             *     This is important for maintaining data integrity and accountability.
+             */
+            audit?: components["schemas"]["models.Audit"];
+            /** @description Unique identifier for the model, this is used to retrieve the model from the database by its unique ID. */
+            id?: string;
+            /**
+             * @description Metadata is additional information about the model that is not critical for its primary function,
+             *     but can provide useful context or details.
+             *     e.g.
+             *     User model -> profile information, preferences, etc.
+             *     Device model -> location, installation date, etc.
+             *     Media model -> tags, description, etc.
+             *     Marker model -> comments, tags, etc.
+             */
+            metadata?: components["schemas"]["models.MediaMetadata"];
+        };
         "models.MonitorStage": {
             activity?: components["schemas"]["models.Activity"];
             highUpload?: components["schemas"]["models.HighUpload"];
@@ -5818,8 +5996,6 @@ export interface components {
             devices?: string[];
             groups?: string[];
             id?: string;
-            /** @description Location metadata */
-            locationMetadata?: components["schemas"]["models.SiteLocationMetadata"];
             /** @description Metadata */
             metadata?: components["schemas"]["models.SiteMetadata"];
             name?: string;
@@ -5834,14 +6010,12 @@ export interface components {
             vaultSecretKey?: string;
             vaultUri?: string;
         };
-        "models.SiteLocationMetadata": {
-            location?: components["schemas"]["models.Location"];
-        };
         "models.SiteMetadata": {
             color?: string;
             /** @description List of floor plans associated with the site */
             floorPlans?: components["schemas"]["models.FloorPlan"][];
             initials?: string;
+            location?: components["schemas"]["models.Location"];
             numberOfFloorPlans?: number;
         };
         "models.Sprite": {
@@ -6055,6 +6229,8 @@ export declare namespace models {
     type AnalysisStage = components['schemas']['models.AnalysisStage'];
     type AnalysisWrapper = components['schemas']['models.AnalysisWrapper'];
     type Audit = components['schemas']['models.Audit'];
+    type AuditCreate = components['schemas']['models.AuditCreate'];
+    type AuditUpdate = components['schemas']['models.AuditUpdate'];
     type Classify = components['schemas']['models.Classify'];
     type ClassifyDetails = components['schemas']['models.ClassifyDetails'];
     type Color = components['schemas']['models.Color'];
@@ -6080,10 +6256,12 @@ export declare namespace models {
     type IO = components['schemas']['models.IO'];
     type Location = components['schemas']['models.Location'];
     type Marker = components['schemas']['models.Marker'];
+    type MarkerEvent = components['schemas']['models.MarkerEvent'];
     type MarkerMetadata = components['schemas']['models.MarkerMetadata'];
     type Media = components['schemas']['models.Media'];
     type MediaAtRuntimeMetadata = components['schemas']['models.MediaAtRuntimeMetadata'];
     type MediaMetadata = components['schemas']['models.MediaMetadata'];
+    type Model = components['schemas']['models.Model'];
     type MonitorStage = components['schemas']['models.MonitorStage'];
     type NotificationStage = components['schemas']['models.NotificationStage'];
     type PipelineEvent = components['schemas']['models.PipelineEvent'];
@@ -6095,7 +6273,6 @@ export declare namespace models {
     type Role = components['schemas']['models.Role'];
     type SequenceStage = components['schemas']['models.SequenceStage'];
     type Site = components['schemas']['models.Site'];
-    type SiteLocationMetadata = components['schemas']['models.SiteLocationMetadata'];
     type SiteMetadata = components['schemas']['models.SiteMetadata'];
     type Sprite = components['schemas']['models.Sprite'];
     type Storage = components['schemas']['models.Storage'];

package/package.json

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