@easyedu/js-lsm-api 1.90.0 → 1.92.0

package/src/models/GetLibraryQuizAnalytics.ts

@@ -0,0 +1,120 @@
+/* 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 GetLibraryQuizAnalytics
+ */
+export interface GetLibraryQuizAnalytics {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    quizId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    totalAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    completedAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    pendingReviewAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    averageScore: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    passRate: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    averageDurationSeconds: number;
+}
+
+/**
+ * Check if a given object implements the GetLibraryQuizAnalytics interface.
+ */
+export function instanceOfGetLibraryQuizAnalytics(value: object): value is GetLibraryQuizAnalytics {
+    if (!('quizId' in value) || value['quizId'] === undefined) return false;
+    if (!('totalAttempts' in value) || value['totalAttempts'] === undefined) return false;
+    if (!('completedAttempts' in value) || value['completedAttempts'] === undefined) return false;
+    if (!('pendingReviewAttempts' in value) || value['pendingReviewAttempts'] === undefined) return false;
+    if (!('averageScore' in value) || value['averageScore'] === undefined) return false;
+    if (!('passRate' in value) || value['passRate'] === undefined) return false;
+    if (!('averageDurationSeconds' in value) || value['averageDurationSeconds'] === undefined) return false;
+    return true;
+}
+
+export function GetLibraryQuizAnalyticsFromJSON(json: any): GetLibraryQuizAnalytics {
+    return GetLibraryQuizAnalyticsFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizAnalyticsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizAnalytics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'quizId': json['quiz_id'],
+        'totalAttempts': json['total_attempts'],
+        'completedAttempts': json['completed_attempts'],
+        'pendingReviewAttempts': json['pending_review_attempts'],
+        'averageScore': json['average_score'],
+        'passRate': json['pass_rate'],
+        'averageDurationSeconds': json['average_duration_seconds'],
+    };
+}
+
+export function GetLibraryQuizAnalyticsToJSON(json: any): GetLibraryQuizAnalytics {
+    return GetLibraryQuizAnalyticsToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizAnalyticsToJSONTyped(value?: GetLibraryQuizAnalytics | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'quiz_id': value['quizId'],
+        'total_attempts': value['totalAttempts'],
+        'completed_attempts': value['completedAttempts'],
+        'pending_review_attempts': value['pendingReviewAttempts'],
+        'average_score': value['averageScore'],
+        'pass_rate': value['passRate'],
+        'average_duration_seconds': value['averageDurationSeconds'],
+    };
+}
+

package/src/models/GetLibraryQuizList.ts

@@ -0,0 +1,110 @@
+/* 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 { GetLibraryQuiz } from './GetLibraryQuiz';
+import {
+    GetLibraryQuizFromJSON,
+    GetLibraryQuizFromJSONTyped,
+    GetLibraryQuizToJSON,
+    GetLibraryQuizToJSONTyped,
+} from './GetLibraryQuiz';
+
+/**
+ * 
+ * @export
+ * @interface GetLibraryQuizList
+ */
+export interface GetLibraryQuizList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetLibraryQuiz>}
+     * @memberof GetLibraryQuizList
+     */
+    items: Array<GetLibraryQuiz>;
+}
+
+/**
+ * Check if a given object implements the GetLibraryQuizList interface.
+ */
+export function instanceOfGetLibraryQuizList(value: object): value is GetLibraryQuizList {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetLibraryQuizListFromJSON(json: any): GetLibraryQuizList {
+    return GetLibraryQuizListFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(GetLibraryQuizFromJSON)),
+    };
+}
+
+export function GetLibraryQuizListToJSON(json: any): GetLibraryQuizList {
+    return GetLibraryQuizListToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizListToJSONTyped(value?: GetLibraryQuizList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetLibraryQuizToJSON)),
+    };
+}
+

package/src/models/GetLibraryQuizResult.ts

@@ -0,0 +1,154 @@
+/* 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 GetLibraryQuizResult
+ */
+export interface GetLibraryQuizResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizResult
+     */
+    sessionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizResult
+     */
+    status: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizResult
+     */
+    totalQuestions: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizResult
+     */
+    questionsAnswered: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizResult
+     */
+    correctAnswers: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizResult
+     */
+    totalPoints: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizResult
+     */
+    pointsEarned: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizResult
+     */
+    scorePercentage?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizResult
+     */
+    passed?: boolean | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizResult
+     */
+    pendingManualGrading: boolean;
+    /**
+     * 
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof GetLibraryQuizResult
+     */
+    questions: Array<{ [key: string]: any; }>;
+}
+
+/**
+ * Check if a given object implements the GetLibraryQuizResult interface.
+ */
+export function instanceOfGetLibraryQuizResult(value: object): value is GetLibraryQuizResult {
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined) return false;
+    if (!('questionsAnswered' in value) || value['questionsAnswered'] === undefined) return false;
+    if (!('correctAnswers' in value) || value['correctAnswers'] === undefined) return false;
+    if (!('totalPoints' in value) || value['totalPoints'] === undefined) return false;
+    if (!('pointsEarned' in value) || value['pointsEarned'] === undefined) return false;
+    if (!('pendingManualGrading' in value) || value['pendingManualGrading'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === undefined) return false;
+    return true;
+}
+
+export function GetLibraryQuizResultFromJSON(json: any): GetLibraryQuizResult {
+    return GetLibraryQuizResultFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sessionId': json['session_id'],
+        'status': json['status'],
+        'totalQuestions': json['total_questions'],
+        'questionsAnswered': json['questions_answered'],
+        'correctAnswers': json['correct_answers'],
+        'totalPoints': json['total_points'],
+        'pointsEarned': json['points_earned'],
+        'scorePercentage': json['score_percentage'] == null ? undefined : json['score_percentage'],
+        'passed': json['passed'] == null ? undefined : json['passed'],
+        'pendingManualGrading': json['pending_manual_grading'],
+        'questions': json['questions'],
+    };
+}
+
+export function GetLibraryQuizResultToJSON(json: any): GetLibraryQuizResult {
+    return GetLibraryQuizResultToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizResultToJSONTyped(value?: GetLibraryQuizResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'session_id': value['sessionId'],
+        'status': value['status'],
+        'total_questions': value['totalQuestions'],
+        'questions_answered': value['questionsAnswered'],
+        'correct_answers': value['correctAnswers'],
+        'total_points': value['totalPoints'],
+        'points_earned': value['pointsEarned'],
+        'score_percentage': value['scorePercentage'],
+        'passed': value['passed'],
+        'pending_manual_grading': value['pendingManualGrading'],
+        'questions': value['questions'],
+    };
+}
+

package/src/models/GetLibraryQuizSession.ts

@@ -0,0 +1,286 @@
+/* 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 { ResourceSessionEnvironment } from './ResourceSessionEnvironment';
+import {
+    ResourceSessionEnvironmentFromJSON,
+    ResourceSessionEnvironmentFromJSONTyped,
+    ResourceSessionEnvironmentToJSON,
+    ResourceSessionEnvironmentToJSONTyped,
+} from './ResourceSessionEnvironment';
+import type { LibraryQuizSessionQuestion } from './LibraryQuizSessionQuestion';
+import {
+    LibraryQuizSessionQuestionFromJSON,
+    LibraryQuizSessionQuestionFromJSONTyped,
+    LibraryQuizSessionQuestionToJSON,
+    LibraryQuizSessionQuestionToJSONTyped,
+} from './LibraryQuizSessionQuestion';
+
+/**
+ * 
+ * @export
+ * @interface GetLibraryQuizSession
+ */
+export interface GetLibraryQuizSession {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    userId: string;
+    /**
+     * 
+     * @type {ResourceSessionEnvironment}
+     * @memberof GetLibraryQuizSession
+     */
+    environment: ResourceSessionEnvironment;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    courseId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    courseVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    itemId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    quizId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    quizVersionId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    quizVersionNumber: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    quizName: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    attemptNumber: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizSession
+     */
+    isCurrent: boolean;
+    /**
+     * 
+     * @type {GetLibraryQuizSessionStatusEnum}
+     * @memberof GetLibraryQuizSession
+     */
+    status: GetLibraryQuizSessionStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    questionsAnswered: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    totalQuestions: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    scorePercentage?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetLibraryQuizSession
+     */
+    passed?: boolean | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    timeLimitAt?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizSession
+     */
+    launchUrl: string;
+    /**
+     * 
+     * @type {Array<LibraryQuizSessionQuestion>}
+     * @memberof GetLibraryQuizSession
+     */
+    questions: Array<LibraryQuizSessionQuestion>;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    completedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetLibraryQuizSessionStatusEnum = {
+    InProgress: 'in_progress',
+    PendingReview: 'pending_review',
+    Completed: 'completed',
+    TimedOut: 'timed_out',
+    Abandoned: 'abandoned'
+} as const;
+export type GetLibraryQuizSessionStatusEnum = typeof GetLibraryQuizSessionStatusEnum[keyof typeof GetLibraryQuizSessionStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetLibraryQuizSession interface.
+ */
+export function instanceOfGetLibraryQuizSession(value: object): value is GetLibraryQuizSession {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('environment' in value) || value['environment'] === undefined) return false;
+    if (!('quizId' in value) || value['quizId'] === undefined) return false;
+    if (!('quizVersionId' in value) || value['quizVersionId'] === undefined) return false;
+    if (!('quizVersionNumber' in value) || value['quizVersionNumber'] === undefined) return false;
+    if (!('quizName' in value) || value['quizName'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('questionsAnswered' in value) || value['questionsAnswered'] === undefined) return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined) return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    if (!('questions' in value) || value['questions'] === 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 GetLibraryQuizSessionFromJSON(json: any): GetLibraryQuizSession {
+    return GetLibraryQuizSessionFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'userId': json['user_id'],
+        'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
+        'courseId': json['course_id'] == null ? undefined : json['course_id'],
+        'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
+        'itemId': json['item_id'] == null ? undefined : json['item_id'],
+        'quizId': json['quiz_id'],
+        'quizVersionId': json['quiz_version_id'],
+        'quizVersionNumber': json['quiz_version_number'],
+        'quizName': json['quiz_name'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
+        'status': json['status'],
+        'questionsAnswered': json['questions_answered'],
+        'totalQuestions': json['total_questions'],
+        'scorePercentage': json['score_percentage'] == null ? undefined : json['score_percentage'],
+        'passed': json['passed'] == null ? undefined : json['passed'],
+        'timeLimitAt': json['time_limit_at'] == null ? undefined : json['time_limit_at'],
+        'launchUrl': json['launch_url'],
+        'questions': ((json['questions'] as Array<any>).map(LibraryQuizSessionQuestionFromJSON)),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+    };
+}
+
+export function GetLibraryQuizSessionToJSON(json: any): GetLibraryQuizSession {
+    return GetLibraryQuizSessionToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizSessionToJSONTyped(value?: GetLibraryQuizSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'user_id': value['userId'],
+        'environment': ResourceSessionEnvironmentToJSON(value['environment']),
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'quiz_id': value['quizId'],
+        'quiz_version_id': value['quizVersionId'],
+        'quiz_version_number': value['quizVersionNumber'],
+        'quiz_name': value['quizName'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
+        'status': value['status'],
+        'questions_answered': value['questionsAnswered'],
+        'total_questions': value['totalQuestions'],
+        'score_percentage': value['scorePercentage'],
+        'passed': value['passed'],
+        'time_limit_at': value['timeLimitAt'],
+        'launch_url': value['launchUrl'],
+        'questions': ((value['questions'] as Array<any>).map(LibraryQuizSessionQuestionToJSON)),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'completed_at': value['completedAt'],
+    };
+}
+