@instructure/athena-api-client 4.0.1 → 4.0.2

package/README.md

@@ -163,6 +163,12 @@ All URIs are relative to *http://localhost:3000*
 *ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status
 *SharedQuizzesApi* | [**getSharedQuiz**](docs/SharedQuizzesApi.md#getsharedquiz) | **GET** /api/v1/shared-quizzes/{token} | Resolve a quiz share link
 *SharedQuizzesApi* | [**startSharedQuizSession**](docs/SharedQuizzesApi.md#startsharedquizsession) | **POST** /api/v1/shared-quizzes/{token}/sessions | Start or resume the caller\'s session on a shared quiz
+*StudyGuidesApi* | [**createStudyGuide**](docs/StudyGuidesApi.md#createstudyguideoperation) | **POST** /api/v1/study-guides | Create a study guide and start generating it
+*StudyGuidesApi* | [**createStudyGuideQuiz**](docs/StudyGuidesApi.md#createstudyguidequizoperation) | **POST** /api/v1/study-guides/{studyGuideId}/quizzes | Build a quiz or flashcard deck from a study guide
+*StudyGuidesApi* | [**deleteStudyGuide**](docs/StudyGuidesApi.md#deletestudyguide) | **DELETE** /api/v1/study-guides/{studyGuideId} | Delete a study guide
+*StudyGuidesApi* | [**getStudyGuide**](docs/StudyGuidesApi.md#getstudyguide) | **GET** /api/v1/study-guides/{studyGuideId} | Get a study guide with its concepts
+*StudyGuidesApi* | [**listStudyGuides**](docs/StudyGuidesApi.md#liststudyguides) | **GET** /api/v1/study-guides | List the learner\'s study guides
+*StudyGuidesApi* | [**regenerateStudyGuide**](docs/StudyGuidesApi.md#regeneratestudyguideoperation) | **POST** /api/v1/study-guides/{studyGuideId}/regenerate | Regenerate a study guide with more context
 *StudyObjectiveConceptsApi* | [**listStudyObjectiveConcepts**](docs/StudyObjectiveConceptsApi.md#liststudyobjectiveconcepts) | **GET** /api/v1/study-objective-concepts | List study-objective concept attachments
 *StudyObjectiveConceptsApi* | [**triggerStudyObjectiveConceptExtraction**](docs/StudyObjectiveConceptsApi.md#triggerstudyobjectiveconceptextractionoperation) | **POST** /api/v1/study-objective-concepts/extract | Trigger study-objective concept extraction
 *StudyObjectivesApi* | [**createObjectiveResource**](docs/StudyObjectivesApi.md#createobjectiveresource) | **POST** /api/v1/study-objectives/{studyObjectiveId}/resources | Attach a chat resource to a study objective
@@ -326,6 +332,8 @@ All URIs are relative to *http://localhost:3000*
 - [CreateObjectiveResourceDto](docs/CreateObjectiveResourceDto.md)
 - [CreatePlanDto](docs/CreatePlanDto.md)
 - [CreatePracticeQuizRequest](docs/CreatePracticeQuizRequest.md)
+- [CreateStudyGuideQuizRequest](docs/CreateStudyGuideQuizRequest.md)
+- [CreateStudyGuideRequest](docs/CreateStudyGuideRequest.md)
 - [CreateStudyObjectiveDto](docs/CreateStudyObjectiveDto.md)
 - [CreateStudyObjectiveDtoCanvasDocumentsInner](docs/CreateStudyObjectiveDtoCanvasDocumentsInner.md)
 - [CreateStudyObjectiveDtoCanvasObject](docs/CreateStudyObjectiveDtoCanvasObject.md)
@@ -361,6 +369,7 @@ All URIs are relative to *http://localhost:3000*
 - [PaginatedQuizSessions](docs/PaginatedQuizSessions.md)
 - [PaginatedQuizzes](docs/PaginatedQuizzes.md)
 - [PaginatedResources](docs/PaginatedResources.md)
+- [PaginatedStudyGuides](docs/PaginatedStudyGuides.md)
 - [PaginatedStudyObjectives](docs/PaginatedStudyObjectives.md)
 - [PaginatedTaxonomies](docs/PaginatedTaxonomies.md)
 - [PaginatedUserConcepts](docs/PaginatedUserConcepts.md)
@@ -382,6 +391,7 @@ All URIs are relative to *http://localhost:3000*
 - [QuizSharing](docs/QuizSharing.md)
 - [QuizWithQuestions](docs/QuizWithQuestions.md)
 - [RecordQuizQuestionViewRequest](docs/RecordQuizQuestionViewRequest.md)
+- [RegenerateStudyGuideRequest](docs/RegenerateStudyGuideRequest.md)
 - [ResourceActivity](docs/ResourceActivity.md)
 - [ResourceChat](docs/ResourceChat.md)
 - [ResourceListItem](docs/ResourceListItem.md)
@@ -394,6 +404,12 @@ All URIs are relative to *http://localhost:3000*
 - [ScoreByTypeValue](docs/ScoreByTypeValue.md)
 - [ServiceToken](docs/ServiceToken.md)
 - [SharedQuiz](docs/SharedQuiz.md)
+- [StudyGuide](docs/StudyGuide.md)
+- [StudyGuideConcept](docs/StudyGuideConcept.md)
+- [StudyGuideFile](docs/StudyGuideFile.md)
+- [StudyGuideListItem](docs/StudyGuideListItem.md)
+- [StudyGuideQuiz](docs/StudyGuideQuiz.md)
+- [StudyGuideSourceSummary](docs/StudyGuideSourceSummary.md)
 - [StudyObjective](docs/StudyObjective.md)
 - [StudyObjectiveAccess](docs/StudyObjectiveAccess.md)
 - [StudyObjectiveCanvasDocument](docs/StudyObjectiveCanvasDocument.md)

package/dist/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/apis/StudyGuidesApi.js

@@ -0,0 +1,312 @@
+"use strict";
+/* 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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StudyGuidesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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: (0, index_1.CreateStudyGuideRequestToJSON)(requestParameters['createStudyGuideRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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: (0, index_1.CreateStudyGuideQuizRequestToJSON)(requestParameters['createStudyGuideQuizRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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) => (0, index_1.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) => (0, index_1.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: (0, index_1.RegenerateStudyGuideRequestToJSON)(requestParameters['regenerateStudyGuideRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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();
+        });
+    }
+}
+exports.StudyGuidesApi = StudyGuidesApi;

package/dist/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/apis/index.js

@@ -41,6 +41,7 @@ __exportStar(require("./QuizzesApi"), exports);
 __exportStar(require("./ResourcesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);
 __exportStar(require("./SharedQuizzesApi"), exports);
+__exportStar(require("./StudyGuidesApi"), exports);
 __exportStar(require("./StudyObjectiveConceptsApi"), exports);
 __exportStar(require("./StudyObjectivesApi"), exports);
 __exportStar(require("./StudyPlansApi"), exports);

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>;
+}