@examplary/sdk 2.6.0 → 2.8.0

package/dist/index.d.mts

@@ -466,7 +466,11 @@ interface paths {
         delete: operations["exams.sessions.delete"];
         options?: never;
         head?: never;
-        patch?: 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.
+         */
+        patch: operations["exams.sessions.update"];
         trace?: never;
     };
     "/exams/{id}/sessions/{sessionId}/feedback": {
@@ -814,11 +818,7 @@ interface paths {
          */
         get: operations["exams.get"];
         put?: never;
-        /**
-         * Update exam
-         * @description Update an existing exam.
-         */
-        post: operations["exams.update"];
+        post: operations["postExams:id"];
         /**
          * Delete exam
          * @description Delete the exam.
@@ -826,7 +826,11 @@ interface paths {
         delete: operations["exams.delete"];
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Update exam
+         * @description Update an existing exam.
+         */
+        patch: operations["exams.update"];
         trace?: never;
     };
     "/exams/{id}/duplicate": {
@@ -1744,6 +1748,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/items": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List items
+         * @description Get a list of items (tests and practice spaces) within your workspace. Returns everything by default; filter by `type` or `folder`.
+         */
+        get: operations["items.list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/folders": {
         parameters: {
             query?: never;
@@ -1777,11 +1801,7 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /**
-         * Update folder
-         * @description Update an existing folder in the current workspace.
-         */
-        post: operations["folders.update"];
+        post: operations["postFolders:id"];
         /**
          * Delete folder
          * @description Delete a folder from the current workspace. If there are any exams in the folder, they will be moved out of the folder.
@@ -1789,7 +1809,11 @@ interface paths {
         delete: operations["folders.delete"];
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Update folder
+         * @description Update an existing folder in the current workspace.
+         */
+        patch: operations["folders.update"];
         trace?: never;
     };
     "/groups": {
@@ -1888,6 +1912,54 @@ interface paths {
         patch: operations["groups.updateMember"];
         trace?: never;
     };
+    "/integrations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List integrations
+         * @description List all available integrations and whether they are configured for the current workspace. Settings and field metadata are only included for Admin/Owner.
+         */
+        get: operations["integrations.list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/integrations/{integrationType}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get integration
+         * @description Get a single integration configured for the current workspace.
+         */
+        get: operations["integrations.get"];
+        put?: never;
+        /**
+         * Configure integration
+         * @description Create or update the integration of this type. Settings are validated against the integration before saving.
+         */
+        post: operations["integrations.upsert"];
+        /**
+         * Remove integration
+         * @description Remove the integration of this type from the current workspace.
+         */
+        delete: operations["integrations.delete"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/question-bank": {
         parameters: {
             query?: never;
@@ -2181,6 +2253,91 @@ interface operations {
                         /** @description Optional instructions to guide AI in grading this question type */
                         instructions?: string | string[];
                     };
+                    /** @description Options for response processing */
+                    responseProcessing?: {
+                        /** @description JSONata expression string starting with '=' that evaluates to a boolean to determine if the response is correct */
+                        condition: string;
+                        /** @description Array of test cases to validate the response processing logic for this question type */
+                        testCases?: {
+                            answer: {
+                                value?: (string | (string | null)[]) | null;
+                            } & {
+                                [key: string]: unknown;
+                            };
+                            question: {
+                                /** @description Question ID */
+                                id?: string;
+                                /** @description ID of the question type */
+                                type?: string;
+                                /** @description Title for the question (stem) */
+                                title?: string | null;
+                                /** @description Optional description for the question */
+                                description?: string | null;
+                                /** @description Settings for the question, often specific to the question type */
+                                settings?: {
+                                    [key: string]: unknown;
+                                };
+                                /** @description Scoring configuration for the question */
+                                scoring?: {
+                                    /** @description The type of rubric. Different rubric types have different shapes. */
+                                    rubricType?: ("simple" | "analytical" | "holistic" | "exact-values") | null;
+                                    /** @description The criteria for scoring the question. For 'simple' rubric type, criteria have no levels, and their points stack (total = sum of points for all criteria that apply). For 'analytical' rubric type, there should be at least one criteria, with levels. For each criteria, a matching level is picked. For 'holistic' rubric type, there should be multiple criteria, without levels (score = single selected criteria). For 'exact-values' rubric type, each criteria represents a specific value that must be matched exactly. */
+                                    criteria?: {
+                                        id: string;
+                                        /** @description The title of the scoring criterion or level. Only applies to analytical levels and holistic criteria. */
+                                        title?: string | null;
+                                        /** @description The description of the scoring criterion or level. For analytical levels, this describes the specific requirements to earn the points for that level. For holistic criteria, this describes the overall requirement to earn the points for that criterion. */
+                                        description?: string | null;
+                                        /** @description The default amount of points to assign if this criterion or level is selected. */
+                                        points?: number | null;
+                                        /** @description The minimum amount of points that can be assigned if this criterion or level is selected. */
+                                        minPoints?: number | null;
+                                        /** @description The maximum amount of points that can be assigned if this criterion or level is selected. */
+                                        maxPoints?: number | null;
+                                        /** @description The levels of a analytical rubric criterion. Each level represents a different point value and description for the same criterion. */
+                                        levels?: {
+                                            id: string;
+                                            /** @description The title of the scoring criterion or level. Only applies to analytical levels and holistic criteria. */
+                                            title?: string | null;
+                                            /** @description The description of the scoring criterion or level. For analytical levels, this describes the specific requirements to earn the points for that level. For holistic criteria, this describes the overall requirement to earn the points for that criterion. */
+                                            description?: string | null;
+                                            /** @description The default amount of points to assign if this criterion or level is selected. */
+                                            points?: number | null;
+                                            /** @description The minimum amount of points that can be assigned if this criterion or level is selected. */
+                                            minPoints?: number | null;
+                                            /** @description The maximum amount of points that can be assigned if this criterion or level is selected. */
+                                            maxPoints?: number | null;
+                                        }[] | null;
+                                    }[] | null;
+                                    /** @description Whether exact values matching should be case insensitive. Only applicable for 'exact-values' rubric type. */
+                                    exactValuesCaseInsensitive?: boolean | null;
+                                    /** @description Optional additional grading guidance text. */
+                                    guidance?: string | null;
+                                    /** @description Optional example model answer text to show to graders. */
+                                    modelAnswer?: string | null;
+                                    /** @description The ID of the scoring template applied, if any. */
+                                    templateId?: string | null;
+                                } | null;
+                                /** @description Tags associated with the question for categorization and search */
+                                tags?: string[] | null;
+                                /** @description Optional external ID for the question, used to link to external systems */
+                                externalId?: string | null;
+                                /** @description Metadata for the question */
+                                metadata?: {
+                                    [key: string]: string | number | boolean | null;
+                                } | null;
+                                /** @description Version number, incremented when question is edited */
+                                v?: number | null;
+                                /** @description ID of the question in the question bank */
+                                questionBankItemId?: string | null;
+                                /** @description Trace IDs for internal tracking of AI generation processes */
+                                traceIds?: string[] | null;
+                            } & {
+                                [key: string]: unknown;
+                            };
+                            expectedOutcome: boolean;
+                        }[];
+                    };
                     /** @description Options for AI question scanning */
                     scanning?: {
                         /** @description Optional instructions to guide AI in converting answers for this question type when scanning documents */
@@ -3098,6 +3255,25 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
+    "exams.sessions.update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                sessionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    studentName: string;
+                };
+            };
+        };
+        responses: never;
+    };
     "exams.sessions.saveFeedback": {
         parameters: {
             query?: never;
@@ -3581,7 +3757,7 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
-    "exams.update": {
+    "postExams:id": {
         parameters: {
             query?: never;
             header?: never;
@@ -3605,6 +3781,18 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
+    "exams.update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "exams.duplicate": {
         parameters: {
             query?: never;
@@ -4124,6 +4312,15 @@ interface operations {
                         /** Format: date-time */
                         updatedAt: string;
                         createdBy: string;
+                        /** @description Present when the actor inherits access because the resource lives in a shared folder. */
+                        inheritedFrom?: {
+                            object: string;
+                            /** @constant */
+                            type: "folder";
+                            name?: string;
+                            /** @enum {string} */
+                            role: "owner" | "manager" | "editor" | "viewer" | "participant";
+                        };
                     }[];
                 };
             };
@@ -4194,6 +4391,15 @@ interface operations {
                         /** Format: date-time */
                         updatedAt: string;
                         createdBy: string;
+                        /** @description Present when the actor inherits access because the resource lives in a shared folder. */
+                        inheritedFrom?: {
+                            object: string;
+                            /** @constant */
+                            type: "folder";
+                            name?: string;
+                            /** @enum {string} */
+                            role: "owner" | "manager" | "editor" | "viewer" | "participant";
+                        };
                     };
                 };
             };
@@ -4244,6 +4450,15 @@ interface operations {
                         /** Format: date-time */
                         updatedAt: string;
                         createdBy: string;
+                        /** @description Present when the actor inherits access because the resource lives in a shared folder. */
+                        inheritedFrom?: {
+                            object: string;
+                            /** @constant */
+                            type: "folder";
+                            name?: string;
+                            /** @enum {string} */
+                            role: "owner" | "manager" | "editor" | "viewer" | "participant";
+                        };
                     };
                 };
             };
@@ -4398,10 +4613,12 @@ interface operations {
                         taxonomyId?: string | null;
                         duration?: number | null;
                         intendedDuration?: unknown | null;
-                        enforceOrder?: boolean | null;
                         enforceTimeLimit?: boolean | null;
+                        enforceOrder?: boolean | null;
                         requirePasscode?: boolean | null;
                         passcode?: string | null;
+                        startDateTime?: string | null;
+                        endDateTime?: string | null;
                         showPoints?: boolean | null;
                         showFeedback?: boolean | null;
                         showTableOfContents?: boolean | null;
@@ -4498,10 +4715,12 @@ interface operations {
                         taxonomyId?: string | null;
                         duration?: number | null;
                         intendedDuration?: unknown | null;
-                        enforceOrder?: boolean | null;
                         enforceTimeLimit?: boolean | null;
+                        enforceOrder?: boolean | null;
                         requirePasscode?: boolean | null;
                         passcode?: string | null;
+                        startDateTime?: string | null;
+                        endDateTime?: string | null;
                         showPoints?: boolean | null;
                         showFeedback?: boolean | null;
                         showTableOfContents?: boolean | null;
@@ -5111,6 +5330,21 @@ interface operations {
             };
         };
     };
+    "items.list": {
+        parameters: {
+            query?: {
+                /** @description Optional filter by item type. */
+                type?: "exam" | "practice-space";
+                /** @description Optional filter by folder ID, or `none` for items not in any folder. */
+                folder?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "folders.list": {
         parameters: {
             query?: never;
@@ -5137,7 +5371,7 @@ interface operations {
         };
         responses: never;
     };
-    "folders.update": {
+    "postFolders:id": {
         parameters: {
             query?: never;
             header?: never;
@@ -5167,6 +5401,24 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
+    "folders.update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": {
+                    name: string;
+                };
+            };
+        };
+        responses: never;
+    };
     "groups.list": {
         parameters: {
             query?: never;
@@ -5196,6 +5448,9 @@ interface operations {
             content: {
                 "application/json": {
                     name: string;
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    };
                 };
             };
         };
@@ -5262,7 +5517,10 @@ interface operations {
         requestBody?: {
             content: {
                 "application/json": {
-                    name: string;
+                    name?: string | null;
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    } | null;
                 };
             };
         };
@@ -5448,6 +5706,52 @@ interface operations {
             };
         };
     };
+    "integrations.list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "integrations.get": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                integrationType: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "integrations.upsert": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                integrationType: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
+    "integrations.delete": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                integrationType: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "questionBank.list": {
         parameters: {
             query?: never;
@@ -5953,6 +6257,10 @@ interface _PathOverrides {
         examId: string;
         sessionId: string;
     };
+    "exams.sessions.update": {
+        examId: string;
+        sessionId: string;
+    };
     "exams.sessions.saveFeedback": {
         examId: string;
         sessionId: string;
@@ -6023,6 +6331,9 @@ interface _PathOverrides {
     "exams.update": {
         id: string;
     };
+    "postExams:id": {
+        id: string;
+    };
     "exams.delete": {
         id: string;
     };
@@ -6137,6 +6448,9 @@ interface _PathOverrides {
     "folders.update": {
         id: string;
     };
+    "postFolders:id": {
+        id: string;
+    };
     "folders.delete": {
         id: string;
     };
@@ -6160,6 +6474,15 @@ interface _PathOverrides {
         groupId: string;
         userId: string;
     };
+    "integrations.get": {
+        integrationType: string;
+    };
+    "integrations.upsert": {
+        integrationType: string;
+    };
+    "integrations.delete": {
+        integrationType: string;
+    };
     "questionBank.update": {
         id: string;
     };
@@ -6536,6 +6859,14 @@ declare class ExamsSessions {
      * API endpoint: `DELETE /exams/{examId}/sessions/{sessionId}`
      */
     delete(args: Args<"exams.sessions.delete">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.delete">>;
+    /**
+     * Update session
+     *
+     * Update an exam session. Currently supports renaming the student, which is not allowed for sessions taken by a signed-in student.
+     *
+     * API endpoint: `PATCH /exams/{examId}/sessions/{sessionId}`
+     */
+    update(args: Args<"exams.sessions.update">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.update">>;
     /**
      * Provide feedback
      *
@@ -6687,7 +7018,7 @@ declare class Exams {
      *
      * Update an existing exam.
      *
-     * API endpoint: `POST /exams/{id}`
+     * API endpoint: `PATCH /exams/{id}`
      */
     update(id: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.update">>;
     update(args: Args<"exams.update">, options?: ExamplaryRequestOptions): Promise<Response<"exams.update">>;
@@ -7269,6 +7600,18 @@ declare class SourceMaterials {
      */
     slice(args: Args<"sourceMaterials.slice">, options?: ExamplaryRequestOptions): Promise<Response<"sourceMaterials.slice">>;
 }
+declare class Items {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * List items
+     *
+     * Get a list of items (tests and practice spaces) within your workspace. Returns everything by default; filter by `type` or `folder`.
+     *
+     * API endpoint: `GET /items`
+     */
+    list(args?: Args<"items.list">, options?: ExamplaryRequestOptions): Promise<Response<"items.list">>;
+}
 declare class Folders {
     private readonly ctx;
     constructor(ctx: ClientContext);
@@ -7293,7 +7636,7 @@ declare class Folders {
      *
      * Update an existing folder in the current workspace.
      *
-     * API endpoint: `POST /folders/{id}`
+     * API endpoint: `PATCH /folders/{id}`
      */
     update(args: Args<"folders.update">, options?: ExamplaryRequestOptions): Promise<Response<"folders.update">>;
     /**
@@ -7376,6 +7719,45 @@ declare class Groups {
      */
     removeMember(args: Args<"groups.removeMember">, options?: ExamplaryRequestOptions): Promise<Response<"groups.removeMember">>;
 }
+declare class Integrations {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * List integrations
+     *
+     * List all available integrations and whether they are configured for the current workspace. Settings and field metadata are only included for Admin/Owner.
+     *
+     * API endpoint: `GET /integrations`
+     */
+    list(args?: Args<"integrations.list">, options?: ExamplaryRequestOptions): Promise<Response<"integrations.list">>;
+    /**
+     * Get integration
+     *
+     * Get a single integration configured for the current workspace.
+     *
+     * API endpoint: `GET /integrations/{integrationType}`
+     */
+    get(integrationType: string, options?: ExamplaryRequestOptions): Promise<Response<"integrations.get">>;
+    get(args: Args<"integrations.get">, options?: ExamplaryRequestOptions): Promise<Response<"integrations.get">>;
+    /**
+     * Configure integration
+     *
+     * Create or update the integration of this type. Settings are validated against the integration before saving.
+     *
+     * API endpoint: `POST /integrations/{integrationType}`
+     */
+    upsert(integrationType: string, options?: ExamplaryRequestOptions): Promise<Response<"integrations.upsert">>;
+    upsert(args: Args<"integrations.upsert">, options?: ExamplaryRequestOptions): Promise<Response<"integrations.upsert">>;
+    /**
+     * Remove integration
+     *
+     * Remove the integration of this type from the current workspace.
+     *
+     * API endpoint: `DELETE /integrations/{integrationType}`
+     */
+    delete(integrationType: string, options?: ExamplaryRequestOptions): Promise<Response<"integrations.delete">>;
+    delete(args: Args<"integrations.delete">, options?: ExamplaryRequestOptions): Promise<Response<"integrations.delete">>;
+}
 declare class QuestionBank {
     private readonly ctx;
     constructor(ctx: ClientContext);
@@ -7492,12 +7874,23 @@ declare class Examplary {
     readonly users: Users;
     readonly practiceSpaces: PracticeSpaces;
     readonly sourceMaterials: SourceMaterials;
+    readonly items: Items;
     readonly folders: Folders;
     readonly groups: Groups;
+    readonly integrations: Integrations;
     readonly questionBank: QuestionBank;
     readonly prompts: Prompts;
     readonly jobs: Jobs;
     constructor(options: ExamplaryClientOptions);
+    /**
+     * API endpoint: `POST /exams/{id}`
+     */
+    postExamsId(id: string, options?: ExamplaryRequestOptions): Promise<Response<"postExams:id">>;
+    postExamsId(args: Args<"postExams:id">, options?: ExamplaryRequestOptions): Promise<Response<"postExams:id">>;
+    /**
+     * API endpoint: `POST /folders/{id}`
+     */
+    postFoldersId(args: Args<"postFolders:id">, options?: ExamplaryRequestOptions): Promise<Response<"postFolders:id">>;
     /**
      * Get rubrics
      *