@instructure/athena-api-client 1.0.16 → 1.0.18

package/README.md

@@ -124,6 +124,9 @@ All URIs are relative to *http://localhost:3000*
 - [ChatAnalysis](docs/ChatAnalysis.md)
 - [ChatRequest](docs/ChatRequest.md)
 - [ChatRequestAttachmentsInner](docs/ChatRequestAttachmentsInner.md)
+- [ChatRequestQuizContext](docs/ChatRequestQuizContext.md)
+- [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
+- [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)
 - [CreateAccountRequest](docs/CreateAccountRequest.md)
 - [CreateChatRequest](docs/CreateChatRequest.md)
 - [CreateFeatureDto](docs/CreateFeatureDto.md)

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
+import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
  *
  * @export
@@ -28,12 +29,24 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     chatId: string;
+    /**
+     * Optional chat type. Only applied when a new chat is created (ignored if chatId already exists). Use 'onboarding' to route to onboarding analysis.
+     * @type {string}
+     * @memberof ChatRequest
+     */
+    chatType?: string;
     /**
      * File attachments to include with the message (max 10)
      * @type {Array<ChatRequestAttachmentsInner>}
      * @memberof ChatRequest
      */
     attachments?: Array<ChatRequestAttachmentsInner>;
+    /**
+     *
+     * @type {ChatRequestQuizContext}
+     * @memberof ChatRequest
+     */
+    quizContext?: ChatRequestQuizContext;
 }
 /**
  * Check if a given object implements the ChatRequest interface.

package/dist/esm/models/ChatRequest.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { ChatRequestAttachmentsInnerFromJSON, ChatRequestAttachmentsInnerToJSON, } from './ChatRequestAttachmentsInner';
+import { ChatRequestQuizContextFromJSON, ChatRequestQuizContextToJSON, } from './ChatRequestQuizContext';
 /**
  * Check if a given object implements the ChatRequest interface.
  */
@@ -32,7 +33,9 @@ export function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'message': json['message'],
         'chatId': json['chatId'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
         'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInnerFromJSON)),
+        'quizContext': json['quizContext'] == null ? undefined : ChatRequestQuizContextFromJSON(json['quizContext']),
     };
 }
 export function ChatRequestToJSON(json) {
@@ -45,6 +48,8 @@ export function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'message': value['message'],
         'chatId': value['chatId'],
+        'chatType': value['chatType'],
         'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInnerToJSON)),
+        'quizContext': ChatRequestQuizContextToJSON(value['quizContext']),
     };
 }

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

@@ -0,0 +1,92 @@
+/**
+ * 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 { ChatRequestQuizContextAnswerState } from './ChatRequestQuizContextAnswerState';
+import type { ChatRequestQuizContextCurrentQuestion } from './ChatRequestQuizContextCurrentQuestion';
+/**
+ * Optional quiz/flashcard context when the learner is chatting during an active session
+ * @export
+ * @interface ChatRequestQuizContext
+ */
+export interface ChatRequestQuizContext {
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    sessionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    quizTitle: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    mode: ChatRequestQuizContextModeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ChatRequestQuizContext
+     */
+    totalQuestions: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ChatRequestQuizContext
+     */
+    currentQuestionIndex: number;
+    /**
+     *
+     * @type {ChatRequestQuizContextCurrentQuestion}
+     * @memberof ChatRequestQuizContext
+     */
+    currentQuestion: ChatRequestQuizContextCurrentQuestion;
+    /**
+     *
+     * @type {ChatRequestQuizContextAnswerState}
+     * @memberof ChatRequestQuizContext
+     */
+    answerState?: ChatRequestQuizContextAnswerState;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    sessionStatus: ChatRequestQuizContextSessionStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const ChatRequestQuizContextModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ChatRequestQuizContextModeEnum = typeof ChatRequestQuizContextModeEnum[keyof typeof ChatRequestQuizContextModeEnum];
+/**
+ * @export
+ */
+export declare const ChatRequestQuizContextSessionStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+};
+export type ChatRequestQuizContextSessionStatusEnum = typeof ChatRequestQuizContextSessionStatusEnum[keyof typeof ChatRequestQuizContextSessionStatusEnum];
+/**
+ * Check if a given object implements the ChatRequestQuizContext interface.
+ */
+export declare function instanceOfChatRequestQuizContext(value: object): value is ChatRequestQuizContext;
+export declare function ChatRequestQuizContextFromJSON(json: any): ChatRequestQuizContext;
+export declare function ChatRequestQuizContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizContext;
+export declare function ChatRequestQuizContextToJSON(json: any): ChatRequestQuizContext;
+export declare function ChatRequestQuizContextToJSONTyped(value?: ChatRequestQuizContext | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatRequestQuizContext.js

@@ -0,0 +1,85 @@
+/* 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 { ChatRequestQuizContextAnswerStateFromJSON, ChatRequestQuizContextAnswerStateToJSON, } from './ChatRequestQuizContextAnswerState';
+import { ChatRequestQuizContextCurrentQuestionFromJSON, ChatRequestQuizContextCurrentQuestionToJSON, } from './ChatRequestQuizContextCurrentQuestion';
+/**
+ * @export
+ */
+export const ChatRequestQuizContextModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+export const ChatRequestQuizContextSessionStatusEnum = {
+    Active: 'active',
+    Completed: 'completed'
+};
+/**
+ * Check if a given object implements the ChatRequestQuizContext interface.
+ */
+export function instanceOfChatRequestQuizContext(value) {
+    if (!('sessionId' in value) || value['sessionId'] === undefined)
+        return false;
+    if (!('quizTitle' in value) || value['quizTitle'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    if (!('currentQuestionIndex' in value) || value['currentQuestionIndex'] === undefined)
+        return false;
+    if (!('currentQuestion' in value) || value['currentQuestion'] === undefined)
+        return false;
+    if (!('sessionStatus' in value) || value['sessionStatus'] === undefined)
+        return false;
+    return true;
+}
+export function ChatRequestQuizContextFromJSON(json) {
+    return ChatRequestQuizContextFromJSONTyped(json, false);
+}
+export function ChatRequestQuizContextFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'sessionId': json['sessionId'],
+        'quizTitle': json['quizTitle'],
+        'mode': json['mode'],
+        'totalQuestions': json['totalQuestions'],
+        'currentQuestionIndex': json['currentQuestionIndex'],
+        'currentQuestion': ChatRequestQuizContextCurrentQuestionFromJSON(json['currentQuestion']),
+        'answerState': json['answerState'] == null ? undefined : ChatRequestQuizContextAnswerStateFromJSON(json['answerState']),
+        'sessionStatus': json['sessionStatus'],
+    };
+}
+export function ChatRequestQuizContextToJSON(json) {
+    return ChatRequestQuizContextToJSONTyped(json, false);
+}
+export function ChatRequestQuizContextToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'sessionId': value['sessionId'],
+        'quizTitle': value['quizTitle'],
+        'mode': value['mode'],
+        'totalQuestions': value['totalQuestions'],
+        'currentQuestionIndex': value['currentQuestionIndex'],
+        'currentQuestion': ChatRequestQuizContextCurrentQuestionToJSON(value['currentQuestion']),
+        'answerState': ChatRequestQuizContextAnswerStateToJSON(value['answerState']),
+        'sessionStatus': value['sessionStatus'],
+    };
+}

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

@@ -0,0 +1,62 @@
+/**
+ * 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 ChatRequestQuizContextAnswerState
+ */
+export interface ChatRequestQuizContextAnswerState {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    answered: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    userAnswer?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    isCorrect?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    grade?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    feedback?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    rating?: string | null;
+}
+/**
+ * Check if a given object implements the ChatRequestQuizContextAnswerState interface.
+ */
+export declare function instanceOfChatRequestQuizContextAnswerState(value: object): value is ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateFromJSON(json: any): ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateToJSON(json: any): ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateToJSONTyped(value?: ChatRequestQuizContextAnswerState | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatRequestQuizContextAnswerState.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ChatRequestQuizContextAnswerState interface.
+ */
+export function instanceOfChatRequestQuizContextAnswerState(value) {
+    if (!('answered' in value) || value['answered'] === undefined)
+        return false;
+    return true;
+}
+export function ChatRequestQuizContextAnswerStateFromJSON(json) {
+    return ChatRequestQuizContextAnswerStateFromJSONTyped(json, false);
+}
+export function ChatRequestQuizContextAnswerStateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'answered': json['answered'],
+        'userAnswer': json['userAnswer'] == null ? undefined : json['userAnswer'],
+        'isCorrect': json['isCorrect'] == null ? undefined : json['isCorrect'],
+        'grade': json['grade'] == null ? undefined : json['grade'],
+        'feedback': json['feedback'] == null ? undefined : json['feedback'],
+        'rating': json['rating'] == null ? undefined : json['rating'],
+    };
+}
+export function ChatRequestQuizContextAnswerStateToJSON(json) {
+    return ChatRequestQuizContextAnswerStateToJSONTyped(json, false);
+}
+export function ChatRequestQuizContextAnswerStateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'answered': value['answered'],
+        'userAnswer': value['userAnswer'],
+        'isCorrect': value['isCorrect'],
+        'grade': value['grade'],
+        'feedback': value['feedback'],
+        'rating': value['rating'],
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 ChatRequestQuizContextCurrentQuestion
+ */
+export interface ChatRequestQuizContextCurrentQuestion {
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    type: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    question: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    correctAnswer: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    explanation?: string | null;
+}
+/**
+ * Check if a given object implements the ChatRequestQuizContextCurrentQuestion interface.
+ */
+export declare function instanceOfChatRequestQuizContextCurrentQuestion(value: object): value is ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionFromJSON(json: any): ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionToJSON(json: any): ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionToJSONTyped(value?: ChatRequestQuizContextCurrentQuestion | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatRequestQuizContextCurrentQuestion.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ChatRequestQuizContextCurrentQuestion interface.
+ */
+export function instanceOfChatRequestQuizContextCurrentQuestion(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('question' in value) || value['question'] === undefined)
+        return false;
+    if (!('correctAnswer' in value) || value['correctAnswer'] === undefined)
+        return false;
+    return true;
+}
+export function ChatRequestQuizContextCurrentQuestionFromJSON(json) {
+    return ChatRequestQuizContextCurrentQuestionFromJSONTyped(json, false);
+}
+export function ChatRequestQuizContextCurrentQuestionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+        'question': json['question'],
+        'correctAnswer': json['correctAnswer'],
+        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+    };
+}
+export function ChatRequestQuizContextCurrentQuestionToJSON(json) {
+    return ChatRequestQuizContextCurrentQuestionToJSONTyped(json, false);
+}
+export function ChatRequestQuizContextCurrentQuestionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'question': value['question'],
+        'correctAnswer': value['correctAnswer'],
+        'explanation': value['explanation'],
+    };
+}

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

@@ -9,6 +9,9 @@ export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
+export * from './ChatRequestQuizContext';
+export * from './ChatRequestQuizContextAnswerState';
+export * from './ChatRequestQuizContextCurrentQuestion';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';

package/dist/esm/models/index.js

@@ -11,6 +11,9 @@ export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
+export * from './ChatRequestQuizContext';
+export * from './ChatRequestQuizContextAnswerState';
+export * from './ChatRequestQuizContextCurrentQuestion';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';

package/dist/models/ChatRequest.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
+import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
  *
  * @export
@@ -28,12 +29,24 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     chatId: string;
+    /**
+     * Optional chat type. Only applied when a new chat is created (ignored if chatId already exists). Use 'onboarding' to route to onboarding analysis.
+     * @type {string}
+     * @memberof ChatRequest
+     */
+    chatType?: string;
     /**
      * File attachments to include with the message (max 10)
      * @type {Array<ChatRequestAttachmentsInner>}
      * @memberof ChatRequest
      */
     attachments?: Array<ChatRequestAttachmentsInner>;
+    /**
+     *
+     * @type {ChatRequestQuizContext}
+     * @memberof ChatRequest
+     */
+    quizContext?: ChatRequestQuizContext;
 }
 /**
  * Check if a given object implements the ChatRequest interface.

package/dist/models/ChatRequest.js

@@ -19,6 +19,7 @@ exports.ChatRequestFromJSONTyped = ChatRequestFromJSONTyped;
 exports.ChatRequestToJSON = ChatRequestToJSON;
 exports.ChatRequestToJSONTyped = ChatRequestToJSONTyped;
 const ChatRequestAttachmentsInner_1 = require("./ChatRequestAttachmentsInner");
+const ChatRequestQuizContext_1 = require("./ChatRequestQuizContext");
 /**
  * Check if a given object implements the ChatRequest interface.
  */
@@ -39,7 +40,9 @@ function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'message': json['message'],
         'chatId': json['chatId'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
         'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerFromJSON)),
+        'quizContext': json['quizContext'] == null ? undefined : (0, ChatRequestQuizContext_1.ChatRequestQuizContextFromJSON)(json['quizContext']),
     };
 }
 function ChatRequestToJSON(json) {
@@ -52,6 +55,8 @@ function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'message': value['message'],
         'chatId': value['chatId'],
+        'chatType': value['chatType'],
         'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerToJSON)),
+        'quizContext': (0, ChatRequestQuizContext_1.ChatRequestQuizContextToJSON)(value['quizContext']),
     };
 }

package/dist/models/ChatRequestQuizContext.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 { ChatRequestQuizContextAnswerState } from './ChatRequestQuizContextAnswerState';
+import type { ChatRequestQuizContextCurrentQuestion } from './ChatRequestQuizContextCurrentQuestion';
+/**
+ * Optional quiz/flashcard context when the learner is chatting during an active session
+ * @export
+ * @interface ChatRequestQuizContext
+ */
+export interface ChatRequestQuizContext {
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    sessionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    quizTitle: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    mode: ChatRequestQuizContextModeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ChatRequestQuizContext
+     */
+    totalQuestions: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ChatRequestQuizContext
+     */
+    currentQuestionIndex: number;
+    /**
+     *
+     * @type {ChatRequestQuizContextCurrentQuestion}
+     * @memberof ChatRequestQuizContext
+     */
+    currentQuestion: ChatRequestQuizContextCurrentQuestion;
+    /**
+     *
+     * @type {ChatRequestQuizContextAnswerState}
+     * @memberof ChatRequestQuizContext
+     */
+    answerState?: ChatRequestQuizContextAnswerState;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContext
+     */
+    sessionStatus: ChatRequestQuizContextSessionStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const ChatRequestQuizContextModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ChatRequestQuizContextModeEnum = typeof ChatRequestQuizContextModeEnum[keyof typeof ChatRequestQuizContextModeEnum];
+/**
+ * @export
+ */
+export declare const ChatRequestQuizContextSessionStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+};
+export type ChatRequestQuizContextSessionStatusEnum = typeof ChatRequestQuizContextSessionStatusEnum[keyof typeof ChatRequestQuizContextSessionStatusEnum];
+/**
+ * Check if a given object implements the ChatRequestQuizContext interface.
+ */
+export declare function instanceOfChatRequestQuizContext(value: object): value is ChatRequestQuizContext;
+export declare function ChatRequestQuizContextFromJSON(json: any): ChatRequestQuizContext;
+export declare function ChatRequestQuizContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizContext;
+export declare function ChatRequestQuizContextToJSON(json: any): ChatRequestQuizContext;
+export declare function ChatRequestQuizContextToJSONTyped(value?: ChatRequestQuizContext | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatRequestQuizContext.js

@@ -0,0 +1,93 @@
+"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.ChatRequestQuizContextSessionStatusEnum = exports.ChatRequestQuizContextModeEnum = void 0;
+exports.instanceOfChatRequestQuizContext = instanceOfChatRequestQuizContext;
+exports.ChatRequestQuizContextFromJSON = ChatRequestQuizContextFromJSON;
+exports.ChatRequestQuizContextFromJSONTyped = ChatRequestQuizContextFromJSONTyped;
+exports.ChatRequestQuizContextToJSON = ChatRequestQuizContextToJSON;
+exports.ChatRequestQuizContextToJSONTyped = ChatRequestQuizContextToJSONTyped;
+const ChatRequestQuizContextAnswerState_1 = require("./ChatRequestQuizContextAnswerState");
+const ChatRequestQuizContextCurrentQuestion_1 = require("./ChatRequestQuizContextCurrentQuestion");
+/**
+ * @export
+ */
+exports.ChatRequestQuizContextModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+exports.ChatRequestQuizContextSessionStatusEnum = {
+    Active: 'active',
+    Completed: 'completed'
+};
+/**
+ * Check if a given object implements the ChatRequestQuizContext interface.
+ */
+function instanceOfChatRequestQuizContext(value) {
+    if (!('sessionId' in value) || value['sessionId'] === undefined)
+        return false;
+    if (!('quizTitle' in value) || value['quizTitle'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    if (!('currentQuestionIndex' in value) || value['currentQuestionIndex'] === undefined)
+        return false;
+    if (!('currentQuestion' in value) || value['currentQuestion'] === undefined)
+        return false;
+    if (!('sessionStatus' in value) || value['sessionStatus'] === undefined)
+        return false;
+    return true;
+}
+function ChatRequestQuizContextFromJSON(json) {
+    return ChatRequestQuizContextFromJSONTyped(json, false);
+}
+function ChatRequestQuizContextFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'sessionId': json['sessionId'],
+        'quizTitle': json['quizTitle'],
+        'mode': json['mode'],
+        'totalQuestions': json['totalQuestions'],
+        'currentQuestionIndex': json['currentQuestionIndex'],
+        'currentQuestion': (0, ChatRequestQuizContextCurrentQuestion_1.ChatRequestQuizContextCurrentQuestionFromJSON)(json['currentQuestion']),
+        'answerState': json['answerState'] == null ? undefined : (0, ChatRequestQuizContextAnswerState_1.ChatRequestQuizContextAnswerStateFromJSON)(json['answerState']),
+        'sessionStatus': json['sessionStatus'],
+    };
+}
+function ChatRequestQuizContextToJSON(json) {
+    return ChatRequestQuizContextToJSONTyped(json, false);
+}
+function ChatRequestQuizContextToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'sessionId': value['sessionId'],
+        'quizTitle': value['quizTitle'],
+        'mode': value['mode'],
+        'totalQuestions': value['totalQuestions'],
+        'currentQuestionIndex': value['currentQuestionIndex'],
+        'currentQuestion': (0, ChatRequestQuizContextCurrentQuestion_1.ChatRequestQuizContextCurrentQuestionToJSON)(value['currentQuestion']),
+        'answerState': (0, ChatRequestQuizContextAnswerState_1.ChatRequestQuizContextAnswerStateToJSON)(value['answerState']),
+        'sessionStatus': value['sessionStatus'],
+    };
+}

package/dist/models/ChatRequestQuizContextAnswerState.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 ChatRequestQuizContextAnswerState
+ */
+export interface ChatRequestQuizContextAnswerState {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    answered: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    userAnswer?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    isCorrect?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    grade?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    feedback?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextAnswerState
+     */
+    rating?: string | null;
+}
+/**
+ * Check if a given object implements the ChatRequestQuizContextAnswerState interface.
+ */
+export declare function instanceOfChatRequestQuizContextAnswerState(value: object): value is ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateFromJSON(json: any): ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateToJSON(json: any): ChatRequestQuizContextAnswerState;
+export declare function ChatRequestQuizContextAnswerStateToJSONTyped(value?: ChatRequestQuizContextAnswerState | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatRequestQuizContextAnswerState.js

@@ -0,0 +1,60 @@
+"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.instanceOfChatRequestQuizContextAnswerState = instanceOfChatRequestQuizContextAnswerState;
+exports.ChatRequestQuizContextAnswerStateFromJSON = ChatRequestQuizContextAnswerStateFromJSON;
+exports.ChatRequestQuizContextAnswerStateFromJSONTyped = ChatRequestQuizContextAnswerStateFromJSONTyped;
+exports.ChatRequestQuizContextAnswerStateToJSON = ChatRequestQuizContextAnswerStateToJSON;
+exports.ChatRequestQuizContextAnswerStateToJSONTyped = ChatRequestQuizContextAnswerStateToJSONTyped;
+/**
+ * Check if a given object implements the ChatRequestQuizContextAnswerState interface.
+ */
+function instanceOfChatRequestQuizContextAnswerState(value) {
+    if (!('answered' in value) || value['answered'] === undefined)
+        return false;
+    return true;
+}
+function ChatRequestQuizContextAnswerStateFromJSON(json) {
+    return ChatRequestQuizContextAnswerStateFromJSONTyped(json, false);
+}
+function ChatRequestQuizContextAnswerStateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'answered': json['answered'],
+        'userAnswer': json['userAnswer'] == null ? undefined : json['userAnswer'],
+        'isCorrect': json['isCorrect'] == null ? undefined : json['isCorrect'],
+        'grade': json['grade'] == null ? undefined : json['grade'],
+        'feedback': json['feedback'] == null ? undefined : json['feedback'],
+        'rating': json['rating'] == null ? undefined : json['rating'],
+    };
+}
+function ChatRequestQuizContextAnswerStateToJSON(json) {
+    return ChatRequestQuizContextAnswerStateToJSONTyped(json, false);
+}
+function ChatRequestQuizContextAnswerStateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'answered': value['answered'],
+        'userAnswer': value['userAnswer'],
+        'isCorrect': value['isCorrect'],
+        'grade': value['grade'],
+        'feedback': value['feedback'],
+        'rating': value['rating'],
+    };
+}

package/dist/models/ChatRequestQuizContextCurrentQuestion.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 ChatRequestQuizContextCurrentQuestion
+ */
+export interface ChatRequestQuizContextCurrentQuestion {
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    type: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    question: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    correctAnswer: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ChatRequestQuizContextCurrentQuestion
+     */
+    explanation?: string | null;
+}
+/**
+ * Check if a given object implements the ChatRequestQuizContextCurrentQuestion interface.
+ */
+export declare function instanceOfChatRequestQuizContextCurrentQuestion(value: object): value is ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionFromJSON(json: any): ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionToJSON(json: any): ChatRequestQuizContextCurrentQuestion;
+export declare function ChatRequestQuizContextCurrentQuestionToJSONTyped(value?: ChatRequestQuizContextCurrentQuestion | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatRequestQuizContextCurrentQuestion.js

@@ -0,0 +1,60 @@
+"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.instanceOfChatRequestQuizContextCurrentQuestion = instanceOfChatRequestQuizContextCurrentQuestion;
+exports.ChatRequestQuizContextCurrentQuestionFromJSON = ChatRequestQuizContextCurrentQuestionFromJSON;
+exports.ChatRequestQuizContextCurrentQuestionFromJSONTyped = ChatRequestQuizContextCurrentQuestionFromJSONTyped;
+exports.ChatRequestQuizContextCurrentQuestionToJSON = ChatRequestQuizContextCurrentQuestionToJSON;
+exports.ChatRequestQuizContextCurrentQuestionToJSONTyped = ChatRequestQuizContextCurrentQuestionToJSONTyped;
+/**
+ * Check if a given object implements the ChatRequestQuizContextCurrentQuestion interface.
+ */
+function instanceOfChatRequestQuizContextCurrentQuestion(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('question' in value) || value['question'] === undefined)
+        return false;
+    if (!('correctAnswer' in value) || value['correctAnswer'] === undefined)
+        return false;
+    return true;
+}
+function ChatRequestQuizContextCurrentQuestionFromJSON(json) {
+    return ChatRequestQuizContextCurrentQuestionFromJSONTyped(json, false);
+}
+function ChatRequestQuizContextCurrentQuestionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+        'question': json['question'],
+        'correctAnswer': json['correctAnswer'],
+        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+    };
+}
+function ChatRequestQuizContextCurrentQuestionToJSON(json) {
+    return ChatRequestQuizContextCurrentQuestionToJSONTyped(json, false);
+}
+function ChatRequestQuizContextCurrentQuestionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'question': value['question'],
+        'correctAnswer': value['correctAnswer'],
+        'explanation': value['explanation'],
+    };
+}

package/dist/models/index.d.ts

@@ -9,6 +9,9 @@ export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
+export * from './ChatRequestQuizContext';
+export * from './ChatRequestQuizContextAnswerState';
+export * from './ChatRequestQuizContextCurrentQuestion';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';

package/dist/models/index.js

@@ -27,6 +27,9 @@ __exportStar(require("./Chat"), exports);
 __exportStar(require("./ChatAnalysis"), exports);
 __exportStar(require("./ChatRequest"), exports);
 __exportStar(require("./ChatRequestAttachmentsInner"), exports);
+__exportStar(require("./ChatRequestQuizContext"), exports);
+__exportStar(require("./ChatRequestQuizContextAnswerState"), exports);
+__exportStar(require("./ChatRequestQuizContextCurrentQuestion"), exports);
 __exportStar(require("./CreateAccountRequest"), exports);
 __exportStar(require("./CreateChatRequest"), exports);
 __exportStar(require("./CreateFeatureDto"), exports);

package/package.json

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