@easyedu/js-lsm-api 1.101.0 → 1.103.0

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/PostCourseVersionItemSession.md

@@ -1,7 +1,7 @@
 
 # PostCourseVersionItemSession
 
-Start or resume a learner attempt for an exact course resource version.
+Start or resume a learner attempt, or an isolated sandbox preview attempt, for an exact course resource version.
 
 ## Properties
 

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,

package/docs/PutResourceSessionOverride.md

@@ -10,6 +10,7 @@ Name | Type
 `completionStatus` | string
 `gradeStatus` | string
 `scoreRaw` | number
+`waiveMinimumActiveTime` | boolean
 `reason` | string
 
 ## Example
@@ -22,6 +23,7 @@ const example = {
   "completionStatus": null,
   "gradeStatus": null,
   "scoreRaw": null,
+  "waiveMinimumActiveTime": null,
   "reason": null,
 } satisfies PutResourceSessionOverride
 

package/package.json

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

package/src/apis/ContentLibraryQuizApi.ts

@@ -196,6 +196,7 @@ export interface PostCourseLibraryQuizSessionRequest {
     courseId: string;
     courseVersionId: string;
     itemId: string;
+    preview?: boolean;
     postCourseLibraryQuizSession?: PostCourseLibraryQuizSession;
 }
 
@@ -888,6 +889,10 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         headerParameters['Content-Type'] = 'application/json';
@@ -908,7 +913,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
     }
 
     /**
-     * Start or resume a live attempt for a course-pinned quiz version
+     * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
      */
     async postCourseLibraryQuizSessionRaw(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>> {
         const requestOptions = await this.postCourseLibraryQuizSessionRequestOpts(requestParameters);
@@ -918,7 +923,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
     }
 
     /**
-     * Start or resume a live attempt for a course-pinned quiz version
+     * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
      */
     async postCourseLibraryQuizSession(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession> {
         const response = await this.postCourseLibraryQuizSessionRaw(requestParameters, initOverrides);

package/src/apis/CourseApi.ts

@@ -78,6 +78,11 @@ import {
     GetCourseVersionListFromJSON,
     GetCourseVersionListToJSON,
 } from '../models/GetCourseVersionList';
+import {
+    type GetCourseVersionProgression,
+    GetCourseVersionProgressionFromJSON,
+    GetCourseVersionProgressionToJSON,
+} from '../models/GetCourseVersionProgression';
 import {
     type GetCourseVersionSection,
     GetCourseVersionSectionFromJSON,
@@ -148,6 +153,11 @@ import {
     PostDuplicateFromJSON,
     PostDuplicateToJSON,
 } from '../models/PostDuplicate';
+import {
+    type ProgressionGateError,
+    ProgressionGateErrorFromJSON,
+    ProgressionGateErrorToJSON,
+} from '../models/ProgressionGateError';
 import {
     type PutAttemptAllowance,
     PutAttemptAllowanceFromJSON,
@@ -163,6 +173,11 @@ import {
     PutCourseEnrollmentFromJSON,
     PutCourseEnrollmentToJSON,
 } from '../models/PutCourseEnrollment';
+import {
+    type PutCourseVersionDraft,
+    PutCourseVersionDraftFromJSON,
+    PutCourseVersionDraftToJSON,
+} from '../models/PutCourseVersionDraft';
 import {
     type PutCourseVersionItem,
     PutCourseVersionItemFromJSON,
@@ -264,18 +279,26 @@ export interface GetCourseListRequest {
 export interface GetCourseVersionRequest {
     courseId: string;
     courseVersionId: string;
+    preview?: boolean;
 }
 
 export interface GetCourseVersionItemLaunchRequest {
     courseId: string;
     courseVersionId: string;
     itemId: string;
+    preview?: boolean;
 }
 
 export interface GetCourseVersionListRequest {
     courseId: string;
 }
 
+export interface GetCourseVersionProgressionRequest {
+    courseId: string;
+    courseVersionId: string;
+    preview?: boolean;
+}
+
 export interface PostCourseRequest {
     postCourse: PostCourse;
 }
@@ -331,6 +354,7 @@ export interface PostCourseVersionItemSessionRequest {
     courseId: string;
     courseVersionId: string;
     itemId: string;
+    preview?: boolean;
     postCourseVersionItemSession?: PostCourseVersionItemSession;
 }
 
@@ -370,6 +394,11 @@ export interface PutCourseItemLearnerAttemptAllowanceRequest {
     putAttemptAllowance: PutAttemptAllowance;
 }
 
+export interface PutCourseVersionDraftRequest {
+    courseId: string;
+    putCourseVersionDraft: PutCourseVersionDraft;
+}
+
 export interface PutCourseVersionItemRequest {
     courseId: string;
     sectionId: string;
@@ -1212,6 +1241,10 @@ export class CourseApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -1272,6 +1305,10 @@ export class CourseApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -1351,6 +1388,63 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getCourseVersionProgression without sending the request
+     */
+    async getCourseVersionProgressionRequestOpts(requestParameters: GetCourseVersionProgressionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getCourseVersionProgression().'
+            );
+        }
+
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionProgression().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/versions/{courseVersionId}/progression`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get learner-specific completion and section lock state
+     */
+    async getCourseVersionProgressionRaw(requestParameters: GetCourseVersionProgressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionProgression>> {
+        const requestOptions = await this.getCourseVersionProgressionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionProgressionFromJSON(jsonValue));
+    }
+
+    /**
+     * Get learner-specific completion and section lock state
+     */
+    async getCourseVersionProgression(requestParameters: GetCourseVersionProgressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionProgression> {
+        const response = await this.getCourseVersionProgressionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postCourse without sending the request
      */
@@ -1949,6 +2043,10 @@ export class CourseApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         headerParameters['Content-Type'] = 'application/json';
@@ -2350,6 +2448,61 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putCourseVersionDraft without sending the request
+     */
+    async putCourseVersionDraftRequestOpts(requestParameters: PutCourseVersionDraftRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putCourseVersionDraft().'
+            );
+        }
+
+        if (requestParameters['putCourseVersionDraft'] == null) {
+            throw new runtime.RequiredError(
+                'putCourseVersionDraft',
+                'Required parameter "putCourseVersionDraft" was null or undefined when calling putCourseVersionDraft().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/draft`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutCourseVersionDraftToJSON(requestParameters['putCourseVersionDraft']),
+        };
+    }
+
+    /**
+     * Update progression settings on the editable course draft
+     */
+    async putCourseVersionDraftRaw(requestParameters: PutCourseVersionDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersion>> {
+        const requestOptions = await this.putCourseVersionDraftRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionFromJSON(jsonValue));
+    }
+
+    /**
+     * Update progression settings on the editable course draft
+     */
+    async putCourseVersionDraft(requestParameters: PutCourseVersionDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersion> {
+        const response = await this.putCourseVersionDraftRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putCourseVersionItem without sending the request
      */

package/src/apis/PlayerApi.ts

@@ -58,6 +58,11 @@ import {
     PostResourceSessionActivityEventFromJSON,
     PostResourceSessionActivityEventToJSON,
 } from '../models/PostResourceSessionActivityEvent';
+import {
+    type ProgressionGateError,
+    ProgressionGateErrorFromJSON,
+    ProgressionGateErrorToJSON,
+} from '../models/ProgressionGateError';
 import {
     type PutResourceSessionOverride,
     PutResourceSessionOverrideFromJSON,

package/src/models/CourseProgressionMode.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+
+/**
+ * Controls whether top-level course sections unlock freely or in completion order.
+ * @export
+ */
+export const CourseProgressionMode = {
+    Free: 'free',
+    SequentialSections: 'sequential_sections'
+} as const;
+export type CourseProgressionMode = typeof CourseProgressionMode[keyof typeof CourseProgressionMode];
+
+
+export function instanceOfCourseProgressionMode(value: any): boolean {
+    for (const key in CourseProgressionMode) {
+        if (Object.prototype.hasOwnProperty.call(CourseProgressionMode, key)) {
+            if (CourseProgressionMode[key as keyof typeof CourseProgressionMode] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CourseProgressionModeFromJSON(json: any): CourseProgressionMode {
+    return CourseProgressionModeFromJSONTyped(json, false);
+}
+
+export function CourseProgressionModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseProgressionMode {
+    return json as CourseProgressionMode;
+}
+
+export function CourseProgressionModeToJSON(value?: CourseProgressionMode | null): any {
+    return value as any;
+}
+
+export function CourseProgressionModeToJSONTyped(value: any, ignoreDiscriminator: boolean): CourseProgressionMode {
+    return value as CourseProgressionMode;
+}
+

package/src/models/GetCourseVersion.ts

@@ -27,6 +27,13 @@ import {
     RichTextDocumentToJSON,
     RichTextDocumentToJSONTyped,
 } from './RichTextDocument';
+import type { CourseProgressionMode } from './CourseProgressionMode';
+import {
+    CourseProgressionModeFromJSON,
+    CourseProgressionModeFromJSONTyped,
+    CourseProgressionModeToJSON,
+    CourseProgressionModeToJSONTyped,
+} from './CourseProgressionMode';
 import type { GetCourseVersionSection } from './GetCourseVersionSection';
 import {
     GetCourseVersionSectionFromJSON,
@@ -89,6 +96,12 @@ export interface GetCourseVersion {
      * @memberof GetCourseVersion
      */
     changeNotes?: string | null;
+    /**
+     * 
+     * @type {CourseProgressionMode}
+     * @memberof GetCourseVersion
+     */
+    progressionMode: CourseProgressionMode;
     /**
      * 
      * @type {Array<GetCourseVersionSection>}
@@ -128,6 +141,7 @@ export function instanceOfGetCourseVersion(value: object): value is GetCourseVer
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('descriptionRich' in value) || value['descriptionRich'] === undefined) return false;
+    if (!('progressionMode' in value) || value['progressionMode'] === undefined) return false;
     if (!('sections' in value) || value['sections'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
@@ -152,6 +166,7 @@ export function GetCourseVersionFromJSONTyped(json: any, ignoreDiscriminator: bo
         'description': json['description'],
         'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
         'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'progressionMode': CourseProgressionModeFromJSON(json['progression_mode']),
         'sections': ((json['sections'] as Array<any>).map(GetCourseVersionSectionFromJSON)),
         'createdAt': json['created_at'],
         'updatedAt': json['updated_at'],
@@ -178,6 +193,7 @@ export function GetCourseVersionToJSONTyped(value?: GetCourseVersion | null, ign
         'description': value['description'],
         'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
         'change_notes': value['changeNotes'],
+        'progression_mode': CourseProgressionModeToJSON(value['progressionMode']),
         'sections': ((value['sections'] as Array<any>).map(GetCourseVersionSectionToJSON)),
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],