academe-kit 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -3513,6 +3513,69 @@ interface paths {
         };
         trace?: never;
     };
+    "/institutions/{institutionId}/users": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all users from an institution
+         * @description Retrieve a paginated list of all users registered in an institution with advanced filtering options
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Filter by classroom (institution_classroom_id) */
+                    classroomId?: string;
+                    /** @description Filter by student status (true = students only, false = non-students only) */
+                    isStudent?: boolean;
+                    /** @description Filter by user active status */
+                    isActive?: boolean;
+                    /** @description Filter users with certificates (true) or without (false) */
+                    hasCertificates?: boolean;
+                    /** @description Filter users with guardian (true) or without (false) */
+                    hasGuardian?: boolean;
+                    /** @description Search by email, first name, last name, or full name (case-insensitive) */
+                    search?: string;
+                    /** @description Page number */
+                    page?: number;
+                    /** @description Items per page */
+                    limit?: number;
+                };
+                header?: never;
+                path: {
+                    /** @description Institution ID */
+                    institutionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description List of users from the institution */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["InstitutionUserListResponse"];
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/organizations": {
         parameters: {
             query?: never;
@@ -5896,6 +5959,115 @@ interface components {
             updatedAt?: string;
             guardian?: components["schemas"]["Guardian"];
         };
+        /** @description User with institution registration details (returned by GET /institutions/{institutionId}/users) */
+        InstitutionUser: {
+            /**
+             * Format: uuid
+             * @description Keycloak User ID
+             */
+            id?: string;
+            /** @example John */
+            firstName?: string;
+            /** @example Doe */
+            lastName?: string;
+            /**
+             * Format: email
+             * @example john.doe@example.com
+             */
+            email?: string;
+            /** @example +5511999999999 */
+            phone?: string | null;
+            /** @example 12345678901 */
+            document?: string | null;
+            /** @enum {string|null} */
+            gender?: "male" | "female" | "other" | null;
+            /**
+             * @description Indicates if the user is active
+             * @example true
+             */
+            isActive?: boolean;
+            /** Format: date-time */
+            birthdate?: string | null;
+            /** Format: date-time */
+            createdAt?: string;
+            /** Format: date-time */
+            updatedAt?: string;
+            /**
+             * @description Number of certificates the user has
+             * @example 5
+             */
+            certificatesCount?: number;
+            /** @description User's guardian associations */
+            userGuardians?: {
+                /** Format: uuid */
+                id?: string;
+                guardian?: {
+                    /** Format: uuid */
+                    id?: string;
+                    /** @example Maria Silva */
+                    name?: string;
+                    /**
+                     * Format: email
+                     * @example maria@example.com
+                     */
+                    email?: string;
+                    /** @example +5511999999999 */
+                    phone?: string | null;
+                };
+            }[];
+            /** @description User's registration info in the institution */
+            institutionRegistration?: {
+                /** Format: uuid */
+                id?: string;
+                /**
+                 * @description Indicates if the user is registered as a student
+                 * @example true
+                 */
+                isStudent?: boolean;
+                /**
+                 * @description Indicates if the registration is active
+                 * @example true
+                 */
+                isActive?: boolean;
+                /** @description Classroom assignment details */
+                institutionClassroom?: {
+                    /** Format: uuid */
+                    id?: string;
+                    classroom?: {
+                        /** Format: uuid */
+                        id?: string;
+                        /** @example 9º Ano A */
+                        name?: string;
+                        /** @description Grade level information */
+                        serie?: {
+                            /** Format: uuid */
+                            id?: string;
+                            /**
+                             * @description Grade level value (1-12)
+                             * @example 9
+                             */
+                            value?: number;
+                        } | null;
+                        /** @description Shift information (morning, afternoon, night) */
+                        shift?: {
+                            /** Format: uuid */
+                            id?: string;
+                            /**
+                             * @example manhã
+                             * @enum {string}
+                             */
+                            name?: "manhã" | "tarde" | "noite";
+                        } | null;
+                    } | null;
+                } | null;
+            };
+        };
+        InstitutionUserListResponse: {
+            /** @example success */
+            status?: string;
+            data?: components["schemas"]["InstitutionUser"][];
+            meta?: components["schemas"]["PaginationMeta"];
+        };
         InstitutionRegistration: {
             /** Format: uuid */
             id?: string;
@@ -6818,6 +6990,7 @@ type User = components['schemas']['User'];
 type Institution = components['schemas']['Institution'];
 type Classroom = components['schemas']['Classroom'];
 type InstitutionClassroom = components['schemas']['InstitutionClassroom'];
+type InstitutionUser = components['schemas']['InstitutionUser'];
 type Organization = components['schemas']['Organization'];
 type Serie = components['schemas']['Serie'];
 type Shift = components['schemas']['Shift'];
@@ -6825,12 +6998,13 @@ type Shift = components['schemas']['Shift'];
 type index_d_Classroom = Classroom;
 type index_d_Institution = Institution;
 type index_d_InstitutionClassroom = InstitutionClassroom;
+type index_d_InstitutionUser = InstitutionUser;
 type index_d_Organization = Organization;
 type index_d_Serie = Serie;
 type index_d_Shift = Shift;
 type index_d_User = User;
 declare namespace index_d {
-  export type { index_d_Classroom as Classroom, index_d_Institution as Institution, index_d_InstitutionClassroom as InstitutionClassroom, index_d_Organization as Organization, index_d_Serie as Serie, index_d_Shift as Shift, index_d_User as User };
+  export type { index_d_Classroom as Classroom, index_d_Institution as Institution, index_d_InstitutionClassroom as InstitutionClassroom, index_d_InstitutionUser as InstitutionUser, index_d_Organization as Organization, index_d_Serie as Serie, index_d_Shift as Shift, index_d_User as User };
 }
 
 type CreateUserBody = {
@@ -7730,6 +7904,65 @@ declare function createInstitutionService(apiClient: AcademeApiClient): {
             };
         };
     }, `${string}/${string}`>>;
+    getUsers(institutionId: string, options?: {
+        classroomId?: string;
+        isStudent?: boolean;
+        isActive?: boolean;
+        hasCertificates?: boolean;
+        hasGuardian?: boolean;
+        search?: string;
+        page?: number;
+        limit?: number;
+    }): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: {
+                classroomId?: string;
+                isStudent?: boolean;
+                isActive?: boolean;
+                hasCertificates?: boolean;
+                hasGuardian?: boolean;
+                search?: string;
+                page?: number;
+                limit?: number;
+            };
+            header?: never;
+            path: {
+                institutionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InstitutionUserListResponse"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["ServerError"];
+        };
+    }, {
+        params: {
+            path: {
+                institutionId: string;
+            };
+            query: {
+                classroomId?: string;
+                isStudent?: boolean;
+                isActive?: boolean;
+                hasCertificates?: boolean;
+                hasGuardian?: boolean;
+                search?: string;
+                page?: number;
+                limit?: number;
+            } | undefined;
+        };
+    }, `${string}/${string}`>>;
     getRegistrations(institutionId: string): Promise<openapi_fetch.FetchResponse<{
         parameters: {
             query?: never;

package/dist/index.esm.js

@@ -2839,6 +2839,15 @@ function createInstitutionService(apiClient) {
                 params: { path: { institutionId, classroomId } },
             });
         },
+        // Institution Users (list all users with filters)
+        getUsers(institutionId, options) {
+            return apiClient.GET('/institutions/{institutionId}/users', {
+                params: {
+                    path: { institutionId },
+                    query: options,
+                },
+            });
+        },
         // Institution Registrations (Users in Institution)
         getRegistrations(institutionId) {
             return apiClient.GET('/institutions/{institutionId}/registrations', {