@instructure/athena-api-client 2.26.0 → 2.28.0

package/README.md

@@ -106,6 +106,8 @@ All URIs are relative to *http://localhost:3000*
 *PlansApi* | [**getPlan**](docs/PlansApi.md#getplan) | **GET** /api/v1/plans/{id} | Get plan by ID
 *PlansApi* | [**listPlans**](docs/PlansApi.md#listplans) | **GET** /api/v1/plans | List all plans
 *PlansApi* | [**updatePlan**](docs/PlansApi.md#updateplan) | **PATCH** /api/v1/plans/{id} | Update a plan
+*PracticeQuizzesApi* | [**createPracticeQuiz**](docs/PracticeQuizzesApi.md#createpracticequizoperation) | **POST** /api/v1/practice-quizzes | Find or create a practice-quiz slot
+*PracticeQuizzesApi* | [**listPracticeQuizzes**](docs/PracticeQuizzesApi.md#listpracticequizzes) | **GET** /api/v1/practice-quizzes | List practice-quiz slots for a course
 *QuizSessionsApi* | [**createQuizSession**](docs/QuizSessionsApi.md#createquizsession) | **POST** /api/v1/quizzes/{quizId}/sessions | Create a quiz session
 *QuizSessionsApi* | [**getQuizSessionSummary**](docs/QuizSessionsApi.md#getquizsessionsummary) | **GET** /api/v1/quiz-sessions/{sessionId}/summary | Get quiz session summary
 *QuizSessionsApi* | [**listQuizSessions**](docs/QuizSessionsApi.md#listquizsessions) | **GET** /api/v1/quiz-sessions | List user quiz sessions
@@ -178,6 +180,7 @@ All URIs are relative to *http://localhost:3000*
 - [CreateMessagesRequestMessagesInner](docs/CreateMessagesRequestMessagesInner.md)
 - [CreateMessagesResponse](docs/CreateMessagesResponse.md)
 - [CreatePlanDto](docs/CreatePlanDto.md)
+- [CreatePracticeQuizRequest](docs/CreatePracticeQuizRequest.md)
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
 - [DailyQuizStatus](docs/DailyQuizStatus.md)
@@ -203,6 +206,9 @@ All URIs are relative to *http://localhost:3000*
 - [PaginatedTaxonomies](docs/PaginatedTaxonomies.md)
 - [PaginatedUserConcepts](docs/PaginatedUserConcepts.md)
 - [Plan](docs/Plan.md)
+- [PracticeQuiz](docs/PracticeQuiz.md)
+- [PracticeQuizStatus](docs/PracticeQuizStatus.md)
+- [PracticeQuizStatusList](docs/PracticeQuizStatusList.md)
 - [Quiz](docs/Quiz.md)
 - [QuizListItem](docs/QuizListItem.md)
 - [QuizQuestion](docs/QuizQuestion.md)

package/dist/apis/PracticeQuizzesApi.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 { CreatePracticeQuizRequest, PracticeQuiz, PracticeQuizStatusList } from '../models/index';
+export interface CreatePracticeQuizOperationRequest {
+    xUserId: string;
+    createPracticeQuizRequest: CreatePracticeQuizRequest;
+}
+export interface ListPracticeQuizzesRequest {
+    globalCourseId: string;
+    canvasObjectIds: Array<string>;
+    xUserId: string;
+    modes?: Array<ListPracticeQuizzesModesEnum>;
+}
+/**
+ *
+ */
+export declare class PracticeQuizzesApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuizRaw(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PracticeQuiz>>;
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuiz(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PracticeQuiz>;
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzesRaw(requestParameters: ListPracticeQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PracticeQuizStatusList>>;
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzes(requestParameters: ListPracticeQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PracticeQuizStatusList>;
+}
+/**
+ * @export
+ */
+export declare const ListPracticeQuizzesModesEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListPracticeQuizzesModesEnum = typeof ListPracticeQuizzesModesEnum[keyof typeof ListPracticeQuizzesModesEnum];

package/dist/apis/PracticeQuizzesApi.js

@@ -0,0 +1,134 @@
+"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.ListPracticeQuizzesModesEnum = exports.PracticeQuizzesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class PracticeQuizzesApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuizRaw(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 createPracticeQuiz().');
+            }
+            if (requestParameters['createPracticeQuizRequest'] == null) {
+                throw new runtime.RequiredError('createPracticeQuizRequest', 'Required parameter "createPracticeQuizRequest" was null or undefined when calling createPracticeQuiz().');
+            }
+            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/practice-quizzes`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreatePracticeQuizRequestToJSON)(requestParameters['createPracticeQuizRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PracticeQuizFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createPracticeQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['globalCourseId'] == null) {
+                throw new runtime.RequiredError('globalCourseId', 'Required parameter "globalCourseId" was null or undefined when calling listPracticeQuizzes().');
+            }
+            if (requestParameters['canvasObjectIds'] == null) {
+                throw new runtime.RequiredError('canvasObjectIds', 'Required parameter "canvasObjectIds" was null or undefined when calling listPracticeQuizzes().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listPracticeQuizzes().');
+            }
+            const queryParameters = {};
+            if (requestParameters['globalCourseId'] != null) {
+                queryParameters['globalCourseId'] = requestParameters['globalCourseId'];
+            }
+            if (requestParameters['canvasObjectIds'] != null) {
+                queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
+            }
+            if (requestParameters['modes'] != null) {
+                queryParameters['modes'] = requestParameters['modes'];
+            }
+            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/practice-quizzes`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PracticeQuizStatusListFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzes(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listPracticeQuizzesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.PracticeQuizzesApi = PracticeQuizzesApi;
+/**
+ * @export
+ */
+exports.ListPracticeQuizzesModesEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};

package/dist/apis/index.d.ts

@@ -14,6 +14,7 @@ export * from './LearningSessionEvaluationsApi';
 export * from './LearningStreakApi';
 export * from './MessagesApi';
 export * from './PlansApi';
+export * from './PracticeQuizzesApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';

package/dist/apis/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./LearningSessionEvaluationsApi"), exports);
 __exportStar(require("./LearningStreakApi"), exports);
 __exportStar(require("./MessagesApi"), exports);
 __exportStar(require("./PlansApi"), exports);
+__exportStar(require("./PracticeQuizzesApi"), exports);
 __exportStar(require("./QuizSessionsApi"), exports);
 __exportStar(require("./QuizzesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);

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

@@ -0,0 +1,56 @@
+/**
+ * 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 { CreatePracticeQuizRequest, PracticeQuiz, PracticeQuizStatusList } from '../models/index';
+export interface CreatePracticeQuizOperationRequest {
+    xUserId: string;
+    createPracticeQuizRequest: CreatePracticeQuizRequest;
+}
+export interface ListPracticeQuizzesRequest {
+    globalCourseId: string;
+    canvasObjectIds: Array<string>;
+    xUserId: string;
+    modes?: Array<ListPracticeQuizzesModesEnum>;
+}
+/**
+ *
+ */
+export declare class PracticeQuizzesApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuizRaw(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PracticeQuiz>>;
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuiz(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PracticeQuiz>;
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzesRaw(requestParameters: ListPracticeQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PracticeQuizStatusList>>;
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzes(requestParameters: ListPracticeQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PracticeQuizStatusList>;
+}
+/**
+ * @export
+ */
+export declare const ListPracticeQuizzesModesEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListPracticeQuizzesModesEnum = typeof ListPracticeQuizzesModesEnum[keyof typeof ListPracticeQuizzesModesEnum];

package/dist/esm/apis/PracticeQuizzesApi.js

@@ -0,0 +1,130 @@
+/* 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 { CreatePracticeQuizRequestToJSON, PracticeQuizFromJSON, PracticeQuizStatusListFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class PracticeQuizzesApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuizRaw(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 createPracticeQuiz().');
+            }
+            if (requestParameters['createPracticeQuizRequest'] == null) {
+                throw new runtime.RequiredError('createPracticeQuizRequest', 'Required parameter "createPracticeQuizRequest" was null or undefined when calling createPracticeQuiz().');
+            }
+            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/practice-quizzes`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreatePracticeQuizRequestToJSON(requestParameters['createPracticeQuizRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PracticeQuizFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
+     * Find or create a practice-quiz slot
+     */
+    createPracticeQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createPracticeQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['globalCourseId'] == null) {
+                throw new runtime.RequiredError('globalCourseId', 'Required parameter "globalCourseId" was null or undefined when calling listPracticeQuizzes().');
+            }
+            if (requestParameters['canvasObjectIds'] == null) {
+                throw new runtime.RequiredError('canvasObjectIds', 'Required parameter "canvasObjectIds" was null or undefined when calling listPracticeQuizzes().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listPracticeQuizzes().');
+            }
+            const queryParameters = {};
+            if (requestParameters['globalCourseId'] != null) {
+                queryParameters['globalCourseId'] = requestParameters['globalCourseId'];
+            }
+            if (requestParameters['canvasObjectIds'] != null) {
+                queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
+            }
+            if (requestParameters['modes'] != null) {
+                queryParameters['modes'] = requestParameters['modes'];
+            }
+            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/practice-quizzes`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PracticeQuizStatusListFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Batch lookup of practice-quiz associations within a single Canvas course. Returns one entry per requested (canvasObjectId, mode) pair, including null entries when no row exists yet.
+     * List practice-quiz slots for a course
+     */
+    listPracticeQuizzes(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listPracticeQuizzesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ListPracticeQuizzesModesEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};

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

@@ -14,6 +14,7 @@ export * from './LearningSessionEvaluationsApi';
 export * from './LearningStreakApi';
 export * from './MessagesApi';
 export * from './PlansApi';
+export * from './PracticeQuizzesApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';

package/dist/esm/apis/index.js

@@ -16,6 +16,7 @@ export * from './LearningSessionEvaluationsApi';
 export * from './LearningStreakApi';
 export * from './MessagesApi';
 export * from './PlansApi';
+export * from './PracticeQuizzesApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';

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

@@ -51,6 +51,12 @@ export interface CreateChatRequest {
      * @memberof CreateChatRequest
      */
     initialStrength?: number;
+    /**
+     * Optional study guide (taxonomy) this chat is scoped to. Persists on `chats.taxonomyId` for any chatType — the existing AI tooling (`getTaxonomy` + `getUserTaxonomyProgress` tool registration, study-guide-scoped system prompt) keys off the row regardless of chatType. The level-up prompt additionally injects the study guide name + description as anchoring context in the prompt body. Caller must be actively enrolled in the supplied taxonomy or the request is rejected with 403, matching the message-stream path's enrollment check.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    taxonomyId?: string;
 }
 /**
  * @export

package/dist/esm/models/CreateChatRequest.js

@@ -38,6 +38,7 @@ export function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'visibility': json['visibility'] == null ? undefined : json['visibility'],
         'primaryConceptId': json['primaryConceptId'] == null ? undefined : json['primaryConceptId'],
         'initialStrength': json['initialStrength'] == null ? undefined : json['initialStrength'],
+        'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
     };
 }
 export function CreateChatRequestToJSON(json) {
@@ -54,5 +55,6 @@ export function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
         'visibility': value['visibility'],
         'primaryConceptId': value['primaryConceptId'],
         'initialStrength': value['initialStrength'],
+        'taxonomyId': value['taxonomyId'],
     };
 }

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

@@ -0,0 +1,58 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CreatePracticeQuizRequest
+ */
+export interface CreatePracticeQuizRequest {
+    /**
+     * Canvas global course id. Together with canvasObjectId + mode it identifies the per-exam slot for this learner.
+     * @type {string}
+     * @memberof CreatePracticeQuizRequest
+     */
+    globalCourseId: string;
+    /**
+     * Canvas object identifier formatted '{type}:{local_id}' — e.g. 'assignment:67890' or 'quiz:99999'. The type prefix is required because Canvas namespaces local ids by type.
+     * @type {string}
+     * @memberof CreatePracticeQuizRequest
+     */
+    canvasObjectId: string;
+    /**
+     * Quiz mode: 'quiz' for a graded practice quiz, 'flashcards' for a flashcard set.
+     * @type {string}
+     * @memberof CreatePracticeQuizRequest
+     */
+    mode: CreatePracticeQuizRequestModeEnum;
+    /**
+     * When true, abandon the existing association (if any) and create a new chat. The old chat remains in the learner's history.
+     * @type {boolean}
+     * @memberof CreatePracticeQuizRequest
+     */
+    forceNew?: boolean;
+}
+/**
+ * @export
+ */
+export declare const CreatePracticeQuizRequestModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type CreatePracticeQuizRequestModeEnum = typeof CreatePracticeQuizRequestModeEnum[keyof typeof CreatePracticeQuizRequestModeEnum];
+/**
+ * Check if a given object implements the CreatePracticeQuizRequest interface.
+ */
+export declare function instanceOfCreatePracticeQuizRequest(value: object): value is CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestFromJSON(json: any): CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestToJSON(json: any): CreatePracticeQuizRequest;
+export declare function CreatePracticeQuizRequestToJSONTyped(value?: CreatePracticeQuizRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreatePracticeQuizRequest.js

@@ -0,0 +1,60 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CreatePracticeQuizRequestModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the CreatePracticeQuizRequest interface.
+ */
+export function instanceOfCreatePracticeQuizRequest(value) {
+    if (!('globalCourseId' in value) || value['globalCourseId'] === undefined)
+        return false;
+    if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    return true;
+}
+export function CreatePracticeQuizRequestFromJSON(json) {
+    return CreatePracticeQuizRequestFromJSONTyped(json, false);
+}
+export function CreatePracticeQuizRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'globalCourseId': json['globalCourseId'],
+        'canvasObjectId': json['canvasObjectId'],
+        'mode': json['mode'],
+        'forceNew': json['forceNew'] == null ? undefined : json['forceNew'],
+    };
+}
+export function CreatePracticeQuizRequestToJSON(json) {
+    return CreatePracticeQuizRequestToJSONTyped(json, false);
+}
+export function CreatePracticeQuizRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'globalCourseId': value['globalCourseId'],
+        'canvasObjectId': value['canvasObjectId'],
+        'mode': value['mode'],
+        'forceNew': value['forceNew'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PracticeQuiz
+ */
+export interface PracticeQuiz {
+    /**
+     * Chat id associated with the practice-quiz slot.
+     * @type {string}
+     * @memberof PracticeQuiz
+     */
+    chatId: string;
+    /**
+     * True when this call created a new chat for the slot. False when an existing chat was returned (find-or-create idempotent path).
+     * @type {boolean}
+     * @memberof PracticeQuiz
+     */
+    isNew: boolean;
+}
+/**
+ * Check if a given object implements the PracticeQuiz interface.
+ */
+export declare function instanceOfPracticeQuiz(value: object): value is PracticeQuiz;
+export declare function PracticeQuizFromJSON(json: any): PracticeQuiz;
+export declare function PracticeQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): PracticeQuiz;
+export declare function PracticeQuizToJSON(json: any): PracticeQuiz;
+export declare function PracticeQuizToJSONTyped(value?: PracticeQuiz | null, ignoreDiscriminator?: boolean): any;