@easyedu/js-lsm-api 1.69.0 → 1.71.0

package/src/models/GetCourseStudentReportingModulesInner.ts

@@ -0,0 +1,123 @@
+/* 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 GetCourseStudentReportingModulesInner
+ */
+export interface GetCourseStudentReportingModulesInner {
+    /**
+     * The module external ID.
+     * @type {string}
+     * @memberof GetCourseStudentReportingModulesInner
+     */
+    moduleId: string;
+    /**
+     * Module name.
+     * @type {string}
+     * @memberof GetCourseStudentReportingModulesInner
+     */
+    name: string;
+    /**
+     * Order of the module within the course.
+     * @type {number}
+     * @memberof GetCourseStudentReportingModulesInner
+     */
+    order: number;
+    /**
+     * Number of visible content items in the module.
+     * @type {number}
+     * @memberof GetCourseStudentReportingModulesInner
+     */
+    contentCount: number;
+    /**
+     * Number of visible content items completed by the student.
+     * @type {number}
+     * @memberof GetCourseStudentReportingModulesInner
+     */
+    contentCompletedCount: number;
+    /**
+     * Derived module completion status for this student.
+     * @type {GetCourseStudentReportingModulesInnerCompletionStatusEnum}
+     * @memberof GetCourseStudentReportingModulesInner
+     */
+    completionStatus: GetCourseStudentReportingModulesInnerCompletionStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const GetCourseStudentReportingModulesInnerCompletionStatusEnum = {
+    NotAttempted: 'NotAttempted',
+    InProgress: 'InProgress',
+    Completed: 'Completed'
+} as const;
+export type GetCourseStudentReportingModulesInnerCompletionStatusEnum = typeof GetCourseStudentReportingModulesInnerCompletionStatusEnum[keyof typeof GetCourseStudentReportingModulesInnerCompletionStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetCourseStudentReportingModulesInner interface.
+ */
+export function instanceOfGetCourseStudentReportingModulesInner(value: object): value is GetCourseStudentReportingModulesInner {
+    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('order' in value) || value['order'] === undefined) return false;
+    if (!('contentCount' in value) || value['contentCount'] === undefined) return false;
+    if (!('contentCompletedCount' in value) || value['contentCompletedCount'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseStudentReportingModulesInnerFromJSON(json: any): GetCourseStudentReportingModulesInner {
+    return GetCourseStudentReportingModulesInnerFromJSONTyped(json, false);
+}
+
+export function GetCourseStudentReportingModulesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseStudentReportingModulesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'moduleId': json['module_id'],
+        'name': json['name'],
+        'order': json['order'],
+        'contentCount': json['content_count'],
+        'contentCompletedCount': json['content_completed_count'],
+        'completionStatus': json['completion_status'],
+    };
+}
+
+export function GetCourseStudentReportingModulesInnerToJSON(json: any): GetCourseStudentReportingModulesInner {
+    return GetCourseStudentReportingModulesInnerToJSONTyped(json, false);
+}
+
+export function GetCourseStudentReportingModulesInnerToJSONTyped(value?: GetCourseStudentReportingModulesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'module_id': value['moduleId'],
+        'name': value['name'],
+        'order': value['order'],
+        'content_count': value['contentCount'],
+        'content_completed_count': value['contentCompletedCount'],
+        'completion_status': value['completionStatus'],
+    };
+}
+

package/src/models/GetCourseStudentReportingPerformance.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface GetCourseStudentReportingPerformance {
     /**
-     * Average score percentage across all modules
+     * Average of scored quiz and SCORM content rollups in the course, using each content item's score rollup strategy. Null when no score is available.
      * @type {number}
      * @memberof GetCourseStudentReportingPerformance
      */

package/src/models/GetModuleStudentReporting.ts

@@ -27,6 +27,13 @@ import {
     GetModuleStudentReportingAccessToJSON,
     GetModuleStudentReportingAccessToJSONTyped,
 } from './GetModuleStudentReportingAccess';
+import type { GetModuleStudentReportingContentsInner } from './GetModuleStudentReportingContentsInner';
+import {
+    GetModuleStudentReportingContentsInnerFromJSON,
+    GetModuleStudentReportingContentsInnerFromJSONTyped,
+    GetModuleStudentReportingContentsInnerToJSON,
+    GetModuleStudentReportingContentsInnerToJSONTyped,
+} from './GetModuleStudentReportingContentsInner';
 import type { GetModuleStudentReportingProgress } from './GetModuleStudentReportingProgress';
 import {
     GetModuleStudentReportingProgressFromJSON,
@@ -59,6 +66,12 @@ export interface GetModuleStudentReporting {
      * @memberof GetModuleStudentReporting
      */
     access: GetModuleStudentReportingAccess;
+    /**
+     * Content-level progress for the student within this module.
+     * @type {Array<GetModuleStudentReportingContentsInner>}
+     * @memberof GetModuleStudentReporting
+     */
+    contents: Array<GetModuleStudentReportingContentsInner>;
 }
 
 /**
@@ -68,6 +81,7 @@ export function instanceOfGetModuleStudentReporting(value: object): value is Get
     if (!('moduleInfo' in value) || value['moduleInfo'] === undefined) return false;
     if (!('progress' in value) || value['progress'] === undefined) return false;
     if (!('access' in value) || value['access'] === undefined) return false;
+    if (!('contents' in value) || value['contents'] === undefined) return false;
     return true;
 }
 
@@ -84,6 +98,7 @@ export function GetModuleStudentReportingFromJSONTyped(json: any, ignoreDiscrimi
         'moduleInfo': GetModuleInstructorBasicReportingModuleInfoFromJSON(json['module_info']),
         'progress': GetModuleStudentReportingProgressFromJSON(json['progress']),
         'access': GetModuleStudentReportingAccessFromJSON(json['access']),
+        'contents': ((json['contents'] as Array<any>).map(GetModuleStudentReportingContentsInnerFromJSON)),
     };
 }
 
@@ -101,6 +116,7 @@ export function GetModuleStudentReportingToJSONTyped(value?: GetModuleStudentRep
         'module_info': GetModuleInstructorBasicReportingModuleInfoToJSON(value['moduleInfo']),
         'progress': GetModuleStudentReportingProgressToJSON(value['progress']),
         'access': GetModuleStudentReportingAccessToJSON(value['access']),
+        'contents': ((value['contents'] as Array<any>).map(GetModuleStudentReportingContentsInnerToJSON)),
     };
 }
 

package/src/models/GetModuleStudentReportingContentsInner.ts

@@ -0,0 +1,168 @@
+/* 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 GetModuleStudentReportingContentsInner
+ */
+export interface GetModuleStudentReportingContentsInner {
+    /**
+     * The module external ID.
+     * @type {string}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    moduleId: string;
+    /**
+     * The content external ID.
+     * @type {string}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    contentId: string;
+    /**
+     * Content name.
+     * @type {string}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    name: string;
+    /**
+     * Content type.
+     * @type {string}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    contentType: string;
+    /**
+     * Order of the content within the module.
+     * @type {number}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    order: number;
+    /**
+     * Current live completion status for this student's content progress.
+     * @type {GetModuleStudentReportingContentsInnerCompletionStatusEnum}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    completionStatus: GetModuleStudentReportingContentsInnerCompletionStatusEnum;
+    /**
+     * Current live grade status for this student's content progress, if a session exists.
+     * @type {string}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    gradeStatus: string | null;
+    /**
+     * Current live content session external ID, if a session exists.
+     * @type {string}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    contentSessionId: string | null;
+    /**
+     * Current live attempt number, if a session exists.
+     * @type {number}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    attemptNumber: number | null;
+    /**
+     * Last content session update timestamp (epoch seconds), if a session exists.
+     * @type {number}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    lastAccessedAt: number | null;
+    /**
+     * Duration tracked on the current live content session, or 0 when not started.
+     * @type {number}
+     * @memberof GetModuleStudentReportingContentsInner
+     */
+    durationInSeconds: number;
+}
+
+
+/**
+ * @export
+ */
+export const GetModuleStudentReportingContentsInnerCompletionStatusEnum = {
+    NotAttempted: 'NotAttempted',
+    InProgress: 'InProgress',
+    Completed: 'Completed'
+} as const;
+export type GetModuleStudentReportingContentsInnerCompletionStatusEnum = typeof GetModuleStudentReportingContentsInnerCompletionStatusEnum[keyof typeof GetModuleStudentReportingContentsInnerCompletionStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetModuleStudentReportingContentsInner interface.
+ */
+export function instanceOfGetModuleStudentReportingContentsInner(value: object): value is GetModuleStudentReportingContentsInner {
+    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('contentType' in value) || value['contentType'] === undefined) return false;
+    if (!('order' in value) || value['order'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('contentSessionId' in value) || value['contentSessionId'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('lastAccessedAt' in value) || value['lastAccessedAt'] === undefined) return false;
+    if (!('durationInSeconds' in value) || value['durationInSeconds'] === undefined) return false;
+    return true;
+}
+
+export function GetModuleStudentReportingContentsInnerFromJSON(json: any): GetModuleStudentReportingContentsInner {
+    return GetModuleStudentReportingContentsInnerFromJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingContentsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModuleStudentReportingContentsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'moduleId': json['module_id'],
+        'contentId': json['content_id'],
+        'name': json['name'],
+        'contentType': json['content_type'],
+        'order': json['order'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'contentSessionId': json['content_session_id'],
+        'attemptNumber': json['attempt_number'],
+        'lastAccessedAt': json['last_accessed_at'],
+        'durationInSeconds': json['duration_in_seconds'],
+    };
+}
+
+export function GetModuleStudentReportingContentsInnerToJSON(json: any): GetModuleStudentReportingContentsInner {
+    return GetModuleStudentReportingContentsInnerToJSONTyped(json, false);
+}
+
+export function GetModuleStudentReportingContentsInnerToJSONTyped(value?: GetModuleStudentReportingContentsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'module_id': value['moduleId'],
+        'content_id': value['contentId'],
+        'name': value['name'],
+        'content_type': value['contentType'],
+        'order': value['order'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'content_session_id': value['contentSessionId'],
+        'attempt_number': value['attemptNumber'],
+        'last_accessed_at': value['lastAccessedAt'],
+        'duration_in_seconds': value['durationInSeconds'],
+    };
+}
+

package/src/models/index.ts

@@ -60,6 +60,7 @@ export * from './GetCourseReportingBasic';
 export * from './GetCourseStudentReporting';
 export * from './GetCourseStudentReportingCourseInfo';
 export * from './GetCourseStudentReportingEngagement';
+export * from './GetCourseStudentReportingModulesInner';
 export * from './GetCourseStudentReportingPerformance';
 export * from './GetManualQuestionSelectionItem';
 export * from './GetManualQuestionSelectionList';
@@ -71,6 +72,7 @@ export * from './GetModuleInstructorBasicReportingPerformance';
 export * from './GetModuleList';
 export * from './GetModuleStudentReporting';
 export * from './GetModuleStudentReportingAccess';
+export * from './GetModuleStudentReportingContentsInner';
 export * from './GetModuleStudentReportingProgress';
 export * from './GetPermission';
 export * from './GetPortal';