@easyedu/js-lsm-api 1.96.0 → 1.97.0

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

package/src/models/PutCourseVersionOutlineEntryMove.ts

@@ -0,0 +1,103 @@
+/* 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 PutCourseVersionOutlineEntryMove
+ */
+export interface PutCourseVersionOutlineEntryMove {
+    /**
+     * 
+     * @type {PutCourseVersionOutlineEntryMoveEntryKindEnum}
+     * @memberof PutCourseVersionOutlineEntryMove
+     */
+    entryKind: PutCourseVersionOutlineEntryMoveEntryKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutCourseVersionOutlineEntryMove
+     */
+    entryId: string;
+    /**
+     * Destination parent. Null is allowed only for sections and moves them to the course root.
+     * @type {string}
+     * @memberof PutCourseVersionOutlineEntryMove
+     */
+    targetSectionId: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PutCourseVersionOutlineEntryMove
+     */
+    position?: number;
+}
+
+
+/**
+ * @export
+ */
+export const PutCourseVersionOutlineEntryMoveEntryKindEnum = {
+    Section: 'section',
+    Item: 'item'
+} as const;
+export type PutCourseVersionOutlineEntryMoveEntryKindEnum = typeof PutCourseVersionOutlineEntryMoveEntryKindEnum[keyof typeof PutCourseVersionOutlineEntryMoveEntryKindEnum];
+
+
+/**
+ * Check if a given object implements the PutCourseVersionOutlineEntryMove interface.
+ */
+export function instanceOfPutCourseVersionOutlineEntryMove(value: object): value is PutCourseVersionOutlineEntryMove {
+    if (!('entryKind' in value) || value['entryKind'] === undefined) return false;
+    if (!('entryId' in value) || value['entryId'] === undefined) return false;
+    if (!('targetSectionId' in value) || value['targetSectionId'] === undefined) return false;
+    return true;
+}
+
+export function PutCourseVersionOutlineEntryMoveFromJSON(json: any): PutCourseVersionOutlineEntryMove {
+    return PutCourseVersionOutlineEntryMoveFromJSONTyped(json, false);
+}
+
+export function PutCourseVersionOutlineEntryMoveFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionOutlineEntryMove {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'entryKind': json['entry_kind'],
+        'entryId': json['entry_id'],
+        'targetSectionId': json['target_section_id'],
+        'position': json['position'] == null ? undefined : json['position'],
+    };
+}
+
+export function PutCourseVersionOutlineEntryMoveToJSON(json: any): PutCourseVersionOutlineEntryMove {
+    return PutCourseVersionOutlineEntryMoveToJSONTyped(json, false);
+}
+
+export function PutCourseVersionOutlineEntryMoveToJSONTyped(value?: PutCourseVersionOutlineEntryMove | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'entry_kind': value['entryKind'],
+        'entry_id': value['entryId'],
+        'target_section_id': value['targetSectionId'],
+        'position': value['position'],
+    };
+}
+

package/src/models/{PutCourseVersionModule.ts → PutCourseVersionSection.ts}

@@ -24,47 +24,41 @@ import {
 /**
  * 
  * @export
- * @interface PutCourseVersionModule
+ * @interface PutCourseVersionSection
  */
-export interface PutCourseVersionModule {
+export interface PutCourseVersionSection {
     /**
      * 
      * @type {string}
-     * @memberof PutCourseVersionModule
+     * @memberof PutCourseVersionSection
      */
     name?: string;
     /**
      * 
      * @type {string}
-     * @memberof PutCourseVersionModule
+     * @memberof PutCourseVersionSection
      */
     description?: string;
     /**
      * 
      * @type {RichTextDocument}
-     * @memberof PutCourseVersionModule
+     * @memberof PutCourseVersionSection
      */
     descriptionRich?: RichTextDocument;
-    /**
-     * 
-     * @type {number}
-     * @memberof PutCourseVersionModule
-     */
-    position?: number;
 }
 
 /**
- * Check if a given object implements the PutCourseVersionModule interface.
+ * Check if a given object implements the PutCourseVersionSection interface.
  */
-export function instanceOfPutCourseVersionModule(value: object): value is PutCourseVersionModule {
+export function instanceOfPutCourseVersionSection(value: object): value is PutCourseVersionSection {
     return true;
 }
 
-export function PutCourseVersionModuleFromJSON(json: any): PutCourseVersionModule {
-    return PutCourseVersionModuleFromJSONTyped(json, false);
+export function PutCourseVersionSectionFromJSON(json: any): PutCourseVersionSection {
+    return PutCourseVersionSectionFromJSONTyped(json, false);
 }
 
-export function PutCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionModule {
+export function PutCourseVersionSectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionSection {
     if (json == null) {
         return json;
     }
@@ -73,15 +67,14 @@ export function PutCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminat
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'descriptionRich': json['description_rich'] == null ? undefined : RichTextDocumentFromJSON(json['description_rich']),
-        'position': json['position'] == null ? undefined : json['position'],
     };
 }
 
-export function PutCourseVersionModuleToJSON(json: any): PutCourseVersionModule {
-    return PutCourseVersionModuleToJSONTyped(json, false);
+export function PutCourseVersionSectionToJSON(json: any): PutCourseVersionSection {
+    return PutCourseVersionSectionToJSONTyped(json, false);
 }
 
-export function PutCourseVersionModuleToJSONTyped(value?: PutCourseVersionModule | null, ignoreDiscriminator: boolean = false): any {
+export function PutCourseVersionSectionToJSONTyped(value?: PutCourseVersionSection | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -91,7 +84,6 @@ export function PutCourseVersionModuleToJSONTyped(value?: PutCourseVersionModule
         'name': value['name'],
         'description': value['description'],
         'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
-        'position': value['position'],
     };
 }
 

package/src/models/PutRolePermissions.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface PutRolePermissions {
     /**
-     * List of permission keys to assign (e.g. ["course:create", "module:update"])
+     * List of permission keys to assign (e.g. ["course:create", "section:update"])
      * @type {Array<string>}
      * @memberof PutRolePermissions
      */