@easyedu/js-lsm-api 1.82.0 → 1.83.0

package/src/models/PutQuizAnswerResponse.ts

@@ -0,0 +1,146 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 { mapValues } from '../runtime';
+import type { PutQuizAnswerResponseProgress } from './PutQuizAnswerResponseProgress';
+import {
+    PutQuizAnswerResponseProgressFromJSON,
+    PutQuizAnswerResponseProgressFromJSONTyped,
+    PutQuizAnswerResponseProgressToJSON,
+    PutQuizAnswerResponseProgressToJSONTyped,
+} from './PutQuizAnswerResponseProgress';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+import type { PutQuizAnswerResponseNextQuestion } from './PutQuizAnswerResponseNextQuestion';
+import {
+    PutQuizAnswerResponseNextQuestionFromJSON,
+    PutQuizAnswerResponseNextQuestionFromJSONTyped,
+    PutQuizAnswerResponseNextQuestionToJSON,
+    PutQuizAnswerResponseNextQuestionToJSONTyped,
+} from './PutQuizAnswerResponseNextQuestion';
+
+/**
+ * 
+ * @export
+ * @interface PutQuizAnswerResponse
+ */
+export interface PutQuizAnswerResponse {
+    /**
+     * Whether the answer was saved
+     * @type {boolean}
+     * @memberof PutQuizAnswerResponse
+     */
+    success: boolean;
+    /**
+     * Question ID that was answered
+     * @type {number}
+     * @memberof PutQuizAnswerResponse
+     */
+    questionId: number;
+    /**
+     * Immediate correctness feedback when review is disabled
+     * @type {boolean}
+     * @memberof PutQuizAnswerResponse
+     */
+    isCorrect?: boolean;
+    /**
+     * Immediate points earned when review is disabled
+     * @type {number}
+     * @memberof PutQuizAnswerResponse
+     */
+    pointsEarned?: number;
+    /**
+     * Plain-text explanation when immediate feedback is enabled
+     * @type {string}
+     * @memberof PutQuizAnswerResponse
+     */
+    explanation?: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof PutQuizAnswerResponse
+     */
+    explanationRich?: RichTextDocument;
+    /**
+     * 
+     * @type {PutQuizAnswerResponseNextQuestion}
+     * @memberof PutQuizAnswerResponse
+     */
+    nextQuestion?: PutQuizAnswerResponseNextQuestion;
+    /**
+     * 
+     * @type {PutQuizAnswerResponseProgress}
+     * @memberof PutQuizAnswerResponse
+     */
+    progress: PutQuizAnswerResponseProgress;
+}
+
+/**
+ * Check if a given object implements the PutQuizAnswerResponse interface.
+ */
+export function instanceOfPutQuizAnswerResponse(value: object): value is PutQuizAnswerResponse {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('questionId' in value) || value['questionId'] === undefined) return false;
+    if (!('progress' in value) || value['progress'] === undefined) return false;
+    return true;
+}
+
+export function PutQuizAnswerResponseFromJSON(json: any): PutQuizAnswerResponse {
+    return PutQuizAnswerResponseFromJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutQuizAnswerResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'questionId': json['question_id'],
+        'isCorrect': json['is_correct'] == null ? undefined : json['is_correct'],
+        'pointsEarned': json['points_earned'] == null ? undefined : json['points_earned'],
+        'explanation': json['explanation'] == null ? undefined : json['explanation'],
+        'explanationRich': json['explanation_rich'] == null ? undefined : RichTextDocumentFromJSON(json['explanation_rich']),
+        'nextQuestion': json['next_question'] == null ? undefined : PutQuizAnswerResponseNextQuestionFromJSON(json['next_question']),
+        'progress': PutQuizAnswerResponseProgressFromJSON(json['progress']),
+    };
+}
+
+export function PutQuizAnswerResponseToJSON(json: any): PutQuizAnswerResponse {
+    return PutQuizAnswerResponseToJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseToJSONTyped(value?: PutQuizAnswerResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'question_id': value['questionId'],
+        'is_correct': value['isCorrect'],
+        'points_earned': value['pointsEarned'],
+        'explanation': value['explanation'],
+        'explanation_rich': RichTextDocumentToJSON(value['explanationRich']),
+        'next_question': PutQuizAnswerResponseNextQuestionToJSON(value['nextQuestion']),
+        'progress': PutQuizAnswerResponseProgressToJSON(value['progress']),
+    };
+}
+

package/src/models/PutQuizAnswerResponseNextQuestion.ts

@@ -0,0 +1,175 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+import type { PutQuizAnswerResponseNextQuestionAnswerChoicesInner } from './PutQuizAnswerResponseNextQuestionAnswerChoicesInner';
+import {
+    PutQuizAnswerResponseNextQuestionAnswerChoicesInnerFromJSON,
+    PutQuizAnswerResponseNextQuestionAnswerChoicesInnerFromJSONTyped,
+    PutQuizAnswerResponseNextQuestionAnswerChoicesInnerToJSON,
+    PutQuizAnswerResponseNextQuestionAnswerChoicesInnerToJSONTyped,
+} from './PutQuizAnswerResponseNextQuestionAnswerChoicesInner';
+
+/**
+ * 
+ * @export
+ * @interface PutQuizAnswerResponseNextQuestion
+ */
+export interface PutQuizAnswerResponseNextQuestion {
+    /**
+     * Attempt question ID
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    id: number;
+    /**
+     * Original question ID
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionId: number;
+    /**
+     * Order of question in this attempt
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionOrder: number;
+    /**
+     * Points assigned to this question
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    points: number;
+    /**
+     * Question text
+     * @type {string}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionText: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionTextRich?: RichTextDocument;
+    /**
+     * 
+     * @type {PutQuizAnswerResponseNextQuestionQuestionTypeEnum}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    questionType: PutQuizAnswerResponseNextQuestionQuestionTypeEnum;
+    /**
+     * 
+     * @type {Array<PutQuizAnswerResponseNextQuestionAnswerChoicesInner>}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    answerChoices: Array<PutQuizAnswerResponseNextQuestionAnswerChoicesInner>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    isAnswered: boolean;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof PutQuizAnswerResponseNextQuestion
+     */
+    userAnswer?: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const PutQuizAnswerResponseNextQuestionQuestionTypeEnum = {
+    SingleAnswer: 'single_answer',
+    MultipleAnswer: 'multiple_answer',
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
+} as const;
+export type PutQuizAnswerResponseNextQuestionQuestionTypeEnum = typeof PutQuizAnswerResponseNextQuestionQuestionTypeEnum[keyof typeof PutQuizAnswerResponseNextQuestionQuestionTypeEnum];
+
+
+/**
+ * Check if a given object implements the PutQuizAnswerResponseNextQuestion interface.
+ */
+export function instanceOfPutQuizAnswerResponseNextQuestion(value: object): value is PutQuizAnswerResponseNextQuestion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('questionId' in value) || value['questionId'] === undefined) return false;
+    if (!('questionOrder' in value) || value['questionOrder'] === undefined) return false;
+    if (!('points' in value) || value['points'] === undefined) return false;
+    if (!('questionText' in value) || value['questionText'] === undefined) return false;
+    if (!('questionType' in value) || value['questionType'] === undefined) return false;
+    if (!('answerChoices' in value) || value['answerChoices'] === undefined) return false;
+    if (!('isAnswered' in value) || value['isAnswered'] === undefined) return false;
+    return true;
+}
+
+export function PutQuizAnswerResponseNextQuestionFromJSON(json: any): PutQuizAnswerResponseNextQuestion {
+    return PutQuizAnswerResponseNextQuestionFromJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseNextQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutQuizAnswerResponseNextQuestion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'questionId': json['question_id'],
+        'questionOrder': json['question_order'],
+        'points': json['points'],
+        'questionText': json['question_text'],
+        'questionTextRich': json['question_text_rich'] == null ? undefined : RichTextDocumentFromJSON(json['question_text_rich']),
+        'questionType': json['question_type'],
+        'answerChoices': ((json['answer_choices'] as Array<any>).map(PutQuizAnswerResponseNextQuestionAnswerChoicesInnerFromJSON)),
+        'isAnswered': json['is_answered'],
+        'userAnswer': json['user_answer'] == null ? undefined : json['user_answer'],
+    };
+}
+
+export function PutQuizAnswerResponseNextQuestionToJSON(json: any): PutQuizAnswerResponseNextQuestion {
+    return PutQuizAnswerResponseNextQuestionToJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseNextQuestionToJSONTyped(value?: PutQuizAnswerResponseNextQuestion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'question_id': value['questionId'],
+        'question_order': value['questionOrder'],
+        'points': value['points'],
+        'question_text': value['questionText'],
+        'question_text_rich': RichTextDocumentToJSON(value['questionTextRich']),
+        'question_type': value['questionType'],
+        'answer_choices': ((value['answerChoices'] as Array<any>).map(PutQuizAnswerResponseNextQuestionAnswerChoicesInnerToJSON)),
+        'is_answered': value['isAnswered'],
+        'user_answer': value['userAnswer'],
+    };
+}
+

package/src/models/PutQuizAnswerResponseNextQuestionAnswerChoicesInner.ts

@@ -0,0 +1,100 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
+/**
+ * 
+ * @export
+ * @interface PutQuizAnswerResponseNextQuestionAnswerChoicesInner
+ */
+export interface PutQuizAnswerResponseNextQuestionAnswerChoicesInner {
+    /**
+     * 
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestionAnswerChoicesInner
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutQuizAnswerResponseNextQuestionAnswerChoicesInner
+     */
+    text: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof PutQuizAnswerResponseNextQuestionAnswerChoicesInner
+     */
+    textRich?: RichTextDocument;
+    /**
+     * 
+     * @type {number}
+     * @memberof PutQuizAnswerResponseNextQuestionAnswerChoicesInner
+     */
+    displayOrder: number;
+}
+
+/**
+ * Check if a given object implements the PutQuizAnswerResponseNextQuestionAnswerChoicesInner interface.
+ */
+export function instanceOfPutQuizAnswerResponseNextQuestionAnswerChoicesInner(value: object): value is PutQuizAnswerResponseNextQuestionAnswerChoicesInner {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('text' in value) || value['text'] === undefined) return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    return true;
+}
+
+export function PutQuizAnswerResponseNextQuestionAnswerChoicesInnerFromJSON(json: any): PutQuizAnswerResponseNextQuestionAnswerChoicesInner {
+    return PutQuizAnswerResponseNextQuestionAnswerChoicesInnerFromJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseNextQuestionAnswerChoicesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutQuizAnswerResponseNextQuestionAnswerChoicesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'text': json['text'],
+        'textRich': json['text_rich'] == null ? undefined : RichTextDocumentFromJSON(json['text_rich']),
+        'displayOrder': json['display_order'],
+    };
+}
+
+export function PutQuizAnswerResponseNextQuestionAnswerChoicesInnerToJSON(json: any): PutQuizAnswerResponseNextQuestionAnswerChoicesInner {
+    return PutQuizAnswerResponseNextQuestionAnswerChoicesInnerToJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseNextQuestionAnswerChoicesInnerToJSONTyped(value?: PutQuizAnswerResponseNextQuestionAnswerChoicesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'text': value['text'],
+        'text_rich': RichTextDocumentToJSON(value['textRich']),
+        'display_order': value['displayOrder'],
+    };
+}
+

package/src/models/PutQuizAnswerResponseProgress.ts

@@ -0,0 +1,93 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PutQuizAnswerResponseProgress
+ */
+export interface PutQuizAnswerResponseProgress {
+    /**
+     * 
+     * @type {number}
+     * @memberof PutQuizAnswerResponseProgress
+     */
+    totalQuestions: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PutQuizAnswerResponseProgress
+     */
+    questionsAnswered: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PutQuizAnswerResponseProgress
+     */
+    currentQuestionNumber: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutQuizAnswerResponseProgress
+     */
+    canSubmit: boolean;
+}
+
+/**
+ * Check if a given object implements the PutQuizAnswerResponseProgress interface.
+ */
+export function instanceOfPutQuizAnswerResponseProgress(value: object): value is PutQuizAnswerResponseProgress {
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined) return false;
+    if (!('questionsAnswered' in value) || value['questionsAnswered'] === undefined) return false;
+    if (!('currentQuestionNumber' in value) || value['currentQuestionNumber'] === undefined) return false;
+    if (!('canSubmit' in value) || value['canSubmit'] === undefined) return false;
+    return true;
+}
+
+export function PutQuizAnswerResponseProgressFromJSON(json: any): PutQuizAnswerResponseProgress {
+    return PutQuizAnswerResponseProgressFromJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutQuizAnswerResponseProgress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'totalQuestions': json['total_questions'],
+        'questionsAnswered': json['questions_answered'],
+        'currentQuestionNumber': json['current_question_number'],
+        'canSubmit': json['can_submit'],
+    };
+}
+
+export function PutQuizAnswerResponseProgressToJSON(json: any): PutQuizAnswerResponseProgress {
+    return PutQuizAnswerResponseProgressToJSONTyped(json, false);
+}
+
+export function PutQuizAnswerResponseProgressToJSONTyped(value?: PutQuizAnswerResponseProgress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'total_questions': value['totalQuestions'],
+        'questions_answered': value['questionsAnswered'],
+        'current_question_number': value['currentQuestionNumber'],
+        'can_submit': value['canSubmit'],
+    };
+}
+

package/src/models/index.ts

@@ -267,6 +267,10 @@ export * from './PutQuiz';
 export * from './PutQuizAnswer';
 export * from './PutQuizAnswerAnswer';
 export * from './PutQuizAnswerGrade';
+export * from './PutQuizAnswerResponse';
+export * from './PutQuizAnswerResponseNextQuestion';
+export * from './PutQuizAnswerResponseNextQuestionAnswerChoicesInner';
+export * from './PutQuizAnswerResponseProgress';
 export * from './PutQuizSettings';
 export * from './PutRole';
 export * from './PutRolePermissions';