@easyedu/js-lsm-api 1.100.0 → 1.102.0

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.100.0",
+  "version": "1.102.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ChangelogApi.ts

@@ -0,0 +1,66 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetChangelogList,
+    GetChangelogListFromJSON,
+    GetChangelogListToJSON,
+} from '../models/GetChangelogList';
+
+/**
+ * 
+ */
+export class ChangelogApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getChangelog without sending the request
+     */
+    async getChangelogRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/changelog`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
+     * List user-facing product updates
+     */
+    async getChangelogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChangelogList>> {
+        const requestOptions = await this.getChangelogRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetChangelogListFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
+     * List user-facing product updates
+     */
+    async getChangelog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChangelogList> {
+        const response = await this.getChangelogRaw(initOverrides);
+        return await response.value();
+    }
+
+}

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,
@@ -276,6 +291,11 @@ export interface GetCourseVersionListRequest {
     courseId: string;
 }
 
+export interface GetCourseVersionProgressionRequest {
+    courseId: string;
+    courseVersionId: string;
+}
+
 export interface PostCourseRequest {
     postCourse: PostCourse;
 }
@@ -370,6 +390,11 @@ export interface PutCourseItemLearnerAttemptAllowanceRequest {
     putAttemptAllowance: PutAttemptAllowance;
 }
 
+export interface PutCourseVersionDraftRequest {
+    courseId: string;
+    putCourseVersionDraft: PutCourseVersionDraft;
+}
+
 export interface PutCourseVersionItemRequest {
     courseId: string;
     sectionId: string;
@@ -1351,6 +1376,59 @@ 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 = {};
+
+        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
      */
@@ -2350,6 +2428,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/apis/index.ts

@@ -2,6 +2,7 @@
 /* eslint-disable */
 export * from './CertificateApi';
 export * from './CertificateTemplateApi';
+export * from './ChangelogApi';
 export * from './ChatApi';
 export * from './ContentLibraryApi';
 export * from './ContentLibraryQuizApi';

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/GetChangelogEntry.ts

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * A user-facing summary of product changes published on one date.
+ * @export
+ * @interface GetChangelogEntry
+ */
+export interface GetChangelogEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetChangelogEntry
+     */
+    title: string;
+    /**
+     * A short Markdown-formatted summary. Multiple changes are represented as bullet points.
+     * @type {string}
+     * @memberof GetChangelogEntry
+     */
+    desc: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GetChangelogEntry
+     */
+    date: Date;
+}
+
+/**
+ * Check if a given object implements the GetChangelogEntry interface.
+ */
+export function instanceOfGetChangelogEntry(value: object): value is GetChangelogEntry {
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('desc' in value) || value['desc'] === undefined) return false;
+    if (!('date' in value) || value['date'] === undefined) return false;
+    return true;
+}
+
+export function GetChangelogEntryFromJSON(json: any): GetChangelogEntry {
+    return GetChangelogEntryFromJSONTyped(json, false);
+}
+
+export function GetChangelogEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'title': json['title'],
+        'desc': json['desc'],
+        'date': (new Date(json['date'])),
+    };
+}
+
+export function GetChangelogEntryToJSON(json: any): GetChangelogEntry {
+    return GetChangelogEntryToJSONTyped(json, false);
+}
+
+export function GetChangelogEntryToJSONTyped(value?: GetChangelogEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'title': value['title'],
+        'desc': value['desc'],
+        'date': value['date'].toISOString().substring(0,10),
+    };
+}
+

package/src/models/GetChangelogList.ts

@@ -0,0 +1,74 @@
+/* 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';
+import type { GetChangelogEntry } from './GetChangelogEntry';
+import {
+    GetChangelogEntryFromJSON,
+    GetChangelogEntryFromJSONTyped,
+    GetChangelogEntryToJSON,
+    GetChangelogEntryToJSONTyped,
+} from './GetChangelogEntry';
+
+/**
+ * 
+ * @export
+ * @interface GetChangelogList
+ */
+export interface GetChangelogList {
+    /**
+     * 
+     * @type {Array<GetChangelogEntry>}
+     * @memberof GetChangelogList
+     */
+    items: Array<GetChangelogEntry>;
+}
+
+/**
+ * Check if a given object implements the GetChangelogList interface.
+ */
+export function instanceOfGetChangelogList(value: object): value is GetChangelogList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetChangelogListFromJSON(json: any): GetChangelogList {
+    return GetChangelogListFromJSONTyped(json, false);
+}
+
+export function GetChangelogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetChangelogEntryFromJSON)),
+    };
+}
+
+export function GetChangelogListToJSON(json: any): GetChangelogList {
+    return GetChangelogListToJSONTyped(json, false);
+}
+
+export function GetChangelogListToJSONTyped(value?: GetChangelogList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetChangelogEntryToJSON)),
+    };
+}
+

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'],

package/src/models/GetCourseVersionItem.ts

@@ -99,6 +99,12 @@ export interface GetCourseVersionItem {
      * @memberof GetCourseVersionItem
      */
     isRequired: boolean;
+    /**
+     * Minimum cumulative active time required for this resource placement. Null disables the timer.
+     * @type {number}
+     * @memberof GetCourseVersionItem
+     */
+    minimumActiveSeconds: number | null;
     /**
      * 
      * @type {ContentLaunchMode}
@@ -159,6 +165,7 @@ export function instanceOfGetCourseVersionItem(value: object): value is GetCours
     if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
     if (!('isVisible' in value) || value['isVisible'] === undefined) return false;
     if (!('isRequired' in value) || value['isRequired'] === undefined) return false;
+    if (!('minimumActiveSeconds' in value) || value['minimumActiveSeconds'] === undefined) return false;
     if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
     if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
     if (!('scoreRollupStrategy' in value) || value['scoreRollupStrategy'] === undefined) return false;
@@ -188,6 +195,7 @@ export function GetCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator
         'displayOrder': json['display_order'],
         'isVisible': json['is_visible'],
         'isRequired': json['is_required'],
+        'minimumActiveSeconds': json['minimum_active_seconds'],
         'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
         'maxAttempts': json['max_attempts'],
         'scoreRollupStrategy': json['score_rollup_strategy'],
@@ -218,6 +226,7 @@ export function GetCourseVersionItemToJSONTyped(value?: GetCourseVersionItem | n
         'display_order': value['displayOrder'],
         'is_visible': value['isVisible'],
         'is_required': value['isRequired'],
+        'minimum_active_seconds': value['minimumActiveSeconds'],
         'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
         'max_attempts': value['maxAttempts'],
         'score_rollup_strategy': value['scoreRollupStrategy'],