@instructure/athena-api-client 1.0.6 → 1.0.8

package/dist/models/QuizSession.js

@@ -0,0 +1,77 @@
+"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.QuizSessionStatusEnum = void 0;
+exports.instanceOfQuizSession = instanceOfQuizSession;
+exports.QuizSessionFromJSON = QuizSessionFromJSON;
+exports.QuizSessionFromJSONTyped = QuizSessionFromJSONTyped;
+exports.QuizSessionToJSON = QuizSessionToJSON;
+exports.QuizSessionToJSONTyped = QuizSessionToJSONTyped;
+/**
+ * @export
+ */
+exports.QuizSessionStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the QuizSession interface.
+ */
+function instanceOfQuizSession(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;
+    return true;
+}
+function QuizSessionFromJSON(json) {
+    return QuizSessionFromJSONTyped(json, false);
+}
+function QuizSessionFromJSONTyped(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 ? undefined : (new Date(json['completedAt'])),
+    };
+}
+function QuizSessionToJSON(json) {
+    return QuizSessionToJSONTyped(json, false);
+}
+function QuizSessionToJSONTyped(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(),
+    };
+}

package/dist/models/QuizSessionSummary.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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 { QuizSessionSummaryScore } from './QuizSessionSummaryScore';
+import type { Quiz } from './Quiz';
+import type { QuizSession } from './QuizSession';
+import type { QuizQuestion } from './QuizQuestion';
+import type { QuizResponse } from './QuizResponse';
+/**
+ *
+ * @export
+ * @interface QuizSessionSummary
+ */
+export interface QuizSessionSummary {
+    /**
+     *
+     * @type {QuizSession}
+     * @memberof QuizSessionSummary
+     */
+    session: QuizSession;
+    /**
+     *
+     * @type {Quiz}
+     * @memberof QuizSessionSummary
+     */
+    quiz: Quiz;
+    /**
+     *
+     * @type {Array<QuizQuestion>}
+     * @memberof QuizSessionSummary
+     */
+    questions: Array<QuizQuestion>;
+    /**
+     *
+     * @type {Array<QuizResponse>}
+     * @memberof QuizSessionSummary
+     */
+    responses: Array<QuizResponse>;
+    /**
+     *
+     * @type {QuizSessionSummaryScore}
+     * @memberof QuizSessionSummary
+     */
+    score: QuizSessionSummaryScore;
+}
+/**
+ * Check if a given object implements the QuizSessionSummary interface.
+ */
+export declare function instanceOfQuizSessionSummary(value: object): value is QuizSessionSummary;
+export declare function QuizSessionSummaryFromJSON(json: any): QuizSessionSummary;
+export declare function QuizSessionSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionSummary;
+export declare function QuizSessionSummaryToJSON(json: any): QuizSessionSummary;
+export declare function QuizSessionSummaryToJSONTyped(value?: QuizSessionSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizSessionSummary.js

@@ -0,0 +1,71 @@
+"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.instanceOfQuizSessionSummary = instanceOfQuizSessionSummary;
+exports.QuizSessionSummaryFromJSON = QuizSessionSummaryFromJSON;
+exports.QuizSessionSummaryFromJSONTyped = QuizSessionSummaryFromJSONTyped;
+exports.QuizSessionSummaryToJSON = QuizSessionSummaryToJSON;
+exports.QuizSessionSummaryToJSONTyped = QuizSessionSummaryToJSONTyped;
+const QuizSessionSummaryScore_1 = require("./QuizSessionSummaryScore");
+const Quiz_1 = require("./Quiz");
+const QuizSession_1 = require("./QuizSession");
+const QuizQuestion_1 = require("./QuizQuestion");
+const QuizResponse_1 = require("./QuizResponse");
+/**
+ * Check if a given object implements the QuizSessionSummary interface.
+ */
+function instanceOfQuizSessionSummary(value) {
+    if (!('session' in value) || value['session'] === undefined)
+        return false;
+    if (!('quiz' in value) || value['quiz'] === undefined)
+        return false;
+    if (!('questions' in value) || value['questions'] === undefined)
+        return false;
+    if (!('responses' in value) || value['responses'] === undefined)
+        return false;
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    return true;
+}
+function QuizSessionSummaryFromJSON(json) {
+    return QuizSessionSummaryFromJSONTyped(json, false);
+}
+function QuizSessionSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'session': (0, QuizSession_1.QuizSessionFromJSON)(json['session']),
+        'quiz': (0, Quiz_1.QuizFromJSON)(json['quiz']),
+        'questions': (json['questions'].map(QuizQuestion_1.QuizQuestionFromJSON)),
+        'responses': (json['responses'].map(QuizResponse_1.QuizResponseFromJSON)),
+        'score': (0, QuizSessionSummaryScore_1.QuizSessionSummaryScoreFromJSON)(json['score']),
+    };
+}
+function QuizSessionSummaryToJSON(json) {
+    return QuizSessionSummaryToJSONTyped(json, false);
+}
+function QuizSessionSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'session': (0, QuizSession_1.QuizSessionToJSON)(value['session']),
+        'quiz': (0, Quiz_1.QuizToJSON)(value['quiz']),
+        'questions': (value['questions'].map(QuizQuestion_1.QuizQuestionToJSON)),
+        'responses': (value['responses'].map(QuizResponse_1.QuizResponseToJSON)),
+        'score': (0, QuizSessionSummaryScore_1.QuizSessionSummaryScoreToJSON)(value['score']),
+    };
+}

package/dist/models/QuizSessionSummaryScore.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 { ScoreByTypeValue } from './ScoreByTypeValue';
+/**
+ *
+ * @export
+ * @interface QuizSessionSummaryScore
+ */
+export interface QuizSessionSummaryScore {
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionSummaryScore
+     */
+    totalCorrect: number;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizSessionSummaryScore
+     */
+    totalQuestions: number;
+    /**
+     *
+     * @type {{ [key: string]: ScoreByTypeValue; }}
+     * @memberof QuizSessionSummaryScore
+     */
+    byType: {
+        [key: string]: ScoreByTypeValue;
+    };
+}
+/**
+ * Check if a given object implements the QuizSessionSummaryScore interface.
+ */
+export declare function instanceOfQuizSessionSummaryScore(value: object): value is QuizSessionSummaryScore;
+export declare function QuizSessionSummaryScoreFromJSON(json: any): QuizSessionSummaryScore;
+export declare function QuizSessionSummaryScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSessionSummaryScore;
+export declare function QuizSessionSummaryScoreToJSON(json: any): QuizSessionSummaryScore;
+export declare function QuizSessionSummaryScoreToJSONTyped(value?: QuizSessionSummaryScore | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizSessionSummaryScore.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.instanceOfQuizSessionSummaryScore = instanceOfQuizSessionSummaryScore;
+exports.QuizSessionSummaryScoreFromJSON = QuizSessionSummaryScoreFromJSON;
+exports.QuizSessionSummaryScoreFromJSONTyped = QuizSessionSummaryScoreFromJSONTyped;
+exports.QuizSessionSummaryScoreToJSON = QuizSessionSummaryScoreToJSON;
+exports.QuizSessionSummaryScoreToJSONTyped = QuizSessionSummaryScoreToJSONTyped;
+const runtime_1 = require("../runtime");
+const ScoreByTypeValue_1 = require("./ScoreByTypeValue");
+/**
+ * Check if a given object implements the QuizSessionSummaryScore interface.
+ */
+function instanceOfQuizSessionSummaryScore(value) {
+    if (!('totalCorrect' in value) || value['totalCorrect'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    if (!('byType' in value) || value['byType'] === undefined)
+        return false;
+    return true;
+}
+function QuizSessionSummaryScoreFromJSON(json) {
+    return QuizSessionSummaryScoreFromJSONTyped(json, false);
+}
+function QuizSessionSummaryScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalCorrect': json['totalCorrect'],
+        'totalQuestions': json['totalQuestions'],
+        'byType': ((0, runtime_1.mapValues)(json['byType'], ScoreByTypeValue_1.ScoreByTypeValueFromJSON)),
+    };
+}
+function QuizSessionSummaryScoreToJSON(json) {
+    return QuizSessionSummaryScoreToJSONTyped(json, false);
+}
+function QuizSessionSummaryScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalCorrect': value['totalCorrect'],
+        'totalQuestions': value['totalQuestions'],
+        'byType': ((0, runtime_1.mapValues)(value['byType'], ScoreByTypeValue_1.ScoreByTypeValueToJSON)),
+    };
+}

package/dist/models/QuizWithQuestions.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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 { QuizQuestion } from './QuizQuestion';
+/**
+ *
+ * @export
+ * @interface QuizWithQuestions
+ */
+export interface QuizWithQuestions {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    chatId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    topic: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizWithQuestions
+     */
+    mode: QuizWithQuestionsModeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizWithQuestions
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Array<QuizQuestion>}
+     * @memberof QuizWithQuestions
+     */
+    questions: Array<QuizQuestion>;
+}
+/**
+ * @export
+ */
+export declare const QuizWithQuestionsModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type QuizWithQuestionsModeEnum = typeof QuizWithQuestionsModeEnum[keyof typeof QuizWithQuestionsModeEnum];
+/**
+ * Check if a given object implements the QuizWithQuestions interface.
+ */
+export declare function instanceOfQuizWithQuestions(value: object): value is QuizWithQuestions;
+export declare function QuizWithQuestionsFromJSON(json: any): QuizWithQuestions;
+export declare function QuizWithQuestionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizWithQuestions;
+export declare function QuizWithQuestionsToJSON(json: any): QuizWithQuestions;
+export declare function QuizWithQuestionsToJSONTyped(value?: QuizWithQuestions | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizWithQuestions.js

@@ -0,0 +1,85 @@
+"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.QuizWithQuestionsModeEnum = void 0;
+exports.instanceOfQuizWithQuestions = instanceOfQuizWithQuestions;
+exports.QuizWithQuestionsFromJSON = QuizWithQuestionsFromJSON;
+exports.QuizWithQuestionsFromJSONTyped = QuizWithQuestionsFromJSONTyped;
+exports.QuizWithQuestionsToJSON = QuizWithQuestionsToJSON;
+exports.QuizWithQuestionsToJSONTyped = QuizWithQuestionsToJSONTyped;
+const QuizQuestion_1 = require("./QuizQuestion");
+/**
+ * @export
+ */
+exports.QuizWithQuestionsModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the QuizWithQuestions interface.
+ */
+function instanceOfQuizWithQuestions(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('topic' in value) || value['topic'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('questions' in value) || value['questions'] === undefined)
+        return false;
+    return true;
+}
+function QuizWithQuestionsFromJSON(json) {
+    return QuizWithQuestionsFromJSONTyped(json, false);
+}
+function QuizWithQuestionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'title': json['title'],
+        'topic': json['topic'],
+        'mode': json['mode'],
+        'createdAt': (new Date(json['createdAt'])),
+        'questions': (json['questions'].map(QuizQuestion_1.QuizQuestionFromJSON)),
+    };
+}
+function QuizWithQuestionsToJSON(json) {
+    return QuizWithQuestionsToJSONTyped(json, false);
+}
+function QuizWithQuestionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'chatId': value['chatId'],
+        'title': value['title'],
+        'topic': value['topic'],
+        'mode': value['mode'],
+        'createdAt': value['createdAt'].toISOString(),
+        'questions': (value['questions'].map(QuizQuestion_1.QuizQuestionToJSON)),
+    };
+}

package/dist/models/ScoreByTypeValue.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 ScoreByTypeValue
+ */
+export interface ScoreByTypeValue {
+    /**
+     *
+     * @type {number}
+     * @memberof ScoreByTypeValue
+     */
+    correct: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ScoreByTypeValue
+     */
+    total: number;
+}
+/**
+ * Check if a given object implements the ScoreByTypeValue interface.
+ */
+export declare function instanceOfScoreByTypeValue(value: object): value is ScoreByTypeValue;
+export declare function ScoreByTypeValueFromJSON(json: any): ScoreByTypeValue;
+export declare function ScoreByTypeValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScoreByTypeValue;
+export declare function ScoreByTypeValueToJSON(json: any): ScoreByTypeValue;
+export declare function ScoreByTypeValueToJSONTyped(value?: ScoreByTypeValue | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ScoreByTypeValue.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.instanceOfScoreByTypeValue = instanceOfScoreByTypeValue;
+exports.ScoreByTypeValueFromJSON = ScoreByTypeValueFromJSON;
+exports.ScoreByTypeValueFromJSONTyped = ScoreByTypeValueFromJSONTyped;
+exports.ScoreByTypeValueToJSON = ScoreByTypeValueToJSON;
+exports.ScoreByTypeValueToJSONTyped = ScoreByTypeValueToJSONTyped;
+/**
+ * Check if a given object implements the ScoreByTypeValue interface.
+ */
+function instanceOfScoreByTypeValue(value) {
+    if (!('correct' in value) || value['correct'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    return true;
+}
+function ScoreByTypeValueFromJSON(json) {
+    return ScoreByTypeValueFromJSONTyped(json, false);
+}
+function ScoreByTypeValueFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'correct': json['correct'],
+        'total': json['total'],
+    };
+}
+function ScoreByTypeValueToJSON(json) {
+    return ScoreByTypeValueToJSONTyped(json, false);
+}
+function ScoreByTypeValueToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'correct': value['correct'],
+        'total': value['total'],
+    };
+}

package/dist/models/SubmitQuizResponseRequest.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 SubmitQuizResponseRequest
+ */
+export interface SubmitQuizResponseRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitQuizResponseRequest
+     */
+    questionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitQuizResponseRequest
+     */
+    userAnswer: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SubmitQuizResponseRequest
+     */
+    isCorrect?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitQuizResponseRequest
+     */
+    rating?: SubmitQuizResponseRequestRatingEnum | null;
+}
+/**
+ * @export
+ */
+export declare const SubmitQuizResponseRequestRatingEnum: {
+    readonly WasRight: "was-right";
+    readonly NeedPractice: "need-practice";
+};
+export type SubmitQuizResponseRequestRatingEnum = typeof SubmitQuizResponseRequestRatingEnum[keyof typeof SubmitQuizResponseRequestRatingEnum];
+/**
+ * Check if a given object implements the SubmitQuizResponseRequest interface.
+ */
+export declare function instanceOfSubmitQuizResponseRequest(value: object): value is SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestFromJSON(json: any): SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestToJSON(json: any): SubmitQuizResponseRequest;
+export declare function SubmitQuizResponseRequestToJSONTyped(value?: SubmitQuizResponseRequest | null, ignoreDiscriminator?: boolean): any;