@examplary/sdk 2.9.0 → 2.11.0

package/dist/index.d.mts

@@ -425,6 +425,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/exams/{id}/sessions/release-grades": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Release grades
+         * @description Release grades for all sessions in an exam, optionally sending notifications to students.
+         */
+        post: operations["exams.sessions.releaseGrades"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exams/{id}/sessions/scan-images": {
         parameters: {
             query?: never;
@@ -508,11 +528,31 @@ interface paths {
         head?: never;
         /**
          * Update session
-         * @description Update an exam session. Currently supports renaming the student, which is not allowed for sessions taken by a signed-in student.
+         * @description Update an exam session. Currently supports renaming the student, which is not allowed for sessions connected to a user account.
          */
         patch: operations["exams.sessions.update"];
         trace?: never;
     };
+    "/exams/{id}/sessions/{sessionId}/user": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Assign session to user
+         * @description Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
+         */
+        put: operations["exams.sessions.assignUser"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exams/{id}/sessions/{sessionId}/feedback": {
         parameters: {
             query?: never;
@@ -3278,6 +3318,24 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
+    "exams.sessions.releaseGrades": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    sendNotification?: boolean;
+                };
+            };
+        };
+        responses: never;
+    };
     "exams.sessions.scanImages": {
         parameters: {
             query?: never;
@@ -3381,6 +3439,33 @@ interface operations {
         };
         responses: never;
     };
+    "exams.sessions.assignUser": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                sessionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    user: string;
+                    sendNotification?: boolean;
+                } | {
+                    /**
+                     * Format: email
+                     * @description The email of the student to link. Creates a new student account if no user with this email exists yet.
+                     */
+                    email: string;
+                    sendNotification?: boolean;
+                };
+            };
+        };
+        responses: never;
+    };
     "exams.sessions.saveFeedback": {
         parameters: {
             query?: never;
@@ -3527,6 +3612,8 @@ interface operations {
                     inReplyTo?: string;
                     /** @enum {string} */
                     status?: "open" | "resolved";
+                    /** @enum {string} */
+                    visibility?: "public" | "private";
                     /** @description Question ID the comment is attached to */
                     question: string;
                 };
@@ -3571,6 +3658,8 @@ interface operations {
                     inReplyTo?: string;
                     /** @enum {string} */
                     status?: "open" | "resolved";
+                    /** @enum {string} */
+                    visibility?: "public" | "private";
                 };
             };
         };
@@ -4423,6 +4512,8 @@ interface operations {
                 q: string;
                 /** @description Type of entity to search */
                 type?: "user" | "group";
+                /** @description Filter by user role */
+                role?: "owner" | "admin" | "teacher" | "student" | "member";
             };
             header?: never;
             path?: never;
@@ -4789,6 +4880,12 @@ interface operations {
                         passcode?: string | null;
                         startDateTime?: string | null;
                         endDateTime?: string | null;
+                        reviewPublished?: boolean | null;
+                        reviewNotificationsSent?: boolean | null;
+                        reviewShowGrade?: boolean | null;
+                        reviewShowPoints?: boolean | null;
+                        reviewShowFeedback?: boolean | null;
+                        reviewShowComments?: boolean | null;
                         showPoints?: boolean | null;
                         showFeedback?: boolean | null;
                         showTableOfContents?: boolean | null;
@@ -4891,6 +4988,12 @@ interface operations {
                         passcode?: string | null;
                         startDateTime?: string | null;
                         endDateTime?: string | null;
+                        reviewPublished?: boolean | null;
+                        reviewNotificationsSent?: boolean | null;
+                        reviewShowGrade?: boolean | null;
+                        reviewShowPoints?: boolean | null;
+                        reviewShowFeedback?: boolean | null;
+                        reviewShowComments?: boolean | null;
                         showPoints?: boolean | null;
                         showFeedback?: boolean | null;
                         showTableOfContents?: boolean | null;
@@ -6443,6 +6546,9 @@ interface _PathOverrides {
     "exams.sessions.scan": {
         examId: string;
     };
+    "exams.sessions.releaseGrades": {
+        examId: string;
+    };
     "exams.sessions.scanImages": {
         examId: string;
     };
@@ -6464,6 +6570,10 @@ interface _PathOverrides {
         examId: string;
         sessionId: string;
     };
+    "exams.sessions.assignUser": {
+        examId: string;
+        sessionId: string;
+    };
     "exams.sessions.saveFeedback": {
         examId: string;
         sessionId: string;
@@ -7046,6 +7156,14 @@ declare class ExamsSessions {
      */
     scan(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
     scan(args: Args<"exams.sessions.scan">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
+    /**
+     * Release grades
+     *
+     * Release grades for all sessions in an exam, optionally sending notifications to students.
+     *
+     * API endpoint: `POST /exams/{examId}/sessions/release-grades`
+     */
+    releaseGrades(args: Args<"exams.sessions.releaseGrades">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.releaseGrades">>;
     /**
      * Scan images for student answers
      *
@@ -7089,11 +7207,19 @@ declare class ExamsSessions {
     /**
      * Update session
      *
-     * Update an exam session. Currently supports renaming the student, which is not allowed for sessions taken by a signed-in student.
+     * Update an exam session. Currently supports renaming the student, which is not allowed for sessions connected to a user account.
      *
      * API endpoint: `PATCH /exams/{examId}/sessions/{sessionId}`
      */
     update(args: Args<"exams.sessions.update">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.update">>;
+    /**
+     * Assign session to user
+     *
+     * Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
+     *
+     * API endpoint: `PUT /exams/{examId}/sessions/{sessionId}/user`
+     */
+    assignUser(args: Args<"exams.sessions.assignUser">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.assignUser">>;
     /**
      * Provide feedback
      *

package/dist/index.d.ts

@@ -425,6 +425,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/exams/{id}/sessions/release-grades": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Release grades
+         * @description Release grades for all sessions in an exam, optionally sending notifications to students.
+         */
+        post: operations["exams.sessions.releaseGrades"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exams/{id}/sessions/scan-images": {
         parameters: {
             query?: never;
@@ -508,11 +528,31 @@ interface paths {
         head?: never;
         /**
          * Update session
-         * @description Update an exam session. Currently supports renaming the student, which is not allowed for sessions taken by a signed-in student.
+         * @description Update an exam session. Currently supports renaming the student, which is not allowed for sessions connected to a user account.
          */
         patch: operations["exams.sessions.update"];
         trace?: never;
     };
+    "/exams/{id}/sessions/{sessionId}/user": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Assign session to user
+         * @description Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
+         */
+        put: operations["exams.sessions.assignUser"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/exams/{id}/sessions/{sessionId}/feedback": {
         parameters: {
             query?: never;
@@ -3278,6 +3318,24 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
+    "exams.sessions.releaseGrades": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    sendNotification?: boolean;
+                };
+            };
+        };
+        responses: never;
+    };
     "exams.sessions.scanImages": {
         parameters: {
             query?: never;
@@ -3381,6 +3439,33 @@ interface operations {
         };
         responses: never;
     };
+    "exams.sessions.assignUser": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                sessionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    user: string;
+                    sendNotification?: boolean;
+                } | {
+                    /**
+                     * Format: email
+                     * @description The email of the student to link. Creates a new student account if no user with this email exists yet.
+                     */
+                    email: string;
+                    sendNotification?: boolean;
+                };
+            };
+        };
+        responses: never;
+    };
     "exams.sessions.saveFeedback": {
         parameters: {
             query?: never;
@@ -3527,6 +3612,8 @@ interface operations {
                     inReplyTo?: string;
                     /** @enum {string} */
                     status?: "open" | "resolved";
+                    /** @enum {string} */
+                    visibility?: "public" | "private";
                     /** @description Question ID the comment is attached to */
                     question: string;
                 };
@@ -3571,6 +3658,8 @@ interface operations {
                     inReplyTo?: string;
                     /** @enum {string} */
                     status?: "open" | "resolved";
+                    /** @enum {string} */
+                    visibility?: "public" | "private";
                 };
             };
         };
@@ -4423,6 +4512,8 @@ interface operations {
                 q: string;
                 /** @description Type of entity to search */
                 type?: "user" | "group";
+                /** @description Filter by user role */
+                role?: "owner" | "admin" | "teacher" | "student" | "member";
             };
             header?: never;
             path?: never;
@@ -4789,6 +4880,12 @@ interface operations {
                         passcode?: string | null;
                         startDateTime?: string | null;
                         endDateTime?: string | null;
+                        reviewPublished?: boolean | null;
+                        reviewNotificationsSent?: boolean | null;
+                        reviewShowGrade?: boolean | null;
+                        reviewShowPoints?: boolean | null;
+                        reviewShowFeedback?: boolean | null;
+                        reviewShowComments?: boolean | null;
                         showPoints?: boolean | null;
                         showFeedback?: boolean | null;
                         showTableOfContents?: boolean | null;
@@ -4891,6 +4988,12 @@ interface operations {
                         passcode?: string | null;
                         startDateTime?: string | null;
                         endDateTime?: string | null;
+                        reviewPublished?: boolean | null;
+                        reviewNotificationsSent?: boolean | null;
+                        reviewShowGrade?: boolean | null;
+                        reviewShowPoints?: boolean | null;
+                        reviewShowFeedback?: boolean | null;
+                        reviewShowComments?: boolean | null;
                         showPoints?: boolean | null;
                         showFeedback?: boolean | null;
                         showTableOfContents?: boolean | null;
@@ -6443,6 +6546,9 @@ interface _PathOverrides {
     "exams.sessions.scan": {
         examId: string;
     };
+    "exams.sessions.releaseGrades": {
+        examId: string;
+    };
     "exams.sessions.scanImages": {
         examId: string;
     };
@@ -6464,6 +6570,10 @@ interface _PathOverrides {
         examId: string;
         sessionId: string;
     };
+    "exams.sessions.assignUser": {
+        examId: string;
+        sessionId: string;
+    };
     "exams.sessions.saveFeedback": {
         examId: string;
         sessionId: string;
@@ -7046,6 +7156,14 @@ declare class ExamsSessions {
      */
     scan(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
     scan(args: Args<"exams.sessions.scan">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
+    /**
+     * Release grades
+     *
+     * Release grades for all sessions in an exam, optionally sending notifications to students.
+     *
+     * API endpoint: `POST /exams/{examId}/sessions/release-grades`
+     */
+    releaseGrades(args: Args<"exams.sessions.releaseGrades">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.releaseGrades">>;
     /**
      * Scan images for student answers
      *
@@ -7089,11 +7207,19 @@ declare class ExamsSessions {
     /**
      * Update session
      *
-     * Update an exam session. Currently supports renaming the student, which is not allowed for sessions taken by a signed-in student.
+     * Update an exam session. Currently supports renaming the student, which is not allowed for sessions connected to a user account.
      *
      * API endpoint: `PATCH /exams/{examId}/sessions/{sessionId}`
      */
     update(args: Args<"exams.sessions.update">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.update">>;
+    /**
+     * Assign session to user
+     *
+     * Connect an anonymous exam session to a student account, by user ID or email address (inviting a new student if needed). Optionally notifies the student that their results are available for review. Only allowed when the session is not connected to a user yet.
+     *
+     * API endpoint: `PUT /exams/{examId}/sessions/{sessionId}/user`
+     */
+    assignUser(args: Args<"exams.sessions.assignUser">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.assignUser">>;
     /**
      * Provide feedback
      *

package/dist/index.js

@@ -326,6 +326,10 @@ var ExamsSessions = class {
     const args = typeof arg === "string" ? { examId: arg } : arg;
     return request(this.ctx, "POST", "/exams/{examId}/sessions/scan", ["examId"], [], false, args, options);
   }
+  releaseGrades(arg, options) {
+    const args = arg;
+    return request(this.ctx, "POST", "/exams/{examId}/sessions/release-grades", ["examId"], [], true, args, options);
+  }
   scanImages(arg, options) {
     const args = arg;
     return request(this.ctx, "POST", "/exams/{examId}/sessions/scan-images", ["examId"], [], true, args, options);
@@ -350,6 +354,10 @@ var ExamsSessions = class {
     const args = arg;
     return request(this.ctx, "PATCH", "/exams/{examId}/sessions/{sessionId}", ["examId", "sessionId"], [], true, args, options);
   }
+  assignUser(arg, options) {
+    const args = arg;
+    return request(this.ctx, "PUT", "/exams/{examId}/sessions/{sessionId}/user", ["examId", "sessionId"], [], true, args, options);
+  }
   saveFeedback(arg, options) {
     const args = arg;
     return request(this.ctx, "POST", "/exams/{examId}/sessions/{sessionId}/feedback", ["examId", "sessionId"], [], true, args, options);
@@ -619,7 +627,7 @@ var Permissions = class {
   }
   autocomplete(arg, options) {
     const args = arg;
-    return request(this.ctx, "GET", "/permissions/autocomplete", [], ["q", "type"], false, args, options);
+    return request(this.ctx, "GET", "/permissions/autocomplete", [], ["q", "type", "role"], false, args, options);
   }
   list(arg, options) {
     const args = typeof arg === "string" ? { resource: arg } : arg;