@examplary/sdk 2.7.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;
@@ -3183,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;
@@ -3666,7 +3757,7 @@ interface operations {
         requestBody?: never;
         responses: never;
     };
-    "exams.update": {
+    "postExams:id": {
         parameters: {
             query?: never;
             header?: never;
@@ -3690,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;
@@ -4209,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";
+                        };
                     }[];
                 };
             };
@@ -4279,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";
+                        };
                     };
                 };
             };
@@ -4329,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";
+                        };
                     };
                 };
             };
@@ -4483,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;
@@ -4583,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;
@@ -5196,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;
@@ -5222,7 +5371,7 @@ interface operations {
         };
         responses: never;
     };
-    "folders.update": {
+    "postFolders:id": {
         parameters: {
             query?: never;
             header?: never;
@@ -5252,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;
@@ -5281,6 +5448,9 @@ interface operations {
             content: {
                 "application/json": {
                     name: string;
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    };
                 };
             };
         };
@@ -5347,7 +5517,10 @@ interface operations {
         requestBody?: {
             content: {
                 "application/json": {
-                    name: string;
+                    name?: string | null;
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    } | null;
                 };
             };
         };
@@ -5533,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;
@@ -6038,6 +6257,10 @@ interface _PathOverrides {
         examId: string;
         sessionId: string;
     };
+    "exams.sessions.update": {
+        examId: string;
+        sessionId: string;
+    };
     "exams.sessions.saveFeedback": {
         examId: string;
         sessionId: string;
@@ -6108,6 +6331,9 @@ interface _PathOverrides {
     "exams.update": {
         id: string;
     };
+    "postExams:id": {
+        id: string;
+    };
     "exams.delete": {
         id: string;
     };
@@ -6222,6 +6448,9 @@ interface _PathOverrides {
     "folders.update": {
         id: string;
     };
+    "postFolders:id": {
+        id: string;
+    };
     "folders.delete": {
         id: string;
     };
@@ -6245,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;
     };
@@ -6621,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
      *
@@ -6772,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">>;
@@ -7354,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);
@@ -7378,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">>;
     /**
@@ -7461,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);
@@ -7577,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
      *