@easyedu/js-lsm-api 1.96.0 → 1.98.0

package/src/models/GetCourseVersionSectionChild.ts

@@ -0,0 +1,108 @@
+/* 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 { GetCourseVersionItem } from './GetCourseVersionItem';
+import {
+    GetCourseVersionItemFromJSON,
+    GetCourseVersionItemFromJSONTyped,
+    GetCourseVersionItemToJSON,
+    GetCourseVersionItemToJSONTyped,
+} from './GetCourseVersionItem';
+import type { GetCourseVersionSection } from './GetCourseVersionSection';
+import {
+    GetCourseVersionSectionFromJSON,
+    GetCourseVersionSectionFromJSONTyped,
+    GetCourseVersionSectionToJSON,
+    GetCourseVersionSectionToJSONTyped,
+} from './GetCourseVersionSection';
+
+/**
+ * An ordered child entry containing exactly one section or course item.
+ * @export
+ * @interface GetCourseVersionSectionChild
+ */
+export interface GetCourseVersionSectionChild {
+    /**
+     * 
+     * @type {GetCourseVersionSectionChildKindEnum}
+     * @memberof GetCourseVersionSectionChild
+     */
+    kind: GetCourseVersionSectionChildKindEnum;
+    /**
+     * 
+     * @type {GetCourseVersionSection}
+     * @memberof GetCourseVersionSectionChild
+     */
+    section?: GetCourseVersionSection | null;
+    /**
+     * 
+     * @type {GetCourseVersionItem}
+     * @memberof GetCourseVersionSectionChild
+     */
+    item?: GetCourseVersionItem | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetCourseVersionSectionChildKindEnum = {
+    Section: 'section',
+    Item: 'item'
+} as const;
+export type GetCourseVersionSectionChildKindEnum = typeof GetCourseVersionSectionChildKindEnum[keyof typeof GetCourseVersionSectionChildKindEnum];
+
+
+/**
+ * Check if a given object implements the GetCourseVersionSectionChild interface.
+ */
+export function instanceOfGetCourseVersionSectionChild(value: object): value is GetCourseVersionSectionChild {
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionSectionChildFromJSON(json: any): GetCourseVersionSectionChild {
+    return GetCourseVersionSectionChildFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionSectionChildFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionSectionChild {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'kind': json['kind'],
+        'section': json['section'] == null ? undefined : GetCourseVersionSectionFromJSON(json['section']),
+        'item': json['item'] == null ? undefined : GetCourseVersionItemFromJSON(json['item']),
+    };
+}
+
+export function GetCourseVersionSectionChildToJSON(json: any): GetCourseVersionSectionChild {
+    return GetCourseVersionSectionChildToJSONTyped(json, false);
+}
+
+export function GetCourseVersionSectionChildToJSONTyped(value?: GetCourseVersionSectionChild | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'kind': value['kind'],
+        'section': GetCourseVersionSectionToJSON(value['section']),
+        'item': GetCourseVersionItemToJSON(value['item']),
+    };
+}
+

package/src/models/{GetCourseVersionModuleReporting.ts → GetCourseVersionSectionReporting.ts}

@@ -24,88 +24,88 @@ import {
 /**
  * 
  * @export
- * @interface GetCourseVersionModuleReporting
+ * @interface GetCourseVersionSectionReporting
  */
-export interface GetCourseVersionModuleReporting {
+export interface GetCourseVersionSectionReporting {
     /**
      * 
      * @type {string}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
-    moduleId: string;
+    sectionId: string;
     /**
      * 
      * @type {string}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     name: string;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     itemCount: number;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     requiredItemCount: number;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     enrollmentCount: number;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     completedCount: number;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     inProgressCount: number;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     notStartedCount: number;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     completionRatePercentage: number | null;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     avgScorePercentage: number | null;
     /**
      * 
      * @type {number}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     totalDurationSeconds: number;
     /**
      * 
      * @type {Array<GetCourseVersionItemReporting>}
-     * @memberof GetCourseVersionModuleReporting
+     * @memberof GetCourseVersionSectionReporting
      */
     items: Array<GetCourseVersionItemReporting>;
 }
 
 /**
- * Check if a given object implements the GetCourseVersionModuleReporting interface.
+ * Check if a given object implements the GetCourseVersionSectionReporting interface.
  */
-export function instanceOfGetCourseVersionModuleReporting(value: object): value is GetCourseVersionModuleReporting {
-    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+export function instanceOfGetCourseVersionSectionReporting(value: object): value is GetCourseVersionSectionReporting {
+    if (!('sectionId' in value) || value['sectionId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('itemCount' in value) || value['itemCount'] === undefined) return false;
     if (!('requiredItemCount' in value) || value['requiredItemCount'] === undefined) return false;
@@ -120,17 +120,17 @@ export function instanceOfGetCourseVersionModuleReporting(value: object): value
     return true;
 }
 
-export function GetCourseVersionModuleReportingFromJSON(json: any): GetCourseVersionModuleReporting {
-    return GetCourseVersionModuleReportingFromJSONTyped(json, false);
+export function GetCourseVersionSectionReportingFromJSON(json: any): GetCourseVersionSectionReporting {
+    return GetCourseVersionSectionReportingFromJSONTyped(json, false);
 }
 
-export function GetCourseVersionModuleReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModuleReporting {
+export function GetCourseVersionSectionReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionSectionReporting {
     if (json == null) {
         return json;
     }
     return {
         
-        'moduleId': json['module_id'],
+        'sectionId': json['section_id'],
         'name': json['name'],
         'itemCount': json['item_count'],
         'requiredItemCount': json['required_item_count'],
@@ -145,18 +145,18 @@ export function GetCourseVersionModuleReportingFromJSONTyped(json: any, ignoreDi
     };
 }
 
-export function GetCourseVersionModuleReportingToJSON(json: any): GetCourseVersionModuleReporting {
-    return GetCourseVersionModuleReportingToJSONTyped(json, false);
+export function GetCourseVersionSectionReportingToJSON(json: any): GetCourseVersionSectionReporting {
+    return GetCourseVersionSectionReportingToJSONTyped(json, false);
 }
 
-export function GetCourseVersionModuleReportingToJSONTyped(value?: GetCourseVersionModuleReporting | null, ignoreDiscriminator: boolean = false): any {
+export function GetCourseVersionSectionReportingToJSONTyped(value?: GetCourseVersionSectionReporting | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
 
     return {
         
-        'module_id': value['moduleId'],
+        'section_id': value['sectionId'],
         'name': value['name'],
         'item_count': value['itemCount'],
         'required_item_count': value['requiredItemCount'],

package/src/models/GetPermission.ts

@@ -38,7 +38,7 @@ export interface GetPermission {
      */
     description?: string | null;
     /**
-     * Grouping domain (e.g. course, module, content)
+     * Grouping domain (e.g. course, section, content)
      * @type {string}
      * @memberof GetPermission
      */

package/src/models/PostCourseExport.ts

@@ -32,11 +32,11 @@ export interface PostCourseExport {
      */
     exportType: PostCourseExportExportTypeEnum;
     /**
-     * IDs of the modules to include in the export
+     * IDs of the root sections to include in the export. Descendant sections are included automatically.
      * @type {Array<string>}
      * @memberof PostCourseExport
      */
-    moduleIds: Array<string>;
+    sectionIds: Array<string>;
 }
 
 
@@ -57,7 +57,7 @@ export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEn
 export function instanceOfPostCourseExport(value: object): value is PostCourseExport {
     if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
     if (!('exportType' in value) || value['exportType'] === undefined) return false;
-    if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
+    if (!('sectionIds' in value) || value['sectionIds'] === undefined) return false;
     return true;
 }
 
@@ -73,7 +73,7 @@ export function PostCourseExportFromJSONTyped(json: any, ignoreDiscriminator: bo
         
         'courseVersionId': json['course_version_id'],
         'exportType': json['export_type'],
-        'moduleIds': json['module_ids'],
+        'sectionIds': json['section_ids'],
     };
 }
 
@@ -90,7 +90,7 @@ export function PostCourseExportToJSONTyped(value?: PostCourseExport | null, ign
         
         'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
-        'module_ids': value['moduleIds'],
+        'section_ids': value['sectionIds'],
     };
 }
 

package/src/models/PostCourseResume.ts

@@ -36,7 +36,7 @@ export interface PostCourseResume {
      * @type {string}
      * @memberof PostCourseResume
      */
-    moduleId: string;
+    sectionId: string;
     /**
      * 
      * @type {string}
@@ -107,7 +107,7 @@ export type PostCourseResumeActionEnum = typeof PostCourseResumeActionEnum[keyof
 export function instanceOfPostCourseResume(value: object): value is PostCourseResume {
     if (!('courseId' in value) || value['courseId'] === undefined) return false;
     if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
-    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    if (!('sectionId' in value) || value['sectionId'] === undefined) return false;
     if (!('itemId' in value) || value['itemId'] === undefined) return false;
     if (!('kind' in value) || value['kind'] === undefined) return false;
     if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
@@ -130,7 +130,7 @@ export function PostCourseResumeFromJSONTyped(json: any, ignoreDiscriminator: bo
         
         'courseId': json['course_id'],
         'courseVersionId': json['course_version_id'],
-        'moduleId': json['module_id'],
+        'sectionId': json['section_id'],
         'itemId': json['item_id'],
         'kind': json['kind'],
         'sessionId': json['session_id'],
@@ -154,7 +154,7 @@ export function PostCourseResumeToJSONTyped(value?: PostCourseResume | null, ign
         
         'course_id': value['courseId'],
         'course_version_id': value['courseVersionId'],
-        'module_id': value['moduleId'],
+        'section_id': value['sectionId'],
         'item_id': value['itemId'],
         'kind': value['kind'],
         'session_id': value['sessionId'],

package/src/models/PostCourseVersionPublish.ts

@@ -25,6 +25,16 @@ export interface PostCourseVersionPublish {
      * @memberof PostCourseVersionPublish
      */
     changeNotes?: string;
+    /**
+     * When true, assign all Enrolled, InProgress, and Suspended Student enrollments
+     * for this course to the newly published version. Completed and other historical
+     * enrollments remain pinned to their original version. Existing progress and
+     * session history remain stored against the previous version and are not transferred.
+     * 
+     * @type {boolean}
+     * @memberof PostCourseVersionPublish
+     */
+    promoteActiveEnrollments?: boolean;
 }
 
 /**
@@ -45,6 +55,7 @@ export function PostCourseVersionPublishFromJSONTyped(json: any, ignoreDiscrimin
     return {
         
         'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'promoteActiveEnrollments': json['promote_active_enrollments'] == null ? undefined : json['promote_active_enrollments'],
     };
 }
 
@@ -60,6 +71,7 @@ export function PostCourseVersionPublishToJSONTyped(value?: PostCourseVersionPub
     return {
         
         'change_notes': value['changeNotes'],
+        'promote_active_enrollments': value['promoteActiveEnrollments'],
     };
 }
 

package/src/models/{PostCourseVersionModule.ts → PostCourseVersionSection.ts}

@@ -24,48 +24,54 @@ import {
 /**
  * 
  * @export
- * @interface PostCourseVersionModule
+ * @interface PostCourseVersionSection
  */
-export interface PostCourseVersionModule {
+export interface PostCourseVersionSection {
     /**
      * 
      * @type {string}
-     * @memberof PostCourseVersionModule
+     * @memberof PostCourseVersionSection
      */
     name: string;
     /**
      * 
      * @type {string}
-     * @memberof PostCourseVersionModule
+     * @memberof PostCourseVersionSection
      */
     description?: string;
     /**
      * 
      * @type {RichTextDocument}
-     * @memberof PostCourseVersionModule
+     * @memberof PostCourseVersionSection
      */
     descriptionRich?: RichTextDocument;
+    /**
+     * Parent section. Omit to create a root section.
+     * @type {string}
+     * @memberof PostCourseVersionSection
+     */
+    parentSectionId?: string;
     /**
      * 
      * @type {number}
-     * @memberof PostCourseVersionModule
+     * @memberof PostCourseVersionSection
      */
     position?: number;
 }
 
 /**
- * Check if a given object implements the PostCourseVersionModule interface.
+ * Check if a given object implements the PostCourseVersionSection interface.
  */
-export function instanceOfPostCourseVersionModule(value: object): value is PostCourseVersionModule {
+export function instanceOfPostCourseVersionSection(value: object): value is PostCourseVersionSection {
     if (!('name' in value) || value['name'] === undefined) return false;
     return true;
 }
 
-export function PostCourseVersionModuleFromJSON(json: any): PostCourseVersionModule {
-    return PostCourseVersionModuleFromJSONTyped(json, false);
+export function PostCourseVersionSectionFromJSON(json: any): PostCourseVersionSection {
+    return PostCourseVersionSectionFromJSONTyped(json, false);
 }
 
-export function PostCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionModule {
+export function PostCourseVersionSectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionSection {
     if (json == null) {
         return json;
     }
@@ -74,15 +80,16 @@ export function PostCourseVersionModuleFromJSONTyped(json: any, ignoreDiscrimina
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'descriptionRich': json['description_rich'] == null ? undefined : RichTextDocumentFromJSON(json['description_rich']),
+        'parentSectionId': json['parent_section_id'] == null ? undefined : json['parent_section_id'],
         'position': json['position'] == null ? undefined : json['position'],
     };
 }
 
-export function PostCourseVersionModuleToJSON(json: any): PostCourseVersionModule {
-    return PostCourseVersionModuleToJSONTyped(json, false);
+export function PostCourseVersionSectionToJSON(json: any): PostCourseVersionSection {
+    return PostCourseVersionSectionToJSONTyped(json, false);
 }
 
-export function PostCourseVersionModuleToJSONTyped(value?: PostCourseVersionModule | null, ignoreDiscriminator: boolean = false): any {
+export function PostCourseVersionSectionToJSONTyped(value?: PostCourseVersionSection | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -92,6 +99,7 @@ export function PostCourseVersionModuleToJSONTyped(value?: PostCourseVersionModu
         'name': value['name'],
         'description': value['description'],
         'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
+        'parent_section_id': value['parentSectionId'],
         'position': value['position'],
     };
 }

package/src/models/PostCourseVersionSectionDuplicate.ts

@@ -0,0 +1,81 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface PostCourseVersionSectionDuplicate
+ */
+export interface PostCourseVersionSectionDuplicate {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionSectionDuplicate
+     */
+    name?: string;
+    /**
+     * New parent section. Omit to duplicate at the root.
+     * @type {string}
+     * @memberof PostCourseVersionSectionDuplicate
+     */
+    targetSectionId?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCourseVersionSectionDuplicate
+     */
+    position?: number;
+}
+
+/**
+ * Check if a given object implements the PostCourseVersionSectionDuplicate interface.
+ */
+export function instanceOfPostCourseVersionSectionDuplicate(value: object): value is PostCourseVersionSectionDuplicate {
+    return true;
+}
+
+export function PostCourseVersionSectionDuplicateFromJSON(json: any): PostCourseVersionSectionDuplicate {
+    return PostCourseVersionSectionDuplicateFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionSectionDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionSectionDuplicate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'targetSectionId': json['target_section_id'] == null ? undefined : json['target_section_id'],
+        'position': json['position'] == null ? undefined : json['position'],
+    };
+}
+
+export function PostCourseVersionSectionDuplicateToJSON(json: any): PostCourseVersionSectionDuplicate {
+    return PostCourseVersionSectionDuplicateToJSONTyped(json, false);
+}
+
+export function PostCourseVersionSectionDuplicateToJSONTyped(value?: PostCourseVersionSectionDuplicate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'target_section_id': value['targetSectionId'],
+        'position': value['position'],
+    };
+}
+

package/src/models/PutCourseEnrollment.ts

@@ -52,6 +52,15 @@ export interface PutCourseEnrollment {
      * @memberof PutCourseEnrollment
      */
     notes?: string;
+    /**
+     * Reassign this learner enrollment to a published version of the same course.
+     * Only active or suspended Student enrollments can be reassigned. Progress and
+     * session history for the previous version are retained but are not transferred.
+     * 
+     * @type {string}
+     * @memberof PutCourseEnrollment
+     */
+    courseVersionId?: string;
 }
 
 
@@ -101,6 +110,7 @@ export function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
         'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
         'notes': json['notes'] == null ? undefined : json['notes'],
+        'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
     };
 }
 
@@ -120,6 +130,7 @@ export function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | nul
         'enrollment_date_end': value['enrollmentDateEnd'],
         'extension_days': value['extensionDays'],
         'notes': value['notes'],
+        'course_version_id': value['courseVersionId'],
     };
 }
 

package/src/models/PutCourseVersionItem.ts

@@ -38,7 +38,7 @@ export interface PutCourseVersionItem {
      * @type {string}
      * @memberof PutCourseVersionItem
      */
-    targetModuleId?: string;
+    targetSectionId?: string;
     /**
      * 
      * @type {string}
@@ -118,7 +118,7 @@ export function PutCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'libraryVersionId': json['library_version_id'] == null ? undefined : json['library_version_id'],
-        'targetModuleId': json['target_module_id'] == null ? undefined : json['target_module_id'],
+        'targetSectionId': json['target_section_id'] == null ? undefined : json['target_section_id'],
         'displayName': json['display_name'] == null ? undefined : json['display_name'],
         'position': json['position'] == null ? undefined : json['position'],
         'isVisible': json['is_visible'] == null ? undefined : json['is_visible'],
@@ -142,7 +142,7 @@ export function PutCourseVersionItemToJSONTyped(value?: PutCourseVersionItem | n
     return {
         
         'library_version_id': value['libraryVersionId'],
-        'target_module_id': value['targetModuleId'],
+        'target_section_id': value['targetSectionId'],
         'display_name': value['displayName'],
         'position': value['position'],
         'is_visible': value['isVisible'],