@uug-ai/models 1.3.16 → 1.4.0

package/dist/types.d.ts

@@ -8310,6 +8310,162 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/organisation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Organisation (schema generation only)
+         * @description Internal endpoint used only to ensure Organisation 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.Organisation"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/internal/organisationinvitation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get OrganisationInvitation (schema generation only)
+         * @description Internal endpoint used only to ensure OrganisationInvitation 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.OrganisationInvitation"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/internal/organisationmember": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get OrganisationMember (schema generation only)
+         * @description Internal endpoint used only to ensure OrganisationMember 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.OrganisationMember"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/internal/organisationsettings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get OrganisationSettings (schema generation only)
+         * @description Internal endpoint used only to ensure OrganisationSettings 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.OrganisationSettings"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/panicresponse": {
         parameters: {
             query?: never;
@@ -8895,6 +9051,84 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/roleassignment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get RoleAssignment (schema generation only)
+         * @description Internal endpoint used only to ensure RoleAssignment 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.RoleAssignment"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/internal/rolescope": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get RoleScope (schema generation only)
+         * @description Internal endpoint used only to ensure RoleScope 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.RoleScope"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/savefaceredactionerrorresponse": {
         parameters: {
             query?: never;
@@ -10962,6 +11196,123 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/userorganisation": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get UserOrganisation (schema generation only)
+         * @description Internal endpoint used only to ensure UserOrganisation 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.UserOrganisation"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/internal/userorganisationdetails": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get UserOrganisationDetails (schema generation only)
+         * @description Internal endpoint used only to ensure UserOrganisationDetails 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.UserOrganisationDetails"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        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;
@@ -11040,6 +11391,45 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/internal/userroleassignments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get UserRoleAssignments (schema generation only)
+         * @description Internal endpoint used only to ensure UserRoleAssignments 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.UserRoleAssignments"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/internal/usersettings": {
         parameters: {
             query?: never;
@@ -12724,6 +13114,8 @@ export interface components {
         "api.mediaMetadataPatch": {
             description?: string;
         };
+        /** @enum {integer} */
+        "models.AccessLevel": 0 | 1 | 2 | 3;
         "models.AccessToken": {
             /** @description Audit information */
             audit?: components["schemas"]["models.Audit"];
@@ -13349,11 +13741,36 @@ export interface components {
             traject?: number[][];
         };
         "models.FeaturePermissions": {
-            floorPlans?: number;
-            io?: number;
-            liveview?: number;
-            ptz?: number;
-            remote_config?: number;
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            alerts?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            devices?: 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 */
+            floorPlans?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            groups?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            io?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            liveview?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            markers?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            playback?: components["schemas"]["models.AccessLevel"];
+            /** @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"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            roles?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            settings?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            sites?: components["schemas"]["models.AccessLevel"];
+            /** @description 0=none, 1=read, 2=write, 3=admin */
+            users?: components["schemas"]["models.AccessLevel"];
         };
         "models.FloorPlan": {
             /** @description Audit information */
@@ -13986,6 +14403,48 @@ export interface components {
             payload?: unknown;
             type?: string;
         };
+        "models.Organisation": {
+            audit?: components["schemas"]["models.Audit"];
+            description?: string;
+            domain?: string;
+            id?: string;
+            is_active?: number;
+            name?: string;
+            /** @description The user who owns this organisation */
+            owner_id?: string;
+            settings?: components["schemas"]["models.OrganisationSettings"];
+        };
+        "models.OrganisationInvitation": {
+            audit?: components["schemas"]["models.Audit"];
+            email?: string;
+            expires_at?: string;
+            id?: string;
+            invited_by?: string;
+            organisation_id?: string;
+            /** @description Roles to assign upon acceptance */
+            role_ids?: string[];
+            /** @description "pending", "accepted", "expired", "revoked" */
+            status?: string;
+            token?: string;
+        };
+        "models.OrganisationMember": {
+            membership?: components["schemas"]["models.UserOrganisation"];
+            organisation_id?: string;
+            /** @description Member's role assignments */
+            role_assignments?: components["schemas"]["models.RoleAssignment"][];
+            /** @description Populated role details */
+            roles?: components["schemas"]["models.Role"][];
+            user?: components["schemas"]["models.User"];
+        };
+        "models.OrganisationSettings": {
+            allow_invitations?: boolean;
+            /** @description Email domains allowed for membership */
+            allowed_domains?: string[];
+            /** @description Default role for new members */
+            default_role_id?: string;
+            force_mfa?: boolean;
+            max_members?: number;
+        };
         /** @enum {integer} */
         "models.PermissionLevel": 1 | 2 | 3 | 4 | 2 | 3 | 4 | 5 | 2 | 3 | 2 | 2 | 3 | 2 | 3 | 4;
         "models.Permissions": {
@@ -14097,16 +14556,43 @@ export interface components {
             y?: number;
         };
         "models.Role": {
+            audit?: components["schemas"]["models.Audit"];
+            description?: string;
             featurePermissions?: components["schemas"]["models.FeaturePermissions"];
             id?: string;
             isActive?: number;
+            /** @description Organisation this role belongs to */
+            organisation_id?: string;
             pages?: string[];
             role?: string;
             roleName?: string;
             timeWindow?: components["schemas"]["models.TimeWindow"];
             timeWindowActive?: number;
+        };
+        "models.RoleAssignment": {
+            audit?: components["schemas"]["models.Audit"];
+            /** @description Optional expiration for temporary assignments */
+            expires_at?: string;
+            id?: string;
+            is_active?: number;
+            /** @description Organisation context for this assignment */
+            organisation_id?: string;
+            /** @description Reference to the organisation-specific Role */
+            role_id?: string;
+            /** @description Optional granular scope within organisation */
+            scope?: components["schemas"]["models.RoleScope"];
             user_id?: 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.SequenceStage": {
             name?: string;
             /** @description Add fields relevant to sequence stage */
@@ -14493,6 +14979,43 @@ 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.UserOrganisation": {
+            audit?: components["schemas"]["models.Audit"];
+            /** @description Optional expiration for temporary access */
+            expires_at?: 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;
+        };
+        "models.UserOrganisationDetails": {
+            membership?: components["schemas"]["models.UserOrganisation"];
+            organisation?: components["schemas"]["models.Organisation"];
+            /** @description User's role assignments in this organisation */
+            role_assignments?: components["schemas"]["models.RoleAssignment"][];
+            /** @description Populated role details */
+            roles?: components["schemas"]["models.Role"][];
+            user_id?: string;
+        };
         "models.UserProfile": {
             card?: components["schemas"]["models.Card"];
             user?: components["schemas"]["models.User"];
@@ -14520,6 +15043,12 @@ export interface components {
             timezone?: string;
             username?: string;
         };
+        "models.UserRoleAssignments": {
+            assignments?: components["schemas"]["models.RoleAssignment"][];
+            /** @description Populated role details */
+            roles?: components["schemas"]["models.Role"][];
+            user_id?: string;
+        };
         "models.UserSettings": {
             hls_callback_url?: string;
             oauth_client_creation_date?: number;
@@ -14716,6 +15245,10 @@ export declare namespace models {
     type NotificationStage = components['schemas']['models.NotificationStage'];
     type NotificationUpdate = components['schemas']['models.NotificationUpdate'];
     type NotificationUpdatePayload = components['schemas']['models.NotificationUpdatePayload'];
+    type Organisation = components['schemas']['models.Organisation'];
+    type OrganisationInvitation = components['schemas']['models.OrganisationInvitation'];
+    type OrganisationMember = components['schemas']['models.OrganisationMember'];
+    type OrganisationSettings = components['schemas']['models.OrganisationSettings'];
     type Permissions = components['schemas']['models.Permissions'];
     type PipelineEvent = components['schemas']['models.PipelineEvent'];
     type PipelineMetadata = components['schemas']['models.PipelineMetadata'];
@@ -14729,6 +15262,8 @@ export declare namespace models {
     type Region = components['schemas']['models.Region'];
     type RegionPoint = components['schemas']['models.RegionPoint'];
     type Role = components['schemas']['models.Role'];
+    type RoleAssignment = components['schemas']['models.RoleAssignment'];
+    type RoleScope = components['schemas']['models.RoleScope'];
     type SequenceStage = components['schemas']['models.SequenceStage'];
     type Settings = components['schemas']['models.Settings'];
     type Site = components['schemas']['models.Site'];
@@ -14751,8 +15286,12 @@ export declare namespace models {
     type TimeWindow = components['schemas']['models.TimeWindow'];
     type TrackBox = components['schemas']['models.TrackBox'];
     type User = components['schemas']['models.User'];
+    type UserOrgPermissions = components['schemas']['models.UserOrgPermissions'];
+    type UserOrganisation = components['schemas']['models.UserOrganisation'];
+    type UserOrganisationDetails = components['schemas']['models.UserOrganisationDetails'];
     type UserProfile = components['schemas']['models.UserProfile'];
     type UserProfileSettings = components['schemas']['models.UserProfileSettings'];
+    type UserRoleAssignments = components['schemas']['models.UserRoleAssignments'];
     type UserSettings = components['schemas']['models.UserSettings'];
     type UserShort = components['schemas']['models.UserShort'];
     type UserUpdate = components['schemas']['models.UserUpdate'];

package/package.json

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