@examplary/sdk 2.13.0 → 2.15.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;
@@ -785,6 +809,26 @@ interface paths {
         patch: operations["exams.questions.update"];
         trace?: never;
     };
+    "/exams/{id}/questions/{questionId}/quality": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get question quality score
+         * @description Retrieve the quality score of a question. This is an async endpoint - when called for the first time, it will trigger a quality assessment and return a status of `pending`. Subsequent calls will return the quality score once available. We recommend polling this endpoint every 5-10 seconds until the score is available.
+         */
+        get: operations["exams.questions.getQuality"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exams/{id}/questions/{questionId}/generate": {
         parameters: {
             query?: never;
@@ -1041,6 +1085,34 @@ interface paths {
         patch: operations["me.update"];
         trace?: never;
     };
+    "/me/two-factor": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get two-factor status
+         * @description Check whether two-factor authentication is enabled for the current user, and whether the workspace requires it.
+         */
+        get: operations["me.twoFactor.get"];
+        put?: never;
+        /**
+         * Enable two-factor authentication
+         * @description Turn on two-factor authentication, after an authenticator app has been registered and verified with Cognito.
+         */
+        post: operations["me.twoFactor.enable"];
+        /**
+         * Disable two-factor authentication
+         * @description Turn off two-factor authentication for the current user. Not allowed when the workspace requires it.
+         */
+        delete: operations["me.twoFactor.disable"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/media/upload": {
         parameters: {
             query?: never;
@@ -1468,6 +1540,26 @@ interface paths {
         patch: operations["users.update"];
         trace?: never;
     };
+    "/users/{id}/two-factor": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Reset two-factor authentication
+         * @description Remove a user's authenticator app, so they can sign in again after losing their device.
+         */
+        delete: operations["users.resetTwoFactor"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/practice-spaces": {
         parameters: {
             query?: never;
@@ -2375,7 +2467,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?: {
@@ -2882,6 +2974,10 @@ interface operations {
                         backgroundColor?: string;
                         /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                         locale?: string;
+                        /** @description Optional overrides for specific UI strings, keyed by string ID */
+                        strings?: {
+                            [key: string]: string;
+                        };
                     };
                     /** @description Additional key-value metadata */
                     metadata?: {
@@ -2910,6 +3006,11 @@ interface operations {
                         language?: string | null;
                         intendedDuration?: unknown | null;
                         allowedGenerationQuestionTypes?: string[] | null;
+                        hideStudentLevel?: boolean | null;
+                        hideSubject?: boolean | null;
+                        hideDuration?: boolean | null;
+                        hideQuestionTypes?: boolean | null;
+                        hideTaxonomy?: boolean | null;
                     };
                 } | {
                     /** @description The user ID for whom the embed session is created */
@@ -2922,6 +3023,10 @@ interface operations {
                         backgroundColor?: string;
                         /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                         locale?: string;
+                        /** @description Optional overrides for specific UI strings, keyed by string ID */
+                        strings?: {
+                            [key: string]: string;
+                        };
                     };
                     /** @description Additional key-value metadata */
                     metadata?: {
@@ -2999,6 +3104,10 @@ interface operations {
                         backgroundColor?: string;
                         /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                         locale?: string;
+                        /** @description Optional overrides for specific UI strings, keyed by string ID */
+                        strings?: {
+                            [key: string]: string;
+                        };
                     };
                     /** @description Additional key-value metadata */
                     metadata?: {
@@ -3039,6 +3148,10 @@ interface operations {
                         backgroundColor?: string;
                         /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                         locale?: string;
+                        /** @description Optional overrides for specific UI strings, keyed by string ID */
+                        strings?: {
+                            [key: string]: string;
+                        };
                     };
                     /** @description Additional key-value metadata */
                     metadata?: {
@@ -3074,6 +3187,10 @@ interface operations {
                         backgroundColor?: string;
                         /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                         locale?: string;
+                        /** @description Optional overrides for specific UI strings, keyed by string ID */
+                        strings?: {
+                            [key: string]: string;
+                        };
                     };
                     /** @description Additional key-value metadata */
                     metadata?: {
@@ -3106,6 +3223,10 @@ interface operations {
                         backgroundColor?: string;
                         /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                         locale?: string;
+                        /** @description Optional overrides for specific UI strings, keyed by string ID */
+                        strings?: {
+                            [key: string]: string;
+                        };
                     };
                     /** @description Additional key-value metadata */
                     metadata?: {
@@ -3138,6 +3259,10 @@ interface operations {
                         backgroundColor?: string;
                         /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                         locale?: string;
+                        /** @description Optional overrides for specific UI strings, keyed by string ID */
+                        strings?: {
+                            [key: string]: string;
+                        };
                     };
                     /** @description Additional key-value metadata */
                     metadata?: {
@@ -3194,6 +3319,10 @@ interface operations {
                             backgroundColor?: string;
                             /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                             locale?: string;
+                            /** @description Optional overrides for specific UI strings, keyed by string ID */
+                            strings?: {
+                                [key: string]: string;
+                            };
                         };
                         metadata: {
                             [key: string]: unknown;
@@ -3245,6 +3374,10 @@ interface operations {
                             backgroundColor?: string;
                             /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
                             locale?: string;
+                            /** @description Optional overrides for specific UI strings, keyed by string ID */
+                            strings?: {
+                                [key: string]: string;
+                            };
                         };
                         metadata: {
                             [key: string]: unknown;
@@ -3409,6 +3542,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 +3853,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;
@@ -3807,6 +3964,46 @@ interface operations {
         };
         responses: never;
     };
+    "exams.questions.getQuality": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Exam ID, e.g. `exam_1234`. */
+                id: string;
+                /** @description Question ID, e.g. `question_1234`, or `first` to get the first question. */
+                questionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Quality score of the specified question. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        status: "pending" | "complete";
+                        checkerVersion?: number;
+                        qualityScore?: number;
+                        timeTakenMs?: number;
+                        totalScorePercentage?: number;
+                        criteria?: {
+                            id: string;
+                            name: string;
+                            description: string;
+                            reasoning?: string;
+                            score?: number;
+                            passed: boolean;
+                        }[];
+                    };
+                };
+            };
+        };
+    };
     "exams.questions.regenerate": {
         parameters: {
             query?: never;
@@ -3926,7 +4123,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?: {
@@ -4165,6 +4362,36 @@ interface operations {
         };
         responses: never;
     };
+    "me.twoFactor.get": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "me.twoFactor.enable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "me.twoFactor.disable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "media.upload": {
         parameters: {
             query?: {
@@ -4237,6 +4464,8 @@ interface operations {
                         sharingBlockPublic?: boolean;
                         /** @description Whether the organization blocks teachers from inviting new users. */
                         sharingBlockTeachersInvitingUsers?: boolean;
+                        /** @description Whether members signing in with a password must use two-factor authentication. */
+                        requireTwoFactor?: boolean;
                     };
                 };
             };
@@ -4854,6 +5083,18 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
+    "users.resetTwoFactor": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "practiceSpaces.list": {
         parameters: {
             query?: {
@@ -6084,7 +6325,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 +6423,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 +6814,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;
@@ -6647,6 +6894,10 @@ interface _PathOverrides {
         examId: string;
         questionId: string;
     };
+    "exams.questions.getQuality": {
+        examId: string;
+        questionId: string;
+    };
     "exams.questions.regenerate": {
         examId: string;
         questionId: string;
@@ -6716,6 +6967,9 @@ interface _PathOverrides {
     "users.delete": {
         id: string;
     };
+    "users.resetTwoFactor": {
+        userId: string;
+    };
     "practiceSpaces.get": {
         id: string;
     };
@@ -7203,6 +7457,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
      *
@@ -7319,6 +7591,14 @@ declare class ExamsQuestions {
      * API endpoint: `PATCH /exams/{examId}/questions/{questionId}`
      */
     update(args: Args<"exams.questions.update">, options?: ExamplaryRequestOptions): Promise<Response<"exams.questions.update">>;
+    /**
+     * Get question quality score
+     *
+     * Retrieve the quality score of a question. This is an async endpoint - when called for the first time, it will trigger a quality assessment and return a status of `pending`. Subsequent calls will return the quality score once available. We recommend polling this endpoint every 5-10 seconds until the score is available.
+     *
+     * API endpoint: `GET /exams/{examId}/questions/{questionId}/quality`
+     */
+    getQuality(args: Args<"exams.questions.getQuality">, options?: ExamplaryRequestOptions): Promise<Response<"exams.questions.getQuality">>;
     /**
      * Regenerate question
      *
@@ -7452,8 +7732,37 @@ declare class Exams {
     getContextSuggestions(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.getContextSuggestions">>;
     getContextSuggestions(args: Args<"exams.getContextSuggestions">, options?: ExamplaryRequestOptions): Promise<Response<"exams.getContextSuggestions">>;
 }
+declare class MeTwoFactor {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * Get two-factor status
+     *
+     * Check whether two-factor authentication is enabled for the current user, and whether the workspace requires it.
+     *
+     * API endpoint: `GET /me/two-factor`
+     */
+    get(args?: Args<"me.twoFactor.get">, options?: ExamplaryRequestOptions): Promise<Response<"me.twoFactor.get">>;
+    /**
+     * Enable two-factor authentication
+     *
+     * Turn on two-factor authentication, after an authenticator app has been registered and verified with Cognito.
+     *
+     * API endpoint: `POST /me/two-factor`
+     */
+    enable(args?: Args<"me.twoFactor.enable">, options?: ExamplaryRequestOptions): Promise<Response<"me.twoFactor.enable">>;
+    /**
+     * Disable two-factor authentication
+     *
+     * Turn off two-factor authentication for the current user. Not allowed when the workspace requires it.
+     *
+     * API endpoint: `DELETE /me/two-factor`
+     */
+    disable(args?: Args<"me.twoFactor.disable">, options?: ExamplaryRequestOptions): Promise<Response<"me.twoFactor.disable">>;
+}
 declare class Me {
     private readonly ctx;
+    readonly twoFactor: MeTwoFactor;
     constructor(ctx: ClientContext);
     /**
      * Get me
@@ -7763,6 +8072,15 @@ declare class Users {
      */
     delete(id: string, options?: ExamplaryRequestOptions): Promise<Response<"users.delete">>;
     delete(args: Args<"users.delete">, options?: ExamplaryRequestOptions): Promise<Response<"users.delete">>;
+    /**
+     * Reset two-factor authentication
+     *
+     * Remove a user's authenticator app, so they can sign in again after losing their device.
+     *
+     * API endpoint: `DELETE /users/{userId}/two-factor`
+     */
+    resetTwoFactor(userId: string, options?: ExamplaryRequestOptions): Promise<Response<"users.resetTwoFactor">>;
+    resetTwoFactor(args: Args<"users.resetTwoFactor">, options?: ExamplaryRequestOptions): Promise<Response<"users.resetTwoFactor">>;
 }
 declare class PracticeSpacesStudents {
     private readonly ctx;