@easyedu/js-lsm-api 1.68.0 → 1.70.0

package/docs/PutContentAttemptSettings.md

@@ -0,0 +1,36 @@
+
+# PutContentAttemptSettings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`maxAttempts` | number
+`scoreRollupStrategy` | string
+
+## Example
+
+```typescript
+import type { PutContentAttemptSettings } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "maxAttempts": null,
+  "scoreRollupStrategy": null,
+} satisfies PutContentAttemptSettings
+
+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 PutContentAttemptSettings
+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.68.0",
+  "version": "1.70.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/models/ContentAttemptSettings.ts

@@ -0,0 +1,86 @@
+/* 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 ContentAttemptSettings
+ */
+export interface ContentAttemptSettings {
+    /**
+     * Maximum allowed attempts for this content
+     * @type {number}
+     * @memberof ContentAttemptSettings
+     */
+    maxAttempts: number;
+    /**
+     * Strategy used to calculate the content rollup score
+     * @type {ContentAttemptSettingsScoreRollupStrategyEnum}
+     * @memberof ContentAttemptSettings
+     */
+    scoreRollupStrategy: ContentAttemptSettingsScoreRollupStrategyEnum;
+}
+
+
+/**
+ * @export
+ */
+export const ContentAttemptSettingsScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type ContentAttemptSettingsScoreRollupStrategyEnum = typeof ContentAttemptSettingsScoreRollupStrategyEnum[keyof typeof ContentAttemptSettingsScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the ContentAttemptSettings interface.
+ */
+export function instanceOfContentAttemptSettings(value: object): value is ContentAttemptSettings {
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
+    if (!('scoreRollupStrategy' in value) || value['scoreRollupStrategy'] === undefined) return false;
+    return true;
+}
+
+export function ContentAttemptSettingsFromJSON(json: any): ContentAttemptSettings {
+    return ContentAttemptSettingsFromJSONTyped(json, false);
+}
+
+export function ContentAttemptSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptSettings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'maxAttempts': json['max_attempts'],
+        'scoreRollupStrategy': json['score_rollup_strategy'],
+    };
+}
+
+export function ContentAttemptSettingsToJSON(json: any): ContentAttemptSettings {
+    return ContentAttemptSettingsToJSONTyped(json, false);
+}
+
+export function ContentAttemptSettingsToJSONTyped(value?: ContentAttemptSettings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'max_attempts': value['maxAttempts'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+    };
+}
+

package/src/models/GetContent.ts

@@ -20,6 +20,13 @@ import {
     GetContentContentDataToJSON,
     GetContentContentDataToJSONTyped,
 } from './GetContentContentData';
+import type { ContentAttemptSettings } from './ContentAttemptSettings';
+import {
+    ContentAttemptSettingsFromJSON,
+    ContentAttemptSettingsFromJSONTyped,
+    ContentAttemptSettingsToJSON,
+    ContentAttemptSettingsToJSONTyped,
+} from './ContentAttemptSettings';
 import type { ContentLaunchMode } from './ContentLaunchMode';
 import {
     ContentLaunchModeFromJSON,
@@ -70,6 +77,12 @@ export interface GetContent {
      * @memberof GetContent
      */
     launchMode: ContentLaunchMode;
+    /**
+     * 
+     * @type {ContentAttemptSettings}
+     * @memberof GetContent
+     */
+    attemptSettings: ContentAttemptSettings;
     /**
      * 
      * @type {GetContentContentData}
@@ -145,6 +158,7 @@ export function instanceOfGetContent(value: object): value is GetContent {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('contentType' in value) || value['contentType'] === undefined) return false;
     if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
+    if (!('attemptSettings' in value) || value['attemptSettings'] === undefined) return false;
     if (!('contentData' in value) || value['contentData'] === undefined) return false;
     if (!('published' in value) || value['published'] === undefined) return false;
     return true;
@@ -166,6 +180,7 @@ export function GetContentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'description': json['description'] == null ? undefined : json['description'],
         'contentType': json['content_type'],
         'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'attemptSettings': ContentAttemptSettingsFromJSON(json['attempt_settings']),
         'contentData': GetContentContentDataFromJSON(json['content_data']),
         'order': json['order'] == null ? undefined : json['order'],
         'published': json['published'],
@@ -193,6 +208,7 @@ export function GetContentToJSONTyped(value?: Omit<GetContent, 'id'|'created_dat
         'description': value['description'],
         'content_type': value['contentType'],
         'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'attempt_settings': ContentAttemptSettingsToJSON(value['attemptSettings']),
         'content_data': GetContentContentDataToJSON(value['contentData']),
         'order': value['order'],
         'published': value['published'],

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)),
     };
 }
 

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/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/PutContent.ts

@@ -20,6 +20,13 @@ import {
     ContentLaunchModeToJSON,
     ContentLaunchModeToJSONTyped,
 } from './ContentLaunchMode';
+import type { PutContentAttemptSettings } from './PutContentAttemptSettings';
+import {
+    PutContentAttemptSettingsFromJSON,
+    PutContentAttemptSettingsFromJSONTyped,
+    PutContentAttemptSettingsToJSON,
+    PutContentAttemptSettingsToJSONTyped,
+} from './PutContentAttemptSettings';
 
 /**
  * 
@@ -45,6 +52,12 @@ export interface PutContent {
      * @memberof PutContent
      */
     launchMode?: ContentLaunchMode;
+    /**
+     * 
+     * @type {PutContentAttemptSettings}
+     * @memberof PutContent
+     */
+    attemptSettings?: PutContentAttemptSettings;
 }
 
 
@@ -69,6 +82,7 @@ export function PutContentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'name': json['name'] == null ? undefined : json['name'],
         'published': json['published'] == null ? undefined : json['published'],
         'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
+        'attemptSettings': json['attempt_settings'] == null ? undefined : PutContentAttemptSettingsFromJSON(json['attempt_settings']),
     };
 }
 
@@ -86,6 +100,7 @@ export function PutContentToJSONTyped(value?: PutContent | null, ignoreDiscrimin
         'name': value['name'],
         'published': value['published'],
         'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'attempt_settings': PutContentAttemptSettingsToJSON(value['attemptSettings']),
     };
 }