@instructure/athena-api-client 3.18.3 → 3.18.4

package/README.md

@@ -115,6 +115,7 @@ All URIs are relative to *http://localhost:3000*
 *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* | [**getQuizSessionConceptSummary**](docs/QuizSessionsApi.md#getquizsessionconceptsummary) | **GET** /api/v1/quiz-sessions/{sessionId}/concept-summary | Get quiz session concept mastery summary
 *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
 *QuizSessionsApi* | [**recordQuizQuestionView**](docs/QuizSessionsApi.md#recordquizquestionviewoperation) | **POST** /api/v1/quiz-sessions/{sessionId}/views | Record a question view
@@ -211,6 +212,7 @@ All URIs are relative to *http://localhost:3000*
 - [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
 - [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)
 - [ConceptAssessmentEntity](docs/ConceptAssessmentEntity.md)
+- [ConceptChange](docs/ConceptChange.md)
 - [CreateAccountRequest](docs/CreateAccountRequest.md)
 - [CreateChatRequest](docs/CreateChatRequest.md)
 - [CreateFeatureDto](docs/CreateFeatureDto.md)
@@ -255,6 +257,7 @@ All URIs are relative to *http://localhost:3000*
 - [PracticeQuizStatus](docs/PracticeQuizStatus.md)
 - [PracticeQuizStatusList](docs/PracticeQuizStatusList.md)
 - [Quiz](docs/Quiz.md)
+- [QuizConceptSummary](docs/QuizConceptSummary.md)
 - [QuizListItem](docs/QuizListItem.md)
 - [QuizQuestion](docs/QuizQuestion.md)
 - [QuizQuestionView](docs/QuizQuestionView.md)

package/dist/apis/QuizSessionsApi.d.ts

@@ -10,11 +10,15 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedQuizSessions, QuizQuestionView, QuizResponse, QuizSession, QuizSessionSummary, RecordQuizQuestionViewRequest, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
+import type { PaginatedQuizSessions, QuizConceptSummary, QuizQuestionView, QuizResponse, QuizSession, QuizSessionSummary, RecordQuizQuestionViewRequest, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
 export interface CreateQuizSessionRequest {
     quizId: string;
     xUserId: string;
 }
+export interface GetQuizSessionConceptSummaryRequest {
+    sessionId: string;
+    xUserId: string;
+}
 export interface GetQuizSessionSummaryRequest {
     sessionId: string;
     xUserId: string;
@@ -55,6 +59,16 @@ export declare class QuizSessionsApi extends runtime.BaseAPI {
      * Create a quiz session
      */
     createQuizSession(requestParameters: CreateQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSession>;
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummaryRaw(requestParameters: GetQuizSessionConceptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuizConceptSummary>>;
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummary(requestParameters: GetQuizSessionConceptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizConceptSummary>;
     /**
      * Returns the session summary with quiz details, questions, responses, and score breakdown.
      * Get quiz session summary

package/dist/apis/QuizSessionsApi.js

@@ -70,6 +70,47 @@ class QuizSessionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['sessionId'] == null) {
+                throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getQuizSessionConceptSummary().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getQuizSessionConceptSummary().');
+            }
+            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/quiz-sessions/{sessionId}/concept-summary`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.QuizConceptSummaryFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getQuizSessionConceptSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns the session summary with quiz details, questions, responses, and score breakdown.
      * Get quiz session summary

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

@@ -10,11 +10,15 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedQuizSessions, QuizQuestionView, QuizResponse, QuizSession, QuizSessionSummary, RecordQuizQuestionViewRequest, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
+import type { PaginatedQuizSessions, QuizConceptSummary, QuizQuestionView, QuizResponse, QuizSession, QuizSessionSummary, RecordQuizQuestionViewRequest, SubmitQuizResponseRequest, UpdateQuizSessionRequest } from '../models/index';
 export interface CreateQuizSessionRequest {
     quizId: string;
     xUserId: string;
 }
+export interface GetQuizSessionConceptSummaryRequest {
+    sessionId: string;
+    xUserId: string;
+}
 export interface GetQuizSessionSummaryRequest {
     sessionId: string;
     xUserId: string;
@@ -55,6 +59,16 @@ export declare class QuizSessionsApi extends runtime.BaseAPI {
      * Create a quiz session
      */
     createQuizSession(requestParameters: CreateQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSession>;
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummaryRaw(requestParameters: GetQuizSessionConceptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuizConceptSummary>>;
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummary(requestParameters: GetQuizSessionConceptSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizConceptSummary>;
     /**
      * Returns the session summary with quiz details, questions, responses, and score breakdown.
      * Get quiz session summary

package/dist/esm/apis/QuizSessionsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { PaginatedQuizSessionsFromJSON, QuizQuestionViewFromJSON, QuizResponseFromJSON, QuizSessionFromJSON, QuizSessionSummaryFromJSON, RecordQuizQuestionViewRequestToJSON, SubmitQuizResponseRequestToJSON, UpdateQuizSessionRequestToJSON, } from '../models/index';
+import { PaginatedQuizSessionsFromJSON, QuizConceptSummaryFromJSON, QuizQuestionViewFromJSON, QuizResponseFromJSON, QuizSessionFromJSON, QuizSessionSummaryFromJSON, RecordQuizQuestionViewRequestToJSON, SubmitQuizResponseRequestToJSON, UpdateQuizSessionRequestToJSON, } from '../models/index';
 /**
  *
  */
@@ -67,6 +67,47 @@ export class QuizSessionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['sessionId'] == null) {
+                throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getQuizSessionConceptSummary().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getQuizSessionConceptSummary().');
+            }
+            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/quiz-sessions/{sessionId}/concept-summary`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => QuizConceptSummaryFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns each concept assessed during the session with its mastery strength and tier before and after the session.
+     * Get quiz session concept mastery summary
+     */
+    getQuizSessionConceptSummary(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getQuizSessionConceptSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns the session summary with quiz details, questions, responses, and score breakdown.
      * Get quiz session summary

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

@@ -0,0 +1,111 @@
+/**
+ * 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 ConceptChange
+ */
+export interface ConceptChange {
+    /**
+     * Foreign key to the concept row
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    conceptId: string;
+    /**
+     * Human-readable concept name
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    name: string;
+    /**
+     * Short display label for the concept
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    shortName: string;
+    /**
+     * Mastery strength for this concept before the quiz session, expressed as a fixed-point string in [0, 1]. Reconstructed from the most recent history entry at or before the session start; "0.000" if the concept had never been assessed.
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    beforeStrength: string;
+    /**
+     * Mastery tier bucketed from beforeStrength
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    beforeTier: ConceptChangeBeforeTierEnum;
+    /**
+     * Current mastery strength for this concept, expressed as a fixed-point string in [0, 1].
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    afterStrength: string;
+    /**
+     * Mastery tier bucketed from afterStrength
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    afterTier: ConceptChangeAfterTierEnum;
+    /**
+     * Direction of change from before to after
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    direction: ConceptChangeDirectionEnum;
+    /**
+     * Count of answered questions in this session tagged with this concept
+     * @type {number}
+     * @memberof ConceptChange
+     */
+    questionsReinforced: number;
+}
+/**
+ * @export
+ */
+export declare const ConceptChangeBeforeTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type ConceptChangeBeforeTierEnum = typeof ConceptChangeBeforeTierEnum[keyof typeof ConceptChangeBeforeTierEnum];
+/**
+ * @export
+ */
+export declare const ConceptChangeAfterTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type ConceptChangeAfterTierEnum = typeof ConceptChangeAfterTierEnum[keyof typeof ConceptChangeAfterTierEnum];
+/**
+ * @export
+ */
+export declare const ConceptChangeDirectionEnum: {
+    readonly Up: "up";
+    readonly Down: "down";
+    readonly Same: "same";
+};
+export type ConceptChangeDirectionEnum = typeof ConceptChangeDirectionEnum[keyof typeof ConceptChangeDirectionEnum];
+/**
+ * Check if a given object implements the ConceptChange interface.
+ */
+export declare function instanceOfConceptChange(value: object): value is ConceptChange;
+export declare function ConceptChangeFromJSON(json: any): ConceptChange;
+export declare function ConceptChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptChange;
+export declare function ConceptChangeToJSON(json: any): ConceptChange;
+export declare function ConceptChangeToJSONTyped(value?: ConceptChange | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptChange.js

@@ -0,0 +1,103 @@
+/* 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 ConceptChangeBeforeTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * @export
+ */
+export const ConceptChangeAfterTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * @export
+ */
+export const ConceptChangeDirectionEnum = {
+    Up: 'up',
+    Down: 'down',
+    Same: 'same'
+};
+/**
+ * Check if a given object implements the ConceptChange interface.
+ */
+export function instanceOfConceptChange(value) {
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('shortName' in value) || value['shortName'] === undefined)
+        return false;
+    if (!('beforeStrength' in value) || value['beforeStrength'] === undefined)
+        return false;
+    if (!('beforeTier' in value) || value['beforeTier'] === undefined)
+        return false;
+    if (!('afterStrength' in value) || value['afterStrength'] === undefined)
+        return false;
+    if (!('afterTier' in value) || value['afterTier'] === undefined)
+        return false;
+    if (!('direction' in value) || value['direction'] === undefined)
+        return false;
+    if (!('questionsReinforced' in value) || value['questionsReinforced'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptChangeFromJSON(json) {
+    return ConceptChangeFromJSONTyped(json, false);
+}
+export function ConceptChangeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conceptId': json['conceptId'],
+        'name': json['name'],
+        'shortName': json['shortName'],
+        'beforeStrength': json['beforeStrength'],
+        'beforeTier': json['beforeTier'],
+        'afterStrength': json['afterStrength'],
+        'afterTier': json['afterTier'],
+        'direction': json['direction'],
+        'questionsReinforced': json['questionsReinforced'],
+    };
+}
+export function ConceptChangeToJSON(json) {
+    return ConceptChangeToJSONTyped(json, false);
+}
+export function ConceptChangeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conceptId': value['conceptId'],
+        'name': value['name'],
+        'shortName': value['shortName'],
+        'beforeStrength': value['beforeStrength'],
+        'beforeTier': value['beforeTier'],
+        'afterStrength': value['afterStrength'],
+        'afterTier': value['afterTier'],
+        'direction': value['direction'],
+        'questionsReinforced': value['questionsReinforced'],
+    };
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { ConceptChange } from './ConceptChange';
+/**
+ *
+ * @export
+ * @interface QuizConceptSummary
+ */
+export interface QuizConceptSummary {
+    /**
+     *
+     * @type {Array<ConceptChange>}
+     * @memberof QuizConceptSummary
+     */
+    concepts: Array<ConceptChange>;
+    /**
+     * Study objective this quiz's chat is linked to, or null if the quiz wasn't started from a study objective
+     * @type {string}
+     * @memberof QuizConceptSummary
+     */
+    studyObjectiveId: string | null;
+}
+/**
+ * Check if a given object implements the QuizConceptSummary interface.
+ */
+export declare function instanceOfQuizConceptSummary(value: object): value is QuizConceptSummary;
+export declare function QuizConceptSummaryFromJSON(json: any): QuizConceptSummary;
+export declare function QuizConceptSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizConceptSummary;
+export declare function QuizConceptSummaryToJSON(json: any): QuizConceptSummary;
+export declare function QuizConceptSummaryToJSONTyped(value?: QuizConceptSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizConceptSummary.js

@@ -0,0 +1,48 @@
+/* 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 { ConceptChangeFromJSON, ConceptChangeToJSON, } from './ConceptChange';
+/**
+ * Check if a given object implements the QuizConceptSummary interface.
+ */
+export function instanceOfQuizConceptSummary(value) {
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
+        return false;
+    return true;
+}
+export function QuizConceptSummaryFromJSON(json) {
+    return QuizConceptSummaryFromJSONTyped(json, false);
+}
+export function QuizConceptSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'concepts': (json['concepts'].map(ConceptChangeFromJSON)),
+        'studyObjectiveId': json['studyObjectiveId'],
+    };
+}
+export function QuizConceptSummaryToJSON(json) {
+    return QuizConceptSummaryToJSONTyped(json, false);
+}
+export function QuizConceptSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'concepts': (value['concepts'].map(ConceptChangeToJSON)),
+        'studyObjectiveId': value['studyObjectiveId'],
+    };
+}

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

@@ -40,6 +40,7 @@ export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
 export * from './ConceptAssessmentEntity';
+export * from './ConceptChange';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';
@@ -84,6 +85,7 @@ export * from './PracticeQuiz';
 export * from './PracticeQuizStatus';
 export * from './PracticeQuizStatusList';
 export * from './Quiz';
+export * from './QuizConceptSummary';
 export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizQuestionView';

package/dist/esm/models/index.js

@@ -42,6 +42,7 @@ export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
 export * from './ConceptAssessmentEntity';
+export * from './ConceptChange';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';
@@ -86,6 +87,7 @@ export * from './PracticeQuiz';
 export * from './PracticeQuizStatus';
 export * from './PracticeQuizStatusList';
 export * from './Quiz';
+export * from './QuizConceptSummary';
 export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizQuestionView';

package/dist/models/ConceptChange.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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 ConceptChange
+ */
+export interface ConceptChange {
+    /**
+     * Foreign key to the concept row
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    conceptId: string;
+    /**
+     * Human-readable concept name
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    name: string;
+    /**
+     * Short display label for the concept
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    shortName: string;
+    /**
+     * Mastery strength for this concept before the quiz session, expressed as a fixed-point string in [0, 1]. Reconstructed from the most recent history entry at or before the session start; "0.000" if the concept had never been assessed.
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    beforeStrength: string;
+    /**
+     * Mastery tier bucketed from beforeStrength
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    beforeTier: ConceptChangeBeforeTierEnum;
+    /**
+     * Current mastery strength for this concept, expressed as a fixed-point string in [0, 1].
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    afterStrength: string;
+    /**
+     * Mastery tier bucketed from afterStrength
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    afterTier: ConceptChangeAfterTierEnum;
+    /**
+     * Direction of change from before to after
+     * @type {string}
+     * @memberof ConceptChange
+     */
+    direction: ConceptChangeDirectionEnum;
+    /**
+     * Count of answered questions in this session tagged with this concept
+     * @type {number}
+     * @memberof ConceptChange
+     */
+    questionsReinforced: number;
+}
+/**
+ * @export
+ */
+export declare const ConceptChangeBeforeTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type ConceptChangeBeforeTierEnum = typeof ConceptChangeBeforeTierEnum[keyof typeof ConceptChangeBeforeTierEnum];
+/**
+ * @export
+ */
+export declare const ConceptChangeAfterTierEnum: {
+    readonly Novice: "Novice";
+    readonly Developing: "Developing";
+    readonly Competent: "Competent";
+    readonly Proficient: "Proficient";
+    readonly Expert: "Expert";
+};
+export type ConceptChangeAfterTierEnum = typeof ConceptChangeAfterTierEnum[keyof typeof ConceptChangeAfterTierEnum];
+/**
+ * @export
+ */
+export declare const ConceptChangeDirectionEnum: {
+    readonly Up: "up";
+    readonly Down: "down";
+    readonly Same: "same";
+};
+export type ConceptChangeDirectionEnum = typeof ConceptChangeDirectionEnum[keyof typeof ConceptChangeDirectionEnum];
+/**
+ * Check if a given object implements the ConceptChange interface.
+ */
+export declare function instanceOfConceptChange(value: object): value is ConceptChange;
+export declare function ConceptChangeFromJSON(json: any): ConceptChange;
+export declare function ConceptChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptChange;
+export declare function ConceptChangeToJSON(json: any): ConceptChange;
+export declare function ConceptChangeToJSONTyped(value?: ConceptChange | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ConceptChange.js

@@ -0,0 +1,111 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConceptChangeDirectionEnum = exports.ConceptChangeAfterTierEnum = exports.ConceptChangeBeforeTierEnum = void 0;
+exports.instanceOfConceptChange = instanceOfConceptChange;
+exports.ConceptChangeFromJSON = ConceptChangeFromJSON;
+exports.ConceptChangeFromJSONTyped = ConceptChangeFromJSONTyped;
+exports.ConceptChangeToJSON = ConceptChangeToJSON;
+exports.ConceptChangeToJSONTyped = ConceptChangeToJSONTyped;
+/**
+ * @export
+ */
+exports.ConceptChangeBeforeTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * @export
+ */
+exports.ConceptChangeAfterTierEnum = {
+    Novice: 'Novice',
+    Developing: 'Developing',
+    Competent: 'Competent',
+    Proficient: 'Proficient',
+    Expert: 'Expert'
+};
+/**
+ * @export
+ */
+exports.ConceptChangeDirectionEnum = {
+    Up: 'up',
+    Down: 'down',
+    Same: 'same'
+};
+/**
+ * Check if a given object implements the ConceptChange interface.
+ */
+function instanceOfConceptChange(value) {
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('shortName' in value) || value['shortName'] === undefined)
+        return false;
+    if (!('beforeStrength' in value) || value['beforeStrength'] === undefined)
+        return false;
+    if (!('beforeTier' in value) || value['beforeTier'] === undefined)
+        return false;
+    if (!('afterStrength' in value) || value['afterStrength'] === undefined)
+        return false;
+    if (!('afterTier' in value) || value['afterTier'] === undefined)
+        return false;
+    if (!('direction' in value) || value['direction'] === undefined)
+        return false;
+    if (!('questionsReinforced' in value) || value['questionsReinforced'] === undefined)
+        return false;
+    return true;
+}
+function ConceptChangeFromJSON(json) {
+    return ConceptChangeFromJSONTyped(json, false);
+}
+function ConceptChangeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conceptId': json['conceptId'],
+        'name': json['name'],
+        'shortName': json['shortName'],
+        'beforeStrength': json['beforeStrength'],
+        'beforeTier': json['beforeTier'],
+        'afterStrength': json['afterStrength'],
+        'afterTier': json['afterTier'],
+        'direction': json['direction'],
+        'questionsReinforced': json['questionsReinforced'],
+    };
+}
+function ConceptChangeToJSON(json) {
+    return ConceptChangeToJSONTyped(json, false);
+}
+function ConceptChangeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conceptId': value['conceptId'],
+        'name': value['name'],
+        'shortName': value['shortName'],
+        'beforeStrength': value['beforeStrength'],
+        'beforeTier': value['beforeTier'],
+        'afterStrength': value['afterStrength'],
+        'afterTier': value['afterTier'],
+        'direction': value['direction'],
+        'questionsReinforced': value['questionsReinforced'],
+    };
+}

package/dist/models/QuizConceptSummary.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { ConceptChange } from './ConceptChange';
+/**
+ *
+ * @export
+ * @interface QuizConceptSummary
+ */
+export interface QuizConceptSummary {
+    /**
+     *
+     * @type {Array<ConceptChange>}
+     * @memberof QuizConceptSummary
+     */
+    concepts: Array<ConceptChange>;
+    /**
+     * Study objective this quiz's chat is linked to, or null if the quiz wasn't started from a study objective
+     * @type {string}
+     * @memberof QuizConceptSummary
+     */
+    studyObjectiveId: string | null;
+}
+/**
+ * Check if a given object implements the QuizConceptSummary interface.
+ */
+export declare function instanceOfQuizConceptSummary(value: object): value is QuizConceptSummary;
+export declare function QuizConceptSummaryFromJSON(json: any): QuizConceptSummary;
+export declare function QuizConceptSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizConceptSummary;
+export declare function QuizConceptSummaryToJSON(json: any): QuizConceptSummary;
+export declare function QuizConceptSummaryToJSONTyped(value?: QuizConceptSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizConceptSummary.js

@@ -0,0 +1,55 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfQuizConceptSummary = instanceOfQuizConceptSummary;
+exports.QuizConceptSummaryFromJSON = QuizConceptSummaryFromJSON;
+exports.QuizConceptSummaryFromJSONTyped = QuizConceptSummaryFromJSONTyped;
+exports.QuizConceptSummaryToJSON = QuizConceptSummaryToJSON;
+exports.QuizConceptSummaryToJSONTyped = QuizConceptSummaryToJSONTyped;
+const ConceptChange_1 = require("./ConceptChange");
+/**
+ * Check if a given object implements the QuizConceptSummary interface.
+ */
+function instanceOfQuizConceptSummary(value) {
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
+        return false;
+    return true;
+}
+function QuizConceptSummaryFromJSON(json) {
+    return QuizConceptSummaryFromJSONTyped(json, false);
+}
+function QuizConceptSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'concepts': (json['concepts'].map(ConceptChange_1.ConceptChangeFromJSON)),
+        'studyObjectiveId': json['studyObjectiveId'],
+    };
+}
+function QuizConceptSummaryToJSON(json) {
+    return QuizConceptSummaryToJSONTyped(json, false);
+}
+function QuizConceptSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'concepts': (value['concepts'].map(ConceptChange_1.ConceptChangeToJSON)),
+        'studyObjectiveId': value['studyObjectiveId'],
+    };
+}

package/dist/models/index.d.ts

@@ -40,6 +40,7 @@ export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
 export * from './ConceptAssessmentEntity';
+export * from './ConceptChange';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';
@@ -84,6 +85,7 @@ export * from './PracticeQuiz';
 export * from './PracticeQuizStatus';
 export * from './PracticeQuizStatusList';
 export * from './Quiz';
+export * from './QuizConceptSummary';
 export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizQuestionView';

package/dist/models/index.js

@@ -58,6 +58,7 @@ __exportStar(require("./ChatRequestQuizContext"), exports);
 __exportStar(require("./ChatRequestQuizContextAnswerState"), exports);
 __exportStar(require("./ChatRequestQuizContextCurrentQuestion"), exports);
 __exportStar(require("./ConceptAssessmentEntity"), exports);
+__exportStar(require("./ConceptChange"), exports);
 __exportStar(require("./CreateAccountRequest"), exports);
 __exportStar(require("./CreateChatRequest"), exports);
 __exportStar(require("./CreateFeatureDto"), exports);
@@ -102,6 +103,7 @@ __exportStar(require("./PracticeQuiz"), exports);
 __exportStar(require("./PracticeQuizStatus"), exports);
 __exportStar(require("./PracticeQuizStatusList"), exports);
 __exportStar(require("./Quiz"), exports);
+__exportStar(require("./QuizConceptSummary"), exports);
 __exportStar(require("./QuizListItem"), exports);
 __exportStar(require("./QuizQuestion"), exports);
 __exportStar(require("./QuizQuestionView"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.18.3",
+  "version": "3.18.4",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {