@easyedu/js-lsm-api 1.48.0 → 1.49.0

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.48.0
+# @easyedu/js-lsm-api@1.49.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -421,7 +421,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.48.0`
+- Package version: `1.49.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/esm/models/GetModuleInstructorBasicReportingEngagement.d.ts

@@ -21,6 +21,30 @@ export interface GetModuleInstructorBasicReportingEngagement {
      * @memberof GetModuleInstructorBasicReportingEngagement
      */
     avgTimeSpentHours: number | null;
+    /**
+     * Percentage of active course-enrolled students who have completed every published content item in this module. Null if there are no active enrolled students.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completionRatePercentage: number | null;
+    /**
+     * Number of active course-enrolled students who have completed every published content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completedCount: number;
+    /**
+     * Number of active course-enrolled students who have started at least one content item in this module but have not completed all published items.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    inProgressCount: number;
+    /**
+     * Number of active course-enrolled students who have not opened any content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    notStartedCount: number;
 }
 /**
  * Check if a given object implements the GetModuleInstructorBasicReportingEngagement interface.

package/dist/esm/models/GetModuleInstructorBasicReportingEngagement.js

@@ -17,6 +17,14 @@
 export function instanceOfGetModuleInstructorBasicReportingEngagement(value) {
     if (!('avgTimeSpentHours' in value) || value['avgTimeSpentHours'] === undefined)
         return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined)
+        return false;
+    if (!('completedCount' in value) || value['completedCount'] === undefined)
+        return false;
+    if (!('inProgressCount' in value) || value['inProgressCount'] === undefined)
+        return false;
+    if (!('notStartedCount' in value) || value['notStartedCount'] === undefined)
+        return false;
     return true;
 }
 export function GetModuleInstructorBasicReportingEngagementFromJSON(json) {
@@ -28,6 +36,10 @@ export function GetModuleInstructorBasicReportingEngagementFromJSONTyped(json, i
     }
     return {
         'avgTimeSpentHours': json['avg_time_spent_hours'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+        'completedCount': json['completed_count'],
+        'inProgressCount': json['in_progress_count'],
+        'notStartedCount': json['not_started_count'],
     };
 }
 export function GetModuleInstructorBasicReportingEngagementToJSON(json) {
@@ -39,5 +51,9 @@ export function GetModuleInstructorBasicReportingEngagementToJSONTyped(value, ig
     }
     return {
         'avg_time_spent_hours': value['avgTimeSpentHours'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+        'completed_count': value['completedCount'],
+        'in_progress_count': value['inProgressCount'],
+        'not_started_count': value['notStartedCount'],
     };
 }

package/dist/models/GetModuleInstructorBasicReportingEngagement.d.ts

@@ -21,6 +21,30 @@ export interface GetModuleInstructorBasicReportingEngagement {
      * @memberof GetModuleInstructorBasicReportingEngagement
      */
     avgTimeSpentHours: number | null;
+    /**
+     * Percentage of active course-enrolled students who have completed every published content item in this module. Null if there are no active enrolled students.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completionRatePercentage: number | null;
+    /**
+     * Number of active course-enrolled students who have completed every published content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completedCount: number;
+    /**
+     * Number of active course-enrolled students who have started at least one content item in this module but have not completed all published items.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    inProgressCount: number;
+    /**
+     * Number of active course-enrolled students who have not opened any content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    notStartedCount: number;
 }
 /**
  * Check if a given object implements the GetModuleInstructorBasicReportingEngagement interface.

package/dist/models/GetModuleInstructorBasicReportingEngagement.js

@@ -24,6 +24,14 @@ exports.GetModuleInstructorBasicReportingEngagementToJSONTyped = GetModuleInstru
 function instanceOfGetModuleInstructorBasicReportingEngagement(value) {
     if (!('avgTimeSpentHours' in value) || value['avgTimeSpentHours'] === undefined)
         return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined)
+        return false;
+    if (!('completedCount' in value) || value['completedCount'] === undefined)
+        return false;
+    if (!('inProgressCount' in value) || value['inProgressCount'] === undefined)
+        return false;
+    if (!('notStartedCount' in value) || value['notStartedCount'] === undefined)
+        return false;
     return true;
 }
 function GetModuleInstructorBasicReportingEngagementFromJSON(json) {
@@ -35,6 +43,10 @@ function GetModuleInstructorBasicReportingEngagementFromJSONTyped(json, ignoreDi
     }
     return {
         'avgTimeSpentHours': json['avg_time_spent_hours'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+        'completedCount': json['completed_count'],
+        'inProgressCount': json['in_progress_count'],
+        'notStartedCount': json['not_started_count'],
     };
 }
 function GetModuleInstructorBasicReportingEngagementToJSON(json) {
@@ -46,5 +58,9 @@ function GetModuleInstructorBasicReportingEngagementToJSONTyped(value, ignoreDis
     }
     return {
         'avg_time_spent_hours': value['avgTimeSpentHours'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+        'completed_count': value['completedCount'],
+        'in_progress_count': value['inProgressCount'],
+        'not_started_count': value['notStartedCount'],
     };
 }

package/docs/GetModuleInstructorBasicReportingEngagement.md

@@ -7,6 +7,10 @@
 Name | Type
 ------------ | -------------
 `avgTimeSpentHours` | number
+`completionRatePercentage` | number
+`completedCount` | number
+`inProgressCount` | number
+`notStartedCount` | number
 
 ## Example
 
@@ -16,6 +20,10 @@ import type { GetModuleInstructorBasicReportingEngagement } from '@easyedu/js-ls
 // TODO: Update the object below with actual values
 const example = {
   "avgTimeSpentHours": null,
+  "completionRatePercentage": null,
+  "completedCount": null,
+  "inProgressCount": null,
+  "notStartedCount": null,
 } satisfies GetModuleInstructorBasicReportingEngagement
 
 console.log(example)

package/package.json

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

package/src/models/GetModuleInstructorBasicReportingEngagement.ts

@@ -25,6 +25,30 @@ export interface GetModuleInstructorBasicReportingEngagement {
      * @memberof GetModuleInstructorBasicReportingEngagement
      */
     avgTimeSpentHours: number | null;
+    /**
+     * Percentage of active course-enrolled students who have completed every published content item in this module. Null if there are no active enrolled students.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completionRatePercentage: number | null;
+    /**
+     * Number of active course-enrolled students who have completed every published content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completedCount: number;
+    /**
+     * Number of active course-enrolled students who have started at least one content item in this module but have not completed all published items.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    inProgressCount: number;
+    /**
+     * Number of active course-enrolled students who have not opened any content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    notStartedCount: number;
 }
 
 /**
@@ -32,6 +56,10 @@ export interface GetModuleInstructorBasicReportingEngagement {
  */
 export function instanceOfGetModuleInstructorBasicReportingEngagement(value: object): value is GetModuleInstructorBasicReportingEngagement {
     if (!('avgTimeSpentHours' in value) || value['avgTimeSpentHours'] === undefined) return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
+    if (!('completedCount' in value) || value['completedCount'] === undefined) return false;
+    if (!('inProgressCount' in value) || value['inProgressCount'] === undefined) return false;
+    if (!('notStartedCount' in value) || value['notStartedCount'] === undefined) return false;
     return true;
 }
 
@@ -46,6 +74,10 @@ export function GetModuleInstructorBasicReportingEngagementFromJSONTyped(json: a
     return {
         
         'avgTimeSpentHours': json['avg_time_spent_hours'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+        'completedCount': json['completed_count'],
+        'inProgressCount': json['in_progress_count'],
+        'notStartedCount': json['not_started_count'],
     };
 }
 
@@ -61,6 +93,10 @@ export function GetModuleInstructorBasicReportingEngagementToJSONTyped(value?: G
     return {
         
         'avg_time_spent_hours': value['avgTimeSpentHours'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+        'completed_count': value['completedCount'],
+        'in_progress_count': value['inProgressCount'],
+        'not_started_count': value['notStartedCount'],
     };
 }