@instructure/athena-api-client 4.0.1 → 4.1.0

package/dist/esm/apis/ConceptImagesApi.js

@@ -27,7 +27,7 @@ import { ConceptMediaFlagResultFromJSON, PaginatedConceptImagesFromJSON, } from
  */
 export class ConceptImagesApi extends runtime.BaseAPI {
     /**
-     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved image stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor). An admin-approved image stays visible but goes back in the admins\' flagged list for re-review (flaggedAfterApprovalAt keeps the first such flag). hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
      * Flag a concept image so learners stop being shown it
      */
     flagConceptImageRaw(requestParameters, initOverrides) {
@@ -58,7 +58,7 @@ export class ConceptImagesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor), and an admin-approved image stays visible. hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
+     * Acts on a learner\'s thumbs-down on a shared concept image. A visible image that no admin has approved is hidden at once, from every learner, until an admin shows it again or shows a revision of it. Any authenticated learner may flag any image id; the calling client is expected to check that the image was shown to this learner. Idempotent: an image that is already hidden or deleted is left as it is (the first hide keeps its time and actor). An admin-approved image stays visible but goes back in the admins\' flagged list for re-review (flaggedAfterApprovalAt keeps the first such flag). hidden says whether learners are kept from it after the call. Applies to later reads only: a signed URL already handed out stays valid until it expires (12 hours).
      * Flag a concept image so learners stop being shown it
      */
     flagConceptImage(requestParameters, initOverrides) {

package/dist/esm/apis/StudyGuidesApi.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateStudyGuideQuizRequest, CreateStudyGuideRequest, PaginatedStudyGuides, RegenerateStudyGuideRequest, StudyGuide, StudyGuideQuiz } from '../models/index';
+export interface CreateStudyGuideOperationRequest {
+    xUserId: string;
+    createStudyGuideRequest: CreateStudyGuideRequest;
+    xCanvasDomain?: string;
+    xCanvasToken?: string;
+}
+export interface CreateStudyGuideQuizOperationRequest {
+    xUserId: string;
+    studyGuideId: string;
+    createStudyGuideQuizRequest: CreateStudyGuideQuizRequest;
+}
+export interface DeleteStudyGuideRequest {
+    xUserId: string;
+    studyGuideId: string;
+}
+export interface GetStudyGuideRequest {
+    xUserId: string;
+    studyGuideId: string;
+}
+export interface ListStudyGuidesRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    studySpaceId?: string;
+    studyObjectiveId?: string;
+    courseId?: string;
+}
+export interface RegenerateStudyGuideOperationRequest {
+    xUserId: string;
+    studyGuideId: string;
+    regenerateStudyGuideRequest: RegenerateStudyGuideRequest;
+    xCanvasDomain?: string;
+    xCanvasToken?: string;
+}
+/**
+ *
+ */
+export declare class StudyGuidesApi extends runtime.BaseAPI {
+    /**
+     * Creates a study guide for one assessment and starts generation in the background; the row comes back in status \'generating\' and the client polls GET /api/v1/study-guides/{studyGuideId}. Generation reads the linked Canvas assessment and course syllabus (with Canvas credentials), the linked study objective\'s notes, attachments and extracted concepts, the learner\'s own context, and any attached user files. It refuses (\'needs-context\') when none of that says what the assessment covers.
+     * Create a study guide and start generating it
+     */
+    createStudyGuideRaw(requestParameters: CreateStudyGuideOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyGuide>>;
+    /**
+     * Creates a study guide for one assessment and starts generation in the background; the row comes back in status \'generating\' and the client polls GET /api/v1/study-guides/{studyGuideId}. Generation reads the linked Canvas assessment and course syllabus (with Canvas credentials), the linked study objective\'s notes, attachments and extracted concepts, the learner\'s own context, and any attached user files. It refuses (\'needs-context\') when none of that says what the assessment covers.
+     * Create a study guide and start generating it
+     */
+    createStudyGuide(requestParameters: CreateStudyGuideOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyGuide>;
+    /**
+     * Generates and persists a quiz (or flashcard deck) from the guide\'s concepts, at least one question per concept, with every question bound to its concept id. Omit conceptIds for the whole guide. Synchronous: the response carries the quiz id to open a session on.
+     * Build a quiz or flashcard deck from a study guide
+     */
+    createStudyGuideQuizRaw(requestParameters: CreateStudyGuideQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyGuideQuiz>>;
+    /**
+     * Generates and persists a quiz (or flashcard deck) from the guide\'s concepts, at least one question per concept, with every question bound to its concept id. Omit conceptIds for the whole guide. Synchronous: the response carries the quiz id to open a session on.
+     * Build a quiz or flashcard deck from a study guide
+     */
+    createStudyGuideQuiz(requestParameters: CreateStudyGuideQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyGuideQuiz>;
+    /**
+     * Removes the guide and its concept list. Attached user files are detached, not deleted; quizzes built from the guide remain.
+     * Delete a study guide
+     */
+    deleteStudyGuideRaw(requestParameters: DeleteStudyGuideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the guide and its concept list. Attached user files are detached, not deleted; quizzes built from the guide remain.
+     * Delete a study guide
+     */
+    deleteStudyGuide(requestParameters: DeleteStudyGuideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the guide, its concepts in display order, its attached files, and its generation status. Poll while status is \'generating\'.
+     * Get a study guide with its concepts
+     */
+    getStudyGuideRaw(requestParameters: GetStudyGuideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyGuide>>;
+    /**
+     * Returns the guide, its concepts in display order, its attached files, and its generation status. Poll while status is \'generating\'.
+     * Get a study guide with its concepts
+     */
+    getStudyGuide(requestParameters: GetStudyGuideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyGuide>;
+    /**
+     * Newest first, with a concept count per guide. Optionally scoped to a study space, study objective, or Canvas course.
+     * List the learner\'s study guides
+     */
+    listStudyGuidesRaw(requestParameters: ListStudyGuidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedStudyGuides>>;
+    /**
+     * Newest first, with a concept count per guide. Optionally scoped to a study space, study objective, or Canvas course.
+     * List the learner\'s study guides
+     */
+    listStudyGuides(requestParameters: ListStudyGuidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedStudyGuides>;
+    /**
+     * Appends the learner\'s additional context and files, then generates again. This is how a \'needs-context\' guide becomes a ready one. A ready guide can also be regenerated to refine it.
+     * Regenerate a study guide with more context
+     */
+    regenerateStudyGuideRaw(requestParameters: RegenerateStudyGuideOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyGuide>>;
+    /**
+     * Appends the learner\'s additional context and files, then generates again. This is how a \'needs-context\' guide becomes a ready one. A ready guide can also be regenerated to refine it.
+     * Regenerate a study guide with more context
+     */
+    regenerateStudyGuide(requestParameters: RegenerateStudyGuideOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyGuide>;
+}

package/dist/esm/apis/StudyGuidesApi.js

@@ -0,0 +1,308 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CreateStudyGuideQuizRequestToJSON, CreateStudyGuideRequestToJSON, PaginatedStudyGuidesFromJSON, RegenerateStudyGuideRequestToJSON, StudyGuideFromJSON, StudyGuideQuizFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class StudyGuidesApi extends runtime.BaseAPI {
+    /**
+     * Creates a study guide for one assessment and starts generation in the background; the row comes back in status \'generating\' and the client polls GET /api/v1/study-guides/{studyGuideId}. Generation reads the linked Canvas assessment and course syllabus (with Canvas credentials), the linked study objective\'s notes, attachments and extracted concepts, the learner\'s own context, and any attached user files. It refuses (\'needs-context\') when none of that says what the assessment covers.
+     * Create a study guide and start generating it
+     */
+    createStudyGuideRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling createStudyGuide().');
+            }
+            if (requestParameters['createStudyGuideRequest'] == null) {
+                throw new runtime.RequiredError('createStudyGuideRequest', 'Required parameter "createStudyGuideRequest" was null or undefined when calling createStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateStudyGuideRequestToJSON(requestParameters['createStudyGuideRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a study guide for one assessment and starts generation in the background; the row comes back in status \'generating\' and the client polls GET /api/v1/study-guides/{studyGuideId}. Generation reads the linked Canvas assessment and course syllabus (with Canvas credentials), the linked study objective\'s notes, attachments and extracted concepts, the learner\'s own context, and any attached user files. It refuses (\'needs-context\') when none of that says what the assessment covers.
+     * Create a study guide and start generating it
+     */
+    createStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createStudyGuideRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Generates and persists a quiz (or flashcard deck) from the guide\'s concepts, at least one question per concept, with every question bound to its concept id. Omit conceptIds for the whole guide. Synchronous: the response carries the quiz id to open a session on.
+     * Build a quiz or flashcard deck from a study guide
+     */
+    createStudyGuideQuizRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling createStudyGuideQuiz().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling createStudyGuideQuiz().');
+            }
+            if (requestParameters['createStudyGuideQuizRequest'] == null) {
+                throw new runtime.RequiredError('createStudyGuideQuizRequest', 'Required parameter "createStudyGuideQuizRequest" was null or undefined when calling createStudyGuideQuiz().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides/{studyGuideId}/quizzes`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateStudyGuideQuizRequestToJSON(requestParameters['createStudyGuideQuizRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideQuizFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Generates and persists a quiz (or flashcard deck) from the guide\'s concepts, at least one question per concept, with every question bound to its concept id. Omit conceptIds for the whole guide. Synchronous: the response carries the quiz id to open a session on.
+     * Build a quiz or flashcard deck from a study guide
+     */
+    createStudyGuideQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createStudyGuideQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Removes the guide and its concept list. Attached user files are detached, not deleted; quizzes built from the guide remain.
+     * Delete a study guide
+     */
+    deleteStudyGuideRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteStudyGuide().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling deleteStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides/{studyGuideId}`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Removes the guide and its concept list. Attached user files are detached, not deleted; quizzes built from the guide remain.
+     * Delete a study guide
+     */
+    deleteStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteStudyGuideRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Returns the guide, its concepts in display order, its attached files, and its generation status. Poll while status is \'generating\'.
+     * Get a study guide with its concepts
+     */
+    getStudyGuideRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getStudyGuide().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling getStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides/{studyGuideId}`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the guide, its concepts in display order, its attached files, and its generation status. Poll while status is \'generating\'.
+     * Get a study guide with its concepts
+     */
+    getStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getStudyGuideRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Newest first, with a concept count per guide. Optionally scoped to a study space, study objective, or Canvas course.
+     * List the learner\'s study guides
+     */
+    listStudyGuidesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listStudyGuides().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['studySpaceId'] != null) {
+                queryParameters['studySpaceId'] = requestParameters['studySpaceId'];
+            }
+            if (requestParameters['studyObjectiveId'] != null) {
+                queryParameters['studyObjectiveId'] = requestParameters['studyObjectiveId'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedStudyGuidesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Newest first, with a concept count per guide. Optionally scoped to a study space, study objective, or Canvas course.
+     * List the learner\'s study guides
+     */
+    listStudyGuides(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudyGuidesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Appends the learner\'s additional context and files, then generates again. This is how a \'needs-context\' guide becomes a ready one. A ready guide can also be regenerated to refine it.
+     * Regenerate a study guide with more context
+     */
+    regenerateStudyGuideRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling regenerateStudyGuide().');
+            }
+            if (requestParameters['studyGuideId'] == null) {
+                throw new runtime.RequiredError('studyGuideId', 'Required parameter "studyGuideId" was null or undefined when calling regenerateStudyGuide().');
+            }
+            if (requestParameters['regenerateStudyGuideRequest'] == null) {
+                throw new runtime.RequiredError('regenerateStudyGuideRequest', 'Required parameter "regenerateStudyGuideRequest" was null or undefined when calling regenerateStudyGuide().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
+            }
+            if (requestParameters['xCanvasToken'] != null) {
+                headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-guides/{studyGuideId}/regenerate`;
+            urlPath = urlPath.replace(`{${"studyGuideId"}}`, encodeURIComponent(String(requestParameters['studyGuideId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: RegenerateStudyGuideRequestToJSON(requestParameters['regenerateStudyGuideRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyGuideFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Appends the learner\'s additional context and files, then generates again. This is how a \'needs-context\' guide becomes a ready one. A ready guide can also be regenerated to refine it.
+     * Regenerate a study guide with more context
+     */
+    regenerateStudyGuide(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.regenerateStudyGuideRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/index.d.ts

@@ -23,6 +23,7 @@ export * from './QuizzesApi';
 export * from './ResourcesApi';
 export * from './ServiceTokensApi';
 export * from './SharedQuizzesApi';
+export * from './StudyGuidesApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';

package/dist/esm/apis/index.js

@@ -25,6 +25,7 @@ export * from './QuizzesApi';
 export * from './ResourcesApi';
 export * from './ServiceTokensApi';
 export * from './SharedQuizzesApi';
+export * from './StudyGuidesApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';

package/dist/esm/models/AdminConceptDiagram.d.ts

@@ -84,7 +84,7 @@ export interface AdminConceptDiagram {
      */
     hiddenByFlag: boolean;
     /**
-     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * When an admin last showed (approved) it. A learner flag never hides an approved row (see flaggedAfterApprovalAt). Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
      * @type {Date}
      * @memberof AdminConceptDiagram
      */
@@ -95,6 +95,12 @@ export interface AdminConceptDiagram {
      * @memberof AdminConceptDiagram
      */
     approvedBy: AdminConceptMediaActor | null;
+    /**
+     * When a learner first flagged it after an admin approved it. The flag leaves an approved row visible, so this is what puts it back in state=flagged for re-review. Null when no flag has come in since the last admin show or hide; cleared by show, hide, restore, and by showing another version with hideOtherVersions.
+     * @type {Date}
+     * @memberof AdminConceptDiagram
+     */
+    flaggedAfterApprovalAt: Date | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptDiagram.js

@@ -58,6 +58,8 @@ export function instanceOfAdminConceptDiagram(value) {
         return false;
     if (!('approvedBy' in value) || value['approvedBy'] === undefined)
         return false;
+    if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -101,6 +103,7 @@ export function AdminConceptDiagramFromJSONTyped(json, ignoreDiscriminator) {
         'hiddenByFlag': json['hiddenByFlag'],
         'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
         'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
+        'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -134,6 +137,7 @@ export function AdminConceptDiagramToJSONTyped(value, ignoreDiscriminator = fals
         'hiddenByFlag': value['hiddenByFlag'],
         'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
         'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
+        'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

package/dist/esm/models/AdminConceptDiagramDetail.d.ts

@@ -86,7 +86,7 @@ export interface AdminConceptDiagramDetail {
      */
     hiddenByFlag: boolean;
     /**
-     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * When an admin last showed (approved) it. A learner flag never hides an approved row (see flaggedAfterApprovalAt). Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
      * @type {Date}
      * @memberof AdminConceptDiagramDetail
      */
@@ -97,6 +97,12 @@ export interface AdminConceptDiagramDetail {
      * @memberof AdminConceptDiagramDetail
      */
     approvedBy: AdminConceptMediaActor | null;
+    /**
+     * When a learner first flagged it after an admin approved it. The flag leaves an approved row visible, so this is what puts it back in state=flagged for re-review. Null when no flag has come in since the last admin show or hide; cleared by show, hide, restore, and by showing another version with hideOtherVersions.
+     * @type {Date}
+     * @memberof AdminConceptDiagramDetail
+     */
+    flaggedAfterApprovalAt: Date | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptDiagramDetail.js

@@ -60,6 +60,8 @@ export function instanceOfAdminConceptDiagramDetail(value) {
         return false;
     if (!('approvedBy' in value) || value['approvedBy'] === undefined)
         return false;
+    if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -115,6 +117,7 @@ export function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator
         'hiddenByFlag': json['hiddenByFlag'],
         'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
         'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
+        'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -154,6 +157,7 @@ export function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator
         'hiddenByFlag': value['hiddenByFlag'],
         'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
         'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
+        'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

package/dist/esm/models/AdminConceptImage.d.ts

@@ -84,7 +84,7 @@ export interface AdminConceptImage {
      */
     hiddenByFlag: boolean;
     /**
-     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * When an admin last showed (approved) it. A learner flag never hides an approved row (see flaggedAfterApprovalAt). Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
      * @type {Date}
      * @memberof AdminConceptImage
      */
@@ -95,6 +95,12 @@ export interface AdminConceptImage {
      * @memberof AdminConceptImage
      */
     approvedBy: AdminConceptMediaActor | null;
+    /**
+     * When a learner first flagged it after an admin approved it. The flag leaves an approved row visible, so this is what puts it back in state=flagged for re-review. Null when no flag has come in since the last admin show or hide; cleared by show, hide, restore, and by showing another version with hideOtherVersions.
+     * @type {Date}
+     * @memberof AdminConceptImage
+     */
+    flaggedAfterApprovalAt: Date | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptImage.js

@@ -58,6 +58,8 @@ export function instanceOfAdminConceptImage(value) {
         return false;
     if (!('approvedBy' in value) || value['approvedBy'] === undefined)
         return false;
+    if (!('flaggedAfterApprovalAt' in value) || value['flaggedAfterApprovalAt'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -107,6 +109,7 @@ export function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
         'hiddenByFlag': json['hiddenByFlag'],
         'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
         'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
+        'flaggedAfterApprovalAt': (json['flaggedAfterApprovalAt'] == null ? null : new Date(json['flaggedAfterApprovalAt'])),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -143,6 +146,7 @@ export function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false)
         'hiddenByFlag': value['hiddenByFlag'],
         'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
         'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
+        'flaggedAfterApprovalAt': value['flaggedAfterApprovalAt'] == null ? value['flaggedAfterApprovalAt'] : value['flaggedAfterApprovalAt'].toISOString(),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

package/dist/esm/models/AdminConceptImageDetail.d.ts

@@ -86,7 +86,7 @@ export interface AdminConceptImageDetail {
      */
     hiddenByFlag: boolean;
     /**
-     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * When an admin last showed (approved) it. A learner flag never hides an approved row (see flaggedAfterApprovalAt). Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
      * @type {Date}
      * @memberof AdminConceptImageDetail
      */
@@ -97,6 +97,12 @@ export interface AdminConceptImageDetail {
      * @memberof AdminConceptImageDetail
      */
     approvedBy: AdminConceptMediaActor | null;
+    /**
+     * When a learner first flagged it after an admin approved it. The flag leaves an approved row visible, so this is what puts it back in state=flagged for re-review. Null when no flag has come in since the last admin show or hide; cleared by show, hide, restore, and by showing another version with hideOtherVersions.
+     * @type {Date}
+     * @memberof AdminConceptImageDetail
+     */
+    flaggedAfterApprovalAt: Date | null;
     /**
      *
      * @type {Date}