@easyedu/js-lsm-api 1.123.0 → 1.125.0

package/src/models/GetPortalManagementDashboardTopCourse.ts

@@ -0,0 +1,102 @@
+/* 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 GetPortalManagementDashboardTopCourse
+ */
+export interface GetPortalManagementDashboardTopCourse {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPortalManagementDashboardTopCourse
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPortalManagementDashboardTopCourse
+     */
+    courseName: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardTopCourse
+     */
+    enrollmentCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardTopCourse
+     */
+    activeLearnerCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalManagementDashboardTopCourse
+     */
+    completionRatePercentage: number | null;
+}
+
+/**
+ * Check if a given object implements the GetPortalManagementDashboardTopCourse interface.
+ */
+export function instanceOfGetPortalManagementDashboardTopCourse(value: object): value is GetPortalManagementDashboardTopCourse {
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseName' in value) || value['courseName'] === undefined) return false;
+    if (!('enrollmentCount' in value) || value['enrollmentCount'] === undefined) return false;
+    if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === undefined) return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalManagementDashboardTopCourseFromJSON(json: any): GetPortalManagementDashboardTopCourse {
+    return GetPortalManagementDashboardTopCourseFromJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardTopCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalManagementDashboardTopCourse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseId': json['course_id'],
+        'courseName': json['course_name'],
+        'enrollmentCount': json['enrollment_count'],
+        'activeLearnerCount': json['active_learner_count'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+    };
+}
+
+export function GetPortalManagementDashboardTopCourseToJSON(json: any): GetPortalManagementDashboardTopCourse {
+    return GetPortalManagementDashboardTopCourseToJSONTyped(json, false);
+}
+
+export function GetPortalManagementDashboardTopCourseToJSONTyped(value?: GetPortalManagementDashboardTopCourse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_id': value['courseId'],
+        'course_name': value['courseName'],
+        'enrollment_count': value['enrollmentCount'],
+        'active_learner_count': value['activeLearnerCount'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+    };
+}
+

package/src/models/PostCourseEnrollment.ts

@@ -44,15 +44,19 @@ export interface PostCourseEnrollment {
      */
     notes?: string | null;
     /**
-     * The role/type of the user in this enrollment
+     * The role/type of this enrollment. A user may have one current Student and
+     * one current Instructor enrollment for the same course. Assign both roles
+     * with two requests, one for each user_type.
+     * 
      * @type {PostCourseEnrollmentUserTypeEnum}
      * @memberof PostCourseEnrollment
      */
     userType?: PostCourseEnrollmentUserTypeEnum | null;
     /**
-     * How to handle a learner with a prior terminal enrollment for this course.
-     * restart creates a new enrollment period; resume reopens the latest terminal
-     * enrollment. Active enrollments always conflict.
+     * How to handle a user with a prior terminal enrollment of the requested
+     * user_type for this course. restart creates a new enrollment period; resume
+     * reopens the latest terminal enrollment of that type. A current enrollment
+     * of the same type always conflicts.
      * 
      * @type {PostCourseEnrollmentReEnrollmentModeEnum}
      * @memberof PostCourseEnrollment

package/src/models/PutCourseEnrollment.ts

@@ -28,12 +28,6 @@ export interface PutCourseEnrollment {
      * @memberof PutCourseEnrollment
      */
     status?: PutCourseEnrollmentStatusEnum;
-    /**
-     * The role/type of the user in this enrollment
-     * @type {PutCourseEnrollmentUserTypeEnum}
-     * @memberof PutCourseEnrollment
-     */
-    userType?: PutCourseEnrollmentUserTypeEnum;
     /**
      * End date of the enrollment (Unix timestamp)
      * @type {number}
@@ -78,15 +72,6 @@ export const PutCourseEnrollmentStatusEnum = {
 } as const;
 export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
 
-/**
- * @export
- */
-export const PutCourseEnrollmentUserTypeEnum = {
-    Student: 'Student',
-    Instructor: 'Instructor'
-} as const;
-export type PutCourseEnrollmentUserTypeEnum = typeof PutCourseEnrollmentUserTypeEnum[keyof typeof PutCourseEnrollmentUserTypeEnum];
-
 
 /**
  * Check if a given object implements the PutCourseEnrollment interface.
@@ -106,7 +91,6 @@ export function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'status': json['status'] == null ? undefined : json['status'],
-        'userType': json['user_type'] == null ? undefined : json['user_type'],
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
         'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
         'notes': json['notes'] == null ? undefined : json['notes'],
@@ -126,7 +110,6 @@ export function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | nul
     return {
         
         'status': value['status'],
-        'user_type': value['userType'],
         'enrollment_date_end': value['enrollmentDateEnd'],
         'extension_days': value['extensionDays'],
         'notes': value['notes'],

package/src/models/index.ts

@@ -119,6 +119,12 @@ export * from './GetPortalFaviconUpload';
 export * from './GetPortalInvitationSummary';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
+export * from './GetPortalManagementDashboard';
+export * from './GetPortalManagementDashboardActivityDay';
+export * from './GetPortalManagementDashboardAttention';
+export * from './GetPortalManagementDashboardEnrollmentStatus';
+export * from './GetPortalManagementDashboardSummary';
+export * from './GetPortalManagementDashboardTopCourse';
 export * from './GetPortalUser';
 export * from './GetPortalUserFieldValues';
 export * from './GetPortalUserList';