@easyedu/js-lsm-api 1.90.0 → 1.92.0

package/src/models/LibraryQuizQuestion.ts

@@ -0,0 +1,118 @@
+/* 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 LibraryQuizQuestion
+ */
+export interface LibraryQuizQuestion {
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizQuestion
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizQuestion
+     */
+    questionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizQuestion
+     */
+    questionGroupId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizQuestion
+     */
+    displayOrder: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizQuestion
+     */
+    points: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof LibraryQuizQuestion
+     */
+    versionLocked: boolean;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof LibraryQuizQuestion
+     */
+    snapshot?: { [key: string]: any; } | null;
+}
+
+/**
+ * Check if a given object implements the LibraryQuizQuestion interface.
+ */
+export function instanceOfLibraryQuizQuestion(value: object): value is LibraryQuizQuestion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('questionId' in value) || value['questionId'] === undefined) return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    if (!('points' in value) || value['points'] === undefined) return false;
+    if (!('versionLocked' in value) || value['versionLocked'] === undefined) return false;
+    return true;
+}
+
+export function LibraryQuizQuestionFromJSON(json: any): LibraryQuizQuestion {
+    return LibraryQuizQuestionFromJSONTyped(json, false);
+}
+
+export function LibraryQuizQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizQuestion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'questionId': json['question_id'],
+        'questionGroupId': json['question_group_id'] == null ? undefined : json['question_group_id'],
+        'displayOrder': json['display_order'],
+        'points': json['points'],
+        'versionLocked': json['version_locked'],
+        'snapshot': json['snapshot'] == null ? undefined : json['snapshot'],
+    };
+}
+
+export function LibraryQuizQuestionToJSON(json: any): LibraryQuizQuestion {
+    return LibraryQuizQuestionToJSONTyped(json, false);
+}
+
+export function LibraryQuizQuestionToJSONTyped(value?: LibraryQuizQuestion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'question_id': value['questionId'],
+        'question_group_id': value['questionGroupId'],
+        'display_order': value['displayOrder'],
+        'points': value['points'],
+        'version_locked': value['versionLocked'],
+        'snapshot': value['snapshot'],
+    };
+}
+

package/src/models/LibraryQuizQuestionInput.ts

@@ -0,0 +1,91 @@
+/* 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 LibraryQuizQuestionInput
+ */
+export interface LibraryQuizQuestionInput {
+    /**
+     * External ID of the selected question version.
+     * @type {string}
+     * @memberof LibraryQuizQuestionInput
+     */
+    questionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizQuestionInput
+     */
+    displayOrder: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizQuestionInput
+     */
+    points?: number;
+    /**
+     * When false, publication resolves the latest question in the same version group.
+     * @type {boolean}
+     * @memberof LibraryQuizQuestionInput
+     */
+    versionLocked?: boolean;
+}
+
+/**
+ * Check if a given object implements the LibraryQuizQuestionInput interface.
+ */
+export function instanceOfLibraryQuizQuestionInput(value: object): value is LibraryQuizQuestionInput {
+    if (!('questionId' in value) || value['questionId'] === undefined) return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    return true;
+}
+
+export function LibraryQuizQuestionInputFromJSON(json: any): LibraryQuizQuestionInput {
+    return LibraryQuizQuestionInputFromJSONTyped(json, false);
+}
+
+export function LibraryQuizQuestionInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizQuestionInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'questionId': json['question_id'],
+        'displayOrder': json['display_order'],
+        'points': json['points'] == null ? undefined : json['points'],
+        'versionLocked': json['version_locked'] == null ? undefined : json['version_locked'],
+    };
+}
+
+export function LibraryQuizQuestionInputToJSON(json: any): LibraryQuizQuestionInput {
+    return LibraryQuizQuestionInputToJSONTyped(json, false);
+}
+
+export function LibraryQuizQuestionInputToJSONTyped(value?: LibraryQuizQuestionInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'question_id': value['questionId'],
+        'display_order': value['displayOrder'],
+        'points': value['points'],
+        'version_locked': value['versionLocked'],
+    };
+}
+

package/src/models/LibraryQuizSessionAnswerChoice.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 LibraryQuizSessionAnswerChoice
+ */
+export interface LibraryQuizSessionAnswerChoice {
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizSessionAnswerChoice
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizSessionAnswerChoice
+     */
+    text: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof LibraryQuizSessionAnswerChoice
+     */
+    textRich?: RichTextDocument | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizSessionAnswerChoice
+     */
+    displayOrder: number;
+}
+
+/**
+ * Check if a given object implements the LibraryQuizSessionAnswerChoice interface.
+ */
+export function instanceOfLibraryQuizSessionAnswerChoice(value: object): value is LibraryQuizSessionAnswerChoice {
+    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 LibraryQuizSessionAnswerChoiceFromJSON(json: any): LibraryQuizSessionAnswerChoice {
+    return LibraryQuizSessionAnswerChoiceFromJSONTyped(json, false);
+}
+
+export function LibraryQuizSessionAnswerChoiceFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizSessionAnswerChoice {
+    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 LibraryQuizSessionAnswerChoiceToJSON(json: any): LibraryQuizSessionAnswerChoice {
+    return LibraryQuizSessionAnswerChoiceToJSONTyped(json, false);
+}
+
+export function LibraryQuizSessionAnswerChoiceToJSONTyped(value?: LibraryQuizSessionAnswerChoice | 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/LibraryQuizSessionQuestion.ts

@@ -0,0 +1,166 @@
+/* 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 { LibraryQuizSessionAnswerChoice } from './LibraryQuizSessionAnswerChoice';
+import {
+    LibraryQuizSessionAnswerChoiceFromJSON,
+    LibraryQuizSessionAnswerChoiceFromJSONTyped,
+    LibraryQuizSessionAnswerChoiceToJSON,
+    LibraryQuizSessionAnswerChoiceToJSONTyped,
+} from './LibraryQuizSessionAnswerChoice';
+
+/**
+ * 
+ * @export
+ * @interface LibraryQuizSessionQuestion
+ */
+export interface LibraryQuizSessionQuestion {
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    displayOrder: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    points: number;
+    /**
+     * 
+     * @type {LibraryQuizSessionQuestionQuestionTypeEnum}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    questionType: LibraryQuizSessionQuestionQuestionTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    questionText: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    questionTextRich?: RichTextDocument | null;
+    /**
+     * 
+     * @type {Array<LibraryQuizSessionAnswerChoice>}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    answerChoices: Array<LibraryQuizSessionAnswerChoice>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    isAnswered: boolean;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof LibraryQuizSessionQuestion
+     */
+    answer?: { [key: string]: any; } | null;
+}
+
+
+/**
+ * @export
+ */
+export const LibraryQuizSessionQuestionQuestionTypeEnum = {
+    SingleAnswer: 'single_answer',
+    MultipleAnswer: 'multiple_answer',
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
+} as const;
+export type LibraryQuizSessionQuestionQuestionTypeEnum = typeof LibraryQuizSessionQuestionQuestionTypeEnum[keyof typeof LibraryQuizSessionQuestionQuestionTypeEnum];
+
+
+/**
+ * Check if a given object implements the LibraryQuizSessionQuestion interface.
+ */
+export function instanceOfLibraryQuizSessionQuestion(value: object): value is LibraryQuizSessionQuestion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    if (!('points' in value) || value['points'] === undefined) return false;
+    if (!('questionType' in value) || value['questionType'] === undefined) return false;
+    if (!('questionText' in value) || value['questionText'] === 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 LibraryQuizSessionQuestionFromJSON(json: any): LibraryQuizSessionQuestion {
+    return LibraryQuizSessionQuestionFromJSONTyped(json, false);
+}
+
+export function LibraryQuizSessionQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizSessionQuestion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'displayOrder': json['display_order'],
+        'points': json['points'],
+        'questionType': json['question_type'],
+        'questionText': json['question_text'],
+        'questionTextRich': json['question_text_rich'] == null ? undefined : RichTextDocumentFromJSON(json['question_text_rich']),
+        'answerChoices': ((json['answer_choices'] as Array<any>).map(LibraryQuizSessionAnswerChoiceFromJSON)),
+        'isAnswered': json['is_answered'],
+        'answer': json['answer'] == null ? undefined : json['answer'],
+    };
+}
+
+export function LibraryQuizSessionQuestionToJSON(json: any): LibraryQuizSessionQuestion {
+    return LibraryQuizSessionQuestionToJSONTyped(json, false);
+}
+
+export function LibraryQuizSessionQuestionToJSONTyped(value?: LibraryQuizSessionQuestion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'display_order': value['displayOrder'],
+        'points': value['points'],
+        'question_type': value['questionType'],
+        'question_text': value['questionText'],
+        'question_text_rich': RichTextDocumentToJSON(value['questionTextRich']),
+        'answer_choices': ((value['answerChoices'] as Array<any>).map(LibraryQuizSessionAnswerChoiceToJSON)),
+        'is_answered': value['isAnswered'],
+        'answer': value['answer'],
+    };
+}
+

package/src/models/PostCourseLibraryQuizSession.ts

@@ -0,0 +1,65 @@
+/* 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 PostCourseLibraryQuizSession
+ */
+export interface PostCourseLibraryQuizSession {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostCourseLibraryQuizSession
+     */
+    retake?: boolean;
+}
+
+/**
+ * Check if a given object implements the PostCourseLibraryQuizSession interface.
+ */
+export function instanceOfPostCourseLibraryQuizSession(value: object): value is PostCourseLibraryQuizSession {
+    return true;
+}
+
+export function PostCourseLibraryQuizSessionFromJSON(json: any): PostCourseLibraryQuizSession {
+    return PostCourseLibraryQuizSessionFromJSONTyped(json, false);
+}
+
+export function PostCourseLibraryQuizSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseLibraryQuizSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'retake': json['retake'] == null ? undefined : json['retake'],
+    };
+}
+
+export function PostCourseLibraryQuizSessionToJSON(json: any): PostCourseLibraryQuizSession {
+    return PostCourseLibraryQuizSessionToJSONTyped(json, false);
+}
+
+export function PostCourseLibraryQuizSessionToJSONTyped(value?: PostCourseLibraryQuizSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'retake': value['retake'],
+    };
+}
+