@easyedu/js-lsm-api 1.100.0 → 1.102.0

package/docs/CourseApi.md

@@ -22,6 +22,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getCourseVersion**](CourseApi.md#getcourseversion) | **GET** /courses/{courseId}/versions/{courseVersionId} | Get one immutable course version or preview the owned draft |
 | [**getCourseVersionItemLaunch**](CourseApi.md#getcourseversionitemlaunch) | **GET** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch | Resolve the exact immutable resource launch selected by a course version |
 | [**getCourseVersionList**](CourseApi.md#getcourseversionlist) | **GET** /courses/{courseId}/versions | List immutable course versions and the current draft |
+| [**getCourseVersionProgression**](CourseApi.md#getcourseversionprogression) | **GET** /courses/{courseId}/versions/{courseVersionId}/progression | Get learner-specific completion and section lock state |
 | [**postCourse**](CourseApi.md#postcourse) | **POST** /courses | Post a new course |
 | [**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 |
@@ -39,6 +40,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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 |
 | [**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 |
 | [**putCourseVersionOutlineEntryMove**](CourseApi.md#putcourseversionoutlineentrymove) | **PUT** /courses/{courseId}/draft/outline/move | Move a section or item to a new parent and sibling position |
 | [**putCourseVersionSection**](CourseApi.md#putcourseversionsection) | **PUT** /courses/{courseId}/draft/sections/{sectionId} | Update a draft section |
@@ -1240,6 +1242,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | Pinned resource launch descriptor |  -  |
 | **403** | Learner is not assigned to this course version |  -  |
+| **409** | The item\'s top-level section is locked |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -1309,6 +1312,76 @@ 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)
 
 
+## getCourseVersionProgression
+
+> GetCourseVersionProgression getCourseVersionProgression(courseId, courseVersionId)
+
+Get learner-specific completion and section lock state
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseVersionProgressionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCourseVersionProgressionRequest;
+
+  try {
+    const data = await api.getCourseVersionProgression(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **courseVersionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetCourseVersionProgression**](GetCourseVersionProgression.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Learner progression state |  -  |
+| **403** | Learner is not assigned to this course version |  -  |
+| **404** | Course version not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postCourse
 
 > GetCourse postCourse(postCourse)
@@ -2081,7 +2154,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | Existing current attempt or a newly created attempt |  -  |
 | **403** | Learner is not assigned to this course version |  -  |
-| **409** | Maximum attempts reached |  -  |
+| **409** | Maximum attempts reached or the item\'s top-level section is locked |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -2515,6 +2588,75 @@ 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)
 
 
+## putCourseVersionDraft
+
+> GetCourseVersion putCourseVersionDraft(courseId, putCourseVersionDraft)
+
+Update progression settings on the editable course draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PutCourseVersionDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // PutCourseVersionDraft
+    putCourseVersionDraft: ...,
+  } satisfies PutCourseVersionDraftRequest;
+
+  try {
+    const data = await api.putCourseVersionDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **putCourseVersionDraft** | [PutCourseVersionDraft](PutCourseVersionDraft.md) |  | |
+
+### Return type
+
+[**GetCourseVersion**](GetCourseVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated course draft |  -  |
+| **404** | No draft exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## putCourseVersionItem
 
 > GetCourseVersionItem putCourseVersionItem(courseId, sectionId, itemId, putCourseVersionItem)

package/docs/CourseProgressionMode.md

@@ -0,0 +1,33 @@
+
+# CourseProgressionMode
+
+Controls whether top-level course sections unlock freely or in completion order.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { CourseProgressionMode } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies CourseProgressionMode
+
+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 CourseProgressionMode
+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/GetChangelogEntry.md

@@ -0,0 +1,39 @@
+
+# GetChangelogEntry
+
+A user-facing summary of product changes published on one date.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`title` | string
+`desc` | string
+`date` | Date
+
+## Example
+
+```typescript
+import type { GetChangelogEntry } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "title": null,
+  "desc": null,
+  "date": null,
+} satisfies GetChangelogEntry
+
+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 GetChangelogEntry
+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/GetChangelogList.md

@@ -0,0 +1,34 @@
+
+# GetChangelogList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<GetChangelogEntry>](GetChangelogEntry.md)
+
+## Example
+
+```typescript
+import type { GetChangelogList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetChangelogList
+
+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 GetChangelogList
+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/GetCourseVersion.md

@@ -14,6 +14,7 @@ Name | Type
 `description` | string
 `descriptionRich` | [RichTextDocument](RichTextDocument.md)
 `changeNotes` | string
+`progressionMode` | [CourseProgressionMode](CourseProgressionMode.md)
 `sections` | [Array<GetCourseVersionSection>](GetCourseVersionSection.md)
 `createdAt` | number
 `updatedAt` | number
@@ -34,6 +35,7 @@ const example = {
   "description": null,
   "descriptionRich": null,
   "changeNotes": null,
+  "progressionMode": null,
   "sections": null,
   "createdAt": null,
   "updatedAt": null,

package/docs/GetCourseVersionItem.md

@@ -18,6 +18,7 @@ Name | Type
 `displayOrder` | number
 `isVisible` | boolean
 `isRequired` | boolean
+`minimumActiveSeconds` | number
 `launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `maxAttempts` | number
 `scoreRollupStrategy` | string
@@ -42,6 +43,7 @@ const example = {
   "displayOrder": null,
   "isVisible": null,
   "isRequired": null,
+  "minimumActiveSeconds": null,
   "launchMode": null,
   "maxAttempts": null,
   "scoreRollupStrategy": null,

package/docs/GetCourseVersionItemProgression.md

@@ -0,0 +1,58 @@
+
+# GetCourseVersionItemProgression
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`itemId` | string
+`rootSectionId` | string
+`isRequired` | boolean
+`isLocked` | boolean
+`lockReason` | [ProgressionLockReason](ProgressionLockReason.md)
+`blockingSectionId` | string
+`nativeCompleted` | boolean
+`effectiveCompleted` | boolean
+`activeSeconds` | number
+`minimumActiveSeconds` | number
+`remainingActiveSeconds` | number
+`timeRequirementMet` | boolean
+`timeRequirementWaived` | boolean
+
+## Example
+
+```typescript
+import type { GetCourseVersionItemProgression } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "itemId": null,
+  "rootSectionId": null,
+  "isRequired": null,
+  "isLocked": null,
+  "lockReason": null,
+  "blockingSectionId": null,
+  "nativeCompleted": null,
+  "effectiveCompleted": null,
+  "activeSeconds": null,
+  "minimumActiveSeconds": null,
+  "remainingActiveSeconds": null,
+  "timeRequirementMet": null,
+  "timeRequirementWaived": null,
+} satisfies GetCourseVersionItemProgression
+
+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 GetCourseVersionItemProgression
+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/GetCourseVersionItemSession.md

@@ -22,6 +22,12 @@ Name | Type
 `gradeStatus` | string
 `scoreRaw` | number
 `durationSeconds` | number
+`minimumActiveSeconds` | number
+`accumulatedActiveSeconds` | number
+`remainingActiveSeconds` | number
+`timeRequirementMet` | boolean
+`timeRequirementWaived` | boolean
+`effectiveCompletionMet` | boolean
 `createdAt` | number
 `updatedAt` | number
 `completedAt` | number
@@ -48,6 +54,12 @@ const example = {
   "gradeStatus": null,
   "scoreRaw": null,
   "durationSeconds": null,
+  "minimumActiveSeconds": null,
+  "accumulatedActiveSeconds": null,
+  "remainingActiveSeconds": null,
+  "timeRequirementMet": null,
+  "timeRequirementWaived": null,
+  "effectiveCompletionMet": null,
   "createdAt": null,
   "updatedAt": null,
   "completedAt": null,

package/docs/GetCourseVersionProgression.md

@@ -0,0 +1,43 @@
+
+# GetCourseVersionProgression
+
+Learner-specific completion and lock state for an enrollment-pinned course version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`courseVersionId` | string
+`progressionMode` | [CourseProgressionMode](CourseProgressionMode.md)
+`sections` | [Array<GetCourseVersionSectionProgression>](GetCourseVersionSectionProgression.md)
+`items` | [Array<GetCourseVersionItemProgression>](GetCourseVersionItemProgression.md)
+
+## Example
+
+```typescript
+import type { GetCourseVersionProgression } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "courseVersionId": null,
+  "progressionMode": null,
+  "sections": null,
+  "items": null,
+} satisfies GetCourseVersionProgression
+
+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 GetCourseVersionProgression
+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/GetCourseVersionSectionProgression.md

@@ -0,0 +1,48 @@
+
+# GetCourseVersionSectionProgression
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sectionId` | string
+`rootSectionId` | string
+`isRootSection` | boolean
+`isComplete` | boolean
+`isLocked` | boolean
+`lockReason` | [ProgressionLockReason](ProgressionLockReason.md)
+`blockingSectionId` | string
+`blockingItemIds` | Array<string>
+
+## Example
+
+```typescript
+import type { GetCourseVersionSectionProgression } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sectionId": null,
+  "rootSectionId": null,
+  "isRootSection": null,
+  "isComplete": null,
+  "isLocked": null,
+  "lockReason": null,
+  "blockingSectionId": null,
+  "blockingItemIds": null,
+} satisfies GetCourseVersionSectionProgression
+
+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 GetCourseVersionSectionProgression
+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/GetResourceSession.md

@@ -30,6 +30,12 @@ Name | Type
 `gradeStatus` | string
 `scoreRaw` | number
 `durationSeconds` | number
+`minimumActiveSeconds` | number
+`accumulatedActiveSeconds` | number
+`remainingActiveSeconds` | number
+`timeRequirementMet` | boolean
+`timeRequirementWaived` | boolean
+`effectiveCompletionMet` | boolean
 `initializedAt` | number
 `terminatedAt` | number
 `createdAt` | number
@@ -66,6 +72,12 @@ const example = {
   "gradeStatus": null,
   "scoreRaw": null,
   "durationSeconds": null,
+  "minimumActiveSeconds": null,
+  "accumulatedActiveSeconds": null,
+  "remainingActiveSeconds": null,
+  "timeRequirementMet": null,
+  "timeRequirementWaived": null,
+  "effectiveCompletionMet": null,
   "initializedAt": null,
   "terminatedAt": null,
   "createdAt": null,

package/docs/PlayerApi.md

@@ -1181,6 +1181,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | Completed resource session |  -  |
 | **400** | SCORM sessions complete through their runtime |  -  |
+| **409** | Minimum active time has not elapsed |  -  |
 
 [[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/PostCourseVersionItem.md

@@ -12,6 +12,7 @@ Name | Type
 `position` | number
 `isVisible` | boolean
 `isRequired` | boolean
+`minimumActiveSeconds` | number
 `launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `maxAttempts` | number
 `scoreRollupStrategy` | string
@@ -30,6 +31,7 @@ const example = {
   "position": null,
   "isVisible": null,
   "isRequired": null,
+  "minimumActiveSeconds": null,
   "launchMode": null,
   "maxAttempts": null,
   "scoreRollupStrategy": null,

package/docs/ProgressionGateError.md

@@ -0,0 +1,47 @@
+
+# ProgressionGateError
+
+Structured detail explaining why learner progression is currently blocked.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+`blockingSectionId` | string
+`blockingItemIds` | Array<string>
+`minimumActiveSeconds` | number
+`activeSeconds` | number
+`remainingActiveSeconds` | number
+
+## Example
+
+```typescript
+import type { ProgressionGateError } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+  "blockingSectionId": null,
+  "blockingItemIds": null,
+  "minimumActiveSeconds": null,
+  "activeSeconds": null,
+  "remainingActiveSeconds": null,
+} satisfies ProgressionGateError
+
+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 ProgressionGateError
+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/ProgressionLockReason.md

@@ -0,0 +1,32 @@
+
+# ProgressionLockReason
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ProgressionLockReason } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ProgressionLockReason
+
+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 ProgressionLockReason
+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/PutCourseVersionDraft.md

@@ -0,0 +1,34 @@
+
+# PutCourseVersionDraft
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`progressionMode` | [CourseProgressionMode](CourseProgressionMode.md)
+
+## Example
+
+```typescript
+import type { PutCourseVersionDraft } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "progressionMode": null,
+} satisfies PutCourseVersionDraft
+
+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 PutCourseVersionDraft
+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/PutCourseVersionItem.md

@@ -12,6 +12,7 @@ Name | Type
 `position` | number
 `isVisible` | boolean
 `isRequired` | boolean
+`minimumActiveSeconds` | number
 `launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `maxAttempts` | number
 `scoreRollupStrategy` | string
@@ -30,6 +31,7 @@ const example = {
   "position": null,
   "isVisible": null,
   "isRequired": null,
+  "minimumActiveSeconds": null,
   "launchMode": null,
   "maxAttempts": null,
   "scoreRollupStrategy": null,