@easyedu/js-lsm-api 1.101.0 → 1.102.0

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

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

package/src/models/GetCourseVersionItemProgression.ts

@@ -0,0 +1,184 @@
+/* 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 { ProgressionLockReason } from './ProgressionLockReason';
+import {
+    ProgressionLockReasonFromJSON,
+    ProgressionLockReasonFromJSONTyped,
+    ProgressionLockReasonToJSON,
+    ProgressionLockReasonToJSONTyped,
+} from './ProgressionLockReason';
+
+/**
+ * 
+ * @export
+ * @interface GetCourseVersionItemProgression
+ */
+export interface GetCourseVersionItemProgression {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemProgression
+     */
+    itemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemProgression
+     */
+    rootSectionId: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemProgression
+     */
+    isRequired: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemProgression
+     */
+    isLocked: boolean;
+    /**
+     * 
+     * @type {ProgressionLockReason}
+     * @memberof GetCourseVersionItemProgression
+     */
+    lockReason: ProgressionLockReason | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionItemProgression
+     */
+    blockingSectionId: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemProgression
+     */
+    nativeCompleted: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemProgression
+     */
+    effectiveCompleted: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemProgression
+     */
+    activeSeconds: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemProgression
+     */
+    minimumActiveSeconds: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemProgression
+     */
+    remainingActiveSeconds: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemProgression
+     */
+    timeRequirementMet: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemProgression
+     */
+    timeRequirementWaived: boolean;
+}
+
+
+
+/**
+ * Check if a given object implements the GetCourseVersionItemProgression interface.
+ */
+export function instanceOfGetCourseVersionItemProgression(value: object): value is GetCourseVersionItemProgression {
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('rootSectionId' in value) || value['rootSectionId'] === undefined) return false;
+    if (!('isRequired' in value) || value['isRequired'] === undefined) return false;
+    if (!('isLocked' in value) || value['isLocked'] === undefined) return false;
+    if (!('lockReason' in value) || value['lockReason'] === undefined) return false;
+    if (!('blockingSectionId' in value) || value['blockingSectionId'] === undefined) return false;
+    if (!('nativeCompleted' in value) || value['nativeCompleted'] === undefined) return false;
+    if (!('effectiveCompleted' in value) || value['effectiveCompleted'] === undefined) return false;
+    if (!('activeSeconds' in value) || value['activeSeconds'] === undefined) return false;
+    if (!('minimumActiveSeconds' in value) || value['minimumActiveSeconds'] === undefined) return false;
+    if (!('remainingActiveSeconds' in value) || value['remainingActiveSeconds'] === undefined) return false;
+    if (!('timeRequirementMet' in value) || value['timeRequirementMet'] === undefined) return false;
+    if (!('timeRequirementWaived' in value) || value['timeRequirementWaived'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionItemProgressionFromJSON(json: any): GetCourseVersionItemProgression {
+    return GetCourseVersionItemProgressionFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemProgressionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemProgression {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'itemId': json['item_id'],
+        'rootSectionId': json['root_section_id'],
+        'isRequired': json['is_required'],
+        'isLocked': json['is_locked'],
+        'lockReason': ProgressionLockReasonFromJSON(json['lock_reason']),
+        'blockingSectionId': json['blocking_section_id'],
+        'nativeCompleted': json['native_completed'],
+        'effectiveCompleted': json['effective_completed'],
+        'activeSeconds': json['active_seconds'],
+        'minimumActiveSeconds': json['minimum_active_seconds'],
+        'remainingActiveSeconds': json['remaining_active_seconds'],
+        'timeRequirementMet': json['time_requirement_met'],
+        'timeRequirementWaived': json['time_requirement_waived'],
+    };
+}
+
+export function GetCourseVersionItemProgressionToJSON(json: any): GetCourseVersionItemProgression {
+    return GetCourseVersionItemProgressionToJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemProgressionToJSONTyped(value?: GetCourseVersionItemProgression | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'item_id': value['itemId'],
+        'root_section_id': value['rootSectionId'],
+        'is_required': value['isRequired'],
+        'is_locked': value['isLocked'],
+        'lock_reason': ProgressionLockReasonToJSON(value['lockReason']),
+        'blocking_section_id': value['blockingSectionId'],
+        'native_completed': value['nativeCompleted'],
+        'effective_completed': value['effectiveCompleted'],
+        'active_seconds': value['activeSeconds'],
+        'minimum_active_seconds': value['minimumActiveSeconds'],
+        'remaining_active_seconds': value['remainingActiveSeconds'],
+        'time_requirement_met': value['timeRequirementMet'],
+        'time_requirement_waived': value['timeRequirementWaived'],
+    };
+}
+

package/src/models/GetCourseVersionItemSession.ts

@@ -126,11 +126,47 @@ export interface GetCourseVersionItemSession {
      */
     scoreRaw?: number | null;
     /**
-     * Accumulated active learner time across this session's activities.
+     * 
      * @type {number}
      * @memberof GetCourseVersionItemSession
      */
     durationSeconds: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    minimumActiveSeconds: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    accumulatedActiveSeconds: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    remainingActiveSeconds: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemSession
+     */
+    timeRequirementMet: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItemSession
+     */
+    timeRequirementWaived: boolean;
+    /**
+     * True when native completion and the placement's active-time requirement are both satisfied.
+     * @type {boolean}
+     * @memberof GetCourseVersionItemSession
+     */
+    effectiveCompletionMet: boolean;
     /**
      * 
      * @type {number}
@@ -171,6 +207,12 @@ export function instanceOfGetCourseVersionItemSession(value: object): value is G
     if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
     if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
+    if (!('minimumActiveSeconds' in value) || value['minimumActiveSeconds'] === undefined) return false;
+    if (!('accumulatedActiveSeconds' in value) || value['accumulatedActiveSeconds'] === undefined) return false;
+    if (!('remainingActiveSeconds' in value) || value['remainingActiveSeconds'] === undefined) return false;
+    if (!('timeRequirementMet' in value) || value['timeRequirementMet'] === undefined) return false;
+    if (!('timeRequirementWaived' in value) || value['timeRequirementWaived'] === undefined) return false;
+    if (!('effectiveCompletionMet' in value) || value['effectiveCompletionMet'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -201,6 +243,12 @@ export function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscri
         'gradeStatus': json['grade_status'],
         'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
         'durationSeconds': json['duration_seconds'],
+        'minimumActiveSeconds': json['minimum_active_seconds'],
+        'accumulatedActiveSeconds': json['accumulated_active_seconds'],
+        'remainingActiveSeconds': json['remaining_active_seconds'],
+        'timeRequirementMet': json['time_requirement_met'],
+        'timeRequirementWaived': json['time_requirement_waived'],
+        'effectiveCompletionMet': json['effective_completion_met'],
         'createdAt': json['created_at'],
         'updatedAt': json['updated_at'],
         'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
@@ -233,6 +281,12 @@ export function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionI
         'grade_status': value['gradeStatus'],
         'score_raw': value['scoreRaw'],
         'duration_seconds': value['durationSeconds'],
+        'minimum_active_seconds': value['minimumActiveSeconds'],
+        'accumulated_active_seconds': value['accumulatedActiveSeconds'],
+        'remaining_active_seconds': value['remainingActiveSeconds'],
+        'time_requirement_met': value['timeRequirementMet'],
+        'time_requirement_waived': value['timeRequirementWaived'],
+        'effective_completion_met': value['effectiveCompletionMet'],
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],
         'completed_at': value['completedAt'],