@easyedu/js-lsm-api 1.69.0 → 1.70.0

package/dist/models/GetCourseStudentReportingModulesInner.js

@@ -0,0 +1,79 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetCourseStudentReportingModulesInnerCompletionStatusEnum = void 0;
+exports.instanceOfGetCourseStudentReportingModulesInner = instanceOfGetCourseStudentReportingModulesInner;
+exports.GetCourseStudentReportingModulesInnerFromJSON = GetCourseStudentReportingModulesInnerFromJSON;
+exports.GetCourseStudentReportingModulesInnerFromJSONTyped = GetCourseStudentReportingModulesInnerFromJSONTyped;
+exports.GetCourseStudentReportingModulesInnerToJSON = GetCourseStudentReportingModulesInnerToJSON;
+exports.GetCourseStudentReportingModulesInnerToJSONTyped = GetCourseStudentReportingModulesInnerToJSONTyped;
+/**
+ * @export
+ */
+exports.GetCourseStudentReportingModulesInnerCompletionStatusEnum = {
+    NotAttempted: 'NotAttempted',
+    InProgress: 'InProgress',
+    Completed: 'Completed'
+};
+/**
+ * Check if a given object implements the GetCourseStudentReportingModulesInner interface.
+ */
+function instanceOfGetCourseStudentReportingModulesInner(value) {
+    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;
+}
+function GetCourseStudentReportingModulesInnerFromJSON(json) {
+    return GetCourseStudentReportingModulesInnerFromJSONTyped(json, false);
+}
+function GetCourseStudentReportingModulesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function GetCourseStudentReportingModulesInnerToJSON(json) {
+    return GetCourseStudentReportingModulesInnerToJSONTyped(json, false);
+}
+function GetCourseStudentReportingModulesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/GetModuleStudentReporting.d.ts

@@ -11,6 +11,7 @@
  */
 import type { GetModuleInstructorBasicReportingModuleInfo } from './GetModuleInstructorBasicReportingModuleInfo';
 import type { GetModuleStudentReportingAccess } from './GetModuleStudentReportingAccess';
+import type { GetModuleStudentReportingContentsInner } from './GetModuleStudentReportingContentsInner';
 import type { GetModuleStudentReportingProgress } from './GetModuleStudentReportingProgress';
 /**
  *
@@ -36,6 +37,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>;
 }
 /**
  * Check if a given object implements the GetModuleStudentReporting interface.

package/dist/models/GetModuleStudentReporting.js

@@ -20,6 +20,7 @@ exports.GetModuleStudentReportingToJSON = GetModuleStudentReportingToJSON;
 exports.GetModuleStudentReportingToJSONTyped = GetModuleStudentReportingToJSONTyped;
 const GetModuleInstructorBasicReportingModuleInfo_1 = require("./GetModuleInstructorBasicReportingModuleInfo");
 const GetModuleStudentReportingAccess_1 = require("./GetModuleStudentReportingAccess");
+const GetModuleStudentReportingContentsInner_1 = require("./GetModuleStudentReportingContentsInner");
 const GetModuleStudentReportingProgress_1 = require("./GetModuleStudentReportingProgress");
 /**
  * Check if a given object implements the GetModuleStudentReporting interface.
@@ -31,6 +32,8 @@ function instanceOfGetModuleStudentReporting(value) {
         return false;
     if (!('access' in value) || value['access'] === undefined)
         return false;
+    if (!('contents' in value) || value['contents'] === undefined)
+        return false;
     return true;
 }
 function GetModuleStudentReportingFromJSON(json) {
@@ -44,6 +47,7 @@ function GetModuleStudentReportingFromJSONTyped(json, ignoreDiscriminator) {
         'moduleInfo': (0, GetModuleInstructorBasicReportingModuleInfo_1.GetModuleInstructorBasicReportingModuleInfoFromJSON)(json['module_info']),
         'progress': (0, GetModuleStudentReportingProgress_1.GetModuleStudentReportingProgressFromJSON)(json['progress']),
         'access': (0, GetModuleStudentReportingAccess_1.GetModuleStudentReportingAccessFromJSON)(json['access']),
+        'contents': (json['contents'].map(GetModuleStudentReportingContentsInner_1.GetModuleStudentReportingContentsInnerFromJSON)),
     };
 }
 function GetModuleStudentReportingToJSON(json) {
@@ -57,5 +61,6 @@ function GetModuleStudentReportingToJSONTyped(value, ignoreDiscriminator = false
         'module_info': (0, GetModuleInstructorBasicReportingModuleInfo_1.GetModuleInstructorBasicReportingModuleInfoToJSON)(value['moduleInfo']),
         'progress': (0, GetModuleStudentReportingProgress_1.GetModuleStudentReportingProgressToJSON)(value['progress']),
         'access': (0, GetModuleStudentReportingAccess_1.GetModuleStudentReportingAccessToJSON)(value['access']),
+        'contents': (value['contents'].map(GetModuleStudentReportingContentsInner_1.GetModuleStudentReportingContentsInnerToJSON)),
     };
 }

package/dist/models/GetModuleStudentReportingContentsInner.d.ts

@@ -0,0 +1,101 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare const GetModuleStudentReportingContentsInnerCompletionStatusEnum: {
+    readonly NotAttempted: "NotAttempted";
+    readonly InProgress: "InProgress";
+    readonly Completed: "Completed";
+};
+export type GetModuleStudentReportingContentsInnerCompletionStatusEnum = typeof GetModuleStudentReportingContentsInnerCompletionStatusEnum[keyof typeof GetModuleStudentReportingContentsInnerCompletionStatusEnum];
+/**
+ * Check if a given object implements the GetModuleStudentReportingContentsInner interface.
+ */
+export declare function instanceOfGetModuleStudentReportingContentsInner(value: object): value is GetModuleStudentReportingContentsInner;
+export declare function GetModuleStudentReportingContentsInnerFromJSON(json: any): GetModuleStudentReportingContentsInner;
+export declare function GetModuleStudentReportingContentsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModuleStudentReportingContentsInner;
+export declare function GetModuleStudentReportingContentsInnerToJSON(json: any): GetModuleStudentReportingContentsInner;
+export declare function GetModuleStudentReportingContentsInnerToJSONTyped(value?: GetModuleStudentReportingContentsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetModuleStudentReportingContentsInner.js

@@ -0,0 +1,99 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetModuleStudentReportingContentsInnerCompletionStatusEnum = void 0;
+exports.instanceOfGetModuleStudentReportingContentsInner = instanceOfGetModuleStudentReportingContentsInner;
+exports.GetModuleStudentReportingContentsInnerFromJSON = GetModuleStudentReportingContentsInnerFromJSON;
+exports.GetModuleStudentReportingContentsInnerFromJSONTyped = GetModuleStudentReportingContentsInnerFromJSONTyped;
+exports.GetModuleStudentReportingContentsInnerToJSON = GetModuleStudentReportingContentsInnerToJSON;
+exports.GetModuleStudentReportingContentsInnerToJSONTyped = GetModuleStudentReportingContentsInnerToJSONTyped;
+/**
+ * @export
+ */
+exports.GetModuleStudentReportingContentsInnerCompletionStatusEnum = {
+    NotAttempted: 'NotAttempted',
+    InProgress: 'InProgress',
+    Completed: 'Completed'
+};
+/**
+ * Check if a given object implements the GetModuleStudentReportingContentsInner interface.
+ */
+function instanceOfGetModuleStudentReportingContentsInner(value) {
+    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;
+}
+function GetModuleStudentReportingContentsInnerFromJSON(json) {
+    return GetModuleStudentReportingContentsInnerFromJSONTyped(json, false);
+}
+function GetModuleStudentReportingContentsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function GetModuleStudentReportingContentsInnerToJSON(json) {
+    return GetModuleStudentReportingContentsInnerToJSONTyped(json, false);
+}
+function GetModuleStudentReportingContentsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/index.d.ts

@@ -58,6 +58,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';
@@ -69,6 +70,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';

package/dist/models/index.js

@@ -76,6 +76,7 @@ __exportStar(require("./GetCourseReportingBasic"), exports);
 __exportStar(require("./GetCourseStudentReporting"), exports);
 __exportStar(require("./GetCourseStudentReportingCourseInfo"), exports);
 __exportStar(require("./GetCourseStudentReportingEngagement"), exports);
+__exportStar(require("./GetCourseStudentReportingModulesInner"), exports);
 __exportStar(require("./GetCourseStudentReportingPerformance"), exports);
 __exportStar(require("./GetManualQuestionSelectionItem"), exports);
 __exportStar(require("./GetManualQuestionSelectionList"), exports);
@@ -87,6 +88,7 @@ __exportStar(require("./GetModuleInstructorBasicReportingPerformance"), exports)
 __exportStar(require("./GetModuleList"), exports);
 __exportStar(require("./GetModuleStudentReporting"), exports);
 __exportStar(require("./GetModuleStudentReportingAccess"), exports);
+__exportStar(require("./GetModuleStudentReportingContentsInner"), exports);
 __exportStar(require("./GetModuleStudentReportingProgress"), exports);
 __exportStar(require("./GetPermission"), exports);
 __exportStar(require("./GetPortal"), exports);

package/docs/GetCourseStudentReporting.md

@@ -9,6 +9,7 @@ Name | Type
 `courseInfo` | [GetCourseStudentReportingCourseInfo](GetCourseStudentReportingCourseInfo.md)
 `engagement` | [GetCourseStudentReportingEngagement](GetCourseStudentReportingEngagement.md)
 `performance` | [GetCourseStudentReportingPerformance](GetCourseStudentReportingPerformance.md)
+`modules` | [Array<GetCourseStudentReportingModulesInner>](GetCourseStudentReportingModulesInner.md)
 
 ## Example
 
@@ -20,6 +21,7 @@ const example = {
   "courseInfo": null,
   "engagement": null,
   "performance": null,
+  "modules": null,
 } satisfies GetCourseStudentReporting
 
 console.log(example)

package/docs/GetCourseStudentReportingModulesInner.md

@@ -0,0 +1,44 @@
+
+# GetCourseStudentReportingModulesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`moduleId` | string
+`name` | string
+`order` | number
+`contentCount` | number
+`contentCompletedCount` | number
+`completionStatus` | string
+
+## Example
+
+```typescript
+import type { GetCourseStudentReportingModulesInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "moduleId": null,
+  "name": null,
+  "order": null,
+  "contentCount": null,
+  "contentCompletedCount": null,
+  "completionStatus": null,
+} satisfies GetCourseStudentReportingModulesInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetCourseStudentReportingModulesInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetModuleStudentReporting.md

@@ -9,6 +9,7 @@ Name | Type
 `moduleInfo` | [GetModuleInstructorBasicReportingModuleInfo](GetModuleInstructorBasicReportingModuleInfo.md)
 `progress` | [GetModuleStudentReportingProgress](GetModuleStudentReportingProgress.md)
 `access` | [GetModuleStudentReportingAccess](GetModuleStudentReportingAccess.md)
+`contents` | [Array<GetModuleStudentReportingContentsInner>](GetModuleStudentReportingContentsInner.md)
 
 ## Example
 
@@ -20,6 +21,7 @@ const example = {
   "moduleInfo": null,
   "progress": null,
   "access": null,
+  "contents": null,
 } satisfies GetModuleStudentReporting
 
 console.log(example)

package/docs/GetModuleStudentReportingContentsInner.md

@@ -0,0 +1,54 @@
+
+# GetModuleStudentReportingContentsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`moduleId` | string
+`contentId` | string
+`name` | string
+`contentType` | string
+`order` | number
+`completionStatus` | string
+`gradeStatus` | string
+`contentSessionId` | string
+`attemptNumber` | number
+`lastAccessedAt` | number
+`durationInSeconds` | number
+
+## Example
+
+```typescript
+import type { GetModuleStudentReportingContentsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "moduleId": null,
+  "contentId": null,
+  "name": null,
+  "contentType": null,
+  "order": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "contentSessionId": null,
+  "attemptNumber": null,
+  "lastAccessedAt": null,
+  "durationInSeconds": null,
+} satisfies GetModuleStudentReportingContentsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetModuleStudentReportingContentsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.69.0",
+  "version": "1.70.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/models/GetCourseStudentReporting.ts

@@ -20,6 +20,13 @@ import {
     GetCourseStudentReportingEngagementToJSON,
     GetCourseStudentReportingEngagementToJSONTyped,
 } from './GetCourseStudentReportingEngagement';
+import type { GetCourseStudentReportingModulesInner } from './GetCourseStudentReportingModulesInner';
+import {
+    GetCourseStudentReportingModulesInnerFromJSON,
+    GetCourseStudentReportingModulesInnerFromJSONTyped,
+    GetCourseStudentReportingModulesInnerToJSON,
+    GetCourseStudentReportingModulesInnerToJSONTyped,
+} from './GetCourseStudentReportingModulesInner';
 import type { GetCourseStudentReportingCourseInfo } from './GetCourseStudentReportingCourseInfo';
 import {
     GetCourseStudentReportingCourseInfoFromJSON,
@@ -59,6 +66,12 @@ export interface GetCourseStudentReporting {
      * @memberof GetCourseStudentReporting
      */
     performance: GetCourseStudentReportingPerformance;
+    /**
+     * Module-level progress for the student within this course.
+     * @type {Array<GetCourseStudentReportingModulesInner>}
+     * @memberof GetCourseStudentReporting
+     */
+    modules: Array<GetCourseStudentReportingModulesInner>;
 }
 
 /**
@@ -68,6 +81,7 @@ export function instanceOfGetCourseStudentReporting(value: object): value is Get
     if (!('courseInfo' in value) || value['courseInfo'] === undefined) return false;
     if (!('engagement' in value) || value['engagement'] === undefined) return false;
     if (!('performance' in value) || value['performance'] === undefined) return false;
+    if (!('modules' in value) || value['modules'] === undefined) return false;
     return true;
 }
 
@@ -84,6 +98,7 @@ export function GetCourseStudentReportingFromJSONTyped(json: any, ignoreDiscrimi
         'courseInfo': GetCourseStudentReportingCourseInfoFromJSON(json['course_info']),
         'engagement': GetCourseStudentReportingEngagementFromJSON(json['engagement']),
         'performance': GetCourseStudentReportingPerformanceFromJSON(json['performance']),
+        'modules': ((json['modules'] as Array<any>).map(GetCourseStudentReportingModulesInnerFromJSON)),
     };
 }
 
@@ -101,6 +116,7 @@ export function GetCourseStudentReportingToJSONTyped(value?: GetCourseStudentRep
         'course_info': GetCourseStudentReportingCourseInfoToJSON(value['courseInfo']),
         'engagement': GetCourseStudentReportingEngagementToJSON(value['engagement']),
         'performance': GetCourseStudentReportingPerformanceToJSON(value['performance']),
+        'modules': ((value['modules'] as Array<any>).map(GetCourseStudentReportingModulesInnerToJSON)),
     };
 }