academe-kit 0.3.9 → 0.4.0

package/dist/types/types/academe-api.d.ts

@@ -2778,6 +2778,726 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/institutions/curriculum-grids": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all curriculum grids
+         * @description Retrieve a list of all curriculum grids with optional filters
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Filter by institution ID */
+                    institutionId?: string;
+                    /** @description Filter by serie ID */
+                    serie?: string;
+                    /** @description Filter by active status */
+                    isActive?: boolean;
+                    /** @description Page number */
+                    page?: number;
+                    /** @description Items per page */
+                    limit?: number;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description List of curriculum grids */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["CurriculumGrid"][];
+                            meta?: {
+                                total?: number;
+                                page?: number;
+                                limit?: number;
+                                totalPages?: number;
+                            };
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        /**
+         * Create a new curriculum grid
+         * @description Create a new curriculum grid for an institution and serie
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["CreateCurriculumGridDto"];
+                };
+            };
+            responses: {
+                /** @description Curriculum grid created successfully */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["CurriculumGrid"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                409: components["responses"]["Conflict"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/institutions/{institutionId}/curriculum-grids": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List curriculum grids by institution
+         * @description Retrieve all curriculum grids for a specific institution
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Filter by serie ID */
+                    serie?: string;
+                    /** @description Filter by active status */
+                    isActive?: boolean;
+                    /** @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 curriculum grids */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["CurriculumGrid"][];
+                            meta?: {
+                                total?: number;
+                                page?: number;
+                                limit?: number;
+                                totalPages?: number;
+                            };
+                        };
+                    };
+                };
+                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;
+    };
+    "/institutions/curriculum-grids/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get curriculum grid by ID
+         * @description Retrieve detailed information about a specific curriculum grid
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Resource ID */
+                    id: components["parameters"]["id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Curriculum grid information */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["CurriculumGrid"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        /**
+         * Delete curriculum grid
+         * @description Remove a curriculum grid from the system
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Resource ID */
+                    id: components["parameters"]["id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Curriculum grid deleted successfully */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        options?: never;
+        head?: never;
+        /**
+         * Update curriculum grid
+         * @description Update curriculum grid information
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Resource ID */
+                    id: components["parameters"]["id"];
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["UpdateCurriculumGridDto"];
+                };
+            };
+            responses: {
+                /** @description Curriculum grid updated successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["CurriculumGrid"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                409: components["responses"]["Conflict"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        trace?: never;
+    };
+    "/institutions/educational-model-periods": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all educational model periods
+         * @description Retrieve a list of all educational model periods, optionally filtered by educationModelId
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Filter by educational model ID (institution ID) */
+                    educationModelId?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description List of educational model periods */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModelPeriod"][];
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        /**
+         * Create a new educational model period
+         * @description Create a new educational model period
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["CreateEducationalModelPeriodDto"];
+                };
+            };
+            responses: {
+                /** @description Educational model period created successfully */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModelPeriod"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/institutions/{institutionId}/educational-model/periods": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get educational model periods by institution
+         * @description Retrieve all periods for a specific institution's educational model
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Institution ID (used as educational model ID) */
+                    institutionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description List of educational model periods */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModelPeriod"][];
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/institutions/educational-model-periods/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get educational model period by ID
+         * @description Retrieve a specific educational model period
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Educational model period ID */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Educational model period information */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModelPeriod"];
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        /**
+         * Delete educational model period
+         * @description Remove an educational model period from the system
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Educational model period ID */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Educational model period deleted successfully */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        options?: never;
+        head?: never;
+        /**
+         * Update educational model period
+         * @description Update educational model period information
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Educational model period ID */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["UpdateEducationalModelPeriodDto"];
+                };
+            };
+            responses: {
+                /** @description Educational model period updated successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModelPeriod"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        trace?: never;
+    };
+    "/institutions/educational-models": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all educational models
+         * @description Retrieve a list of all educational models
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description List of educational models */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModel"][];
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        /**
+         * Create a new educational model
+         * @description Create a new educational model for an institution
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["CreateEducationalModelDto"];
+                };
+            };
+            responses: {
+                /** @description Educational model created successfully */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModel"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                409: components["responses"]["Conflict"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/institutions/{institutionId}/educational-model": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get educational model by institution
+         * @description Retrieve educational model for a specific institution
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Institution ID */
+                    institutionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Educational model information (returns null if no model exists for the institution) */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            /** @example null */
+                            data?: (components["schemas"]["EducationalModel"] | null) | null;
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        /**
+         * Delete educational model
+         * @description Remove an educational model from the system
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Institution ID */
+                    institutionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Educational model deleted successfully */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        options?: never;
+        head?: never;
+        /**
+         * Update educational model
+         * @description Update educational model information
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Institution ID */
+                    institutionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["UpdateEducationalModelDto"];
+                };
+            };
+            responses: {
+                /** @description Educational model updated successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EducationalModel"];
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        trace?: never;
+    };
     "/institutions/seat-code/{seatCodeId}/classrooms": {
         parameters: {
             query?: never;
@@ -8845,6 +9565,207 @@ export interface components {
             /** Format: date-time */
             updatedAt?: string;
         };
+        CurriculumGrid: {
+            /**
+             * Format: uuid
+             * @description Curriculum grid ID
+             */
+            id?: string;
+            /**
+             * Format: uuid
+             * @description Institution ID
+             */
+            institutionId?: string;
+            /**
+             * Format: uuid
+             * @description Serie ID
+             */
+            serie?: string;
+            /**
+             * @description Whether the curriculum grid is active
+             * @default true
+             */
+            isActive: boolean;
+            /** Format: date-time */
+            createdAt?: string;
+            /** Format: date-time */
+            updatedAt?: string;
+        };
+        CreateCurriculumGridDto: {
+            /**
+             * Format: uuid
+             * @description Institution ID
+             */
+            institutionId: string;
+            /**
+             * Format: uuid
+             * @description Serie ID
+             */
+            serie: string;
+            /**
+             * @description Whether the curriculum grid is active
+             * @default true
+             */
+            isActive: boolean;
+        };
+        UpdateCurriculumGridDto: {
+            /**
+             * Format: uuid
+             * @description Institution ID
+             */
+            institutionId?: string;
+            /**
+             * Format: uuid
+             * @description Serie ID
+             */
+            serie?: string;
+            /** @description Whether the curriculum grid is active */
+            isActive?: boolean;
+        };
+        EducationalModel: {
+            /**
+             * Format: uuid
+             * @description Institution ID (primary key)
+             */
+            institutionId?: string;
+            /**
+             * @description Type of academic period (bimestre, semestre, trimestre)
+             * @example bimestre
+             */
+            periodType?: string;
+            /**
+             * @description Pedagogical model type
+             * @example grade_indicada
+             */
+            pedagogicalModel?: string;
+            /**
+             * @description Number of courses required to complete
+             * @example 10
+             */
+            coursesToComplete?: number | null;
+            /**
+             * @description Type of deadline for course completion
+             * @example semester
+             */
+            deadlineType?: string | null;
+            /** Format: date-time */
+            createdAt?: string;
+            /** Format: date-time */
+            updatedAt?: string;
+        };
+        CreateEducationalModelDto: {
+            /**
+             * Format: uuid
+             * @description Institution ID
+             */
+            institutionId: string;
+            /**
+             * @description Type of academic period (bimestre, semestre, trimestre)
+             * @example bimestre
+             */
+            periodType: string;
+            /**
+             * @description Pedagogical model type
+             * @example grade_indicada
+             */
+            pedagogicalModel: string;
+            /**
+             * @description Number of courses required to complete
+             * @example 10
+             */
+            coursesToComplete?: number | null;
+            /**
+             * @description Type of deadline for course completion
+             * @example semester
+             */
+            deadlineType?: string | null;
+        };
+        UpdateEducationalModelDto: {
+            /**
+             * @description Type of academic period (bimestre, semestre, trimestre)
+             * @example bimestre
+             */
+            periodType?: string;
+            /**
+             * @description Pedagogical model type
+             * @example grade_indicada
+             */
+            pedagogicalModel?: string;
+            /**
+             * @description Number of courses required to complete
+             * @example 10
+             */
+            coursesToComplete?: number | null;
+            /**
+             * @description Type of deadline for course completion
+             * @example semester
+             */
+            deadlineType?: string | null;
+        };
+        EducationalModelPeriod: {
+            /**
+             * Format: uuid
+             * @description Educational model period ID
+             */
+            id?: string;
+            /**
+             * Format: uuid
+             * @description Educational model ID (institution ID)
+             */
+            educationModelId?: string;
+            /**
+             * Format: date-time
+             * @description Period start date
+             */
+            start?: string;
+            /**
+             * Format: date-time
+             * @description Period end date
+             */
+            end?: string;
+            /** Format: date-time */
+            createdAt?: string;
+            /** Format: date-time */
+            updatedAt?: string;
+        };
+        CreateEducationalModelPeriodDto: {
+            /**
+             * Format: uuid
+             * @description Educational model ID (institution ID)
+             */
+            educationModelId: string;
+            /**
+             * Format: date-time
+             * @description Period start date
+             * @example 2024-02-03T00:00:00Z
+             */
+            start: string;
+            /**
+             * Format: date-time
+             * @description Period end date
+             * @example 2024-04-11T23:59:59Z
+             */
+            end: string;
+        };
+        UpdateEducationalModelPeriodDto: {
+            /**
+             * Format: uuid
+             * @description Educational model ID (institution ID)
+             */
+            educationModelId?: string;
+            /**
+             * Format: date-time
+             * @description Period start date
+             * @example 2024-02-03T00:00:00Z
+             */
+            start?: string;
+            /**
+             * Format: date-time
+             * @description Period end date
+             * @example 2024-04-11T23:59:59Z
+             */
+            end?: string;
+        };
         Application: {
             /**
              * Format: uuid
@@ -9140,6 +10061,11 @@ export interface components {
         UpdateSeatsDto: {
             /** @description New available quantity for this group */
             availableQuantity: number;
+            /**
+             * Format: uuid
+             * @description Product ID to associate with the seat (optional, to update the product)
+             */
+            productId?: string;
         };
         /**
          * @example {