@uug-ai/models 1.6.13 → 1.7.0

package/dist/types.d.ts

@@ -1719,7 +1719,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/internal/auditcreate": {
+    "/internal/auditevent": {
         parameters: {
             query?: never;
             header?: never;
@@ -1727,8 +1727,8 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get AuditCreate (schema generation only)
-         * @description Internal endpoint used only to ensure AuditCreate schema is generated in OpenAPI spec
+         * Get AuditEvent (schema generation only)
+         * @description Internal endpoint used only to ensure AuditEvent schema is generated in OpenAPI spec
          */
         get: {
             parameters: {
@@ -1745,7 +1745,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["models.AuditCreate"];
+                        "application/json": components["schemas"]["models.AuditEvent"];
                     };
                 };
             };
@@ -1758,7 +1758,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/internal/auditupdate": {
+    "/internal/auditfieldchange": {
         parameters: {
             query?: never;
             header?: never;
@@ -1766,8 +1766,8 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get AuditUpdate (schema generation only)
-         * @description Internal endpoint used only to ensure AuditUpdate schema is generated in OpenAPI spec
+         * Get AuditFieldChange (schema generation only)
+         * @description Internal endpoint used only to ensure AuditFieldChange schema is generated in OpenAPI spec
          */
         get: {
             parameters: {
@@ -1784,7 +1784,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["models.AuditUpdate"];
+                        "application/json": components["schemas"]["models.AuditFieldChange"];
                     };
                 };
             };
@@ -20088,7 +20088,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/internal/rolescope": {
+    "/internal/roleassignmentscope": {
         parameters: {
             query?: never;
             header?: never;
@@ -20096,8 +20096,8 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get RoleScope (schema generation only)
-         * @description Internal endpoint used only to ensure RoleScope schema is generated in OpenAPI spec
+         * Get RoleAssignmentScope (schema generation only)
+         * @description Internal endpoint used only to ensure RoleAssignmentScope schema is generated in OpenAPI spec
          */
         get: {
             parameters: {
@@ -20114,7 +20114,7 @@ export interface paths {
                         [name: string]: unknown;
                     };
                     content: {
-                        "application/json": components["schemas"]["models.RoleScope"];
+                        "application/json": components["schemas"]["models.RoleAssignmentScope"];
                     };
                 };
             };
@@ -25080,45 +25080,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/internal/userorgpermissions": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * Get UserOrgPermissions (schema generation only)
-         * @description Internal endpoint used only to ensure UserOrgPermissions 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.UserOrgPermissions"];
-                    };
-                };
-            };
-        };
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/internal/userprofile": {
         parameters: {
             query?: never;
@@ -30058,14 +30019,14 @@ export interface components {
             /** @description ISO country code */
             country?: string;
             /** @description Full country name */
-            country_name?: string;
-            postal_code?: string;
+            countryName?: string;
+            postalCode?: string;
             /** @description State/Province/Region */
             region?: string;
             street?: string;
-            street_number?: string;
             /** @description Additional address line */
             street2?: string;
+            streetNumber?: string;
         };
         "models.AlertFeatures": {
             createMarker?: boolean;
@@ -30232,18 +30193,56 @@ export interface components {
             totalRegions?: number;
         };
         "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;
+            createdAt?: string;
             createdBy?: string;
-        };
-        "models.AuditUpdate": {
-            updatedAt?: number;
+            /**
+             * @description LastAction is a short semantic label describing the most recent change
+             *     (e.g. "role.assigned", "member.suspended", "device.renamed"). For the
+             *     complete history, query AuditEvent by TargetType/TargetId.
+             */
+            lastAction?: string;
+            updatedAt?: string;
             updatedBy?: string;
         };
+        "models.AuditEvent": {
+            /**
+             * @description Action is a short semantic label, e.g. "case.commented", "device.renamed",
+             *     "member.suspended".
+             */
+            action?: string;
+            /**
+             * @description ActorId is the user who performed the action; ActorName is denormalised so
+             *     history can be rendered without a lookup.
+             */
+            actorId?: string;
+            actorName?: string;
+            /** @description Changes optionally captures the field-level diff for this event. */
+            changes?: components["schemas"]["models.AuditFieldChange"][];
+            id?: string;
+            /** @description Metadata holds contextual key/value pairs (ip, userAgent, requestId, ...). */
+            metadata?: {
+                [key: string]: string;
+            };
+            /** @description OrganisationId scopes the event to a tenant for org-wide audit queries. */
+            organisationId?: string;
+            targetId?: string;
+            /**
+             * @description TargetType and TargetId identify the entity the action was performed on
+             *     (e.g. TargetType "case" with the case id). Query these to render an
+             *     entity's audit history. TargetId is a string so it can hold either an
+             *     ObjectID hex or a non-ObjectID key (such as a media key).
+             */
+            targetType?: string;
+            /** @description Timestamp is when the action occurred. */
+            timestamp?: string;
+        };
+        "models.AuditFieldChange": {
+            field?: string;
+            newValue?: string;
+            oldValue?: string;
+        };
+        /** @enum {string} */
+        "models.BaseRole": "guest" | "editor" | "admin" | "owner" | "application";
         "models.CameraMetadata": {
             /** @description Bitrate in kbps */
             bitrate?: number;
@@ -30685,19 +30684,19 @@ export interface components {
             /** @description Industry/sector */
             industry?: string;
             /** @description Official registered company name */
-            legal_name?: string;
+            legalName?: string;
             /** @description Company logo URL */
             logo?: string;
             /** @description Main company phone */
             phone?: string;
             /** @description Company registration number */
-            registration_number?: string;
+            registrationNumber?: string;
             /** @description Alternative tax identifier */
-            tax_id?: string;
+            taxId?: string;
             /** @description Trading/DBA name if different */
-            trading_name?: string;
+            tradingName?: string;
             /** @description VAT/Tax ID number */
-            vat_number?: string;
+            vatNumber?: string;
             /** @description Company website */
             website?: string;
         };
@@ -31283,7 +31282,7 @@ export interface components {
             /** @description 0=none, 1=read, 2=write, 3=admin */
             devices?: components["schemas"]["models.AccessLevel"];
             /** @description 0=none, 1=read, 2=write, 3=admin */
-            download_recordings?: components["schemas"]["models.AccessLevel"];
+            downloadRecordings?: components["schemas"]["models.AccessLevel"];
             /** @description 0=none, 1=read, 2=write, 3=admin */
             export?: components["schemas"]["models.AccessLevel"];
             /** @description 0=none, 1=read, 2=write, 3=admin */
@@ -31301,7 +31300,7 @@ export interface components {
             /** @description 0=none, 1=read, 2=write, 3=admin */
             ptz?: components["schemas"]["models.AccessLevel"];
             /** @description 0=none, 1=read, 2=write, 3=admin */
-            remote_config?: components["schemas"]["models.AccessLevel"];
+            remoteConfig?: components["schemas"]["models.AccessLevel"];
             /** @description 0=none, 1=read, 2=write, 3=admin */
             roles?: components["schemas"]["models.AccessLevel"];
             /** @description 0=none, 1=read, 2=write, 3=admin */
@@ -31528,6 +31527,8 @@ export interface components {
             token?: string;
             valid?: boolean;
         };
+        /** @enum {string} */
+        "models.InvitationStatus": "pending" | "accepted" | "expired" | "revoked";
         "models.KeyPair": {
             amazon_access_key_id?: string;
             amazon_secret_access_key?: string;
@@ -32028,6 +32029,8 @@ export interface components {
             type?: string;
             vault?: boolean;
         };
+        /** @enum {string} */
+        "models.MembershipStatus": "pending" | "active" | "suspended" | "revoked";
         "models.Message": {
             alert_id?: string;
             alert_master_user?: string;
@@ -32133,80 +32136,103 @@ export interface components {
         };
         "models.Organisation": {
             audit?: components["schemas"]["models.Audit"];
-            billing_address?: components["schemas"]["models.Address"];
+            billingAddress?: components["schemas"]["models.Address"];
             /** @description Company Details */
             company?: components["schemas"]["models.CompanyDetails"];
             description?: string;
             domain?: string;
             id?: string;
-            is_active?: number;
+            isActive?: boolean;
             name?: string;
             /** @description The user who owns this organisation */
-            owner_id?: string;
+            ownerId?: string;
             settings?: components["schemas"]["models.OrganisationSettings"];
+            /**
+             * @description Slug is a stable, URL-friendly handle for the organisation (e.g. "acme-corp").
+             *     It is unique and decoupled from the display Name so it can be used in URLs
+             *     and references without breaking when the name changes.
+             */
+            slug?: string;
             /** @description Billing & Subscription */
             subscription?: components["schemas"]["models.Subscription"];
         };
         "models.OrganisationInvitation": {
             audit?: components["schemas"]["models.Audit"];
             email?: string;
-            expires_at?: string;
+            expiresAt?: string;
             id?: string;
-            invited_by?: string;
-            organisation_id?: string;
+            invitedBy?: string;
+            organisationId?: string;
             /** @description Roles to assign upon acceptance */
-            role_ids?: string[];
-            /** @description "pending", "accepted", "expired", "revoked" */
-            status?: string;
+            roleIds?: string[];
+            /**
+             * @description Scope is the granular scope applied to every role in RoleIds when the
+             *     invitation is accepted, i.e. it seeds the Scope of each resulting
+             *     RoleAssignment. Following the RoleAssignmentScope convention, a zero value
+             *     grants the roles organisation-wide; populate a dimension to restrict the
+             *     resulting assignments to specific resources (see RoleAssignmentScope).
+             */
+            scope?: components["schemas"]["models.RoleAssignmentScope"];
+            status?: components["schemas"]["models.InvitationStatus"];
             token?: string;
         };
         "models.OrganisationMember": {
             membership?: components["schemas"]["models.OrganisationUser"];
-            organisation_id?: string;
+            organisationId?: string;
             /** @description Member's role assignments */
-            role_assignments?: components["schemas"]["models.RoleAssignment"][];
+            roleAssignments?: components["schemas"]["models.RoleAssignment"][];
             /** @description Populated role details */
             roles?: components["schemas"]["models.Role"][];
             user?: components["schemas"]["models.User"];
         };
         "models.OrganisationSettings": {
-            allow_invitations?: boolean;
+            allowInvitations?: boolean;
             /** @description Email domains allowed for membership */
-            allowed_domains?: string[];
+            allowedDomains?: string[];
+            /** @description ISO 4217 currency code, e.g. "EUR" */
+            currency?: string;
             /** @description Default role for new members */
-            default_role_id?: string;
+            defaultRoleId?: string;
             /** @description Contacts for different purposes */
-            financial_contact?: components["schemas"]["models.Contact"];
-            force_mfa?: boolean;
-            max_members?: number;
+            financialContact?: components["schemas"]["models.Contact"];
+            forceMFA?: boolean;
+            /** @description BCP-47 locale tag, e.g. "en-US" */
+            locale?: string;
+            maxMembers?: number;
             /** @description Main point of contact */
-            primary_contact?: components["schemas"]["models.Contact"];
+            primaryContact?: components["schemas"]["models.Contact"];
             /** @description Technical/support contact */
-            technical_contact?: components["schemas"]["models.Contact"];
+            technicalContact?: components["schemas"]["models.Contact"];
+            /**
+             * @description Regional defaults applied across the organisation for display, scheduling
+             *     and billing.
+             */
+            timezone?: string;
         };
         "models.OrganisationUser": {
             audit?: components["schemas"]["models.Audit"];
-            /** @description Optional expiration for temporary access */
-            expires_at?: string;
+            /**
+             * @description ExpiresAt optionally bounds the membership in time. It is an overlay on
+             *     Status: a membership is only effectively active when Status is
+             *     MembershipStatusActive AND ExpiresAt is unset or in the future.
+             */
+            expiresAt?: string;
             id?: string;
-            invited_at?: string;
-            invited_by?: string;
-            joined_at?: string;
-            organisation_id?: string;
-            /** @description Additional permissions specific to this membership */
-            permissions?: components["schemas"]["models.UserOrgPermissions"];
-            /** @description "pending", "active", "suspended", "revoked" */
-            status?: string;
-            user_id?: string;
+            invitedAt?: string;
+            invitedBy?: string;
+            joinedAt?: string;
+            organisationId?: string;
+            status?: components["schemas"]["models.MembershipStatus"];
+            userId?: string;
         };
         "models.OrganisationUserDetails": {
             membership?: components["schemas"]["models.OrganisationUser"];
             organisation?: components["schemas"]["models.Organisation"];
             /** @description User's role assignments in this organisation */
-            role_assignments?: components["schemas"]["models.RoleAssignment"][];
+            roleAssignments?: components["schemas"]["models.RoleAssignment"][];
             /** @description Populated role details */
             roles?: components["schemas"]["models.Role"][];
-            user_id?: string;
+            userId?: string;
         };
         "models.PatchVideowallInput": {
             updates?: {
@@ -32350,38 +32376,56 @@ export interface components {
             description?: string;
             featurePermissions?: components["schemas"]["models.FeaturePermissions"];
             id?: string;
-            isActive?: number;
+            isActive?: boolean;
             /** @description Organisation this role belongs to */
-            organisation_id?: string;
+            organisationId?: string;
+            /**
+             * @description Pages and FeaturePermissions are two orthogonal authorization axes:
+             *       - Pages controls which UI/nav pages are visible (coarse allow-list).
+             *       - FeaturePermissions controls the CRUD AccessLevel per feature.
+             *     Some names appear in both (e.g. sites/groups/roles/settings); that overlap
+             *     is intentional - visibility and capability are decided independently, and
+             *     the consuming service resolves them together (page hidden => not shown;
+             *     feature level => what may be done once on the page).
+             */
             pages?: string[];
-            role?: string;
+            /**
+             * @description ParentRole is the built-in BaseRole tier this custom role extends. It is a
+             *     live tier identifier (NOT an ObjectID reference to another Role document):
+             *     it sets the effective tier/RoleLevel for coarse gating and bounds which
+             *     pages the role may grant. See BaseRole.
+             */
+            role?: components["schemas"]["models.BaseRole"];
             roleName?: string;
             timeWindow?: components["schemas"]["models.TimeWindow"];
-            timeWindowActive?: number;
+            timeWindowActive?: boolean;
         };
         "models.RoleAssignment": {
             audit?: components["schemas"]["models.Audit"];
-            /** @description Optional expiration for temporary assignments */
-            expires_at?: string;
+            /**
+             * @description ExpiresAt optionally bounds the assignment in time. It is an overlay on
+             *     IsActive: an assignment is only effectively active when IsActive is true
+             *     AND ExpiresAt is unset or in the future. Use IsEffectivelyActive().
+             */
+            expiresAt?: string;
             id?: string;
-            is_active?: number;
+            /** @description Administrative enable/disable switch (independent of expiry) */
+            isActive?: boolean;
             /** @description Organisation context for this assignment */
-            organisation_id?: string;
+            organisationId?: string;
             /** @description Reference to the organisation-specific Role */
-            role_id?: string;
+            roleId?: string;
             /** @description Optional granular scope within organisation */
-            scope?: components["schemas"]["models.RoleScope"];
-            user_id?: string;
+            scope?: components["schemas"]["models.RoleAssignmentScope"];
+            userId?: string;
         };
-        "models.RoleScope": {
-            /** @description Devices where the role applies */
-            device_ids?: string[];
-            /** @description Groups where the role applies */
-            group_ids?: string[];
-            /** @description Sites where the role applies */
-            site_ids?: string[];
-            /** @description e.g., "global", "site", "group", "device" */
-            type?: string;
+        "models.RoleAssignmentScope": {
+            /** @description Restrict to these devices (empty = all devices) */
+            deviceIds?: string[];
+            /** @description Restrict to these groups (empty = all groups) */
+            groupIds?: string[];
+            /** @description Restrict to these sites (empty = all sites) */
+            siteIds?: string[];
         };
         "models.RuntimeConfig": {
             mqttPassword?: string;
@@ -32991,7 +33035,7 @@ export interface components {
             amazon_access_key_id?: string;
             amazon_secret_access_key?: string;
             archive_storage?: components["schemas"]["models.Storage"];
-            audit?: components["schemas"]["models.Audit"][];
+            audit?: components["schemas"]["models.Audit"];
             bucket?: string;
             camera_brands?: components["schemas"]["models.Settings"];
             cameras?: string[];
@@ -33074,19 +33118,6 @@ export interface components {
             user_id?: string;
             username?: string;
         };
-        "models.UserOrgPermissions": {
-            can_invite_users?: boolean;
-            can_manage_devices?: boolean;
-            can_manage_groups?: boolean;
-            can_manage_roles?: boolean;
-            can_manage_sites?: boolean;
-            /** @description Specific devices user has access to */
-            device_ids?: string[];
-            /** @description Specific groups user has access to */
-            group_ids?: string[];
-            /** @description Specific sites user has access to */
-            site_ids?: string[];
-        };
         "models.UserProfile": {
             card?: components["schemas"]["models.Card"];
             user?: components["schemas"]["models.User"];
@@ -33118,7 +33149,7 @@ export interface components {
             assignments?: components["schemas"]["models.RoleAssignment"][];
             /** @description Populated role details */
             roles?: components["schemas"]["models.Role"][];
-            user_id?: string;
+            userId?: string;
         };
         "models.UserSettings": {
             hls_callback_url?: string;
@@ -33727,8 +33758,8 @@ export declare namespace models {
     type AnalyticsLists = components['schemas']['models.AnalyticsLists'];
     type AnalyticsSummary = components['schemas']['models.AnalyticsSummary'];
     type Audit = components['schemas']['models.Audit'];
-    type AuditCreate = components['schemas']['models.AuditCreate'];
-    type AuditUpdate = components['schemas']['models.AuditUpdate'];
+    type AuditEvent = components['schemas']['models.AuditEvent'];
+    type AuditFieldChange = components['schemas']['models.AuditFieldChange'];
     type CameraMetadata = components['schemas']['models.CameraMetadata'];
     type CameraPreset = components['schemas']['models.CameraPreset'];
     type CameraTour = components['schemas']['models.CameraTour'];
@@ -33891,7 +33922,7 @@ export declare namespace models {
     type RemoveAlertInput = components['schemas']['models.RemoveAlertInput'];
     type Role = components['schemas']['models.Role'];
     type RoleAssignment = components['schemas']['models.RoleAssignment'];
-    type RoleScope = components['schemas']['models.RoleScope'];
+    type RoleAssignmentScope = components['schemas']['models.RoleAssignmentScope'];
     type RuntimeConfig = components['schemas']['models.RuntimeConfig'];
     type Sequence = components['schemas']['models.Sequence'];
     type SequenceStage = components['schemas']['models.SequenceStage'];
@@ -33938,7 +33969,6 @@ export declare namespace models {
     type UpdateWorkflowStageInput = components['schemas']['models.UpdateWorkflowStageInput'];
     type UpdateWorkflowStageOutput = components['schemas']['models.UpdateWorkflowStageOutput'];
     type User = components['schemas']['models.User'];
-    type UserOrgPermissions = components['schemas']['models.UserOrgPermissions'];
     type UserProfile = components['schemas']['models.UserProfile'];
     type UserProfileSettings = components['schemas']['models.UserProfileSettings'];
     type UserRoleAssignments = components['schemas']['models.UserRoleAssignments'];

package/package.json

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