@meshery/schemas 1.0.9 → 1.1.0

package/dist/constructs/v1beta3/event/Event.d.ts

@@ -0,0 +1,733 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/events/{eventId}": {
+        delete: operations["deleteEvent"];
+    };
+    "/events": {
+        post: operations["createEvent"];
+    };
+    "/events/delete": {
+        post: operations["bulkDeleteEvents"];
+    };
+    "/events/status": {
+        put: operations["bulkUpdateEventStatus"];
+    };
+    "/events/{eventId}/status": {
+        put: operations["updateEventStatus"];
+    };
+    "/api/workspaces/{workspaceId}/events": {
+        /** Gets events for a workspace. */
+        get: operations["getEventsOfWorkspace"];
+    };
+    "/api/events": {
+        get: operations["getEventsAggregate"];
+    };
+    "/api/events/list": {
+        get: operations["getEvents"];
+    };
+    "/api/events/summary": {
+        get: operations["getEventSummaryByUser"];
+    };
+    "/api/events/types": {
+        get: operations["getEventTypes"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Payload for creating a new event. */
+        EventPayload: {
+            /**
+             * Format: uuid
+             * @description UUID of the user associated with the event.
+             */
+            userId?: string;
+            /** @description The category of the event. */
+            category?: string;
+            /** @description The action of the event. */
+            action?: string;
+            /** @description Description of the event. */
+            description?: string;
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description Payload for updating the status of a single event. */
+        UpdateEventStatusRequest: {
+            /**
+             * @description Current status of the event.
+             * @example completed
+             */
+            status: string;
+        };
+        /** @description Response body returned after updating an event's status. */
+        UpdateEventStatusResponse: {
+            /** @description Human-readable status message. */
+            message?: string;
+            /**
+             * Format: uuid
+             * @description UUID of the event whose status was updated.
+             */
+            eventId?: string;
+            /** @description Updated status of the event. */
+            status?: string;
+        };
+        /** @description Payload for bulk-deleting events by ID. */
+        BulkDeleteRequest: {
+            /** @description UUIDs of the events to delete. */
+            ids: string[];
+        };
+        /** @description Response body returned after bulk event deletion. */
+        BulkDeleteResponse: {
+            /** @description UUIDs of events that were deleted. */
+            deleted?: string[];
+        };
+        /** @description Payload for bulk-updating the status of events. */
+        BulkUpdateStatusRequest: {
+            /** @description UUIDs of the events to update. */
+            ids: string[];
+            /**
+             * @description New status to apply to the selected events.
+             * @example failed
+             */
+            status: string;
+        };
+        /** @description Response body returned after bulk event status update. */
+        BulkUpdateStatusResponse: {
+            /** @description UUIDs of events whose status was updated. */
+            updated?: string[];
+        };
+        /** @description EventResult entity schema. */
+        EventResult: {
+            /**
+             * Format: uuid
+             * @description UUID of the user associated with the event.
+             */
+            userId: string;
+            /** @description System identifier of the event source. */
+            systemId?: string;
+            /** @description The category of the event. */
+            category: string;
+            /** @description The action of the event. */
+            action: string;
+            /** @description Description of the event. */
+            description?: string;
+            /** @description The first name of the user associated with the event. */
+            firstName?: string;
+            /** @description The last name of the user associated with the event. */
+            lastName?: string;
+            /**
+             * Format: email
+             * @description Email address of the user associated with the event.
+             */
+            email?: string;
+            /** @description Authentication provider of the user associated with the event. */
+            provider?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the event was recorded.
+             */
+            createdAt?: string;
+        };
+        /** @description Paginated list of events. */
+        EventsPage: {
+            /** @description Zero-based page index returned in this response. */
+            page?: number;
+            /** @description Maximum number of items returned on each page. */
+            pageSize?: number;
+            /** @description Total number of items across all pages. */
+            totalCount?: number;
+            /** @description The events returned on the current page. */
+            data?: {
+                /**
+                 * Format: uuid
+                 * @description UUID of the user associated with the event.
+                 */
+                userId: string;
+                /** @description System identifier of the event source. */
+                systemId?: string;
+                /** @description The category of the event. */
+                category: string;
+                /** @description The action of the event. */
+                action: string;
+                /** @description Description of the event. */
+                description?: string;
+                /** @description The first name of the user associated with the event. */
+                firstName?: string;
+                /** @description The last name of the user associated with the event. */
+                lastName?: string;
+                /**
+                 * Format: email
+                 * @description Email address of the user associated with the event.
+                 */
+                email?: string;
+                /** @description Authentication provider of the user associated with the event. */
+                provider?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the event was recorded.
+                 */
+                createdAt?: string;
+            }[];
+        };
+        /** @description Aggregated event counts across categories. */
+        EventsAggregate: {
+            /** @description Count of audit-category events. */
+            audit?: number;
+        } & {
+            [key: string]: unknown;
+        };
+        /** @description Per-user event summary entry. */
+        EventSummary: {
+            [key: string]: unknown;
+        };
+        /** @description Paginated list of per-user event summaries. */
+        EventSummaryPage: {
+            /** @description Current page number of the result set. */
+            page?: number;
+            /** @description Number of items per page. */
+            pageSize?: number;
+            /** @description Total number of items available. */
+            totalCount?: number;
+            /** @description The event summaries returned on the current page. */
+            data?: {
+                [key: string]: unknown;
+            }[];
+        };
+        /** @description A category/action pair describing one kind of event. */
+        EventType: {
+            /** @description The category of the event type. */
+            category?: string;
+            /** @description The action of the event type. */
+            action?: string;
+        };
+        /** @description Generic error envelope returned for non-2xx responses. */
+        ErrorResponse: {
+            /** @description Human-readable error message. */
+            error?: string;
+        };
+    };
+    responses: {
+        /** Invalid request body or request param */
+        400: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Expired JWT token used or insufficient privilege */
+        401: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Result not found */
+        404: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Internal server error */
+        500: {
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+    parameters: {
+        /** @description ID of the event. */
+        eventId: string;
+        /** @description Workspace ID */
+        workspaceId: string;
+        /** @description Get responses by page */
+        page: string;
+        /** @description Get responses by pagesize */
+        pagesize: string;
+        /** @description Get responses that match search param value */
+        search: string;
+        /** @description Get ordered responses */
+        order: string;
+        /** @description When true, return cumulative aggregate counts across all time. */
+        cumulative: boolean;
+        /** @description Get filtered reponses */
+        filter: string;
+        /** @description Get filtered reponses */
+        eventsFilter: string;
+    };
+}
+interface operations {
+    deleteEvent: {
+        parameters: {
+            path: {
+                /** ID of the event. */
+                eventId: string;
+            };
+        };
+        responses: {
+            /** Event deleted */
+            204: never;
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Result not found */
+            404: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    createEvent: {
+        responses: {
+            /** Event created */
+            201: unknown;
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: uuid
+                     * @description UUID of the user associated with the event.
+                     */
+                    userId?: string;
+                    /** @description The category of the event. */
+                    category?: string;
+                    /** @description The action of the event. */
+                    action?: string;
+                    /** @description Description of the event. */
+                    description?: string;
+                } & {
+                    [key: string]: unknown;
+                };
+            };
+        };
+    };
+    bulkDeleteEvents: {
+        responses: {
+            /** Events deleted */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description UUIDs of events that were deleted. */
+                        deleted?: string[];
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description UUIDs of the events to delete. */
+                    ids: string[];
+                };
+            };
+        };
+    };
+    bulkUpdateEventStatus: {
+        responses: {
+            /** Events updated */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description UUIDs of events whose status was updated. */
+                        updated?: string[];
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description UUIDs of the events to update. */
+                    ids: string[];
+                    /**
+                     * @description New status to apply to the selected events.
+                     * @example failed
+                     */
+                    status: string;
+                };
+            };
+        };
+    };
+    updateEventStatus: {
+        parameters: {
+            path: {
+                /** ID of the event. */
+                eventId: string;
+            };
+        };
+        responses: {
+            /** Event status updated */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Human-readable status message. */
+                        message?: string;
+                        /**
+                         * Format: uuid
+                         * @description UUID of the event whose status was updated.
+                         */
+                        eventId?: string;
+                        /** @description Updated status of the event. */
+                        status?: string;
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Result not found */
+            404: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * @description Current status of the event.
+                     * @example completed
+                     */
+                    status: string;
+                };
+            };
+        };
+    };
+    /** Gets events for a workspace. */
+    getEventsOfWorkspace: {
+        parameters: {
+            path: {
+                /** Workspace ID */
+                workspaceId: string;
+            };
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+            };
+        };
+        responses: {
+            /** Workspace events */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Zero-based page index returned in this response. */
+                        page?: number;
+                        /** @description Maximum number of items returned on each page. */
+                        pageSize?: number;
+                        /** @description Total number of items across all pages. */
+                        totalCount?: number;
+                        /** @description The events returned on the current page. */
+                        data?: {
+                            /**
+                             * Format: uuid
+                             * @description UUID of the user associated with the event.
+                             */
+                            userId: string;
+                            /** @description System identifier of the event source. */
+                            systemId?: string;
+                            /** @description The category of the event. */
+                            category: string;
+                            /** @description The action of the event. */
+                            action: string;
+                            /** @description Description of the event. */
+                            description?: string;
+                            /** @description The first name of the user associated with the event. */
+                            firstName?: string;
+                            /** @description The last name of the user associated with the event. */
+                            lastName?: string;
+                            /**
+                             * Format: email
+                             * @description Email address of the user associated with the event.
+                             */
+                            email?: string;
+                            /** @description Authentication provider of the user associated with the event. */
+                            provider?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the event was recorded.
+                             */
+                            createdAt?: string;
+                        }[];
+                    };
+                };
+            };
+            /** Invalid request */
+            400: {
+                content: {
+                    "application/json": {
+                        /** @description Human-readable error message. */
+                        error?: string;
+                    };
+                };
+            };
+            /** Unauthorized */
+            401: unknown;
+            /** Workspace not found */
+            404: unknown;
+            /** Server error */
+            500: unknown;
+        };
+    };
+    getEventsAggregate: {
+        parameters: {
+            query: {
+                /** When true, return cumulative aggregate counts across all time. */
+                cumulative?: boolean;
+            };
+        };
+        responses: {
+            /** Events aggregate */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Count of audit-category events. */
+                        audit?: number;
+                    } & {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** Unauthorized */
+            401: unknown;
+            /** Not found */
+            404: unknown;
+            /** Server error */
+            500: unknown;
+        };
+    };
+    getEvents: {
+        parameters: {
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+                /** Get filtered reponses */
+                filter?: string;
+            };
+        };
+        responses: {
+            /** Events page */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Zero-based page index returned in this response. */
+                        page?: number;
+                        /** @description Maximum number of items returned on each page. */
+                        pageSize?: number;
+                        /** @description Total number of items across all pages. */
+                        totalCount?: number;
+                        /** @description The events returned on the current page. */
+                        data?: {
+                            /**
+                             * Format: uuid
+                             * @description UUID of the user associated with the event.
+                             */
+                            userId: string;
+                            /** @description System identifier of the event source. */
+                            systemId?: string;
+                            /** @description The category of the event. */
+                            category: string;
+                            /** @description The action of the event. */
+                            action: string;
+                            /** @description Description of the event. */
+                            description?: string;
+                            /** @description The first name of the user associated with the event. */
+                            firstName?: string;
+                            /** @description The last name of the user associated with the event. */
+                            lastName?: string;
+                            /**
+                             * Format: email
+                             * @description Email address of the user associated with the event.
+                             */
+                            email?: string;
+                            /** @description Authentication provider of the user associated with the event. */
+                            provider?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the event was recorded.
+                             */
+                            createdAt?: string;
+                        }[];
+                    };
+                };
+            };
+            /** Unauthorized */
+            401: unknown;
+            /** Not found */
+            404: unknown;
+            /** Server error */
+            500: unknown;
+        };
+    };
+    getEventSummaryByUser: {
+        parameters: {
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+                /** Get filtered reponses */
+                filter?: string;
+            };
+        };
+        responses: {
+            /** Event summary page */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Current page number of the result set. */
+                        page?: number;
+                        /** @description Number of items per page. */
+                        pageSize?: number;
+                        /** @description Total number of items available. */
+                        totalCount?: number;
+                        /** @description The event summaries returned on the current page. */
+                        data?: {
+                            [key: string]: unknown;
+                        }[];
+                    };
+                };
+            };
+            /** Unauthorized */
+            401: unknown;
+            /** Not found */
+            404: unknown;
+            /** Server error */
+            500: unknown;
+        };
+    };
+    getEventTypes: {
+        parameters: {
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+            };
+        };
+        responses: {
+            /** Event types */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description The category of the event type. */
+                        category?: string;
+                        /** @description The action of the event type. */
+                        action?: string;
+                    }[];
+                };
+            };
+            /** Unauthorized */
+            401: unknown;
+            /** Not found */
+            404: unknown;
+            /** Server error */
+            500: unknown;
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };