academe-kit 0.9.9 → 0.10.0

package/dist/index.d.ts

@@ -10734,7 +10734,12 @@ interface paths {
          */
         get: {
             parameters: {
-                query?: never;
+                query?: {
+                    /** @description UUID do educational_model_period. Quando omitido, o backend resolve para o período corrente (NOW). Ignorado quando allPeriods=true. */
+                    periodId?: string;
+                    /** @description Quando 'true', desliga o recorte por período em Jornada/Classes/TopTeachers — passa a refletir o ano letivo inteiro. SubmissionsCard continua sempre no bimestre corrente. */
+                    allPeriods?: "true";
+                };
                 header?: never;
                 path: {
                     /** @description ID da instituição */
@@ -14757,9 +14762,6 @@ interface components {
             createdAt: string;
             /** Format: date-time */
             updatedAt: string;
-            organization?: components["schemas"]["Organization"] | null;
-            address?: components["schemas"]["Address"] | null;
-            institutionReward?: Record<string, never> | null;
         };
         Organization: {
             /** Format: uuid */
@@ -20199,14 +20201,29 @@ declare function createReportService(apiClient: AcademeApiClient): {
     /**
      * Get encourage dashboard for an institution
      * Retorna o payload agregado da tela /new-dashboard:
-     * overview, KPIs, licenças (alunos), jornada (cursos), submissões,
-     * desempenho por turma, top alunos e top professores.
+     * overview (com lista de períodos do ano letivo + flag isAllPeriods),
+     * KPIs, licenças (alunos), jornada (cursos do bimestre selecionado ou do
+     * ano letivo quando allPeriods), submissões do bimestre corrente,
+     * desempenho por turma, top alunos e top professores do bimestre.
      *
-     * @param id UUID da instituição.
+     * @param id                UUID da instituição.
+     * @param params.periodId   UUID do educational_model_period. Quando omitido,
+     *                          o backend resolve para o período corrente (NOW).
+     *                          Ignorado quando allPeriods=true.
+     * @param params.allPeriods Quando true, desliga o recorte por período em
+     *                          Jornada/Classes/TopTeachers — passa a refletir
+     *                          o ano letivo inteiro. SubmissionsCard continua
+     *                          sempre no bimestre corrente.
      */
-    getEncourageDashboardByInstitution(id: string): Promise<openapi_fetch.FetchResponse<{
+    getEncourageDashboardByInstitution(id: string, params?: {
+        periodId?: string;
+        allPeriods?: boolean;
+    }): Promise<openapi_fetch.FetchResponse<{
         parameters: {
-            query?: never;
+            query?: {
+                periodId?: string;
+                allPeriods?: "true";
+            };
             header?: never;
             path: {
                 id: string;
@@ -20250,6 +20267,10 @@ declare function createReportService(apiClient: AcademeApiClient): {
             path: {
                 id: string;
             };
+            query: {
+                periodId?: string;
+                allPeriods?: "true";
+            } | undefined;
         };
     }, `${string}/${string}`>>;
 };

package/dist/index.esm.js

@@ -4942,15 +4942,30 @@ function createReportService(apiClient) {
         /**
          * Get encourage dashboard for an institution
          * Retorna o payload agregado da tela /new-dashboard:
-         * overview, KPIs, licenças (alunos), jornada (cursos), submissões,
-         * desempenho por turma, top alunos e top professores.
+         * overview (com lista de períodos do ano letivo + flag isAllPeriods),
+         * KPIs, licenças (alunos), jornada (cursos do bimestre selecionado ou do
+         * ano letivo quando allPeriods), submissões do bimestre corrente,
+         * desempenho por turma, top alunos e top professores do bimestre.
          *
-         * @param id UUID da instituição.
-         */
-        getEncourageDashboardByInstitution(id) {
+         * @param id                UUID da instituição.
+         * @param params.periodId   UUID do educational_model_period. Quando omitido,
+         *                          o backend resolve para o período corrente (NOW).
+         *                          Ignorado quando allPeriods=true.
+         * @param params.allPeriods Quando true, desliga o recorte por período em
+         *                          Jornada/Classes/TopTeachers — passa a refletir
+         *                          o ano letivo inteiro. SubmissionsCard continua
+         *                          sempre no bimestre corrente.
+         */
+        getEncourageDashboardByInstitution(id, params) {
+            const query = {};
+            if (params?.allPeriods)
+                query.allPeriods = 'true';
+            else if (params?.periodId)
+                query.periodId = params.periodId;
             return apiClient.GET('/reports/encourage-dashboard/{id}', {
                 params: {
                     path: { id },
+                    query: Object.keys(query).length > 0 ? query : undefined,
                 },
             });
         },