@easyedu/js-lsm-api 1.78.0 → 1.80.0

package/src/models/GetQuiz.ts

@@ -0,0 +1,228 @@
+/* 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 { GetQuizStatistics } from './GetQuizStatistics';
+import {
+    GetQuizStatisticsFromJSON,
+    GetQuizStatisticsFromJSONTyped,
+    GetQuizStatisticsToJSON,
+    GetQuizStatisticsToJSONTyped,
+} from './GetQuizStatistics';
+
+/**
+ * 
+ * @export
+ * @interface GetQuiz
+ */
+export interface GetQuiz {
+    /**
+     * Quiz configuration ID
+     * @type {string}
+     * @memberof GetQuiz
+     */
+    id: string;
+    /**
+     * External UUID for the quiz
+     * @type {string}
+     * @memberof GetQuiz
+     */
+    externalId: string;
+    /**
+     * ID of the content record this quiz belongs to
+     * @type {string}
+     * @memberof GetQuiz
+     */
+    contentId: string;
+    /**
+     * How questions are selected
+     * @type {GetQuizQuestionSelectionMethodEnum}
+     * @memberof GetQuiz
+     */
+    questionSelectionMethod: GetQuizQuestionSelectionMethodEnum;
+    /**
+     * Maximum questions to show (null for no limit)
+     * @type {number}
+     * @memberof GetQuiz
+     */
+    maxQuestions?: number;
+    /**
+     * Maximum attempts allowed per user
+     * @type {number}
+     * @memberof GetQuiz
+     */
+    maxAttempts: number;
+    /**
+     * Passing score percentage
+     * @type {number}
+     * @memberof GetQuiz
+     */
+    passingScore: number;
+    /**
+     * Time limit in minutes (null for no limit)
+     * @type {number}
+     * @memberof GetQuiz
+     */
+    timeLimitMinutes?: number;
+    /**
+     * Whether to randomize question order
+     * @type {boolean}
+     * @memberof GetQuiz
+     */
+    randomizeQuestions?: boolean;
+    /**
+     * Whether to randomize answer choices
+     * @type {boolean}
+     * @memberof GetQuiz
+     */
+    randomizeAnswers?: boolean;
+    /**
+     * Whether to show results after completion
+     * @type {boolean}
+     * @memberof GetQuiz
+     */
+    showResults?: boolean;
+    /**
+     * Whether to show correct answers in results
+     * @type {boolean}
+     * @memberof GetQuiz
+     */
+    showCorrectAnswers?: boolean;
+    /**
+     * Whether to allow reviewing before submission
+     * @type {boolean}
+     * @memberof GetQuiz
+     */
+    allowReview?: boolean;
+    /**
+     * Whether all questions must be answered
+     * @type {boolean}
+     * @memberof GetQuiz
+     */
+    requireAllQuestions?: boolean;
+    /**
+     * Additional quiz settings
+     * @type {object}
+     * @memberof GetQuiz
+     */
+    settings?: object;
+    /**
+     * 
+     * @type {GetQuizStatistics}
+     * @memberof GetQuiz
+     */
+    statistics?: GetQuizStatistics;
+    /**
+     * When the quiz was created
+     * @type {Date}
+     * @memberof GetQuiz
+     */
+    createdAt: Date;
+    /**
+     * When the quiz was last updated
+     * @type {Date}
+     * @memberof GetQuiz
+     */
+    updatedAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const GetQuizQuestionSelectionMethodEnum = {
+    Manual: 'manual',
+    CriteriaBased: 'criteria_based'
+} as const;
+export type GetQuizQuestionSelectionMethodEnum = typeof GetQuizQuestionSelectionMethodEnum[keyof typeof GetQuizQuestionSelectionMethodEnum];
+
+
+/**
+ * Check if a given object implements the GetQuiz interface.
+ */
+export function instanceOfGetQuiz(value: object): value is GetQuiz {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('externalId' in value) || value['externalId'] === undefined) return false;
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('questionSelectionMethod' in value) || value['questionSelectionMethod'] === undefined) return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
+    if (!('passingScore' in value) || value['passingScore'] === 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 GetQuizFromJSON(json: any): GetQuiz {
+    return GetQuizFromJSONTyped(json, false);
+}
+
+export function GetQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetQuiz {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'externalId': json['external_id'],
+        'contentId': json['content_id'],
+        'questionSelectionMethod': json['question_selection_method'],
+        'maxQuestions': json['max_questions'] == null ? undefined : json['max_questions'],
+        'maxAttempts': json['max_attempts'],
+        'passingScore': 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'],
+        'statistics': json['statistics'] == null ? undefined : GetQuizStatisticsFromJSON(json['statistics']),
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function GetQuizToJSON(json: any): GetQuiz {
+    return GetQuizToJSONTyped(json, false);
+}
+
+export function GetQuizToJSONTyped(value?: GetQuiz | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'external_id': value['externalId'],
+        'content_id': value['contentId'],
+        'question_selection_method': value['questionSelectionMethod'],
+        'max_questions': value['maxQuestions'],
+        'max_attempts': value['maxAttempts'],
+        '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'],
+        'statistics': GetQuizStatisticsToJSON(value['statistics']),
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+

package/src/models/GetQuizAttempt.ts

@@ -0,0 +1,106 @@
+/* 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 { GetQuizAttemptAttempt } from './GetQuizAttemptAttempt';
+import {
+    GetQuizAttemptAttemptFromJSON,
+    GetQuizAttemptAttemptFromJSONTyped,
+    GetQuizAttemptAttemptToJSON,
+    GetQuizAttemptAttemptToJSONTyped,
+} from './GetQuizAttemptAttempt';
+import type { GetQuizAttemptQuestionsInner } from './GetQuizAttemptQuestionsInner';
+import {
+    GetQuizAttemptQuestionsInnerFromJSON,
+    GetQuizAttemptQuestionsInnerFromJSONTyped,
+    GetQuizAttemptQuestionsInnerToJSON,
+    GetQuizAttemptQuestionsInnerToJSONTyped,
+} from './GetQuizAttemptQuestionsInner';
+import type { GetQuizAttemptQuizSettings } from './GetQuizAttemptQuizSettings';
+import {
+    GetQuizAttemptQuizSettingsFromJSON,
+    GetQuizAttemptQuizSettingsFromJSONTyped,
+    GetQuizAttemptQuizSettingsToJSON,
+    GetQuizAttemptQuizSettingsToJSONTyped,
+} from './GetQuizAttemptQuizSettings';
+
+/**
+ * 
+ * @export
+ * @interface GetQuizAttempt
+ */
+export interface GetQuizAttempt {
+    /**
+     * 
+     * @type {GetQuizAttemptAttempt}
+     * @memberof GetQuizAttempt
+     */
+    attempt: GetQuizAttemptAttempt;
+    /**
+     * Questions in this attempt with current answers
+     * @type {Array<GetQuizAttemptQuestionsInner>}
+     * @memberof GetQuizAttempt
+     */
+    questions: Array<GetQuizAttemptQuestionsInner>;
+    /**
+     * 
+     * @type {GetQuizAttemptQuizSettings}
+     * @memberof GetQuizAttempt
+     */
+    quizSettings: GetQuizAttemptQuizSettings;
+}
+
+/**
+ * Check if a given object implements the GetQuizAttempt interface.
+ */
+export function instanceOfGetQuizAttempt(value: object): value is GetQuizAttempt {
+    if (!('attempt' in value) || value['attempt'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === undefined) return false;
+    if (!('quizSettings' in value) || value['quizSettings'] === undefined) return false;
+    return true;
+}
+
+export function GetQuizAttemptFromJSON(json: any): GetQuizAttempt {
+    return GetQuizAttemptFromJSONTyped(json, false);
+}
+
+export function GetQuizAttemptFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetQuizAttempt {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'attempt': GetQuizAttemptAttemptFromJSON(json['attempt']),
+        'questions': ((json['questions'] as Array<any>).map(GetQuizAttemptQuestionsInnerFromJSON)),
+        'quizSettings': GetQuizAttemptQuizSettingsFromJSON(json['quiz_settings']),
+    };
+}
+
+export function GetQuizAttemptToJSON(json: any): GetQuizAttempt {
+    return GetQuizAttemptToJSONTyped(json, false);
+}
+
+export function GetQuizAttemptToJSONTyped(value?: GetQuizAttempt | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'attempt': GetQuizAttemptAttemptToJSON(value['attempt']),
+        'questions': ((value['questions'] as Array<any>).map(GetQuizAttemptQuestionsInnerToJSON)),
+        'quiz_settings': GetQuizAttemptQuizSettingsToJSON(value['quizSettings']),
+    };
+}
+

package/src/models/GetQuizAttemptAnalytics.ts

@@ -0,0 +1,149 @@
+/* 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 { GetQuizAttemptAnalyticsPerformanceBreakdown } from './GetQuizAttemptAnalyticsPerformanceBreakdown';
+import {
+    GetQuizAttemptAnalyticsPerformanceBreakdownFromJSON,
+    GetQuizAttemptAnalyticsPerformanceBreakdownFromJSONTyped,
+    GetQuizAttemptAnalyticsPerformanceBreakdownToJSON,
+    GetQuizAttemptAnalyticsPerformanceBreakdownToJSONTyped,
+} from './GetQuizAttemptAnalyticsPerformanceBreakdown';
+import type { GetQuizAttemptAnalyticsBasicInfo } from './GetQuizAttemptAnalyticsBasicInfo';
+import {
+    GetQuizAttemptAnalyticsBasicInfoFromJSON,
+    GetQuizAttemptAnalyticsBasicInfoFromJSONTyped,
+    GetQuizAttemptAnalyticsBasicInfoToJSON,
+    GetQuizAttemptAnalyticsBasicInfoToJSONTyped,
+} from './GetQuizAttemptAnalyticsBasicInfo';
+import type { GetQuizAttemptAnalyticsQuestionAnalysisInner } from './GetQuizAttemptAnalyticsQuestionAnalysisInner';
+import {
+    GetQuizAttemptAnalyticsQuestionAnalysisInnerFromJSON,
+    GetQuizAttemptAnalyticsQuestionAnalysisInnerFromJSONTyped,
+    GetQuizAttemptAnalyticsQuestionAnalysisInnerToJSON,
+    GetQuizAttemptAnalyticsQuestionAnalysisInnerToJSONTyped,
+} from './GetQuizAttemptAnalyticsQuestionAnalysisInner';
+import type { GetQuizAttemptAnalyticsScoring } from './GetQuizAttemptAnalyticsScoring';
+import {
+    GetQuizAttemptAnalyticsScoringFromJSON,
+    GetQuizAttemptAnalyticsScoringFromJSONTyped,
+    GetQuizAttemptAnalyticsScoringToJSON,
+    GetQuizAttemptAnalyticsScoringToJSONTyped,
+} from './GetQuizAttemptAnalyticsScoring';
+
+/**
+ * 
+ * @export
+ * @interface GetQuizAttemptAnalytics
+ */
+export interface GetQuizAttemptAnalytics {
+    /**
+     * Quiz attempt ID
+     * @type {string}
+     * @memberof GetQuizAttemptAnalytics
+     */
+    attemptId: string;
+    /**
+     * User ID
+     * @type {string}
+     * @memberof GetQuizAttemptAnalytics
+     */
+    userId: string;
+    /**
+     * Quiz ID
+     * @type {string}
+     * @memberof GetQuizAttemptAnalytics
+     */
+    quizId: string;
+    /**
+     * 
+     * @type {GetQuizAttemptAnalyticsBasicInfo}
+     * @memberof GetQuizAttemptAnalytics
+     */
+    basicInfo: GetQuizAttemptAnalyticsBasicInfo;
+    /**
+     * 
+     * @type {GetQuizAttemptAnalyticsScoring}
+     * @memberof GetQuizAttemptAnalytics
+     */
+    scoring: GetQuizAttemptAnalyticsScoring;
+    /**
+     * Detailed analysis of each question
+     * @type {Array<GetQuizAttemptAnalyticsQuestionAnalysisInner>}
+     * @memberof GetQuizAttemptAnalytics
+     */
+    questionAnalysis: Array<GetQuizAttemptAnalyticsQuestionAnalysisInner>;
+    /**
+     * 
+     * @type {GetQuizAttemptAnalyticsPerformanceBreakdown}
+     * @memberof GetQuizAttemptAnalytics
+     */
+    performanceBreakdown: GetQuizAttemptAnalyticsPerformanceBreakdown;
+}
+
+/**
+ * Check if a given object implements the GetQuizAttemptAnalytics interface.
+ */
+export function instanceOfGetQuizAttemptAnalytics(value: object): value is GetQuizAttemptAnalytics {
+    if (!('attemptId' in value) || value['attemptId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('quizId' in value) || value['quizId'] === undefined) return false;
+    if (!('basicInfo' in value) || value['basicInfo'] === undefined) return false;
+    if (!('scoring' in value) || value['scoring'] === undefined) return false;
+    if (!('questionAnalysis' in value) || value['questionAnalysis'] === undefined) return false;
+    if (!('performanceBreakdown' in value) || value['performanceBreakdown'] === undefined) return false;
+    return true;
+}
+
+export function GetQuizAttemptAnalyticsFromJSON(json: any): GetQuizAttemptAnalytics {
+    return GetQuizAttemptAnalyticsFromJSONTyped(json, false);
+}
+
+export function GetQuizAttemptAnalyticsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetQuizAttemptAnalytics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'attemptId': json['attempt_id'],
+        'userId': json['user_id'],
+        'quizId': json['quiz_id'],
+        'basicInfo': GetQuizAttemptAnalyticsBasicInfoFromJSON(json['basic_info']),
+        'scoring': GetQuizAttemptAnalyticsScoringFromJSON(json['scoring']),
+        'questionAnalysis': ((json['question_analysis'] as Array<any>).map(GetQuizAttemptAnalyticsQuestionAnalysisInnerFromJSON)),
+        'performanceBreakdown': GetQuizAttemptAnalyticsPerformanceBreakdownFromJSON(json['performance_breakdown']),
+    };
+}
+
+export function GetQuizAttemptAnalyticsToJSON(json: any): GetQuizAttemptAnalytics {
+    return GetQuizAttemptAnalyticsToJSONTyped(json, false);
+}
+
+export function GetQuizAttemptAnalyticsToJSONTyped(value?: GetQuizAttemptAnalytics | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'attempt_id': value['attemptId'],
+        'user_id': value['userId'],
+        'quiz_id': value['quizId'],
+        'basic_info': GetQuizAttemptAnalyticsBasicInfoToJSON(value['basicInfo']),
+        'scoring': GetQuizAttemptAnalyticsScoringToJSON(value['scoring']),
+        'question_analysis': ((value['questionAnalysis'] as Array<any>).map(GetQuizAttemptAnalyticsQuestionAnalysisInnerToJSON)),
+        'performance_breakdown': GetQuizAttemptAnalyticsPerformanceBreakdownToJSON(value['performanceBreakdown']),
+    };
+}
+

package/src/models/GetQuizAttemptAnalyticsBasicInfo.ts

@@ -0,0 +1,140 @@
+/* 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';
+/**
+ * Basic attempt information
+ * @export
+ * @interface GetQuizAttemptAnalyticsBasicInfo
+ */
+export interface GetQuizAttemptAnalyticsBasicInfo {
+    /**
+     * User's name
+     * @type {string}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    userName: string;
+    /**
+     * User's email
+     * @type {string}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    userEmail: string;
+    /**
+     * Quiz name
+     * @type {string}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    quizName: string;
+    /**
+     * Attempt number
+     * @type {number}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    attemptNumber: number;
+    /**
+     * Attempt status
+     * @type {GetQuizAttemptAnalyticsBasicInfoStatusEnum}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    status: GetQuizAttemptAnalyticsBasicInfoStatusEnum;
+    /**
+     * When attempt started
+     * @type {Date}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    startedAt: Date;
+    /**
+     * When attempt completed
+     * @type {Date}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    completedAt?: Date;
+    /**
+     * Total time spent
+     * @type {number}
+     * @memberof GetQuizAttemptAnalyticsBasicInfo
+     */
+    timeSpentSeconds?: number;
+}
+
+
+/**
+ * @export
+ */
+export const GetQuizAttemptAnalyticsBasicInfoStatusEnum = {
+    InProgress: 'in_progress',
+    Completed: 'completed',
+    TimedOut: 'timed_out',
+    Abandoned: 'abandoned'
+} as const;
+export type GetQuizAttemptAnalyticsBasicInfoStatusEnum = typeof GetQuizAttemptAnalyticsBasicInfoStatusEnum[keyof typeof GetQuizAttemptAnalyticsBasicInfoStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetQuizAttemptAnalyticsBasicInfo interface.
+ */
+export function instanceOfGetQuizAttemptAnalyticsBasicInfo(value: object): value is GetQuizAttemptAnalyticsBasicInfo {
+    if (!('userName' in value) || value['userName'] === undefined) return false;
+    if (!('userEmail' in value) || value['userEmail'] === undefined) return false;
+    if (!('quizName' in value) || value['quizName'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined) return false;
+    return true;
+}
+
+export function GetQuizAttemptAnalyticsBasicInfoFromJSON(json: any): GetQuizAttemptAnalyticsBasicInfo {
+    return GetQuizAttemptAnalyticsBasicInfoFromJSONTyped(json, false);
+}
+
+export function GetQuizAttemptAnalyticsBasicInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetQuizAttemptAnalyticsBasicInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userName': json['user_name'],
+        'userEmail': json['user_email'],
+        'quizName': json['quiz_name'],
+        'attemptNumber': json['attempt_number'],
+        'status': json['status'],
+        'startedAt': (new Date(json['started_at'])),
+        'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
+        'timeSpentSeconds': json['time_spent_seconds'] == null ? undefined : json['time_spent_seconds'],
+    };
+}
+
+export function GetQuizAttemptAnalyticsBasicInfoToJSON(json: any): GetQuizAttemptAnalyticsBasicInfo {
+    return GetQuizAttemptAnalyticsBasicInfoToJSONTyped(json, false);
+}
+
+export function GetQuizAttemptAnalyticsBasicInfoToJSONTyped(value?: GetQuizAttemptAnalyticsBasicInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_name': value['userName'],
+        'user_email': value['userEmail'],
+        'quiz_name': value['quizName'],
+        'attempt_number': value['attemptNumber'],
+        'status': value['status'],
+        'started_at': value['startedAt'].toISOString(),
+        'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'time_spent_seconds': value['timeSpentSeconds'],
+    };
+}
+