@easyedu/js-lsm-api 1.91.0 → 1.92.0

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'],
+    };
+}
+

package/src/models/PostLibraryQuiz.ts

@@ -0,0 +1,173 @@
+/* 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 { QuestionSelectionMethod } from './QuestionSelectionMethod';
+import {
+    QuestionSelectionMethodFromJSON,
+    QuestionSelectionMethodFromJSONTyped,
+    QuestionSelectionMethodToJSON,
+    QuestionSelectionMethodToJSONTyped,
+} from './QuestionSelectionMethod';
+
+/**
+ * 
+ * @export
+ * @interface PostLibraryQuiz
+ */
+export interface PostLibraryQuiz {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostLibraryQuiz
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostLibraryQuiz
+     */
+    description?: string;
+    /**
+     * 
+     * @type {QuestionSelectionMethod}
+     * @memberof PostLibraryQuiz
+     */
+    questionSelectionMethod: QuestionSelectionMethod;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostLibraryQuiz
+     */
+    maxQuestions?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostLibraryQuiz
+     */
+    passingScore?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostLibraryQuiz
+     */
+    timeLimitMinutes?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostLibraryQuiz
+     */
+    randomizeQuestions?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostLibraryQuiz
+     */
+    randomizeAnswers?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostLibraryQuiz
+     */
+    showResults?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostLibraryQuiz
+     */
+    showCorrectAnswers?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostLibraryQuiz
+     */
+    allowReview?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostLibraryQuiz
+     */
+    requireAllQuestions?: boolean;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof PostLibraryQuiz
+     */
+    settings?: { [key: string]: any; };
+}
+
+
+
+/**
+ * Check if a given object implements the PostLibraryQuiz interface.
+ */
+export function instanceOfPostLibraryQuiz(value: object): value is PostLibraryQuiz {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('questionSelectionMethod' in value) || value['questionSelectionMethod'] === undefined) return false;
+    return true;
+}
+
+export function PostLibraryQuizFromJSON(json: any): PostLibraryQuiz {
+    return PostLibraryQuizFromJSONTyped(json, false);
+}
+
+export function PostLibraryQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostLibraryQuiz {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'questionSelectionMethod': QuestionSelectionMethodFromJSON(json['question_selection_method']),
+        'maxQuestions': json['max_questions'] == null ? undefined : json['max_questions'],
+        'passingScore': json['passing_score'] == null ? undefined : json['passing_score'],
+        'timeLimitMinutes': json['time_limit_minutes'] == null ? undefined : json['time_limit_minutes'],
+        'randomizeQuestions': json['randomize_questions'] == null ? undefined : json['randomize_questions'],
+        'randomizeAnswers': json['randomize_answers'] == null ? undefined : json['randomize_answers'],
+        'showResults': json['show_results'] == null ? undefined : json['show_results'],
+        'showCorrectAnswers': json['show_correct_answers'] == null ? undefined : json['show_correct_answers'],
+        'allowReview': json['allow_review'] == null ? undefined : json['allow_review'],
+        'requireAllQuestions': json['require_all_questions'] == null ? undefined : json['require_all_questions'],
+        'settings': json['settings'] == null ? undefined : json['settings'],
+    };
+}
+
+export function PostLibraryQuizToJSON(json: any): PostLibraryQuiz {
+    return PostLibraryQuizToJSONTyped(json, false);
+}
+
+export function PostLibraryQuizToJSONTyped(value?: PostLibraryQuiz | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        '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'],
+    };
+}
+

package/src/models/PostLibraryQuizSession.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 PostLibraryQuizSession
+ */
+export interface PostLibraryQuizSession {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostLibraryQuizSession
+     */
+    restart?: boolean;
+}
+
+/**
+ * Check if a given object implements the PostLibraryQuizSession interface.
+ */
+export function instanceOfPostLibraryQuizSession(value: object): value is PostLibraryQuizSession {
+    return true;
+}
+
+export function PostLibraryQuizSessionFromJSON(json: any): PostLibraryQuizSession {
+    return PostLibraryQuizSessionFromJSONTyped(json, false);
+}
+
+export function PostLibraryQuizSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostLibraryQuizSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'restart': json['restart'] == null ? undefined : json['restart'],
+    };
+}
+
+export function PostLibraryQuizSessionToJSON(json: any): PostLibraryQuizSession {
+    return PostLibraryQuizSessionToJSONTyped(json, false);
+}
+
+export function PostLibraryQuizSessionToJSONTyped(value?: PostLibraryQuizSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'restart': value['restart'],
+    };
+}
+

package/src/models/PostLibraryQuizVersion.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 PostLibraryQuizVersion
+ */
+export interface PostLibraryQuizVersion {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostLibraryQuizVersion
+     */
+    changeNotes?: string;
+}
+
+/**
+ * Check if a given object implements the PostLibraryQuizVersion interface.
+ */
+export function instanceOfPostLibraryQuizVersion(value: object): value is PostLibraryQuizVersion {
+    return true;
+}
+
+export function PostLibraryQuizVersionFromJSON(json: any): PostLibraryQuizVersion {
+    return PostLibraryQuizVersionFromJSONTyped(json, false);
+}
+
+export function PostLibraryQuizVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostLibraryQuizVersion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+
+export function PostLibraryQuizVersionToJSON(json: any): PostLibraryQuizVersion {
+    return PostLibraryQuizVersionToJSONTyped(json, false);
+}
+
+export function PostLibraryQuizVersionToJSONTyped(value?: PostLibraryQuizVersion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'change_notes': value['changeNotes'],
+    };
+}
+

package/src/models/PutLibraryQuiz.ts

@@ -0,0 +1,73 @@
+/* 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 PutLibraryQuiz
+ */
+export interface PutLibraryQuiz {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutLibraryQuiz
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutLibraryQuiz
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the PutLibraryQuiz interface.
+ */
+export function instanceOfPutLibraryQuiz(value: object): value is PutLibraryQuiz {
+    return true;
+}
+
+export function PutLibraryQuizFromJSON(json: any): PutLibraryQuiz {
+    return PutLibraryQuizFromJSONTyped(json, false);
+}
+
+export function PutLibraryQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutLibraryQuiz {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function PutLibraryQuizToJSON(json: any): PutLibraryQuiz {
+    return PutLibraryQuizToJSONTyped(json, false);
+}
+
+export function PutLibraryQuizToJSONTyped(value?: PutLibraryQuiz | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+    };
+}
+