@instructure/athena-api-client 1.0.7 → 1.0.8

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;

package/dist/models/SubmitQuizResponseRequest.js

@@ -0,0 +1,66 @@
+"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.SubmitQuizResponseRequestRatingEnum = void 0;
+exports.instanceOfSubmitQuizResponseRequest = instanceOfSubmitQuizResponseRequest;
+exports.SubmitQuizResponseRequestFromJSON = SubmitQuizResponseRequestFromJSON;
+exports.SubmitQuizResponseRequestFromJSONTyped = SubmitQuizResponseRequestFromJSONTyped;
+exports.SubmitQuizResponseRequestToJSON = SubmitQuizResponseRequestToJSON;
+exports.SubmitQuizResponseRequestToJSONTyped = SubmitQuizResponseRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.SubmitQuizResponseRequestRatingEnum = {
+    WasRight: 'was-right',
+    NeedPractice: 'need-practice'
+};
+/**
+ * Check if a given object implements the SubmitQuizResponseRequest interface.
+ */
+function instanceOfSubmitQuizResponseRequest(value) {
+    if (!('questionId' in value) || value['questionId'] === undefined)
+        return false;
+    if (!('userAnswer' in value) || value['userAnswer'] === undefined)
+        return false;
+    return true;
+}
+function SubmitQuizResponseRequestFromJSON(json) {
+    return SubmitQuizResponseRequestFromJSONTyped(json, false);
+}
+function SubmitQuizResponseRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'questionId': json['questionId'],
+        'userAnswer': json['userAnswer'],
+        'isCorrect': json['isCorrect'] == null ? undefined : json['isCorrect'],
+        'rating': json['rating'] == null ? undefined : json['rating'],
+    };
+}
+function SubmitQuizResponseRequestToJSON(json) {
+    return SubmitQuizResponseRequestToJSONTyped(json, false);
+}
+function SubmitQuizResponseRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'questionId': value['questionId'],
+        'userAnswer': value['userAnswer'],
+        'isCorrect': value['isCorrect'],
+        'rating': value['rating'],
+    };
+}

package/dist/models/UpdateQuizSessionRequest.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 UpdateQuizSessionRequest
+ */
+export interface UpdateQuizSessionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateQuizSessionRequest
+     */
+    status: UpdateQuizSessionRequestStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const UpdateQuizSessionRequestStatusEnum: {
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type UpdateQuizSessionRequestStatusEnum = typeof UpdateQuizSessionRequestStatusEnum[keyof typeof UpdateQuizSessionRequestStatusEnum];
+/**
+ * Check if a given object implements the UpdateQuizSessionRequest interface.
+ */
+export declare function instanceOfUpdateQuizSessionRequest(value: object): value is UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestFromJSON(json: any): UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestToJSON(json: any): UpdateQuizSessionRequest;
+export declare function UpdateQuizSessionRequestToJSONTyped(value?: UpdateQuizSessionRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateQuizSessionRequest.js

@@ -0,0 +1,58 @@
+"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.UpdateQuizSessionRequestStatusEnum = void 0;
+exports.instanceOfUpdateQuizSessionRequest = instanceOfUpdateQuizSessionRequest;
+exports.UpdateQuizSessionRequestFromJSON = UpdateQuizSessionRequestFromJSON;
+exports.UpdateQuizSessionRequestFromJSONTyped = UpdateQuizSessionRequestFromJSONTyped;
+exports.UpdateQuizSessionRequestToJSON = UpdateQuizSessionRequestToJSON;
+exports.UpdateQuizSessionRequestToJSONTyped = UpdateQuizSessionRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.UpdateQuizSessionRequestStatusEnum = {
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the UpdateQuizSessionRequest interface.
+ */
+function instanceOfUpdateQuizSessionRequest(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+function UpdateQuizSessionRequestFromJSON(json) {
+    return UpdateQuizSessionRequestFromJSONTyped(json, false);
+}
+function UpdateQuizSessionRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+    };
+}
+function UpdateQuizSessionRequestToJSON(json) {
+    return UpdateQuizSessionRequestToJSONTyped(json, false);
+}
+function UpdateQuizSessionRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+    };
+}

package/dist/models/index.d.ts

@@ -18,9 +18,19 @@ export * from './ModelError';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './Quiz';
+export * from './QuizQuestion';
+export * from './QuizResponse';
+export * from './QuizSession';
+export * from './QuizSessionSummary';
+export * from './QuizSessionSummaryScore';
+export * from './QuizWithQuestions';
+export * from './ScoreByTypeValue';
 export * from './ServiceToken';
+export * from './SubmitQuizResponseRequest';
 export * from './Tag';
 export * from './UpdateChatRequest';
+export * from './UpdateQuizSessionRequest';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
 export * from './UploadUrlRequest';

package/dist/models/index.js

@@ -36,9 +36,19 @@ __exportStar(require("./ModelError"), exports);
 __exportStar(require("./PaginatedChats"), exports);
 __exportStar(require("./PaginatedLearningMoments"), exports);
 __exportStar(require("./PaginatedMessages"), exports);
+__exportStar(require("./Quiz"), exports);
+__exportStar(require("./QuizQuestion"), exports);
+__exportStar(require("./QuizResponse"), exports);
+__exportStar(require("./QuizSession"), exports);
+__exportStar(require("./QuizSessionSummary"), exports);
+__exportStar(require("./QuizSessionSummaryScore"), exports);
+__exportStar(require("./QuizWithQuestions"), exports);
+__exportStar(require("./ScoreByTypeValue"), exports);
 __exportStar(require("./ServiceToken"), exports);
+__exportStar(require("./SubmitQuizResponseRequest"), exports);
 __exportStar(require("./Tag"), exports);
 __exportStar(require("./UpdateChatRequest"), exports);
+__exportStar(require("./UpdateQuizSessionRequest"), exports);
 __exportStar(require("./UpdateTokenRequest"), exports);
 __exportStar(require("./UpdateTokenResponse"), exports);
 __exportStar(require("./UploadUrlRequest"), exports);

package/package.json

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