@easyedu/js-lsm-api 1.123.0 → 1.125.0

package/dist/models/GetPortalManagementDashboardTopCourse.js

@@ -0,0 +1,66 @@
+"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.instanceOfGetPortalManagementDashboardTopCourse = instanceOfGetPortalManagementDashboardTopCourse;
+exports.GetPortalManagementDashboardTopCourseFromJSON = GetPortalManagementDashboardTopCourseFromJSON;
+exports.GetPortalManagementDashboardTopCourseFromJSONTyped = GetPortalManagementDashboardTopCourseFromJSONTyped;
+exports.GetPortalManagementDashboardTopCourseToJSON = GetPortalManagementDashboardTopCourseToJSON;
+exports.GetPortalManagementDashboardTopCourseToJSONTyped = GetPortalManagementDashboardTopCourseToJSONTyped;
+/**
+ * Check if a given object implements the GetPortalManagementDashboardTopCourse interface.
+ */
+function instanceOfGetPortalManagementDashboardTopCourse(value) {
+    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;
+}
+function GetPortalManagementDashboardTopCourseFromJSON(json) {
+    return GetPortalManagementDashboardTopCourseFromJSONTyped(json, false);
+}
+function GetPortalManagementDashboardTopCourseFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function GetPortalManagementDashboardTopCourseToJSON(json) {
+    return GetPortalManagementDashboardTopCourseToJSONTyped(json, false);
+}
+function GetPortalManagementDashboardTopCourseToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/PostCourseEnrollment.d.ts

@@ -40,15 +40,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/dist/models/PutCourseEnrollment.d.ts

@@ -24,12 +24,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}
@@ -71,14 +65,6 @@ export declare const PutCourseEnrollmentStatusEnum: {
     readonly Suspended: "Suspended";
 };
 export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
-/**
- * @export
- */
-export declare const PutCourseEnrollmentUserTypeEnum: {
-    readonly Student: "Student";
-    readonly Instructor: "Instructor";
-};
-export type PutCourseEnrollmentUserTypeEnum = typeof PutCourseEnrollmentUserTypeEnum[keyof typeof PutCourseEnrollmentUserTypeEnum];
 /**
  * Check if a given object implements the PutCourseEnrollment interface.
  */

package/dist/models/PutCourseEnrollment.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PutCourseEnrollmentUserTypeEnum = exports.PutCourseEnrollmentStatusEnum = void 0;
+exports.PutCourseEnrollmentStatusEnum = void 0;
 exports.instanceOfPutCourseEnrollment = instanceOfPutCourseEnrollment;
 exports.PutCourseEnrollmentFromJSON = PutCourseEnrollmentFromJSON;
 exports.PutCourseEnrollmentFromJSONTyped = PutCourseEnrollmentFromJSONTyped;
@@ -31,13 +31,6 @@ exports.PutCourseEnrollmentStatusEnum = {
     Archived: 'Archived',
     Suspended: 'Suspended'
 };
-/**
- * @export
- */
-exports.PutCourseEnrollmentUserTypeEnum = {
-    Student: 'Student',
-    Instructor: 'Instructor'
-};
 /**
  * Check if a given object implements the PutCourseEnrollment interface.
  */
@@ -53,7 +46,6 @@ function PutCourseEnrollmentFromJSONTyped(json, 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'],
@@ -69,7 +61,6 @@ function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'status': value['status'],
-        'user_type': value['userType'],
         'enrollment_date_end': value['enrollmentDateEnd'],
         'extension_days': value['extensionDays'],
         'notes': value['notes'],

package/dist/models/index.d.ts

@@ -117,6 +117,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';

package/dist/models/index.js

@@ -135,6 +135,12 @@ __exportStar(require("./GetPortalFaviconUpload"), exports);
 __exportStar(require("./GetPortalInvitationSummary"), exports);
 __exportStar(require("./GetPortalList"), exports);
 __exportStar(require("./GetPortalLogoUpload"), exports);
+__exportStar(require("./GetPortalManagementDashboard"), exports);
+__exportStar(require("./GetPortalManagementDashboardActivityDay"), exports);
+__exportStar(require("./GetPortalManagementDashboardAttention"), exports);
+__exportStar(require("./GetPortalManagementDashboardEnrollmentStatus"), exports);
+__exportStar(require("./GetPortalManagementDashboardSummary"), exports);
+__exportStar(require("./GetPortalManagementDashboardTopCourse"), exports);
 __exportStar(require("./GetPortalUser"), exports);
 __exportStar(require("./GetPortalUserFieldValues"), exports);
 __exportStar(require("./GetPortalUserList"), exports);

package/docs/CourseApi.md

@@ -29,7 +29,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postCourseDraft**](CourseApi.md#postcoursedraft) | **POST** /courses/{courseId}/draft | Create or return the single editable course draft |
 | [**postCourseDraftResourceUpdateAll**](CourseApi.md#postcoursedraftresourceupdateall) | **POST** /courses/{courseId}/draft/resources/update-all | Update all draft resource placements to their latest published versions |
 | [**postCourseDuplicate**](CourseApi.md#postcourseduplicate) | **POST** /courses/{courseId}/duplicate | Duplicate a course |
-| [**postCourseEnrollment**](CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment |
+| [**postCourseEnrollment**](CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new single-role course enrollment |
 | [**postCourseExport**](CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course |
 | [**postCourseImageUpload**](CourseApi.md#postcourseimageupload) | **POST** /courses/{courseId}/image | Upload a course image |
 | [**postCourseItemLearnerSessionsClear**](CourseApi.md#postcourseitemlearnersessionsclear) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear | Clear all live sessions for a learner and course item |
@@ -40,7 +40,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postCourseVersionSection**](CourseApi.md#postcourseversionsection) | **POST** /courses/{courseId}/draft/sections | Add a root or nested section to the editable course draft |
 | [**postCourseVersionSectionDuplicate**](CourseApi.md#postcourseversionsectionduplicate) | **POST** /courses/{courseId}/draft/sections/{sectionId}/duplicate | Recursively duplicate a draft section and reuse its pinned library items |
 | [**putCourse**](CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id |
-| [**putCourseEnrollment**](CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment |
+| [**putCourseEnrollment**](CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update an enrollment without changing its user type |
 | [**putCourseItemLearnerAttemptAllowance**](CourseApi.md#putcourseitemlearnerattemptallowance) | **PUT** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance | Set extra attempts for a learner on a course item |
 | [**putCourseVersionDraft**](CourseApi.md#putcourseversiondraft) | **PUT** /courses/{courseId}/draft | Update progression settings on the editable course draft |
 | [**putCourseVersionItem**](CourseApi.md#putcourseversionitem) | **PUT** /courses/{courseId}/draft/sections/{sectionId}/items/{itemId} | Update a draft placement; use the outline move endpoint to change its parent or position |
@@ -1823,7 +1823,7 @@ No authorization required
 
 > GetCourseEnrollment postCourseEnrollment(courseId, postCourseEnrollment)
 
-Create a new course enrollment
+Create a new single-role course enrollment
 
 ### Example
 
@@ -1882,7 +1882,9 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | post course enrollment response OK |  -  |
+| **200** | A prior terminal enrollment of the requested type was resumed |  -  |
+| **201** | A new enrollment of the requested type was created |  -  |
+| **409** | A current enrollment of the requested type already exists, or an enrollment limit was reached |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -2613,7 +2615,7 @@ No authorization required
 
 > GetCourseEnrollment putCourseEnrollment(courseId, enrollmentId, putCourseEnrollment)
 
-Update a course enrollment
+Update an enrollment without changing its user type
 
 ### Example
 

package/docs/GetPortalManagementDashboard.md

@@ -0,0 +1,46 @@
+
+# GetPortalManagementDashboard
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rangeDays` | number
+`generatedAt` | number
+`summary` | [GetPortalManagementDashboardSummary](GetPortalManagementDashboardSummary.md)
+`enrollmentStatus` | [GetPortalManagementDashboardEnrollmentStatus](GetPortalManagementDashboardEnrollmentStatus.md)
+`activity` | [Array<GetPortalManagementDashboardActivityDay>](GetPortalManagementDashboardActivityDay.md)
+`topCourses` | [Array<GetPortalManagementDashboardTopCourse>](GetPortalManagementDashboardTopCourse.md)
+`attention` | [GetPortalManagementDashboardAttention](GetPortalManagementDashboardAttention.md)
+
+## Example
+
+```typescript
+import type { GetPortalManagementDashboard } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rangeDays": null,
+  "generatedAt": null,
+  "summary": null,
+  "enrollmentStatus": null,
+  "activity": null,
+  "topCourses": null,
+  "attention": null,
+} satisfies GetPortalManagementDashboard
+
+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 GetPortalManagementDashboard
+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/GetPortalManagementDashboardActivityDay.md

@@ -0,0 +1,40 @@
+
+# GetPortalManagementDashboardActivityDay
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`date` | Date
+`activeLearnerCount` | number
+`loginCount` | number
+`completionCount` | number
+
+## Example
+
+```typescript
+import type { GetPortalManagementDashboardActivityDay } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "date": null,
+  "activeLearnerCount": null,
+  "loginCount": null,
+  "completionCount": null,
+} satisfies GetPortalManagementDashboardActivityDay
+
+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 GetPortalManagementDashboardActivityDay
+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/GetPortalManagementDashboardAttention.md

@@ -0,0 +1,42 @@
+
+# GetPortalManagementDashboardAttention
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`notStartedEnrollmentCount` | number
+`inactiveLearnerCount` | number
+`expiringEnrollmentCount` | number
+`expiringCertificateCount` | number
+`draftCourseCount` | number
+
+## Example
+
+```typescript
+import type { GetPortalManagementDashboardAttention } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "notStartedEnrollmentCount": null,
+  "inactiveLearnerCount": null,
+  "expiringEnrollmentCount": null,
+  "expiringCertificateCount": null,
+  "draftCourseCount": null,
+} satisfies GetPortalManagementDashboardAttention
+
+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 GetPortalManagementDashboardAttention
+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/GetPortalManagementDashboardEnrollmentStatus.md

@@ -0,0 +1,38 @@
+
+# GetPortalManagementDashboardEnrollmentStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`notStartedCount` | number
+`inProgressCount` | number
+`completedCount` | number
+
+## Example
+
+```typescript
+import type { GetPortalManagementDashboardEnrollmentStatus } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "notStartedCount": null,
+  "inProgressCount": null,
+  "completedCount": null,
+} satisfies GetPortalManagementDashboardEnrollmentStatus
+
+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 GetPortalManagementDashboardEnrollmentStatus
+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/GetPortalManagementDashboardSummary.md

@@ -0,0 +1,48 @@
+
+# GetPortalManagementDashboardSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`learnerCount` | number
+`activeLearnerCount` | number
+`activeEnrollmentCount` | number
+`completionRatePercentage` | number
+`courseCount` | number
+`publishedCourseCount` | number
+`draftCourseCount` | number
+`loginsToday` | number
+
+## Example
+
+```typescript
+import type { GetPortalManagementDashboardSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "learnerCount": null,
+  "activeLearnerCount": null,
+  "activeEnrollmentCount": null,
+  "completionRatePercentage": null,
+  "courseCount": null,
+  "publishedCourseCount": null,
+  "draftCourseCount": null,
+  "loginsToday": null,
+} satisfies GetPortalManagementDashboardSummary
+
+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 GetPortalManagementDashboardSummary
+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/GetPortalManagementDashboardTopCourse.md

@@ -0,0 +1,42 @@
+
+# GetPortalManagementDashboardTopCourse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`courseName` | string
+`enrollmentCount` | number
+`activeLearnerCount` | number
+`completionRatePercentage` | number
+
+## Example
+
+```typescript
+import type { GetPortalManagementDashboardTopCourse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "courseName": null,
+  "enrollmentCount": null,
+  "activeLearnerCount": null,
+  "completionRatePercentage": null,
+} satisfies GetPortalManagementDashboardTopCourse
+
+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 GetPortalManagementDashboardTopCourse
+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/PutCourseEnrollment.md

@@ -7,7 +7,6 @@
 Name | Type
 ------------ | -------------
 `status` | string
-`userType` | string
 `enrollmentDateEnd` | number
 `extensionDays` | number
 `notes` | string
@@ -21,7 +20,6 @@ import type { PutCourseEnrollment } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "status": null,
-  "userType": null,
   "enrollmentDateEnd": null,
   "extensionDays": null,
   "notes": null,

package/docs/ReportingApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 |------------- | ------------- | -------------|
 | [**getCourseVersionReporting**](ReportingApi.md#getcourseversionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/reporting | Get instructor reporting for one explicit course version |
 | [**getCourseVersionSectionReporting**](ReportingApi.md#getcourseversionsectionreporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/sections/{sectionId}/reporting | Get instructor reporting for one section and its descendants in an explicit course version |
+| [**getPortalManagementDashboard**](ReportingApi.md#getportalmanagementdashboard) | **GET** /reporting/portal/dashboard | Get the selected portal\'s management dashboard reporting |
 
 
 
@@ -149,3 +150,69 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## getPortalManagementDashboard
+
+> GetPortalManagementDashboard getPortalManagementDashboard(days)
+
+Get the selected portal\'s management dashboard reporting
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportingApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalManagementDashboardRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ReportingApi();
+
+  const body = {
+    // number | Number of UTC calendar days to include in activity reporting. (optional)
+    days: 56,
+  } satisfies GetPortalManagementDashboardRequest;
+
+  try {
+    const data = await api.getPortalManagementDashboard(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **days** | `number` | Number of UTC calendar days to include in activity reporting. | [Optional] [Defaults to `30`] |
+
+### Return type
+
+[**GetPortalManagementDashboard**](GetPortalManagementDashboard.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal-scoped dashboard totals, trends, and attention counts |  -  |
+| **400** | Invalid reporting range |  -  |
+
+[[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.123.0",
+  "version": "1.125.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/CourseApi.ts

@@ -1833,7 +1833,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create a new course enrollment
+     * Create a new single-role course enrollment
      */
     async postCourseEnrollmentRaw(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
         const requestOptions = await this.postCourseEnrollmentRequestOpts(requestParameters);
@@ -1843,7 +1843,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create a new course enrollment
+     * Create a new single-role course enrollment
      */
     async postCourseEnrollment(requestParameters: PostCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
         const response = await this.postCourseEnrollmentRaw(requestParameters, initOverrides);
@@ -2512,7 +2512,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update a course enrollment
+     * Update an enrollment without changing its user type
      */
     async putCourseEnrollmentRaw(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseEnrollment>> {
         const requestOptions = await this.putCourseEnrollmentRequestOpts(requestParameters);
@@ -2522,7 +2522,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update a course enrollment
+     * Update an enrollment without changing its user type
      */
     async putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment> {
         const response = await this.putCourseEnrollmentRaw(requestParameters, initOverrides);