@meshery/schemas 1.0.9 → 1.1.1

package/dist/constructs/v1beta2/team/Team.d.ts

@@ -0,0 +1,939 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/identity/orgs/{orgId}/teams": {
+        /** Gets all teams within an organization */
+        get: operations["getTeams"];
+        /** Creates a new team within an organization */
+        post: operations["createTeam"];
+    };
+    "/api/identity/orgs/{orgId}/teams/{teamId}": {
+        /** Gets a team by its ID */
+        get: operations["getTeamById"];
+        /** Updates a team's information */
+        put: operations["updateTeam"];
+        /** Deletes a team by its ID */
+        delete: operations["deleteTeam"];
+    };
+    "/api/identity/teams/{teamId}/users": {
+        /** Gets all users that belong to a team */
+        get: operations["getTeamUsers"];
+    };
+    "/api/identity/orgs/{orgId}/teams/{teamId}/users/{userId}": {
+        /** Assigns a user to a team */
+        post: operations["addUserToTeam"];
+        /** Unassigns a user from a team */
+        delete: operations["removeUserFromTeam"];
+    };
+    "/api/identity/orgs/{orgId}/teams/{teamId}/users": {
+        get: operations["listUsersNotInTeam"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within Meshery. Learn more at https://docs.meshery.io/concepts/logical/teams */
+        Team: {
+            /**
+             * Format: uuid
+             * @description Team ID
+             */
+            id: string;
+            /** @description Team name */
+            name: string;
+            /** @description Team description */
+            description?: string;
+            /**
+             * Format: uuid
+             * @description User ID of the owner of the team
+             */
+            owner?: string;
+            /** @description Additional metadata for the team */
+            metadata?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Format: date-time
+             * @description Timestamp when the team was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the team was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the team was soft-deleted, if applicable.
+             */
+            deletedAt?: string;
+        };
+        /** @description Payload for creating a new team */
+        TeamPayload: {
+            /** @description Team name. Provide a meaningful name that represents this team. */
+            name: string;
+            /** @description A detailed description of the team's purpose and responsibilities. */
+            description?: string;
+        };
+        /** @description Payload for updating an existing team */
+        TeamUpdatePayload: {
+            /** @description Updated team name */
+            name?: string;
+            /** @description Updated team description */
+            description?: string;
+        };
+        /** @description Paginated list of teams */
+        TeamPage: {
+            /** @description Current page number of the result set. */
+            page?: number;
+            /** @description Number of items per page. */
+            page_size?: number;
+            /** @description Total number of items available. */
+            total_count?: number;
+            /** @description The teams of the teampage. */
+            teams?: {
+                /**
+                 * Format: uuid
+                 * @description Team ID
+                 */
+                id: string;
+                /** @description Team name */
+                name: string;
+                /** @description Team description */
+                description?: string;
+                /**
+                 * Format: uuid
+                 * @description User ID of the owner of the team
+                 */
+                owner?: string;
+                /** @description Additional metadata for the team */
+                metadata?: {
+                    [key: string]: unknown;
+                };
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the team was created.
+                 */
+                createdAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the team was last updated.
+                 */
+                updatedAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the team was soft-deleted, if applicable.
+                 */
+                deletedAt?: string;
+            }[];
+        };
+        /** @description Mapping between teams and users */
+        TeamsUsersMapping: {
+            /** Format: uuid */
+            id?: string;
+            /**
+             * Format: uuid
+             * @description Team ID
+             */
+            teamId?: string;
+            /**
+             * Format: uuid
+             * @description User ID
+             */
+            userId?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the mapping was created.
+             */
+            createdAt?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the mapping was last updated.
+             */
+            updatedAt?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the mapping was soft-deleted, if applicable.
+             */
+            deletedAt?: string;
+        };
+        /** @description Paginated list of team-user mappings */
+        TeamsUsersMappingPage: {
+            /** @description Current page number of the result set. */
+            page?: number;
+            /** @description Number of items per page. */
+            page_size?: number;
+            /** @description Total number of items available. */
+            total_count?: number;
+            /** @description The teams users mapping of the teamsusersmappingpage. */
+            teamsUsersMapping?: {
+                /** Format: uuid */
+                id?: string;
+                /**
+                 * Format: uuid
+                 * @description Team ID
+                 */
+                teamId?: string;
+                /**
+                 * Format: uuid
+                 * @description User ID
+                 */
+                userId?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the mapping was created.
+                 */
+                createdAt?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the mapping was last updated.
+                 */
+                updatedAt?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the mapping was soft-deleted, if applicable.
+                 */
+                deletedAt?: string;
+            }[];
+        };
+        /** @description A user who is a prospective or existing team member. */
+        TeamMember: {
+            [key: string]: unknown;
+        };
+        /** @description Paginated list of team members. */
+        TeamMembersPage: {
+            /** @description Current page number of the result set. */
+            page?: number;
+            /** @description Number of items per page. */
+            page_size?: number;
+            /** @description Total number of items available. */
+            total_count?: number;
+            /** @description The data of the teammemberspage. */
+            data?: {
+                [key: string]: unknown;
+            }[];
+        };
+    };
+    responses: {
+        /** ok */
+        200: {
+            content: {
+                "text/plain": 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;
+            };
+        };
+    };
+    parameters: {
+        /** @description Team ID */
+        teamId: string;
+        /** @description Organization ID */
+        orgId: string;
+        /** @description User ID */
+        userId: string;
+        /** @description Get responses that match search param value */
+        search: string;
+        /** @description Get ordered responses */
+        order: string;
+        /** @description Get responses by page */
+        page: string;
+        /** @description Get responses by pagesize */
+        pagesize: string;
+    };
+    requestBodies: {
+        /** Body for creating a team */
+        teamPayload: {
+            content: {
+                "application/json": {
+                    /** @description Team name. Provide a meaningful name that represents this team. */
+                    name: string;
+                    /** @description A detailed description of the team's purpose and responsibilities. */
+                    description?: string;
+                };
+            };
+        };
+        /** Body for updating a team */
+        teamUpdatePayload: {
+            content: {
+                "application/json": {
+                    /** @description Updated team name */
+                    name?: string;
+                    /** @description Updated team description */
+                    description?: string;
+                };
+            };
+        };
+    };
+}
+interface operations {
+    /** Gets all teams within an organization */
+    getTeams: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+            };
+            query: {
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+            };
+        };
+        responses: {
+            /** Teams */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Current page number of the result set. */
+                        page?: number;
+                        /** @description Number of items per page. */
+                        page_size?: number;
+                        /** @description Total number of items available. */
+                        total_count?: number;
+                        /** @description The teams of the teampage. */
+                        teams?: {
+                            /**
+                             * Format: uuid
+                             * @description Team ID
+                             */
+                            id: string;
+                            /** @description Team name */
+                            name: string;
+                            /** @description Team description */
+                            description?: string;
+                            /**
+                             * Format: uuid
+                             * @description User ID of the owner of the team
+                             */
+                            owner?: string;
+                            /** @description Additional metadata for the team */
+                            metadata?: {
+                                [key: string]: unknown;
+                            };
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the team was created.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the team was last updated.
+                             */
+                            updatedAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the team was soft-deleted, if applicable.
+                             */
+                            deletedAt?: 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;
+                };
+            };
+        };
+    };
+    /** Creates a new team within an organization */
+    createTeam: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+            };
+        };
+        responses: {
+            /** Created team */
+            201: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Team ID
+                         */
+                        id: string;
+                        /** @description Team name */
+                        name: string;
+                        /** @description Team description */
+                        description?: string;
+                        /**
+                         * Format: uuid
+                         * @description User ID of the owner of the team
+                         */
+                        owner?: string;
+                        /** @description Additional metadata for the team */
+                        metadata?: {
+                            [key: string]: unknown;
+                        };
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was soft-deleted, if applicable.
+                         */
+                        deletedAt?: 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;
+                };
+            };
+        };
+        /** Body for creating a team */
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description Team name. Provide a meaningful name that represents this team. */
+                    name: string;
+                    /** @description A detailed description of the team's purpose and responsibilities. */
+                    description?: string;
+                };
+            };
+        };
+    };
+    /** Gets a team by its ID */
+    getTeamById: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+                /** Team ID */
+                teamId: string;
+            };
+        };
+        responses: {
+            /** Team */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Team ID
+                         */
+                        id: string;
+                        /** @description Team name */
+                        name: string;
+                        /** @description Team description */
+                        description?: string;
+                        /**
+                         * Format: uuid
+                         * @description User ID of the owner of the team
+                         */
+                        owner?: string;
+                        /** @description Additional metadata for the team */
+                        metadata?: {
+                            [key: string]: unknown;
+                        };
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was soft-deleted, if applicable.
+                         */
+                        deletedAt?: 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;
+                };
+            };
+        };
+    };
+    /** Updates a team's information */
+    updateTeam: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+                /** Team ID */
+                teamId: string;
+            };
+        };
+        responses: {
+            /** Updated team */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Team ID
+                         */
+                        id: string;
+                        /** @description Team name */
+                        name: string;
+                        /** @description Team description */
+                        description?: string;
+                        /**
+                         * Format: uuid
+                         * @description User ID of the owner of the team
+                         */
+                        owner?: string;
+                        /** @description Additional metadata for the team */
+                        metadata?: {
+                            [key: string]: unknown;
+                        };
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the team was soft-deleted, if applicable.
+                         */
+                        deletedAt?: 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;
+                };
+            };
+        };
+        /** Body for updating a team */
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description Updated team name */
+                    name?: string;
+                    /** @description Updated team description */
+                    description?: string;
+                };
+            };
+        };
+    };
+    /** Deletes a team by its ID */
+    deleteTeam: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+                /** Team ID */
+                teamId: string;
+            };
+        };
+        responses: {
+            /** Team 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;
+                };
+            };
+        };
+    };
+    /** Gets all users that belong to a team */
+    getTeamUsers: {
+        parameters: {
+            path: {
+                /** Team ID */
+                teamId: string;
+            };
+            query: {
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+            };
+        };
+        responses: {
+            /** Team users mapping */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Current page number of the result set. */
+                        page?: number;
+                        /** @description Number of items per page. */
+                        page_size?: number;
+                        /** @description Total number of items available. */
+                        total_count?: number;
+                        /** @description The teams users mapping of the teamsusersmappingpage. */
+                        teamsUsersMapping?: {
+                            /** Format: uuid */
+                            id?: string;
+                            /**
+                             * Format: uuid
+                             * @description Team ID
+                             */
+                            teamId?: string;
+                            /**
+                             * Format: uuid
+                             * @description User ID
+                             */
+                            userId?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the mapping was created.
+                             */
+                            createdAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the mapping was last updated.
+                             */
+                            updatedAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the mapping was soft-deleted, if applicable.
+                             */
+                            deletedAt?: 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;
+                };
+            };
+        };
+    };
+    /** Assigns a user to a team */
+    addUserToTeam: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+                /** Team ID */
+                teamId: string;
+                /** User ID */
+                userId: string;
+            };
+        };
+        responses: {
+            /** User added to team */
+            201: {
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        id?: string;
+                        /**
+                         * Format: uuid
+                         * @description Team ID
+                         */
+                        teamId?: string;
+                        /**
+                         * Format: uuid
+                         * @description User ID
+                         */
+                        userId?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the mapping was created.
+                         */
+                        createdAt?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the mapping was last updated.
+                         */
+                        updatedAt?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the mapping was soft-deleted, if applicable.
+                         */
+                        deletedAt?: 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;
+                };
+            };
+        };
+    };
+    /** Unassigns a user from a team */
+    removeUserFromTeam: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+                /** Team ID */
+                teamId: string;
+                /** User ID */
+                userId: string;
+            };
+        };
+        responses: {
+            /** User removed from team */
+            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;
+                };
+            };
+        };
+    };
+    listUsersNotInTeam: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+                /** Team ID */
+                teamId: string;
+            };
+            query: {
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+            };
+        };
+        responses: {
+            /** Users not currently in the team */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Current page number of the result set. */
+                        page?: number;
+                        /** @description Number of items per page. */
+                        page_size?: number;
+                        /** @description Total number of items available. */
+                        total_count?: number;
+                        /** @description The data of the teammemberspage. */
+                        data?: {
+                            [key: string]: unknown;
+                        }[];
+                    };
+                };
+            };
+            /** 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;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };