@easyedu/js-lsm-api 1.91.0 → 1.93.0

package/src/models/GetLibraryQuizVersion.ts

@@ -0,0 +1,290 @@
+/* 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 { LibraryQuizCriterion } from './LibraryQuizCriterion';
+import {
+    LibraryQuizCriterionFromJSON,
+    LibraryQuizCriterionFromJSONTyped,
+    LibraryQuizCriterionToJSON,
+    LibraryQuizCriterionToJSONTyped,
+} from './LibraryQuizCriterion';
+import type { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
+import {
+    ContentLibraryVersionStatusFromJSON,
+    ContentLibraryVersionStatusFromJSONTyped,
+    ContentLibraryVersionStatusToJSON,
+    ContentLibraryVersionStatusToJSONTyped,
+} from './ContentLibraryVersionStatus';
+import type { QuestionSelectionMethod } from './QuestionSelectionMethod';
+import {
+    QuestionSelectionMethodFromJSON,
+    QuestionSelectionMethodFromJSONTyped,
+    QuestionSelectionMethodToJSON,
+    QuestionSelectionMethodToJSONTyped,
+} from './QuestionSelectionMethod';
+import type { LibraryQuizQuestion } from './LibraryQuizQuestion';
+import {
+    LibraryQuizQuestionFromJSON,
+    LibraryQuizQuestionFromJSONTyped,
+    LibraryQuizQuestionToJSON,
+    LibraryQuizQuestionToJSONTyped,
+} from './LibraryQuizQuestion';
+
+/**
+ * 
+ * @export
+ * @interface GetLibraryQuizVersion
+ */
+export interface GetLibraryQuizVersion {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizVersion
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    versionNumber: number;
+    /**
+     * 
+     * @type {ContentLibraryVersionStatus}
+     * @memberof GetLibraryQuizVersion
+     */
+    status: ContentLibraryVersionStatus;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizVersion
+     */
+    changeNotes?: string | null;
+    /**
+     * 
+     * @type {QuestionSelectionMethod}
+     * @memberof GetLibraryQuizVersion
+     */
+    questionSelectionMethod: QuestionSelectionMethod;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    maxQuestions?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    passingScore: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    timeLimitMinutes?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizVersion
+     */
+    randomizeQuestions: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizVersion
+     */
+    randomizeAnswers: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizVersion
+     */
+    showResults: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizVersion
+     */
+    showCorrectAnswers: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizVersion
+     */
+    allowReview: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizVersion
+     */
+    requireAllQuestions: boolean;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof GetLibraryQuizVersion
+     */
+    settings: { [key: string]: any; };
+    /**
+     * 
+     * @type {Array<LibraryQuizQuestion>}
+     * @memberof GetLibraryQuizVersion
+     */
+    questions: Array<LibraryQuizQuestion>;
+    /**
+     * 
+     * @type {Array<LibraryQuizCriterion>}
+     * @memberof GetLibraryQuizVersion
+     */
+    criteria: Array<LibraryQuizCriterion>;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    questionCount: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizVersion
+     */
+    createdBy: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    publishedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizVersion
+     */
+    archivedAt?: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the GetLibraryQuizVersion interface.
+ */
+export function instanceOfGetLibraryQuizVersion(value: object): value is GetLibraryQuizVersion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('questionSelectionMethod' in value) || value['questionSelectionMethod'] === undefined) return false;
+    if (!('passingScore' in value) || value['passingScore'] === undefined) return false;
+    if (!('randomizeQuestions' in value) || value['randomizeQuestions'] === undefined) return false;
+    if (!('randomizeAnswers' in value) || value['randomizeAnswers'] === undefined) return false;
+    if (!('showResults' in value) || value['showResults'] === undefined) return false;
+    if (!('showCorrectAnswers' in value) || value['showCorrectAnswers'] === undefined) return false;
+    if (!('allowReview' in value) || value['allowReview'] === undefined) return false;
+    if (!('requireAllQuestions' in value) || value['requireAllQuestions'] === undefined) return false;
+    if (!('settings' in value) || value['settings'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === undefined) return false;
+    if (!('criteria' in value) || value['criteria'] === undefined) return false;
+    if (!('questionCount' in value) || value['questionCount'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function GetLibraryQuizVersionFromJSON(json: any): GetLibraryQuizVersion {
+    return GetLibraryQuizVersionFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizVersion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'versionNumber': json['version_number'],
+        'status': ContentLibraryVersionStatusFromJSON(json['status']),
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'questionSelectionMethod': QuestionSelectionMethodFromJSON(json['question_selection_method']),
+        'maxQuestions': json['max_questions'] == null ? undefined : json['max_questions'],
+        'passingScore': json['passing_score'],
+        'timeLimitMinutes': json['time_limit_minutes'] == null ? undefined : json['time_limit_minutes'],
+        'randomizeQuestions': json['randomize_questions'],
+        'randomizeAnswers': json['randomize_answers'],
+        'showResults': json['show_results'],
+        'showCorrectAnswers': json['show_correct_answers'],
+        'allowReview': json['allow_review'],
+        'requireAllQuestions': json['require_all_questions'],
+        'settings': json['settings'],
+        'questions': ((json['questions'] as Array<any>).map(LibraryQuizQuestionFromJSON)),
+        'criteria': ((json['criteria'] as Array<any>).map(LibraryQuizCriterionFromJSON)),
+        'questionCount': json['question_count'],
+        'createdBy': json['created_by'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
+        'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
+    };
+}
+
+export function GetLibraryQuizVersionToJSON(json: any): GetLibraryQuizVersion {
+    return GetLibraryQuizVersionToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizVersionToJSONTyped(value?: GetLibraryQuizVersion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'version_number': value['versionNumber'],
+        'status': ContentLibraryVersionStatusToJSON(value['status']),
+        'change_notes': value['changeNotes'],
+        'question_selection_method': QuestionSelectionMethodToJSON(value['questionSelectionMethod']),
+        'max_questions': value['maxQuestions'],
+        'passing_score': value['passingScore'],
+        'time_limit_minutes': value['timeLimitMinutes'],
+        'randomize_questions': value['randomizeQuestions'],
+        'randomize_answers': value['randomizeAnswers'],
+        'show_results': value['showResults'],
+        'show_correct_answers': value['showCorrectAnswers'],
+        'allow_review': value['allowReview'],
+        'require_all_questions': value['requireAllQuestions'],
+        'settings': value['settings'],
+        'questions': ((value['questions'] as Array<any>).map(LibraryQuizQuestionToJSON)),
+        'criteria': ((value['criteria'] as Array<any>).map(LibraryQuizCriterionToJSON)),
+        'question_count': value['questionCount'],
+        'created_by': value['createdBy'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'published_at': value['publishedAt'],
+        'archived_at': value['archivedAt'],
+    };
+}
+

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/LibraryQuizCriterion.ts

@@ -0,0 +1,147 @@
+/* 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 LibraryQuizCriterion
+ */
+export interface LibraryQuizCriterion {
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriterion
+     */
+    id?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizCriterion
+     */
+    topic?: string | null;
+    /**
+     * 
+     * @type {LibraryQuizCriterionDifficultyLevelEnum}
+     * @memberof LibraryQuizCriterion
+     */
+    difficultyLevel?: LibraryQuizCriterionDifficultyLevelEnum | null;
+    /**
+     * 
+     * @type {LibraryQuizCriterionQuestionTypeEnum}
+     * @memberof LibraryQuizCriterion
+     */
+    questionType?: LibraryQuizCriterionQuestionTypeEnum | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof LibraryQuizCriterion
+     */
+    tags?: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterion
+     */
+    minQuestions?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterion
+     */
+    maxQuestions?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof LibraryQuizCriterion
+     */
+    priority: number;
+}
+
+
+/**
+ * @export
+ */
+export const LibraryQuizCriterionDifficultyLevelEnum = {
+    Beginner: 'beginner',
+    Intermediate: 'intermediate',
+    Advanced: 'advanced'
+} as const;
+export type LibraryQuizCriterionDifficultyLevelEnum = typeof LibraryQuizCriterionDifficultyLevelEnum[keyof typeof LibraryQuizCriterionDifficultyLevelEnum];
+
+/**
+ * @export
+ */
+export const LibraryQuizCriterionQuestionTypeEnum = {
+    SingleAnswer: 'single_answer',
+    MultipleAnswer: 'multiple_answer',
+    FillInBlank: 'fill_in_blank',
+    ShortAnswer: 'short_answer',
+    Matching: 'matching',
+    Essay: 'essay'
+} as const;
+export type LibraryQuizCriterionQuestionTypeEnum = typeof LibraryQuizCriterionQuestionTypeEnum[keyof typeof LibraryQuizCriterionQuestionTypeEnum];
+
+
+/**
+ * Check if a given object implements the LibraryQuizCriterion interface.
+ */
+export function instanceOfLibraryQuizCriterion(value: object): value is LibraryQuizCriterion {
+    if (!('priority' in value) || value['priority'] === undefined) return false;
+    return true;
+}
+
+export function LibraryQuizCriterionFromJSON(json: any): LibraryQuizCriterion {
+    return LibraryQuizCriterionFromJSONTyped(json, false);
+}
+
+export function LibraryQuizCriterionFromJSONTyped(json: any, ignoreDiscriminator: boolean): LibraryQuizCriterion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'topic': json['topic'] == null ? undefined : json['topic'],
+        'difficultyLevel': json['difficulty_level'] == null ? undefined : json['difficulty_level'],
+        'questionType': json['question_type'] == null ? undefined : json['question_type'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'minQuestions': json['min_questions'] == null ? undefined : json['min_questions'],
+        'maxQuestions': json['max_questions'] == null ? undefined : json['max_questions'],
+        'priority': json['priority'],
+    };
+}
+
+export function LibraryQuizCriterionToJSON(json: any): LibraryQuizCriterion {
+    return LibraryQuizCriterionToJSONTyped(json, false);
+}
+
+export function LibraryQuizCriterionToJSONTyped(value?: LibraryQuizCriterion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'topic': value['topic'],
+        'difficulty_level': value['difficultyLevel'],
+        'question_type': value['questionType'],
+        'tags': value['tags'],
+        'min_questions': value['minQuestions'],
+        'max_questions': value['maxQuestions'],
+        'priority': value['priority'],
+    };
+}
+

package/src/models/LibraryQuizQuestion.ts

@@ -0,0 +1,185 @@
+/* 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 LibraryQuizQuestion
+ */
+export interface LibraryQuizQuestion {
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizQuestion
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LibraryQuizQuestion
+     */
+    questionId: string;
+    /**
+     * 
+     * @type {string}
+     * @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}
+     * @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;
+}
+
+
+/**
+ * @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;
+    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'],
+        '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'],
+        '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'],
+        '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'],
+        'snapshot': value['snapshot'],
+    };
+}
+