@easyedu/js-lsm-api 1.96.0 → 1.97.0

package/dist/esm/models/GetCourseVersionSectionReporting.d.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 type { GetCourseVersionItemReporting } from './GetCourseVersionItemReporting';
+/**
+ *
+ * @export
+ * @interface GetCourseVersionSectionReporting
+ */
+export interface GetCourseVersionSectionReporting {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    sectionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    name: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    itemCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    requiredItemCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    enrollmentCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    completedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    inProgressCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    notStartedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    completionRatePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    avgScorePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    totalDurationSeconds: number;
+    /**
+     *
+     * @type {Array<GetCourseVersionItemReporting>}
+     * @memberof GetCourseVersionSectionReporting
+     */
+    items: Array<GetCourseVersionItemReporting>;
+}
+/**
+ * Check if a given object implements the GetCourseVersionSectionReporting interface.
+ */
+export declare function instanceOfGetCourseVersionSectionReporting(value: object): value is GetCourseVersionSectionReporting;
+export declare function GetCourseVersionSectionReportingFromJSON(json: any): GetCourseVersionSectionReporting;
+export declare function GetCourseVersionSectionReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionSectionReporting;
+export declare function GetCourseVersionSectionReportingToJSON(json: any): GetCourseVersionSectionReporting;
+export declare function GetCourseVersionSectionReportingToJSONTyped(value?: GetCourseVersionSectionReporting | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/{GetCourseVersionModuleReporting.js → GetCourseVersionSectionReporting.js}

@@ -13,10 +13,10 @@
  */
 import { GetCourseVersionItemReportingFromJSON, GetCourseVersionItemReportingToJSON, } from './GetCourseVersionItemReporting';
 /**
- * Check if a given object implements the GetCourseVersionModuleReporting interface.
+ * Check if a given object implements the GetCourseVersionSectionReporting interface.
  */
-export function instanceOfGetCourseVersionModuleReporting(value) {
-    if (!('moduleId' in value) || value['moduleId'] === undefined)
+export function instanceOfGetCourseVersionSectionReporting(value) {
+    if (!('sectionId' in value) || value['sectionId'] === undefined)
         return false;
     if (!('name' in value) || value['name'] === undefined)
         return false;
@@ -42,15 +42,15 @@ export function instanceOfGetCourseVersionModuleReporting(value) {
         return false;
     return true;
 }
-export function GetCourseVersionModuleReportingFromJSON(json) {
-    return GetCourseVersionModuleReportingFromJSONTyped(json, false);
+export function GetCourseVersionSectionReportingFromJSON(json) {
+    return GetCourseVersionSectionReportingFromJSONTyped(json, false);
 }
-export function GetCourseVersionModuleReportingFromJSONTyped(json, ignoreDiscriminator) {
+export function GetCourseVersionSectionReportingFromJSONTyped(json, ignoreDiscriminator) {
     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'],
@@ -64,15 +64,15 @@ export function GetCourseVersionModuleReportingFromJSONTyped(json, ignoreDiscrim
         'items': (json['items'].map(GetCourseVersionItemReportingFromJSON)),
     };
 }
-export function GetCourseVersionModuleReportingToJSON(json) {
-    return GetCourseVersionModuleReportingToJSONTyped(json, false);
+export function GetCourseVersionSectionReportingToJSON(json) {
+    return GetCourseVersionSectionReportingToJSONTyped(json, false);
 }
-export function GetCourseVersionModuleReportingToJSONTyped(value, ignoreDiscriminator = false) {
+export function GetCourseVersionSectionReportingToJSONTyped(value, ignoreDiscriminator = false) {
     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/dist/esm/models/GetPermission.d.ts

@@ -34,7 +34,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/dist/esm/models/PostCourseExport.d.ts

@@ -28,11 +28,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>;
 }
 /**
  * @export

package/dist/esm/models/PostCourseExport.js

@@ -27,7 +27,7 @@ export function instanceOfPostCourseExport(value) {
         return false;
     if (!('exportType' in value) || value['exportType'] === undefined)
         return false;
-    if (!('moduleIds' in value) || value['moduleIds'] === undefined)
+    if (!('sectionIds' in value) || value['sectionIds'] === undefined)
         return false;
     return true;
 }
@@ -41,7 +41,7 @@ export function PostCourseExportFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'courseVersionId': json['course_version_id'],
         'exportType': json['export_type'],
-        'moduleIds': json['module_ids'],
+        'sectionIds': json['section_ids'],
     };
 }
 export function PostCourseExportToJSON(json) {
@@ -54,6 +54,6 @@ export function PostCourseExportToJSONTyped(value, ignoreDiscriminator = false)
     return {
         'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
-        'module_ids': value['moduleIds'],
+        'section_ids': value['sectionIds'],
     };
 }

package/dist/esm/models/PostCourseResume.d.ts

@@ -32,7 +32,7 @@ export interface PostCourseResume {
      * @type {string}
      * @memberof PostCourseResume
      */
-    moduleId: string;
+    sectionId: string;
     /**
      *
      * @type {string}

package/dist/esm/models/PostCourseResume.js

@@ -33,7 +33,7 @@ export function instanceOfPostCourseResume(value) {
         return false;
     if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
         return false;
-    if (!('moduleId' in value) || value['moduleId'] === undefined)
+    if (!('sectionId' in value) || value['sectionId'] === undefined)
         return false;
     if (!('itemId' in value) || value['itemId'] === undefined)
         return false;
@@ -61,7 +61,7 @@ export function PostCourseResumeFromJSONTyped(json, ignoreDiscriminator) {
     return {
         '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'],
@@ -81,7 +81,7 @@ export function PostCourseResumeToJSONTyped(value, ignoreDiscriminator = false)
     return {
         '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/dist/esm/models/PostCourseVersionSection.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 type { RichTextDocument } from './RichTextDocument';
+/**
+ *
+ * @export
+ * @interface PostCourseVersionSection
+ */
+export interface PostCourseVersionSection {
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionSection
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionSection
+     */
+    description?: string;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof PostCourseVersionSection
+     */
+    descriptionRich?: RichTextDocument;
+    /**
+     * Parent section. Omit to create a root section.
+     * @type {string}
+     * @memberof PostCourseVersionSection
+     */
+    parentSectionId?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PostCourseVersionSection
+     */
+    position?: number;
+}
+/**
+ * Check if a given object implements the PostCourseVersionSection interface.
+ */
+export declare function instanceOfPostCourseVersionSection(value: object): value is PostCourseVersionSection;
+export declare function PostCourseVersionSectionFromJSON(json: any): PostCourseVersionSection;
+export declare function PostCourseVersionSectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionSection;
+export declare function PostCourseVersionSectionToJSON(json: any): PostCourseVersionSection;
+export declare function PostCourseVersionSectionToJSONTyped(value?: PostCourseVersionSection | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/{PostCourseVersionModule.js → PostCourseVersionSection.js}

@@ -13,17 +13,17 @@
  */
 import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
 /**
- * Check if a given object implements the PostCourseVersionModule interface.
+ * Check if a given object implements the PostCourseVersionSection interface.
  */
-export function instanceOfPostCourseVersionModule(value) {
+export function instanceOfPostCourseVersionSection(value) {
     if (!('name' in value) || value['name'] === undefined)
         return false;
     return true;
 }
-export function PostCourseVersionModuleFromJSON(json) {
-    return PostCourseVersionModuleFromJSONTyped(json, false);
+export function PostCourseVersionSectionFromJSON(json) {
+    return PostCourseVersionSectionFromJSONTyped(json, false);
 }
-export function PostCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator) {
+export function PostCourseVersionSectionFromJSONTyped(json, ignoreDiscriminator) {
     if (json == null) {
         return json;
     }
@@ -31,13 +31,14 @@ export function PostCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator)
         '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) {
-    return PostCourseVersionModuleToJSONTyped(json, false);
+export function PostCourseVersionSectionToJSON(json) {
+    return PostCourseVersionSectionToJSONTyped(json, false);
 }
-export function PostCourseVersionModuleToJSONTyped(value, ignoreDiscriminator = false) {
+export function PostCourseVersionSectionToJSONTyped(value, ignoreDiscriminator = false) {
     if (value == null) {
         return value;
     }
@@ -45,6 +46,7 @@ export function PostCourseVersionModuleToJSONTyped(value, ignoreDiscriminator =
         'name': value['name'],
         'description': value['description'],
         'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
+        'parent_section_id': value['parentSectionId'],
         'position': value['position'],
     };
 }

package/dist/esm/models/PostCourseVersionSectionDuplicate.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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
+ * @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 declare function instanceOfPostCourseVersionSectionDuplicate(value: object): value is PostCourseVersionSectionDuplicate;
+export declare function PostCourseVersionSectionDuplicateFromJSON(json: any): PostCourseVersionSectionDuplicate;
+export declare function PostCourseVersionSectionDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionSectionDuplicate;
+export declare function PostCourseVersionSectionDuplicateToJSON(json: any): PostCourseVersionSectionDuplicate;
+export declare function PostCourseVersionSectionDuplicateToJSONTyped(value?: PostCourseVersionSectionDuplicate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCourseVersionSectionDuplicate.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PostCourseVersionSectionDuplicate interface.
+ */
+export function instanceOfPostCourseVersionSectionDuplicate(value) {
+    return true;
+}
+export function PostCourseVersionSectionDuplicateFromJSON(json) {
+    return PostCourseVersionSectionDuplicateFromJSONTyped(json, false);
+}
+export function PostCourseVersionSectionDuplicateFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostCourseVersionSectionDuplicateToJSONTyped(json, false);
+}
+export function PostCourseVersionSectionDuplicateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'target_section_id': value['targetSectionId'],
+        'position': value['position'],
+    };
+}

package/dist/esm/models/PutCourseVersionItem.d.ts

@@ -27,7 +27,7 @@ export interface PutCourseVersionItem {
      * @type {string}
      * @memberof PutCourseVersionItem
      */
-    targetModuleId?: string;
+    targetSectionId?: string;
     /**
      *
      * @type {string}

package/dist/esm/models/PutCourseVersionItem.js

@@ -34,7 +34,7 @@ export function PutCourseVersionItemFromJSONTyped(json, 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'],
@@ -54,7 +54,7 @@ export function PutCourseVersionItemToJSONTyped(value, ignoreDiscriminator = fal
     }
     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/dist/esm/models/PutCourseVersionOutlineEntryMove.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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
+ * @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 declare const PutCourseVersionOutlineEntryMoveEntryKindEnum: {
+    readonly Section: "section";
+    readonly Item: "item";
+};
+export type PutCourseVersionOutlineEntryMoveEntryKindEnum = typeof PutCourseVersionOutlineEntryMoveEntryKindEnum[keyof typeof PutCourseVersionOutlineEntryMoveEntryKindEnum];
+/**
+ * Check if a given object implements the PutCourseVersionOutlineEntryMove interface.
+ */
+export declare function instanceOfPutCourseVersionOutlineEntryMove(value: object): value is PutCourseVersionOutlineEntryMove;
+export declare function PutCourseVersionOutlineEntryMoveFromJSON(json: any): PutCourseVersionOutlineEntryMove;
+export declare function PutCourseVersionOutlineEntryMoveFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionOutlineEntryMove;
+export declare function PutCourseVersionOutlineEntryMoveToJSON(json: any): PutCourseVersionOutlineEntryMove;
+export declare function PutCourseVersionOutlineEntryMoveToJSONTyped(value?: PutCourseVersionOutlineEntryMove | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutCourseVersionOutlineEntryMove.js

@@ -0,0 +1,60 @@
+/* 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 PutCourseVersionOutlineEntryMoveEntryKindEnum = {
+    Section: 'section',
+    Item: 'item'
+};
+/**
+ * Check if a given object implements the PutCourseVersionOutlineEntryMove interface.
+ */
+export function instanceOfPutCourseVersionOutlineEntryMove(value) {
+    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) {
+    return PutCourseVersionOutlineEntryMoveFromJSONTyped(json, false);
+}
+export function PutCourseVersionOutlineEntryMoveFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PutCourseVersionOutlineEntryMoveToJSONTyped(json, false);
+}
+export function PutCourseVersionOutlineEntryMoveToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'entry_kind': value['entryKind'],
+        'entry_id': value['entryId'],
+        'target_section_id': value['targetSectionId'],
+        'position': value['position'],
+    };
+}

package/dist/esm/models/PutCourseVersionSection.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 type { RichTextDocument } from './RichTextDocument';
+/**
+ *
+ * @export
+ * @interface PutCourseVersionSection
+ */
+export interface PutCourseVersionSection {
+    /**
+     *
+     * @type {string}
+     * @memberof PutCourseVersionSection
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PutCourseVersionSection
+     */
+    description?: string;
+    /**
+     *
+     * @type {RichTextDocument}
+     * @memberof PutCourseVersionSection
+     */
+    descriptionRich?: RichTextDocument;
+}
+/**
+ * Check if a given object implements the PutCourseVersionSection interface.
+ */
+export declare function instanceOfPutCourseVersionSection(value: object): value is PutCourseVersionSection;
+export declare function PutCourseVersionSectionFromJSON(json: any): PutCourseVersionSection;
+export declare function PutCourseVersionSectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionSection;
+export declare function PutCourseVersionSectionToJSON(json: any): PutCourseVersionSection;
+export declare function PutCourseVersionSectionToJSONTyped(value?: PutCourseVersionSection | null, ignoreDiscriminator?: boolean): any;