@instructure/athena-api-client 1.0.6 → 1.0.8

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

@@ -0,0 +1,103 @@
+/**
+ * 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 QuizQuestion
+ */
+export interface QuizQuestion {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    conceptId?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof QuizQuestion
+     */
+    ordinal: number;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    type: QuizQuestionTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    question: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof QuizQuestion
+     */
+    options?: Array<string> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    correctAnswer: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    explanation?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizQuestion
+     */
+    topic?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizQuestion
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const QuizQuestionTypeEnum: {
+    readonly Mcq: "mcq";
+    readonly FillBlank: "fill-blank";
+    readonly SpotError: "spot-error";
+    readonly TeachBack: "teach-back";
+    readonly Flashcard: "flashcard";
+};
+export type QuizQuestionTypeEnum = typeof QuizQuestionTypeEnum[keyof typeof QuizQuestionTypeEnum];
+/**
+ * Check if a given object implements the QuizQuestion interface.
+ */
+export declare function instanceOfQuizQuestion(value: object): value is QuizQuestion;
+export declare function QuizQuestionFromJSON(json: any): QuizQuestion;
+export declare function QuizQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizQuestion;
+export declare function QuizQuestionToJSON(json: any): QuizQuestion;
+export declare function QuizQuestionToJSONTyped(value?: QuizQuestion | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizQuestion.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.
+ */
+/**
+ * @export
+ */
+export const QuizQuestionTypeEnum = {
+    Mcq: 'mcq',
+    FillBlank: 'fill-blank',
+    SpotError: 'spot-error',
+    TeachBack: 'teach-back',
+    Flashcard: 'flashcard'
+};
+/**
+ * Check if a given object implements the QuizQuestion interface.
+ */
+export function instanceOfQuizQuestion(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('ordinal' in value) || value['ordinal'] === undefined)
+        return false;
+    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;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function QuizQuestionFromJSON(json) {
+    return QuizQuestionFromJSONTyped(json, false);
+}
+export function QuizQuestionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'quizId': json['quizId'],
+        'conceptId': json['conceptId'] == null ? undefined : json['conceptId'],
+        'ordinal': json['ordinal'],
+        'type': json['type'],
+        'question': json['question'],
+        'options': json['options'] == null ? undefined : json['options'],
+        'correctAnswer': json['correctAnswer'],
+        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+        'topic': json['topic'] == null ? undefined : json['topic'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function QuizQuestionToJSON(json) {
+    return QuizQuestionToJSONTyped(json, false);
+}
+export function QuizQuestionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'quizId': value['quizId'],
+        'conceptId': value['conceptId'],
+        'ordinal': value['ordinal'],
+        'type': value['type'],
+        'question': value['question'],
+        'options': value['options'],
+        'correctAnswer': value['correctAnswer'],
+        'explanation': value['explanation'],
+        'topic': value['topic'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,76 @@
+/**
+ * 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 QuizResponse
+ */
+export interface QuizResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    sessionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    questionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    userAnswer: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof QuizResponse
+     */
+    isCorrect?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizResponse
+     */
+    rating?: QuizResponseRatingEnum | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizResponse
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const QuizResponseRatingEnum: {
+    readonly WasRight: "was-right";
+    readonly NeedPractice: "need-practice";
+};
+export type QuizResponseRatingEnum = typeof QuizResponseRatingEnum[keyof typeof QuizResponseRatingEnum];
+/**
+ * Check if a given object implements the QuizResponse interface.
+ */
+export declare function instanceOfQuizResponse(value: object): value is QuizResponse;
+export declare function QuizResponseFromJSON(json: any): QuizResponse;
+export declare function QuizResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizResponse;
+export declare function QuizResponseToJSON(json: any): QuizResponse;
+export declare function QuizResponseToJSONTyped(value?: QuizResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizResponse.js

@@ -0,0 +1,70 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const QuizResponseRatingEnum = {
+    WasRight: 'was-right',
+    NeedPractice: 'need-practice'
+};
+/**
+ * Check if a given object implements the QuizResponse interface.
+ */
+export function instanceOfQuizResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('sessionId' in value) || value['sessionId'] === undefined)
+        return false;
+    if (!('questionId' in value) || value['questionId'] === undefined)
+        return false;
+    if (!('userAnswer' in value) || value['userAnswer'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function QuizResponseFromJSON(json) {
+    return QuizResponseFromJSONTyped(json, false);
+}
+export function QuizResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'sessionId': json['sessionId'],
+        'questionId': json['questionId'],
+        'userAnswer': json['userAnswer'],
+        'isCorrect': json['isCorrect'] == null ? undefined : json['isCorrect'],
+        'rating': json['rating'] == null ? undefined : json['rating'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function QuizResponseToJSON(json) {
+    return QuizResponseToJSONTyped(json, false);
+}
+export function QuizResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'sessionId': value['sessionId'],
+        'questionId': value['questionId'],
+        'userAnswer': value['userAnswer'],
+        'isCorrect': value['isCorrect'],
+        'rating': value['rating'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,71 @@
+/**
+ * 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 QuizSession
+ */
+export interface QuizSession {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    quizId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSession
+     */
+    status: QuizSessionStatusEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSession
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof QuizSession
+     */
+    completedAt?: Date | null;
+}
+/**
+ * @export
+ */
+export declare const QuizSessionStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type QuizSessionStatusEnum = typeof QuizSessionStatusEnum[keyof typeof QuizSessionStatusEnum];
+/**
+ * Check if a given object implements the QuizSession interface.
+ */
+export declare function instanceOfQuizSession(value: object): value is QuizSession;
+export declare function QuizSessionFromJSON(json: any): QuizSession;
+export declare function QuizSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSession;
+export declare function QuizSessionToJSON(json: any): QuizSession;
+export declare function QuizSessionToJSONTyped(value?: QuizSession | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/QuizSession.js

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const QuizSessionStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the QuizSession interface.
+ */
+export 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;
+}
+export function QuizSessionFromJSON(json) {
+    return QuizSessionFromJSONTyped(json, false);
+}
+export 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'])),
+    };
+}
+export function QuizSessionToJSON(json) {
+    return QuizSessionToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/QuizSessionSummary.js

@@ -0,0 +1,64 @@
+/* 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 { QuizSessionSummaryScoreFromJSON, QuizSessionSummaryScoreToJSON, } from './QuizSessionSummaryScore';
+import { QuizFromJSON, QuizToJSON, } from './Quiz';
+import { QuizSessionFromJSON, QuizSessionToJSON, } from './QuizSession';
+import { QuizQuestionFromJSON, QuizQuestionToJSON, } from './QuizQuestion';
+import { QuizResponseFromJSON, QuizResponseToJSON, } from './QuizResponse';
+/**
+ * Check if a given object implements the QuizSessionSummary interface.
+ */
+export 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;
+}
+export function QuizSessionSummaryFromJSON(json) {
+    return QuizSessionSummaryFromJSONTyped(json, false);
+}
+export function QuizSessionSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'session': QuizSessionFromJSON(json['session']),
+        'quiz': QuizFromJSON(json['quiz']),
+        'questions': (json['questions'].map(QuizQuestionFromJSON)),
+        'responses': (json['responses'].map(QuizResponseFromJSON)),
+        'score': QuizSessionSummaryScoreFromJSON(json['score']),
+    };
+}
+export function QuizSessionSummaryToJSON(json) {
+    return QuizSessionSummaryToJSONTyped(json, false);
+}
+export function QuizSessionSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'session': QuizSessionToJSON(value['session']),
+        'quiz': QuizToJSON(value['quiz']),
+        'questions': (value['questions'].map(QuizQuestionToJSON)),
+        'responses': (value['responses'].map(QuizResponseToJSON)),
+        'score': QuizSessionSummaryScoreToJSON(value['score']),
+    };
+}

package/dist/esm/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;