academe-kit 0.15.0 → 0.17.0

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

@@ -9235,7 +9235,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description provider, embedUrl, videoExternalId, startTimeSeconds, durationSeconds, progress */
+                /** @description provider, embedUrl, videoExternalId, startTimeSeconds, durationSeconds, progress e `ambient` (mídia do Ambient Glow — spriteUrlTemplate com placeholder `{n}`, thumbnailUrl e metadados da grade de seek; null quando o provider não é panda) */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -11411,6 +11411,62 @@ export interface paths {
         };
         trace?: never;
     };
+    "/quiz-questions/{id}/generate-explanations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Generate answer explanations with AI
+         * @description Preenche via IA a explicação de cada alternativa de uma pergunta que já existe — o backfill dos quizzes criados antes da feature. Sobrescreve as explicações existentes; o backoffice confirma antes de chamar.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": {
+                        /** @description Modelo OpenRouter a usar. Omitido, usa o padrão do servidor. */
+                        model?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Pergunta com as alternativas atualizadas */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["QuizQuestion"];
+                        };
+                    };
+                };
+                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;
+    };
     "/quiz-questions/bulk": {
         parameters: {
             query?: never;
@@ -11444,6 +11500,8 @@ export interface paths {
                             options?: {
                                 text?: string;
                                 is_correct?: boolean;
+                                /** @description Resumo revelado ao aluno ao confirmar a resposta. */
+                                explanation?: string;
                             }[];
                         }[];
                     };
@@ -11915,6 +11973,8 @@ export interface paths {
                                 options?: {
                                     text?: string;
                                     is_correct?: boolean;
+                                    /** @description Resumo revelado ao aluno ao confirmar a resposta. String vazia quando a IA não produziu. */
+                                    explanation?: string;
                                 }[];
                             }[];
                         };
@@ -13819,6 +13879,407 @@ export interface paths {
         };
         trace?: never;
     };
+    "/studio/state": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Estado do Estúdio (publicado + MEUS rascunhos mesclados) */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Escola do contexto (hero da escola + preview) */
+                    institutionId?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description hero{global,institution,myDrafts} + playlists[{id,draft,items,meta{state,hasMyDraft,stale,othersDrafts}}] + layout{order,hasMyDraft} + myDraftCount */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Não é staff */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/drafts/playlist/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /** Upsert do MEU rascunho de uma playlist (id pode ser de playlist nova — isNew) */
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        op?: "upsert" | "delete";
+                        isNew?: boolean;
+                        playlist?: {
+                            title?: string;
+                            subtitle?: string | null;
+                            /** @enum {string} */
+                            status?: "draft" | "published";
+                            /** @enum {string} */
+                            source?: "curated" | "continue_watching" | "trending" | "watchlist" | "recent" | "continue_playlist";
+                            /** @enum {string} */
+                            variant?: "common" | "featured";
+                            /** @enum {string} */
+                            cardOrientation?: "horizontal" | "vertical" | "square" | "fullImage";
+                            itemsPerViewDesktop?: number;
+                            itemsPerViewMobile?: number;
+                            autoplay?: boolean;
+                            isGlobal?: boolean;
+                        };
+                        targets?: {
+                            institutionId?: string;
+                            organizationId?: string;
+                        }[];
+                        groupIds?: string[];
+                        /** @description ordem do array = position */
+                        items?: {
+                            courseId?: string;
+                            courseModuleId?: string;
+                            courseModuleLessonId?: string;
+                        }[];
+                    };
+                };
+            };
+            responses: {
+                /** @description Rascunho salvo (não altera o publicado) */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/drafts/hero": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /** Upsert do MEU rascunho do hero (institutionId no body; ausente = global) */
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** Format: uuid */
+                        institutionId?: string | null;
+                        /** @enum {string} */
+                        op?: "upsert" | "delete";
+                        hero?: {
+                            eyebrow?: string | null;
+                            title?: string;
+                            subtitle?: string | null;
+                            ctaLabel?: string | null;
+                            ctaUrl?: string | null;
+                            /** @enum {string} */
+                            mediaType?: "gradient" | "image" | "video";
+                            mediaUrl?: string | null;
+                            mediaLoop?: boolean;
+                        };
+                    };
+                };
+            };
+            responses: {
+                /** @description Rascunho salvo */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/drafts/layout": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /** Upsert do MEU rascunho de ordem das rails (lista completa de ids) */
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        order?: string[];
+                    };
+                };
+            };
+            responses: {
+                /** @description Rascunho salvo */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/drafts/{entityType}/{entityId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /** Desfaz UM rascunho meu (playlist/hero por entidade) */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    entityType: "playlist" | "hero" | "layout";
+                    entityId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description { deleted: n } */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/discard": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Descarta TODOS os meus rascunhos */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description { discarded: n } */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/publish": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Publica atomicamente os MEUS rascunhos (playlists+layout+heroes); nunca os de outro editor */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description { applied{...}, warnings[] (staleness/missing) } */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Nenhuma alteração para publicar */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Falha (ex. conteúdo excluído) — nada foi aplicado */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/catalog": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Busca de conteúdo p/ o picker (cursos/módulos/aulas, com flag published) */
+        get: {
+            parameters: {
+                query?: {
+                    q?: string;
+                    kind?: "course" | "module" | "lesson";
+                    limit?: number;
+                    offset?: number;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description { counts{courses,modules,lessons}, results[{kind,id,courseId,title,subtitle,coverUrl,published}] } */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/studio/audiences": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Chips de escopo do drawer (escolas, organizações e perfis) */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description { institutions[], organizations[], groups[] } */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/submissions": {
         parameters: {
             query?: never;
@@ -16459,6 +16920,92 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/users/{id}/courses/{courseId}/lessons": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Drill-down por aula de um curso para um aluno (drawer do backoffice)
+         * @description Lista as aulas publicadas do curso na ordem de módulo/aula, com o progresso consolidado (user_lesson_progress_v2) e o agregado de sessões por aula. watchedRanges são os intervalos do vídeo efetivamente assistidos (merged), para o heatmap de cobertura. Só leitura — nenhuma migration.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description id do aluno */
+                    id: string;
+                    courseId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Aulas do curso com progresso do aluno */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: {
+                                /** Format: uuid */
+                                courseId?: string;
+                                courseTitle?: string;
+                                totalLessons?: number;
+                                completedLessons?: number;
+                                hoursWatched?: number;
+                                avgPlaybackRate?: number | null;
+                                modules?: {
+                                    /** Format: uuid */
+                                    moduleId?: string;
+                                    title?: string;
+                                    position?: number;
+                                    lessons?: {
+                                        /** Format: uuid */
+                                        lessonId?: string;
+                                        title?: string;
+                                        position?: number;
+                                        durationSeconds?: number;
+                                        completed?: boolean;
+                                        /** Format: date-time */
+                                        completedAt?: string | null;
+                                        positionSeconds?: number;
+                                        watchedSeconds?: number;
+                                        watchedPct?: number;
+                                        /** Format: date-time */
+                                        lastActivityAt?: string | null;
+                                        sessions?: number;
+                                        ranges?: number[][];
+                                    }[];
+                                }[];
+                            };
+                        };
+                    };
+                };
+                /** @description Curso não encontrado */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/vitrine/home": {
         parameters: {
             query?: never;
@@ -16705,7 +17252,12 @@ export interface components {
              * Format: email
              * @example john.doe@example.com
              */
-            email: string;
+            email: string | null;
+            /**
+             * @description Login do usuário (gerado quando não informado)
+             * @example johndoe
+             */
+            username?: string;
             /** @example +5511999999999 */
             phone?: string | null;
             /** @example 12345678901 */
@@ -16905,9 +17457,15 @@ export interface components {
             lastName: string;
             /**
              * Format: email
+             * @description Optional. When omitted, the user logs in with the generated username
              * @example john.doe@example.com
              */
-            email: string;
+            email?: string | null;
+            /**
+             * @description Optional. Auto-generated from firstName + lastName when omitted
+             * @example johndoe
+             */
+            username?: string | null;
             /**
              * @description Password for the user's Keycloak account
              * @example SecurePassword123!
@@ -16916,7 +17474,7 @@ export interface components {
             /** @example +5511999999999 */
             phone?: string | null;
             /** @example 12345678901 */
-            document: string;
+            document?: string | null;
             /**
              * @example male
              * @enum {string|null}
@@ -16939,6 +17497,18 @@ export interface components {
              * @example 550e8400-e29b-41d4-a716-446655440001
              */
             institutionId?: string | null;
+            /**
+             * Format: uuid
+             * @description Optional classroom ID to enroll the user (requires groupId)
+             * @example 550e8400-e29b-41d4-a716-446655440003
+             */
+            institutionClassroomId?: string | null;
+            /**
+             * Format: uuid
+             * @description Optional ID that groups this request with other creation requests
+             * @example 550e8400-e29b-41d4-a716-446655440004
+             */
+            userCreationRequestsGroupId?: string | null;
             /**
              * Format: uuid
              * @description Seat code ID to register the user
@@ -17068,7 +17638,12 @@ export interface components {
              * Format: email
              * @example john.doe@example.com
              */
-            email?: string;
+            email?: string | null;
+            /**
+             * @description Login do usuário (gerado quando não informado)
+             * @example johndoe
+             */
+            username?: string;
             /** @example +5511999999999 */
             phone?: string | null;
             /** @example 12345678901 */
@@ -19258,9 +19833,11 @@ export interface components {
             requestId?: string;
             /**
              * Format: email
-             * @description Email of the user being created
+             * @description Email of the user being created (optional)
              */
-            email?: string;
+            email?: string | null;
+            /** @description Login of the created user, generated by the worker when not provided (available after processing) */
+            username?: string | null;
             /**
              * @description Current status of the creation request
              * @enum {string}
@@ -19771,6 +20348,11 @@ export interface components {
             answer?: string;
             /** @example true */
             isCorrect?: boolean;
+            /**
+             * @description Resumo revelado ao aluno ao confirmar a resposta. Na alternativa correta explica o conceito; nas incorretas, o erro que a opção representa. NULL nas perguntas anteriores à feature.
+             * @example O 'S' significa 'Secure' e indica que o protocolo utiliza SSL/TLS.
+             */
+            explanation?: string | null;
             /** Format: date-time */
             createdAt?: string;
             /** Format: date-time */
@@ -19783,10 +20365,14 @@ export interface components {
             answer: string;
             /** @example true */
             isCorrect: boolean;
+            /** @description Resumo revelado ao aluno ao confirmar a resposta. String vazia limpa. */
+            explanation?: string;
         };
         UpdateQuizQuestionAnswerDto: {
             answer?: string;
             isCorrect?: boolean;
+            /** @description Resumo revelado ao aluno ao confirmar a resposta. String vazia limpa. */
+            explanation?: string;
         };
         QuizAttempt: {
             /** Format: uuid */