@easyedu/js-lsm-api 1.92.0 → 1.94.0

package/src/models/GetQuestion.ts

@@ -101,6 +101,12 @@ export interface GetQuestion {
      * @memberof GetQuestion
      */
     version?: string;
+    /**
+     * Canonical numeric version within the question's version history
+     * @type {number}
+     * @memberof GetQuestion
+     */
+    readonly versionNumber: number;
     /**
      * When the question was created
      * @type {Date}
@@ -167,6 +173,7 @@ export function instanceOfGetQuestion(value: object): value is GetQuestion {
     if (!('questionType' in value) || value['questionType'] === undefined) return false;
     if (!('topic' in value) || value['topic'] === undefined) return false;
     if (!('difficultyLevel' in value) || value['difficultyLevel'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
     if (!('createdDate' in value) || value['createdDate'] === undefined) return false;
     if (!('updatedDate' in value) || value['updatedDate'] === undefined) return false;
     return true;
@@ -192,6 +199,7 @@ export function GetQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'difficultyLevel': json['difficulty_level'],
         'tags': json['tags'] == null ? undefined : json['tags'],
         'version': json['version'] == null ? undefined : json['version'],
+        'versionNumber': json['version_number'],
         'createdDate': (new Date(json['created_date'])),
         'updatedDate': (new Date(json['updated_date'])),
         'createdBy': json['created_by'] == null ? undefined : json['created_by'],
@@ -204,7 +212,7 @@ export function GetQuestionToJSON(json: any): GetQuestion {
     return GetQuestionToJSONTyped(json, false);
 }
 
-export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'created_date'|'updated_date'|'created_by'|'quiz_count'|'quizzes'> | null, ignoreDiscriminator: boolean = false): any {
+export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'version_number'|'created_date'|'updated_date'|'created_by'|'quiz_count'|'quizzes'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }

package/src/models/LibraryQuizCriteriaPreviewQuestion.ts

@@ -0,0 +1,161 @@
+/* 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 LibraryQuizCriteriaPreviewQuestion
+ */
+export interface LibraryQuizCriteriaPreviewQuestion {
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    id: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    questionText: RichTextDocument;
+    /**
+     * 
+     * @type {LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    questionType: LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    versionNumber: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    version?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    topic: string;
+    /**
+     * 
+     * @type {LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    difficultyLevel: LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof LibraryQuizCriteriaPreviewQuestion
+     */
+    tags: Array<string>;
+}
+
+
+/**
+ * @export
+ */
+export const LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum = {
+    SingleAnswer: 'single_answer',
+    MultipleAnswer: 'multiple_answer',
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
+} as const;
+export type LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum = typeof LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum[keyof typeof LibraryQuizCriteriaPreviewQuestionQuestionTypeEnum];
+
+/**
+ * @export
+ */
+export const LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum = {
+    Beginner: 'beginner',
+    Intermediate: 'intermediate',
+    Advanced: 'advanced'
+} as const;
+export type LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum = typeof LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum[keyof typeof LibraryQuizCriteriaPreviewQuestionDifficultyLevelEnum];
+
+
+/**
+ * Check if a given object implements the LibraryQuizCriteriaPreviewQuestion interface.
+ */
+export function instanceOfLibraryQuizCriteriaPreviewQuestion(value: object): value is LibraryQuizCriteriaPreviewQuestion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('questionText' in value) || value['questionText'] === undefined) return false;
+    if (!('questionType' in value) || value['questionType'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('topic' in value) || value['topic'] === undefined) return false;
+    if (!('difficultyLevel' in value) || value['difficultyLevel'] === undefined) return false;
+    if (!('tags' in value) || value['tags'] === undefined) return false;
+    return true;
+}
+
+export function LibraryQuizCriteriaPreviewQuestionFromJSON(json: any): LibraryQuizCriteriaPreviewQuestion {
+    return LibraryQuizCriteriaPreviewQuestionFromJSONTyped(json, false);
+}
+
+export function LibraryQuizCriteriaPreviewQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizCriteriaPreviewQuestion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'questionText': RichTextDocumentFromJSON(json['question_text']),
+        'questionType': json['question_type'],
+        'versionNumber': json['version_number'],
+        'version': json['version'] == null ? undefined : json['version'],
+        'topic': json['topic'],
+        'difficultyLevel': json['difficulty_level'],
+        'tags': json['tags'],
+    };
+}
+
+export function LibraryQuizCriteriaPreviewQuestionToJSON(json: any): LibraryQuizCriteriaPreviewQuestion {
+    return LibraryQuizCriteriaPreviewQuestionToJSONTyped(json, false);
+}
+
+export function LibraryQuizCriteriaPreviewQuestionToJSONTyped(value?: LibraryQuizCriteriaPreviewQuestion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'question_text': RichTextDocumentToJSON(value['questionText']),
+        'question_type': value['questionType'],
+        'version_number': value['versionNumber'],
+        'version': value['version'],
+        'topic': value['topic'],
+        'difficulty_level': value['difficultyLevel'],
+        'tags': value['tags'],
+    };
+}
+

package/src/models/LibraryQuizCriterionPreview.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';
+import type { LibraryQuizCriteriaPreviewQuestion } from './LibraryQuizCriteriaPreviewQuestion';
+import {
+    LibraryQuizCriteriaPreviewQuestionFromJSON,
+    LibraryQuizCriteriaPreviewQuestionFromJSONTyped,
+    LibraryQuizCriteriaPreviewQuestionToJSON,
+    LibraryQuizCriteriaPreviewQuestionToJSONTyped,
+} from './LibraryQuizCriteriaPreviewQuestion';
+
+/**
+ * 
+ * @export
+ * @interface LibraryQuizCriterionPreview
+ */
+export interface LibraryQuizCriterionPreview {
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    priority: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    matchingQuestionCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    minimumQuestions: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    maximumQuestions?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    minimumSatisfied: boolean;
+    /**
+     * 
+     * @type {Array<LibraryQuizCriteriaPreviewQuestion>}
+     * @memberof LibraryQuizCriterionPreview
+     */
+    questions: Array<LibraryQuizCriteriaPreviewQuestion>;
+}
+
+/**
+ * Check if a given object implements the LibraryQuizCriterionPreview interface.
+ */
+export function instanceOfLibraryQuizCriterionPreview(value: object): value is LibraryQuizCriterionPreview {
+    if (!('priority' in value) || value['priority'] === undefined) return false;
+    if (!('matchingQuestionCount' in value) || value['matchingQuestionCount'] === undefined) return false;
+    if (!('minimumQuestions' in value) || value['minimumQuestions'] === undefined) return false;
+    if (!('minimumSatisfied' in value) || value['minimumSatisfied'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === undefined) return false;
+    return true;
+}
+
+export function LibraryQuizCriterionPreviewFromJSON(json: any): LibraryQuizCriterionPreview {
+    return LibraryQuizCriterionPreviewFromJSONTyped(json, false);
+}
+
+export function LibraryQuizCriterionPreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizCriterionPreview {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'priority': json['priority'],
+        'matchingQuestionCount': json['matching_question_count'],
+        'minimumQuestions': json['minimum_questions'],
+        'maximumQuestions': json['maximum_questions'] == null ? undefined : json['maximum_questions'],
+        'minimumSatisfied': json['minimum_satisfied'],
+        'questions': ((json['questions'] as Array<any>).map(LibraryQuizCriteriaPreviewQuestionFromJSON)),
+    };
+}
+
+export function LibraryQuizCriterionPreviewToJSON(json: any): LibraryQuizCriterionPreview {
+    return LibraryQuizCriterionPreviewToJSONTyped(json, false);
+}
+
+export function LibraryQuizCriterionPreviewToJSONTyped(value?: LibraryQuizCriterionPreview | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'priority': value['priority'],
+        'matching_question_count': value['matchingQuestionCount'],
+        'minimum_questions': value['minimumQuestions'],
+        'maximum_questions': value['maximumQuestions'],
+        'minimum_satisfied': value['minimumSatisfied'],
+        'questions': ((value['questions'] as Array<any>).map(LibraryQuizCriteriaPreviewQuestionToJSON)),
+    };
+}
+

package/src/models/LibraryQuizQuestion.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
 /**
  * 
  * @export
@@ -37,6 +45,36 @@ export interface LibraryQuizQuestion {
      * @memberof LibraryQuizQuestion
      */
     questionGroupId?: string | null;
+    /**
+     * Exact question version currently represented by this quiz selection
+     * @type {string}
+     * @memberof LibraryQuizQuestion
+     */
+    effectiveQuestionId: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof LibraryQuizQuestion
+     */
+    questionText: RichTextDocument;
+    /**
+     * 
+     * @type {LibraryQuizQuestionQuestionTypeEnum}
+     * @memberof LibraryQuizQuestion
+     */
+    questionType: LibraryQuizQuestionQuestionTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizQuestion
+     */
+    questionVersionNumber: number;
+    /**
+     * Optional human-readable identifier for the represented question version
+     * @type {string}
+     * @memberof LibraryQuizQuestion
+     */
+    questionVersion?: string | null;
     /**
      * 
      * @type {number}
@@ -63,12 +101,31 @@ export interface LibraryQuizQuestion {
     snapshot?: { [key: string]: any; } | null;
 }
 
+
+/**
+ * @export
+ */
+export const LibraryQuizQuestionQuestionTypeEnum = {
+    SingleAnswer: 'single_answer',
+    MultipleAnswer: 'multiple_answer',
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
+} as const;
+export type LibraryQuizQuestionQuestionTypeEnum = typeof LibraryQuizQuestionQuestionTypeEnum[keyof typeof LibraryQuizQuestionQuestionTypeEnum];
+
+
 /**
  * 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 (!('effectiveQuestionId' in value) || value['effectiveQuestionId'] === undefined) return false;
+    if (!('questionText' in value) || value['questionText'] === undefined) return false;
+    if (!('questionType' in value) || value['questionType'] === undefined) return false;
+    if (!('questionVersionNumber' in value) || value['questionVersionNumber'] === 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;
@@ -88,6 +145,11 @@ export function LibraryQuizQuestionFromJSONTyped(json: any, ignoreDiscriminator:
         'id': json['id'],
         'questionId': json['question_id'],
         'questionGroupId': json['question_group_id'] == null ? undefined : json['question_group_id'],
+        'effectiveQuestionId': json['effective_question_id'],
+        'questionText': RichTextDocumentFromJSON(json['question_text']),
+        'questionType': json['question_type'],
+        'questionVersionNumber': json['question_version_number'],
+        'questionVersion': json['question_version'] == null ? undefined : json['question_version'],
         'displayOrder': json['display_order'],
         'points': json['points'],
         'versionLocked': json['version_locked'],
@@ -109,6 +171,11 @@ export function LibraryQuizQuestionToJSONTyped(value?: LibraryQuizQuestion | nul
         'id': value['id'],
         'question_id': value['questionId'],
         'question_group_id': value['questionGroupId'],
+        'effective_question_id': value['effectiveQuestionId'],
+        'question_text': RichTextDocumentToJSON(value['questionText']),
+        'question_type': value['questionType'],
+        'question_version_number': value['questionVersionNumber'],
+        'question_version': value['questionVersion'],
         'display_order': value['displayOrder'],
         'points': value['points'],
         'version_locked': value['versionLocked'],

package/src/models/index.ts

@@ -104,6 +104,7 @@ export * from './GetEmailTemplateList';
 export * from './GetEmailTemplatePreview';
 export * from './GetLibraryQuiz';
 export * from './GetLibraryQuizAnalytics';
+export * from './GetLibraryQuizCriteriaPreview';
 export * from './GetLibraryQuizList';
 export * from './GetLibraryQuizResult';
 export * from './GetLibraryQuizSession';
@@ -232,7 +233,9 @@ export * from './GetUserQuizAttemptsAllOfAttempts';
 export * from './GetUserQuizAttemptsAllOfFilters';
 export * from './GetUserQuizAttemptsAllOfSummary';
 export * from './GetUserRole';
+export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
+export * from './LibraryQuizCriterionPreview';
 export * from './LibraryQuizQuestion';
 export * from './LibraryQuizQuestionInput';
 export * from './LibraryQuizSessionAnswerChoice';