@easyedu/js-lsm-api 1.96.0 → 1.98.0

package/docs/GetCourseVersionReporting.md

@@ -16,7 +16,7 @@ Name | Type
 `completionRatePercentage` | number
 `avgScorePercentage` | number
 `totalDurationSeconds` | number
-`modules` | [Array<GetCourseVersionModuleReporting>](GetCourseVersionModuleReporting.md)
+`sections` | [Array<GetCourseVersionSectionReporting>](GetCourseVersionSectionReporting.md)
 
 ## Example
 
@@ -35,7 +35,7 @@ const example = {
   "completionRatePercentage": null,
   "avgScorePercentage": null,
   "totalDurationSeconds": null,
-  "modules": null,
+  "sections": null,
 } satisfies GetCourseVersionReporting
 
 console.log(example)

package/docs/{GetCourseVersionModule.md → GetCourseVersionSection.md}

@@ -1,5 +1,5 @@
 
-# GetCourseVersionModule
+# GetCourseVersionSection
 
 
 ## Properties
@@ -11,12 +11,12 @@ Name | Type
 `description` | string
 `descriptionRich` | [RichTextDocument](RichTextDocument.md)
 `displayOrder` | number
-`items` | [Array<GetCourseVersionItem>](GetCourseVersionItem.md)
+`children` | [Array<GetCourseVersionSectionChild>](GetCourseVersionSectionChild.md)
 
 ## Example
 
 ```typescript
-import type { GetCourseVersionModule } from '@easyedu/js-lsm-api'
+import type { GetCourseVersionSection } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -25,8 +25,8 @@ const example = {
   "description": null,
   "descriptionRich": null,
   "displayOrder": null,
-  "items": null,
-} satisfies GetCourseVersionModule
+  "children": null,
+} satisfies GetCourseVersionSection
 
 console.log(example)
 
@@ -35,7 +35,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as GetCourseVersionModule
+const exampleParsed = JSON.parse(exampleJSON) as GetCourseVersionSection
 console.log(exampleParsed)
 ```
 

package/docs/{PutCourseVersionItemReorder.md → GetCourseVersionSectionChild.md}

@@ -1,22 +1,27 @@
 
-# PutCourseVersionItemReorder
+# GetCourseVersionSectionChild
 
+An ordered child entry containing exactly one section or course item.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`itemIds` | Set<string>
+`kind` | string
+`section` | [GetCourseVersionSection](GetCourseVersionSection.md)
+`item` | [GetCourseVersionItem](GetCourseVersionItem.md)
 
 ## Example
 
 ```typescript
-import type { PutCourseVersionItemReorder } from '@easyedu/js-lsm-api'
+import type { GetCourseVersionSectionChild } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
-  "itemIds": null,
-} satisfies PutCourseVersionItemReorder
+  "kind": null,
+  "section": null,
+  "item": null,
+} satisfies GetCourseVersionSectionChild
 
 console.log(example)
 
@@ -25,7 +30,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PutCourseVersionItemReorder
+const exampleParsed = JSON.parse(exampleJSON) as GetCourseVersionSectionChild
 console.log(exampleParsed)
 ```
 

package/docs/{GetCourseVersionModuleReporting.md → GetCourseVersionSectionReporting.md}

@@ -1,12 +1,12 @@
 
-# GetCourseVersionModuleReporting
+# GetCourseVersionSectionReporting
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`moduleId` | string
+`sectionId` | string
 `name` | string
 `itemCount` | number
 `requiredItemCount` | number
@@ -22,11 +22,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { GetCourseVersionModuleReporting } from '@easyedu/js-lsm-api'
+import type { GetCourseVersionSectionReporting } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
-  "moduleId": null,
+  "sectionId": null,
   "name": null,
   "itemCount": null,
   "requiredItemCount": null,
@@ -38,7 +38,7 @@ const example = {
   "avgScorePercentage": null,
   "totalDurationSeconds": null,
   "items": null,
-} satisfies GetCourseVersionModuleReporting
+} satisfies GetCourseVersionSectionReporting
 
 console.log(example)
 
@@ -47,7 +47,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as GetCourseVersionModuleReporting
+const exampleParsed = JSON.parse(exampleJSON) as GetCourseVersionSectionReporting
 console.log(exampleParsed)
 ```
 

package/docs/PostCourseExport.md

@@ -9,7 +9,7 @@ Name | Type
 ------------ | -------------
 `courseVersionId` | string
 `exportType` | string
-`moduleIds` | Array<string>
+`sectionIds` | Array<string>
 
 ## Example
 
@@ -20,7 +20,7 @@ import type { PostCourseExport } from '@easyedu/js-lsm-api'
 const example = {
   "courseVersionId": null,
   "exportType": null,
-  "moduleIds": null,
+  "sectionIds": null,
 } satisfies PostCourseExport
 
 console.log(example)

package/docs/PostCourseResume.md

@@ -9,7 +9,7 @@ Name | Type
 ------------ | -------------
 `courseId` | string
 `courseVersionId` | string
-`moduleId` | string
+`sectionId` | string
 `itemId` | string
 `kind` | string
 `sessionId` | string
@@ -27,7 +27,7 @@ import type { PostCourseResume } from '@easyedu/js-lsm-api'
 const example = {
   "courseId": null,
   "courseVersionId": null,
-  "moduleId": null,
+  "sectionId": null,
   "itemId": null,
   "kind": null,
   "sessionId": null,

package/docs/PostCourseVersionPublish.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `changeNotes` | string
+`promoteActiveEnrollments` | boolean
 
 ## Example
 
@@ -16,6 +17,7 @@ import type { PostCourseVersionPublish } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "changeNotes": null,
+  "promoteActiveEnrollments": null,
 } satisfies PostCourseVersionPublish
 
 console.log(example)

package/docs/{PostCourseVersionModule.md → PostCourseVersionSection.md}

@@ -1,5 +1,5 @@
 
-# PostCourseVersionModule
+# PostCourseVersionSection
 
 
 ## Properties
@@ -9,20 +9,22 @@ Name | Type
 `name` | string
 `description` | string
 `descriptionRich` | [RichTextDocument](RichTextDocument.md)
+`parentSectionId` | string
 `position` | number
 
 ## Example
 
 ```typescript
-import type { PostCourseVersionModule } from '@easyedu/js-lsm-api'
+import type { PostCourseVersionSection } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
   "name": null,
   "description": null,
   "descriptionRich": null,
+  "parentSectionId": null,
   "position": null,
-} satisfies PostCourseVersionModule
+} satisfies PostCourseVersionSection
 
 console.log(example)
 
@@ -31,7 +33,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PostCourseVersionModule
+const exampleParsed = JSON.parse(exampleJSON) as PostCourseVersionSection
 console.log(exampleParsed)
 ```
 

package/docs/{PostCourseVersionModuleDuplicate.md → PostCourseVersionSectionDuplicate.md}

@@ -1,5 +1,5 @@
 
-# PostCourseVersionModuleDuplicate
+# PostCourseVersionSectionDuplicate
 
 
 ## Properties
@@ -7,18 +7,20 @@
 Name | Type
 ------------ | -------------
 `name` | string
+`targetSectionId` | string
 `position` | number
 
 ## Example
 
 ```typescript
-import type { PostCourseVersionModuleDuplicate } from '@easyedu/js-lsm-api'
+import type { PostCourseVersionSectionDuplicate } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
   "name": null,
+  "targetSectionId": null,
   "position": null,
-} satisfies PostCourseVersionModuleDuplicate
+} satisfies PostCourseVersionSectionDuplicate
 
 console.log(example)
 
@@ -27,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PostCourseVersionModuleDuplicate
+const exampleParsed = JSON.parse(exampleJSON) as PostCourseVersionSectionDuplicate
 console.log(exampleParsed)
 ```
 

package/docs/PutCourseEnrollment.md

@@ -11,6 +11,7 @@ Name | Type
 `enrollmentDateEnd` | number
 `extensionDays` | number
 `notes` | string
+`courseVersionId` | string
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "enrollmentDateEnd": null,
   "extensionDays": null,
   "notes": null,
+  "courseVersionId": null,
 } satisfies PutCourseEnrollment
 
 console.log(example)

package/docs/PutCourseVersionItem.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `libraryVersionId` | string
-`targetModuleId` | string
+`targetSectionId` | string
 `displayName` | string
 `position` | number
 `isVisible` | boolean
@@ -25,7 +25,7 @@ import type { PutCourseVersionItem } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "libraryVersionId": null,
-  "targetModuleId": null,
+  "targetSectionId": null,
   "displayName": null,
   "position": null,
   "isVisible": null,

package/docs/{PutCourseVersionModuleReorder.md → PutCourseVersionOutlineEntryMove.md}

@@ -1,22 +1,28 @@
 
-# PutCourseVersionModuleReorder
+# PutCourseVersionOutlineEntryMove
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`moduleIds` | Set<string>
+`entryKind` | string
+`entryId` | string
+`targetSectionId` | string
+`position` | number
 
 ## Example
 
 ```typescript
-import type { PutCourseVersionModuleReorder } from '@easyedu/js-lsm-api'
+import type { PutCourseVersionOutlineEntryMove } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
-  "moduleIds": null,
-} satisfies PutCourseVersionModuleReorder
+  "entryKind": null,
+  "entryId": null,
+  "targetSectionId": null,
+  "position": null,
+} satisfies PutCourseVersionOutlineEntryMove
 
 console.log(example)
 
@@ -25,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PutCourseVersionModuleReorder
+const exampleParsed = JSON.parse(exampleJSON) as PutCourseVersionOutlineEntryMove
 console.log(exampleParsed)
 ```
 

package/docs/{PutCourseVersionModule.md → PutCourseVersionSection.md}

@@ -1,5 +1,5 @@
 
-# PutCourseVersionModule
+# PutCourseVersionSection
 
 
 ## Properties
@@ -9,20 +9,18 @@ Name | Type
 `name` | string
 `description` | string
 `descriptionRich` | [RichTextDocument](RichTextDocument.md)
-`position` | number
 
 ## Example
 
 ```typescript
-import type { PutCourseVersionModule } from '@easyedu/js-lsm-api'
+import type { PutCourseVersionSection } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
   "name": null,
   "description": null,
   "descriptionRich": null,
-  "position": null,
-} satisfies PutCourseVersionModule
+} satisfies PutCourseVersionSection
 
 console.log(example)
 
@@ -31,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PutCourseVersionModule
+const exampleParsed = JSON.parse(exampleJSON) as PutCourseVersionSection
 console.log(exampleParsed)
 ```
 

package/docs/ReportingApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**getCourseVersionModuleReporting**](ReportingApi.md#getcourseversionmodulereporting) | **GET** /courses/{courseId}/versions/{courseVersionId}/modules/{moduleId}/reporting | Get instructor reporting for one module in an explicit course version |
 | [**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 |
 
 
 
-## getCourseVersionModuleReporting
+## getCourseVersionReporting
 
-> GetCourseVersionModuleReporting getCourseVersionModuleReporting(courseId, courseVersionId, moduleId)
+> GetCourseVersionReporting getCourseVersionReporting(courseId, courseVersionId)
 
-Get instructor reporting for one module in an explicit course version
+Get instructor reporting for one explicit course version
 
 ### Example
 
@@ -22,7 +22,7 @@ import {
   Configuration,
   ReportingApi,
 } from '@easyedu/js-lsm-api';
-import type { GetCourseVersionModuleReportingRequest } from '@easyedu/js-lsm-api';
+import type { GetCourseVersionReportingRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
@@ -33,12 +33,10 @@ async function example() {
     courseId: courseId_example,
     // string
     courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string
-    moduleId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-  } satisfies GetCourseVersionModuleReportingRequest;
+  } satisfies GetCourseVersionReportingRequest;
 
   try {
-    const data = await api.getCourseVersionModuleReporting(body);
+    const data = await api.getCourseVersionReporting(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -56,11 +54,10 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **courseVersionId** | `string` |  | [Defaults to `undefined`] |
-| **moduleId** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**GetCourseVersionModuleReporting**](GetCourseVersionModuleReporting.md)
+[**GetCourseVersionReporting**](GetCourseVersionReporting.md)
 
 ### Authorization
 
@@ -75,17 +72,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Version-pinned module and item reporting |  -  |
-| **404** | Course version module not found in the selected portal |  -  |
+| **200** | Version-pinned course reporting |  -  |
+| **404** | Course version not found in the selected portal |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getCourseVersionReporting
+## getCourseVersionSectionReporting
 
-> GetCourseVersionReporting getCourseVersionReporting(courseId, courseVersionId)
+> GetCourseVersionSectionReporting getCourseVersionSectionReporting(courseId, courseVersionId, sectionId)
 
-Get instructor reporting for one explicit course version
+Get instructor reporting for one section and its descendants in an explicit course version
 
 ### Example
 
@@ -94,7 +91,7 @@ import {
   Configuration,
   ReportingApi,
 } from '@easyedu/js-lsm-api';
-import type { GetCourseVersionReportingRequest } from '@easyedu/js-lsm-api';
+import type { GetCourseVersionSectionReportingRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
@@ -105,10 +102,12 @@ async function example() {
     courseId: courseId_example,
     // string
     courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-  } satisfies GetCourseVersionReportingRequest;
+    // string
+    sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCourseVersionSectionReportingRequest;
 
   try {
-    const data = await api.getCourseVersionReporting(body);
+    const data = await api.getCourseVersionSectionReporting(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -126,10 +125,11 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **courseVersionId** | `string` |  | [Defaults to `undefined`] |
+| **sectionId** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**GetCourseVersionReporting**](GetCourseVersionReporting.md)
+[**GetCourseVersionSectionReporting**](GetCourseVersionSectionReporting.md)
 
 ### Authorization
 
@@ -144,8 +144,8 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Version-pinned course reporting |  -  |
-| **404** | Course version not found in the selected portal |  -  |
+| **200** | Version-pinned section and descendant-item reporting |  -  |
+| **404** | Course version section not found in the selected portal |  -  |
 
 [[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.96.0",
+  "version": "1.98.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {