@instructure/athena-api-client 2.22.6 → 2.22.7

package/README.md

@@ -116,6 +116,9 @@ All URIs are relative to *http://localhost:3000*
 *ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID
 *ServiceTokensApi* | [**listServiceTokens**](docs/ServiceTokensApi.md#listservicetokens) | **GET** /api/v1/tokens | List all service tokens
 *ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status
+*StudyPrepApi* | [**assessCanvasKnowledge**](docs/StudyPrepApi.md#assesscanvasknowledge) | **POST** /api/v1/study-prep/knowledge-assessment | Assess user knowledge from Canvas course grades
+*StudyPrepApi* | [**generateCanvasTaxonomy**](docs/StudyPrepApi.md#generatecanvastaxonomy) | **POST** /api/v1/study-prep/taxonomies | Generate a taxonomy from a Canvas course
+*StudyPrepApi* | [**syncCanvasUserProfile**](docs/StudyPrepApi.md#synccanvasuserprofile) | **POST** /api/v1/study-prep/user-profile | Sync user profile from Canvas
 *TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags
 *TaxonomiesApi* | [**getTaxonomy**](docs/TaxonomiesApi.md#gettaxonomy) | **GET** /api/v1/taxonomies/{id} | Get taxonomy by ID with full tree
 *TaxonomiesApi* | [**getTaxonomyBySlug**](docs/TaxonomiesApi.md#gettaxonomybyslug) | **GET** /api/v1/taxonomies/by-slug/{slug} | Get taxonomy by slug
@@ -149,6 +152,8 @@ All URIs are relative to *http://localhost:3000*
 - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)
 - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
 - [AdminUserEngagement](docs/AdminUserEngagement.md)
+- [CanvasKnowledgeAssessmentEntity](docs/CanvasKnowledgeAssessmentEntity.md)
+- [CanvasTaxonomyEntity](docs/CanvasTaxonomyEntity.md)
 - [Chat](docs/Chat.md)
 - [ChatAnalysis](docs/ChatAnalysis.md)
 - [ChatRequest](docs/ChatRequest.md)
@@ -158,6 +163,7 @@ All URIs are relative to *http://localhost:3000*
 - [ChatRequestQuizContext](docs/ChatRequestQuizContext.md)
 - [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
 - [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)
+- [ConceptAssessmentEntity](docs/ConceptAssessmentEntity.md)
 - [CreateAccountRequest](docs/CreateAccountRequest.md)
 - [CreateChatRequest](docs/CreateChatRequest.md)
 - [CreateFeatureDto](docs/CreateFeatureDto.md)

package/dist/apis/StudyPrepApi.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 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 { CanvasKnowledgeAssessmentEntity, CanvasTaxonomyEntity, UserContext } from '../models/index';
+export interface AssessCanvasKnowledgeRequest {
+    courseId: number;
+    xCanvasDomain: string;
+    xCanvasToken: string;
+    slug?: string;
+}
+export interface GenerateCanvasTaxonomyRequest {
+    courseId: number;
+    xCanvasDomain: string;
+    xCanvasToken: string;
+}
+export interface SyncCanvasUserProfileRequest {
+    xCanvasDomain: string;
+    xCanvasToken: string;
+}
+/**
+ *
+ */
+export declare class StudyPrepApi extends runtime.BaseAPI {
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledgeRaw(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasKnowledgeAssessmentEntity>>;
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledge(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasKnowledgeAssessmentEntity>;
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomyRaw(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasTaxonomyEntity>>;
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomy(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasTaxonomyEntity>;
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfileRaw(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserContext>>;
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfile(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserContext>;
+}

package/dist/apis/StudyPrepApi.js

@@ -0,0 +1,177 @@
+"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.StudyPrepApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class StudyPrepApi extends runtime.BaseAPI {
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledgeRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling assessCanvasKnowledge().');
+            }
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling assessCanvasKnowledge().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling assessCanvasKnowledge().');
+            }
+            const queryParameters = {};
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['slug'] != null) {
+                queryParameters['slug'] = requestParameters['slug'];
+            }
+            const headerParameters = {};
+            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-prep/knowledge-assessment`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CanvasKnowledgeAssessmentEntityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledge(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.assessCanvasKnowledgeRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomyRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling generateCanvasTaxonomy().');
+            }
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling generateCanvasTaxonomy().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling generateCanvasTaxonomy().');
+            }
+            const queryParameters = {};
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            const headerParameters = {};
+            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-prep/taxonomies`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CanvasTaxonomyEntityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomy(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.generateCanvasTaxonomyRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfileRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling syncCanvasUserProfile().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling syncCanvasUserProfile().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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-prep/user-profile`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserContextFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfile(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.syncCanvasUserProfileRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.StudyPrepApi = StudyPrepApi;

package/dist/apis/index.d.ts

@@ -16,6 +16,7 @@ export * from './PlansApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
+export * from './StudyPrepApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';

package/dist/apis/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./PlansApi"), exports);
 __exportStar(require("./QuizSessionsApi"), exports);
 __exportStar(require("./QuizzesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);
+__exportStar(require("./StudyPrepApi"), exports);
 __exportStar(require("./TagsApi"), exports);
 __exportStar(require("./TaxonomiesApi"), exports);
 __exportStar(require("./TaxonomyEnrollmentsApi"), exports);

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

@@ -0,0 +1,63 @@
+/**
+ * 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 { CanvasKnowledgeAssessmentEntity, CanvasTaxonomyEntity, UserContext } from '../models/index';
+export interface AssessCanvasKnowledgeRequest {
+    courseId: number;
+    xCanvasDomain: string;
+    xCanvasToken: string;
+    slug?: string;
+}
+export interface GenerateCanvasTaxonomyRequest {
+    courseId: number;
+    xCanvasDomain: string;
+    xCanvasToken: string;
+}
+export interface SyncCanvasUserProfileRequest {
+    xCanvasDomain: string;
+    xCanvasToken: string;
+}
+/**
+ *
+ */
+export declare class StudyPrepApi extends runtime.BaseAPI {
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledgeRaw(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasKnowledgeAssessmentEntity>>;
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledge(requestParameters: AssessCanvasKnowledgeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasKnowledgeAssessmentEntity>;
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomyRaw(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CanvasTaxonomyEntity>>;
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomy(requestParameters: GenerateCanvasTaxonomyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CanvasTaxonomyEntity>;
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfileRaw(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserContext>>;
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfile(requestParameters: SyncCanvasUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserContext>;
+}

package/dist/esm/apis/StudyPrepApi.js

@@ -0,0 +1,173 @@
+/* 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 { CanvasKnowledgeAssessmentEntityFromJSON, CanvasTaxonomyEntityFromJSON, UserContextFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class StudyPrepApi extends runtime.BaseAPI {
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledgeRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling assessCanvasKnowledge().');
+            }
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling assessCanvasKnowledge().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling assessCanvasKnowledge().');
+            }
+            const queryParameters = {};
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['slug'] != null) {
+                queryParameters['slug'] = requestParameters['slug'];
+            }
+            const headerParameters = {};
+            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-prep/knowledge-assessment`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CanvasKnowledgeAssessmentEntityFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Fetches the user\'s grades for the given Canvas course, uses AI to estimate per-concept competency against the existing course taxonomy, and updates the user\'s knowledge state. The taxonomy must already exist (call generateCanvasTaxonomy first). Pass the slug returned by generateCanvasTaxonomy to skip the Canvas course lookup.
+     * Assess user knowledge from Canvas course grades
+     */
+    assessCanvasKnowledge(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.assessCanvasKnowledgeRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomyRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling generateCanvasTaxonomy().');
+            }
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling generateCanvasTaxonomy().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling generateCanvasTaxonomy().');
+            }
+            const queryParameters = {};
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            const headerParameters = {};
+            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-prep/taxonomies`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CanvasTaxonomyEntityFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Fetches quizzes, assignments, pages, modules, and syllabus from the given Canvas course, uses AI to build a knowledge taxonomy, persists it, and enrolls the user. Idempotent — if a taxonomy for this course already exists the user is enrolled and the existing record is returned.
+     * Generate a taxonomy from a Canvas course
+     */
+    generateCanvasTaxonomy(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.generateCanvasTaxonomyRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfileRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xCanvasDomain'] == null) {
+                throw new runtime.RequiredError('xCanvasDomain', 'Required parameter "xCanvasDomain" was null or undefined when calling syncCanvasUserProfile().');
+            }
+            if (requestParameters['xCanvasToken'] == null) {
+                throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling syncCanvasUserProfile().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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-prep/user-profile`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => UserContextFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Fetches the user\'s display name and active course list from Canvas, uses AI to infer their primary field of study, and stores the results in the user\'s context.
+     * Sync user profile from Canvas
+     */
+    syncCanvasUserProfile(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.syncCanvasUserProfileRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -16,6 +16,7 @@ export * from './PlansApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
+export * from './StudyPrepApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';

package/dist/esm/apis/index.js

@@ -18,6 +18,7 @@ export * from './PlansApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
+export * from './StudyPrepApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';

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

@@ -0,0 +1,45 @@
+/**
+ * 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 type { ConceptAssessmentEntity } from './ConceptAssessmentEntity';
+/**
+ *
+ * @export
+ * @interface CanvasKnowledgeAssessmentEntity
+ */
+export interface CanvasKnowledgeAssessmentEntity {
+    /**
+     * Taxonomy UUID the assessment is scoped to
+     * @type {string}
+     * @memberof CanvasKnowledgeAssessmentEntity
+     */
+    taxonomyId: string;
+    /**
+     * Number of concepts that received an estimate
+     * @type {number}
+     * @memberof CanvasKnowledgeAssessmentEntity
+     */
+    assessed: number;
+    /**
+     *
+     * @type {Array<ConceptAssessmentEntity>}
+     * @memberof CanvasKnowledgeAssessmentEntity
+     */
+    concepts: Array<ConceptAssessmentEntity>;
+}
+/**
+ * Check if a given object implements the CanvasKnowledgeAssessmentEntity interface.
+ */
+export declare function instanceOfCanvasKnowledgeAssessmentEntity(value: object): value is CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityFromJSON(json: any): CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityToJSON(json: any): CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityToJSONTyped(value?: CanvasKnowledgeAssessmentEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CanvasKnowledgeAssessmentEntity.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+import { ConceptAssessmentEntityFromJSON, ConceptAssessmentEntityToJSON, } from './ConceptAssessmentEntity';
+/**
+ * Check if a given object implements the CanvasKnowledgeAssessmentEntity interface.
+ */
+export function instanceOfCanvasKnowledgeAssessmentEntity(value) {
+    if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
+        return false;
+    if (!('assessed' in value) || value['assessed'] === undefined)
+        return false;
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    return true;
+}
+export function CanvasKnowledgeAssessmentEntityFromJSON(json) {
+    return CanvasKnowledgeAssessmentEntityFromJSONTyped(json, false);
+}
+export function CanvasKnowledgeAssessmentEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'taxonomyId': json['taxonomyId'],
+        'assessed': json['assessed'],
+        'concepts': (json['concepts'].map(ConceptAssessmentEntityFromJSON)),
+    };
+}
+export function CanvasKnowledgeAssessmentEntityToJSON(json) {
+    return CanvasKnowledgeAssessmentEntityToJSONTyped(json, false);
+}
+export function CanvasKnowledgeAssessmentEntityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'taxonomyId': value['taxonomyId'],
+        'assessed': value['assessed'],
+        'concepts': (value['concepts'].map(ConceptAssessmentEntityToJSON)),
+    };
+}