@examplary/sdk 2.13.0 → 2.14.0

package/dist/index.d.mts

@@ -505,6 +505,30 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/exams/{id}/sessions/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get results summary
+         * @description Get the stored AI-generated summary of the exam's results, if one has been generated.
+         */
+        get: operations["exams.sessions.getResultsSummary"];
+        put?: never;
+        /**
+         * Generate results summary
+         * @description Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
+         */
+        post: operations["exams.sessions.generateResultsSummary"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exams/{id}/sessions/{sessionId}": {
         parameters: {
             query?: never;
@@ -2375,7 +2399,7 @@ interface operations {
                                 type?: string;
                                 /** @description Title for the question (stem) */
                                 title?: string | null;
-                                /** @description Optional description for the question */
+                                /** @description Optional HTML description for the question */
                                 description?: string | null;
                                 /** @description Settings for the question, often specific to the question type */
                                 settings?: {
@@ -3409,6 +3433,30 @@ interface operations {
         };
         responses: never;
     };
+    "exams.sessions.getResultsSummary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "exams.sessions.generateResultsSummary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "exams.sessions.get": {
         parameters: {
             query?: never;
@@ -3696,7 +3744,7 @@ interface operations {
                     name?: string;
                     /** @description MIME type of the file, e.g. application/pdf */
                     type?: string;
-                    /** @description URL of the file, required if no content is specified. */
+                    /** @description URL of the file, required if no content is specified. Needs to be a HTTPS URL without basic auth or port. */
                     url?: string;
                     /** @description Content of the file as a string, as an alternative to URL. Only supported for exports from other systems (e.g. Moodle XML). */
                     content?: string;
@@ -3926,7 +3974,7 @@ interface operations {
                         type?: string;
                         /** @description Title for the question (stem) */
                         title?: string | null;
-                        /** @description Optional description for the question */
+                        /** @description Optional HTML description for the question */
                         description?: string | null;
                         /** @description Settings for the question, often specific to the question type */
                         settings?: {
@@ -6084,7 +6132,7 @@ interface operations {
                         type: string;
                         /** @description Title for the question (stem) */
                         title?: string | null;
-                        /** @description Optional description for the question */
+                        /** @description Optional HTML description for the question */
                         description?: string | null;
                         /** @description Settings for the question, often specific to the question type */
                         settings: {
@@ -6182,7 +6230,7 @@ interface operations {
                         type: string;
                         /** @description Title for the question (stem) */
                         title?: string | null;
-                        /** @description Optional description for the question */
+                        /** @description Optional HTML description for the question */
                         description?: string | null;
                         /** @description Settings for the question, often specific to the question type */
                         settings: {
@@ -6573,6 +6621,12 @@ interface _PathOverrides {
     "exams.sessions.scanDocument": {
         examId: string;
     };
+    "exams.sessions.getResultsSummary": {
+        examId: string;
+    };
+    "exams.sessions.generateResultsSummary": {
+        examId: string;
+    };
     "exams.sessions.get": {
         examId: string;
         sessionId: string;
@@ -7203,6 +7257,24 @@ declare class ExamsSessions {
      * API endpoint: `POST /exams/{examId}/sessions/scan-document`
      */
     scanDocument(args: Args<"exams.sessions.scanDocument">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scanDocument">>;
+    /**
+     * Get results summary
+     *
+     * Get the stored AI-generated summary of the exam's results, if one has been generated.
+     *
+     * API endpoint: `GET /exams/{examId}/sessions/summary`
+     */
+    getResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
+    getResultsSummary(args: Args<"exams.sessions.getResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
+    /**
+     * Generate results summary
+     *
+     * Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
+     *
+     * API endpoint: `POST /exams/{examId}/sessions/summary`
+     */
+    generateResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
+    generateResultsSummary(args: Args<"exams.sessions.generateResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
     /**
      * Get exam session
      *

package/dist/index.d.ts

@@ -505,6 +505,30 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/exams/{id}/sessions/summary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get results summary
+         * @description Get the stored AI-generated summary of the exam's results, if one has been generated.
+         */
+        get: operations["exams.sessions.getResultsSummary"];
+        put?: never;
+        /**
+         * Generate results summary
+         * @description Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
+         */
+        post: operations["exams.sessions.generateResultsSummary"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exams/{id}/sessions/{sessionId}": {
         parameters: {
             query?: never;
@@ -2375,7 +2399,7 @@ interface operations {
                                 type?: string;
                                 /** @description Title for the question (stem) */
                                 title?: string | null;
-                                /** @description Optional description for the question */
+                                /** @description Optional HTML description for the question */
                                 description?: string | null;
                                 /** @description Settings for the question, often specific to the question type */
                                 settings?: {
@@ -3409,6 +3433,30 @@ interface operations {
         };
         responses: never;
     };
+    "exams.sessions.getResultsSummary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "exams.sessions.generateResultsSummary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "exams.sessions.get": {
         parameters: {
             query?: never;
@@ -3696,7 +3744,7 @@ interface operations {
                     name?: string;
                     /** @description MIME type of the file, e.g. application/pdf */
                     type?: string;
-                    /** @description URL of the file, required if no content is specified. */
+                    /** @description URL of the file, required if no content is specified. Needs to be a HTTPS URL without basic auth or port. */
                     url?: string;
                     /** @description Content of the file as a string, as an alternative to URL. Only supported for exports from other systems (e.g. Moodle XML). */
                     content?: string;
@@ -3926,7 +3974,7 @@ interface operations {
                         type?: string;
                         /** @description Title for the question (stem) */
                         title?: string | null;
-                        /** @description Optional description for the question */
+                        /** @description Optional HTML description for the question */
                         description?: string | null;
                         /** @description Settings for the question, often specific to the question type */
                         settings?: {
@@ -6084,7 +6132,7 @@ interface operations {
                         type: string;
                         /** @description Title for the question (stem) */
                         title?: string | null;
-                        /** @description Optional description for the question */
+                        /** @description Optional HTML description for the question */
                         description?: string | null;
                         /** @description Settings for the question, often specific to the question type */
                         settings: {
@@ -6182,7 +6230,7 @@ interface operations {
                         type: string;
                         /** @description Title for the question (stem) */
                         title?: string | null;
-                        /** @description Optional description for the question */
+                        /** @description Optional HTML description for the question */
                         description?: string | null;
                         /** @description Settings for the question, often specific to the question type */
                         settings: {
@@ -6573,6 +6621,12 @@ interface _PathOverrides {
     "exams.sessions.scanDocument": {
         examId: string;
     };
+    "exams.sessions.getResultsSummary": {
+        examId: string;
+    };
+    "exams.sessions.generateResultsSummary": {
+        examId: string;
+    };
     "exams.sessions.get": {
         examId: string;
         sessionId: string;
@@ -7203,6 +7257,24 @@ declare class ExamsSessions {
      * API endpoint: `POST /exams/{examId}/sessions/scan-document`
      */
     scanDocument(args: Args<"exams.sessions.scanDocument">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scanDocument">>;
+    /**
+     * Get results summary
+     *
+     * Get the stored AI-generated summary of the exam's results, if one has been generated.
+     *
+     * API endpoint: `GET /exams/{examId}/sessions/summary`
+     */
+    getResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
+    getResultsSummary(args: Args<"exams.sessions.getResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.getResultsSummary">>;
+    /**
+     * Generate results summary
+     *
+     * Start a background task to generate an AI summary of the exam's results, highlighting what students are struggling with. Returns the stored summary directly when the results haven't changed since the last generation.
+     *
+     * API endpoint: `POST /exams/{examId}/sessions/summary`
+     */
+    generateResultsSummary(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
+    generateResultsSummary(args: Args<"exams.sessions.generateResultsSummary">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.generateResultsSummary">>;
     /**
      * Get exam session
      *

package/dist/index.js

@@ -342,6 +342,14 @@ var ExamsSessions = class {
     const args = arg;
     return request(this.ctx, "POST", "/exams/{examId}/sessions/scan-document", ["examId"], [], true, args, options);
   }
+  getResultsSummary(arg, options) {
+    const args = typeof arg === "string" ? { examId: arg } : arg;
+    return request(this.ctx, "GET", "/exams/{examId}/sessions/summary", ["examId"], [], false, args, options);
+  }
+  generateResultsSummary(arg, options) {
+    const args = typeof arg === "string" ? { examId: arg } : arg;
+    return request(this.ctx, "POST", "/exams/{examId}/sessions/summary", ["examId"], [], false, args, options);
+  }
   get(arg, options) {
     const args = arg;
     return request(this.ctx, "GET", "/exams/{examId}/sessions/{sessionId}", ["examId", "sessionId"], [], false, args, options);