@instructure/athena-api-client 2.12.1 → 2.14.0

package/dist/models/QuizSessionListItem.d.ts

@@ -0,0 +1,85 @@
+/**
+ * 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 { Quiz } from './Quiz';
+import type { QuizSessionScore } from './QuizSessionScore';
+/**
+ *
+ * @export
+ * @interface QuizSessionListItem
+ */
+export interface QuizSessionListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSessionListItem
+     */
+    status: QuizSessionListItemStatusEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSessionListItem
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSessionListItem
+     */
+    completedAt: Date | null;
+    /**
+     *
+     * @type {Quiz}
+     * @memberof QuizSessionListItem
+     */
+    quiz: Quiz;
+    /**
+     *
+     * @type {QuizSessionScore}
+     * @memberof QuizSessionListItem
+     */
+    score: QuizSessionScore;
+}
+/**
+ * @export
+ */
+export declare const QuizSessionListItemStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type QuizSessionListItemStatusEnum = typeof QuizSessionListItemStatusEnum[keyof typeof QuizSessionListItemStatusEnum];
+/**
+ * Check if a given object implements the QuizSessionListItem interface.
+ */
+export declare function instanceOfQuizSessionListItem(value: object): value is QuizSessionListItem;
+export declare function QuizSessionListItemFromJSON(json: any): QuizSessionListItem;
+export declare function QuizSessionListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionListItem;
+export declare function QuizSessionListItemToJSON(json: any): QuizSessionListItem;
+export declare function QuizSessionListItemToJSONTyped(value?: QuizSessionListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizSessionListItem.js

@@ -0,0 +1,89 @@
+"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.QuizSessionListItemStatusEnum = void 0;
+exports.instanceOfQuizSessionListItem = instanceOfQuizSessionListItem;
+exports.QuizSessionListItemFromJSON = QuizSessionListItemFromJSON;
+exports.QuizSessionListItemFromJSONTyped = QuizSessionListItemFromJSONTyped;
+exports.QuizSessionListItemToJSON = QuizSessionListItemToJSON;
+exports.QuizSessionListItemToJSONTyped = QuizSessionListItemToJSONTyped;
+const Quiz_1 = require("./Quiz");
+const QuizSessionScore_1 = require("./QuizSessionScore");
+/**
+ * @export
+ */
+exports.QuizSessionListItemStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the QuizSessionListItem interface.
+ */
+function instanceOfQuizSessionListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    if (!('quiz' in value) || value['quiz'] === undefined)
+        return false;
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    return true;
+}
+function QuizSessionListItemFromJSON(json) {
+    return QuizSessionListItemFromJSONTyped(json, false);
+}
+function QuizSessionListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'quizId': json['quizId'],
+        'accountUserId': json['accountUserId'],
+        'status': json['status'],
+        'startedAt': (new Date(json['startedAt'])),
+        'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'quiz': (0, Quiz_1.QuizFromJSON)(json['quiz']),
+        'score': (0, QuizSessionScore_1.QuizSessionScoreFromJSON)(json['score']),
+    };
+}
+function QuizSessionListItemToJSON(json) {
+    return QuizSessionListItemToJSONTyped(json, false);
+}
+function QuizSessionListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'quizId': value['quizId'],
+        'accountUserId': value['accountUserId'],
+        'status': value['status'],
+        'startedAt': value['startedAt'].toISOString(),
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'quiz': (0, Quiz_1.QuizToJSON)(value['quiz']),
+        'score': (0, QuizSessionScore_1.QuizSessionScoreToJSON)(value['score']),
+    };
+}

package/dist/models/QuizSessionScore.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 QuizSessionScore
+ */
+export interface QuizSessionScore {
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionScore
+     */
+    totalCorrect: number;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionScore
+     */
+    totalQuestions: number;
+}
+/**
+ * Check if a given object implements the QuizSessionScore interface.
+ */
+export declare function instanceOfQuizSessionScore(value: object): value is QuizSessionScore;
+export declare function QuizSessionScoreFromJSON(json: any): QuizSessionScore;
+export declare function QuizSessionScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionScore;
+export declare function QuizSessionScoreToJSON(json: any): QuizSessionScore;
+export declare function QuizSessionScoreToJSONTyped(value?: QuizSessionScore | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizSessionScore.js

@@ -0,0 +1,54 @@
+"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.instanceOfQuizSessionScore = instanceOfQuizSessionScore;
+exports.QuizSessionScoreFromJSON = QuizSessionScoreFromJSON;
+exports.QuizSessionScoreFromJSONTyped = QuizSessionScoreFromJSONTyped;
+exports.QuizSessionScoreToJSON = QuizSessionScoreToJSON;
+exports.QuizSessionScoreToJSONTyped = QuizSessionScoreToJSONTyped;
+/**
+ * Check if a given object implements the QuizSessionScore interface.
+ */
+function instanceOfQuizSessionScore(value) {
+    if (!('totalCorrect' in value) || value['totalCorrect'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    return true;
+}
+function QuizSessionScoreFromJSON(json) {
+    return QuizSessionScoreFromJSONTyped(json, false);
+}
+function QuizSessionScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalCorrect': json['totalCorrect'],
+        'totalQuestions': json['totalQuestions'],
+    };
+}
+function QuizSessionScoreToJSON(json) {
+    return QuizSessionScoreToJSONTyped(json, false);
+}
+function QuizSessionScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalCorrect': value['totalCorrect'],
+        'totalQuestions': value['totalQuestions'],
+    };
+}

package/dist/models/index.d.ts

@@ -15,6 +15,7 @@ export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
 export * from './ChatRequestExternalFileUrl';
+export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
@@ -43,6 +44,7 @@ export * from './MessagePartsInner';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './PaginatedQuizSessions';
 export * from './PaginatedQuizzes';
 export * from './PaginatedTaxonomies';
 export * from './Plan';
@@ -51,6 +53,8 @@ export * from './QuizListItem';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';
+export * from './QuizSessionListItem';
+export * from './QuizSessionScore';
 export * from './QuizSessionSummary';
 export * from './QuizWithQuestions';
 export * from './Score';

package/dist/models/index.js

@@ -33,6 +33,7 @@ __exportStar(require("./ChatAnalysis"), exports);
 __exportStar(require("./ChatRequest"), exports);
 __exportStar(require("./ChatRequestAttachmentsInner"), exports);
 __exportStar(require("./ChatRequestExternalFileUrl"), exports);
+__exportStar(require("./ChatRequestMessageMetadata"), exports);
 __exportStar(require("./ChatRequestQuizContext"), exports);
 __exportStar(require("./ChatRequestQuizContextAnswerState"), exports);
 __exportStar(require("./ChatRequestQuizContextCurrentQuestion"), exports);
@@ -61,6 +62,7 @@ __exportStar(require("./MessagePartsInner"), exports);
 __exportStar(require("./PaginatedChats"), exports);
 __exportStar(require("./PaginatedLearningMoments"), exports);
 __exportStar(require("./PaginatedMessages"), exports);
+__exportStar(require("./PaginatedQuizSessions"), exports);
 __exportStar(require("./PaginatedQuizzes"), exports);
 __exportStar(require("./PaginatedTaxonomies"), exports);
 __exportStar(require("./Plan"), exports);
@@ -69,6 +71,8 @@ __exportStar(require("./QuizListItem"), exports);
 __exportStar(require("./QuizQuestion"), exports);
 __exportStar(require("./QuizResponse"), exports);
 __exportStar(require("./QuizSession"), exports);
+__exportStar(require("./QuizSessionListItem"), exports);
+__exportStar(require("./QuizSessionScore"), exports);
 __exportStar(require("./QuizSessionSummary"), exports);
 __exportStar(require("./QuizWithQuestions"), exports);
 __exportStar(require("./Score"), exports);

package/package.json

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