@easyedu/js-lsm-api 1.101.0 → 1.103.0

package/src/models/PostCourseVersionItemSession.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime';
 /**
- * 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.
  * @export
  * @interface PostCourseVersionItemSession
  */

package/src/models/ProgressionGateError.ts

@@ -0,0 +1,131 @@
+/* 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';
+/**
+ * Structured detail explaining why learner progression is currently blocked.
+ * @export
+ * @interface ProgressionGateError
+ */
+export interface ProgressionGateError {
+    /**
+     * 
+     * @type {ProgressionGateErrorCodeEnum}
+     * @memberof ProgressionGateError
+     */
+    code: ProgressionGateErrorCodeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProgressionGateError
+     */
+    message: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProgressionGateError
+     */
+    blockingSectionId: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ProgressionGateError
+     */
+    blockingItemIds: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ProgressionGateError
+     */
+    minimumActiveSeconds: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ProgressionGateError
+     */
+    activeSeconds: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ProgressionGateError
+     */
+    remainingActiveSeconds: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const ProgressionGateErrorCodeEnum = {
+    ProgressionLocked: 'progression_locked',
+    MinimumActiveTimeNotMet: 'minimum_active_time_not_met'
+} as const;
+export type ProgressionGateErrorCodeEnum = typeof ProgressionGateErrorCodeEnum[keyof typeof ProgressionGateErrorCodeEnum];
+
+
+/**
+ * Check if a given object implements the ProgressionGateError interface.
+ */
+export function instanceOfProgressionGateError(value: object): value is ProgressionGateError {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('blockingSectionId' in value) || value['blockingSectionId'] === undefined) return false;
+    if (!('blockingItemIds' in value) || value['blockingItemIds'] === undefined) return false;
+    if (!('minimumActiveSeconds' in value) || value['minimumActiveSeconds'] === undefined) return false;
+    if (!('activeSeconds' in value) || value['activeSeconds'] === undefined) return false;
+    if (!('remainingActiveSeconds' in value) || value['remainingActiveSeconds'] === undefined) return false;
+    return true;
+}
+
+export function ProgressionGateErrorFromJSON(json: any): ProgressionGateError {
+    return ProgressionGateErrorFromJSONTyped(json, false);
+}
+
+export function ProgressionGateErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProgressionGateError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'],
+        'blockingSectionId': json['blocking_section_id'],
+        'blockingItemIds': json['blocking_item_ids'],
+        'minimumActiveSeconds': json['minimum_active_seconds'],
+        'activeSeconds': json['active_seconds'],
+        'remainingActiveSeconds': json['remaining_active_seconds'],
+    };
+}
+
+export function ProgressionGateErrorToJSON(json: any): ProgressionGateError {
+    return ProgressionGateErrorToJSONTyped(json, false);
+}
+
+export function ProgressionGateErrorToJSONTyped(value?: ProgressionGateError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'blocking_section_id': value['blockingSectionId'],
+        'blocking_item_ids': value['blockingItemIds'],
+        'minimum_active_seconds': value['minimumActiveSeconds'],
+        'active_seconds': value['activeSeconds'],
+        'remaining_active_seconds': value['remainingActiveSeconds'],
+    };
+}
+

package/src/models/ProgressionLockReason.ts

@@ -0,0 +1,52 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const ProgressionLockReason = {
+    PreviousSectionIncomplete: 'previous_section_incomplete'
+} as const;
+export type ProgressionLockReason = typeof ProgressionLockReason[keyof typeof ProgressionLockReason];
+
+
+export function instanceOfProgressionLockReason(value: any): boolean {
+    for (const key in ProgressionLockReason) {
+        if (Object.prototype.hasOwnProperty.call(ProgressionLockReason, key)) {
+            if (ProgressionLockReason[key as keyof typeof ProgressionLockReason] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ProgressionLockReasonFromJSON(json: any): ProgressionLockReason {
+    return ProgressionLockReasonFromJSONTyped(json, false);
+}
+
+export function ProgressionLockReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProgressionLockReason {
+    return json as ProgressionLockReason;
+}
+
+export function ProgressionLockReasonToJSON(value?: ProgressionLockReason | null): any {
+    return value as any;
+}
+
+export function ProgressionLockReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): ProgressionLockReason {
+    return value as ProgressionLockReason;
+}
+

package/src/models/PutCourseVersionDraft.ts

@@ -0,0 +1,76 @@
+/* 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 { CourseProgressionMode } from './CourseProgressionMode';
+import {
+    CourseProgressionModeFromJSON,
+    CourseProgressionModeFromJSONTyped,
+    CourseProgressionModeToJSON,
+    CourseProgressionModeToJSONTyped,
+} from './CourseProgressionMode';
+
+/**
+ * 
+ * @export
+ * @interface PutCourseVersionDraft
+ */
+export interface PutCourseVersionDraft {
+    /**
+     * 
+     * @type {CourseProgressionMode}
+     * @memberof PutCourseVersionDraft
+     */
+    progressionMode: CourseProgressionMode;
+}
+
+
+
+/**
+ * Check if a given object implements the PutCourseVersionDraft interface.
+ */
+export function instanceOfPutCourseVersionDraft(value: object): value is PutCourseVersionDraft {
+    if (!('progressionMode' in value) || value['progressionMode'] === undefined) return false;
+    return true;
+}
+
+export function PutCourseVersionDraftFromJSON(json: any): PutCourseVersionDraft {
+    return PutCourseVersionDraftFromJSONTyped(json, false);
+}
+
+export function PutCourseVersionDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionDraft {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'progressionMode': CourseProgressionModeFromJSON(json['progression_mode']),
+    };
+}
+
+export function PutCourseVersionDraftToJSON(json: any): PutCourseVersionDraft {
+    return PutCourseVersionDraftToJSONTyped(json, false);
+}
+
+export function PutCourseVersionDraftToJSONTyped(value?: PutCourseVersionDraft | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'progression_mode': CourseProgressionModeToJSON(value['progressionMode']),
+    };
+}
+

package/src/models/PutCourseVersionItem.ts

@@ -63,6 +63,12 @@ export interface PutCourseVersionItem {
      * @memberof PutCourseVersionItem
      */
     isRequired?: boolean;
+    /**
+     * Resource placements only. Set null to disable the timer.
+     * @type {number}
+     * @memberof PutCourseVersionItem
+     */
+    minimumActiveSeconds?: number | null;
     /**
      * 
      * @type {ContentLaunchMode}
@@ -123,6 +129,7 @@ export function PutCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator
         'position': json['position'] == null ? undefined : json['position'],
         'isVisible': json['is_visible'] == null ? undefined : json['is_visible'],
         'isRequired': json['is_required'] == null ? undefined : json['is_required'],
+        'minimumActiveSeconds': json['minimum_active_seconds'] == null ? undefined : json['minimum_active_seconds'],
         'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
         'maxAttempts': json['max_attempts'] == null ? undefined : json['max_attempts'],
         'scoreRollupStrategy': json['score_rollup_strategy'] == null ? undefined : json['score_rollup_strategy'],
@@ -147,6 +154,7 @@ export function PutCourseVersionItemToJSONTyped(value?: PutCourseVersionItem | n
         'position': value['position'],
         '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/PutResourceSessionOverride.ts

@@ -37,6 +37,12 @@ export interface PutResourceSessionOverride {
      * @memberof PutResourceSessionOverride
      */
     scoreRaw?: number;
+    /**
+     * Permanently waive the placement's minimum active-time requirement for this learner.
+     * @type {boolean}
+     * @memberof PutResourceSessionOverride
+     */
+    waiveMinimumActiveTime?: boolean;
     /**
      * 
      * @type {string}
@@ -89,6 +95,7 @@ export function PutResourceSessionOverrideFromJSONTyped(json: any, ignoreDiscrim
         'completionStatus': json['completion_status'] == null ? undefined : json['completion_status'],
         'gradeStatus': json['grade_status'] == null ? undefined : json['grade_status'],
         'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'waiveMinimumActiveTime': json['waive_minimum_active_time'] == null ? undefined : json['waive_minimum_active_time'],
         'reason': json['reason'],
     };
 }
@@ -107,6 +114,7 @@ export function PutResourceSessionOverrideToJSONTyped(value?: PutResourceSession
         'completion_status': value['completionStatus'],
         'grade_status': value['gradeStatus'],
         'score_raw': value['scoreRaw'],
+        'waive_minimum_active_time': value['waiveMinimumActiveTime'],
         'reason': value['reason'],
     };
 }

package/src/models/index.ts

@@ -25,6 +25,7 @@ export * from './CertificateTemplateVersion';
 export * from './ContentLaunchMode';
 export * from './ContentLibraryVersionStatus';
 export * from './CourseCatalog';
+export * from './CourseProgressionMode';
 export * from './CourseShare';
 export * from './EffectiveCertificateConfig';
 export * from './EmailTemplateDefinition';
@@ -54,12 +55,15 @@ export * from './GetCourseList';
 export * from './GetCourseVersion';
 export * from './GetCourseVersionItem';
 export * from './GetCourseVersionItemLaunch';
+export * from './GetCourseVersionItemProgression';
 export * from './GetCourseVersionItemReporting';
 export * from './GetCourseVersionItemSession';
 export * from './GetCourseVersionList';
+export * from './GetCourseVersionProgression';
 export * from './GetCourseVersionReporting';
 export * from './GetCourseVersionSection';
 export * from './GetCourseVersionSectionChild';
+export * from './GetCourseVersionSectionProgression';
 export * from './GetCourseVersionSectionReporting';
 export * from './GetEmailAssetUpload';
 export * from './GetEmailDelivery';
@@ -209,6 +213,8 @@ export * from './PostSignupRequest';
 export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
+export * from './ProgressionGateError';
+export * from './ProgressionLockReason';
 export * from './PutAttemptAllowance';
 export * from './PutBadgeIssuer';
 export * from './PutCertificateConfig';
@@ -217,6 +223,7 @@ export * from './PutCertificateTemplateDraft';
 export * from './PutCourse';
 export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';
+export * from './PutCourseVersionDraft';
 export * from './PutCourseVersionItem';
 export * from './PutCourseVersionOutlineEntryMove';
 export * from './PutCourseVersionSection';