@easyedu/js-lsm-api 1.94.0 → 1.95.0

package/dist/esm/apis/index.d.ts

@@ -1,7 +1,6 @@
 export * from './CertificateApi';
 export * from './CertificateTemplateApi';
 export * from './ChatApi';
-export * from './ContentApi';
 export * from './ContentLibraryApi';
 export * from './ContentLibraryQuizApi';
 export * from './CourseApi';
@@ -9,13 +8,11 @@ export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
 export * from './EmailTemplateApi';
-export * from './ModuleApi';
 export * from './OtherApi';
 export * from './PlayerApi';
 export * from './PortalApi';
 export * from './PortalSublicenseApi';
 export * from './QuestionApi';
-export * from './QuizApi';
 export * from './ReportingApi';
 export * from './RichTextApi';
 export * from './RoleApi';

package/dist/esm/apis/index.js

@@ -3,7 +3,6 @@
 export * from './CertificateApi';
 export * from './CertificateTemplateApi';
 export * from './ChatApi';
-export * from './ContentApi';
 export * from './ContentLibraryApi';
 export * from './ContentLibraryQuizApi';
 export * from './CourseApi';
@@ -11,13 +10,11 @@ export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
 export * from './EmailTemplateApi';
-export * from './ModuleApi';
 export * from './OtherApi';
 export * from './PlayerApi';
 export * from './PortalApi';
 export * from './PortalSublicenseApi';
 export * from './QuestionApi';
-export * from './QuizApi';
 export * from './ReportingApi';
 export * from './RichTextApi';
 export * from './RoleApi';

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

@@ -61,11 +61,11 @@ export interface CertificateConfig {
      */
     minQuizScore?: number | null;
     /**
-     * External ID of the gating quiz config
+     * Logical Content Library ID of the reusable gating quiz
      * @type {string}
      * @memberof CertificateConfig
      */
-    quizConfigId?: string | null;
+    quizId?: string | null;
     /**
      * Logical certificate design selection. Null uses scope defaults.
      * @type {string}

package/dist/esm/models/CertificateConfig.js

@@ -45,7 +45,7 @@ export function CertificateConfigFromJSONTyped(json, ignoreDiscriminator) {
         'expiryMonths': json['expiry_months'] == null ? undefined : json['expiry_months'],
         'requireQuizPass': json['require_quiz_pass'] == null ? undefined : json['require_quiz_pass'],
         'minQuizScore': json['min_quiz_score'] == null ? undefined : json['min_quiz_score'],
-        'quizConfigId': json['quiz_config_id'] == null ? undefined : json['quiz_config_id'],
+        'quizId': json['quiz_id'] == null ? undefined : json['quiz_id'],
         'certificateTemplateId': json['certificate_template_id'] == null ? undefined : json['certificate_template_id'],
         'renewalPolicy': json['renewal_policy'] == null ? undefined : CertificateRenewalPolicyFromJSON(json['renewal_policy']),
         'notificationPolicy': json['notification_policy'] == null ? undefined : CertificateNotificationPolicyFromJSON(json['notification_policy']),
@@ -69,7 +69,7 @@ export function CertificateConfigToJSONTyped(value, ignoreDiscriminator = false)
         'expiry_months': value['expiryMonths'],
         'require_quiz_pass': value['requireQuizPass'],
         'min_quiz_score': value['minQuizScore'],
-        'quiz_config_id': value['quizConfigId'],
+        'quiz_id': value['quizId'],
         'certificate_template_id': value['certificateTemplateId'],
         'renewal_policy': CertificateRenewalPolicyToJSON(value['renewalPolicy']),
         'notification_policy': CertificateNotificationPolicyToJSON(value['notificationPolicy']),

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

@@ -47,7 +47,7 @@ export interface EffectiveCertificateConfig {
      * @type {string}
      * @memberof EffectiveCertificateConfig
      */
-    quizConfigId?: string | null;
+    quizId?: string | null;
     /**
      * External ID of the config that resolved this (course override or portal default)
      * @type {string}

package/dist/esm/models/EffectiveCertificateConfig.js

@@ -54,7 +54,7 @@ export function EffectiveCertificateConfigFromJSONTyped(json, ignoreDiscriminato
         'expiryMonths': json['expiry_months'] == null ? undefined : json['expiry_months'],
         'requireQuizPass': json['require_quiz_pass'],
         'minQuizScore': json['min_quiz_score'] == null ? undefined : json['min_quiz_score'],
-        'quizConfigId': json['quiz_config_id'] == null ? undefined : json['quiz_config_id'],
+        'quizId': json['quiz_id'] == null ? undefined : json['quiz_id'],
         'sourceConfigId': json['source_config_id'] == null ? undefined : json['source_config_id'],
         'certificateTemplateId': json['certificate_template_id'] == null ? undefined : json['certificate_template_id'],
         'certificateTemplateVersionId': json['certificate_template_version_id'] == null ? undefined : json['certificate_template_version_id'],
@@ -77,7 +77,7 @@ export function EffectiveCertificateConfigToJSONTyped(value, ignoreDiscriminator
         'expiry_months': value['expiryMonths'],
         'require_quiz_pass': value['requireQuizPass'],
         'min_quiz_score': value['minQuizScore'],
-        'quiz_config_id': value['quizConfigId'],
+        'quiz_id': value['quizId'],
         'source_config_id': value['sourceConfigId'],
         'certificate_template_id': value['certificateTemplateId'],
         'certificate_template_version_id': value['certificateTemplateVersionId'],

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

@@ -27,6 +27,12 @@ export interface GetCourseExport {
      * @memberof GetCourseExport
      */
     courseId: string;
+    /**
+     * Immutable version used by the export; null only for historical records.
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    courseVersionId?: string | null;
     /**
      * The export format type
      * @type {GetCourseExportExportTypeEnum}

package/dist/esm/models/GetCourseExport.js

@@ -58,6 +58,7 @@ export function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
         'exportType': json['export_type'],
         'moduleIds': json['module_ids'],
         'createdBy': json['created_by'],
@@ -78,6 +79,7 @@ export function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'module_ids': value['moduleIds'],
         'created_by': value['createdBy'],

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

@@ -24,34 +24,28 @@ export interface GetCourseVersionItem {
     id: string;
     /**
      *
-     * @type {GetCourseVersionItemSourceKindEnum}
+     * @type {GetCourseVersionItemKindEnum}
      * @memberof GetCourseVersionItem
      */
-    sourceKind: GetCourseVersionItemSourceKindEnum;
-    /**
-     * Discriminates reusable Content Library placements without changing source_kind.
-     * @type {GetCourseVersionItemContentLibraryKindEnum}
-     * @memberof GetCourseVersionItem
-     */
-    contentLibraryKind?: GetCourseVersionItemContentLibraryKindEnum | null;
+    kind: GetCourseVersionItemKindEnum;
     /**
      *
      * @type {string}
      * @memberof GetCourseVersionItem
      */
-    contentLibraryItemId?: string | null;
+    libraryItemId: string;
     /**
      *
      * @type {string}
      * @memberof GetCourseVersionItem
      */
-    contentLibraryVersionId?: string | null;
+    selectedVersionId: string;
     /**
      *
      * @type {number}
      * @memberof GetCourseVersionItem
      */
-    resourceVersionNumber?: number | null;
+    selectedVersionNumber: number;
     /**
      *
      * @type {string}
@@ -88,6 +82,12 @@ export interface GetCourseVersionItem {
      * @memberof GetCourseVersionItem
      */
     isVisible: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetCourseVersionItem
+     */
+    isRequired: boolean;
     /**
      *
      * @type {ContentLaunchMode}
@@ -118,19 +118,11 @@ export interface GetCourseVersionItem {
 /**
  * @export
  */
-export declare const GetCourseVersionItemSourceKindEnum: {
-    readonly Library: "library";
-    readonly QuizSnapshot: "quiz_snapshot";
-};
-export type GetCourseVersionItemSourceKindEnum = typeof GetCourseVersionItemSourceKindEnum[keyof typeof GetCourseVersionItemSourceKindEnum];
-/**
- * @export
- */
-export declare const GetCourseVersionItemContentLibraryKindEnum: {
+export declare const GetCourseVersionItemKindEnum: {
     readonly Resource: "resource";
     readonly Quiz: "quiz";
 };
-export type GetCourseVersionItemContentLibraryKindEnum = typeof GetCourseVersionItemContentLibraryKindEnum[keyof typeof GetCourseVersionItemContentLibraryKindEnum];
+export type GetCourseVersionItemKindEnum = typeof GetCourseVersionItemKindEnum[keyof typeof GetCourseVersionItemKindEnum];
 /**
  * @export
  */

package/dist/esm/models/GetCourseVersionItem.js

@@ -15,14 +15,7 @@ import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLa
 /**
  * @export
  */
-export const GetCourseVersionItemSourceKindEnum = {
-    Library: 'library',
-    QuizSnapshot: 'quiz_snapshot'
-};
-/**
- * @export
- */
-export const GetCourseVersionItemContentLibraryKindEnum = {
+export const GetCourseVersionItemKindEnum = {
     Resource: 'resource',
     Quiz: 'quiz'
 };
@@ -39,7 +32,13 @@ export const GetCourseVersionItemScoreRollupStrategyEnum = {
 export function instanceOfGetCourseVersionItem(value) {
     if (!('id' in value) || value['id'] === undefined)
         return false;
-    if (!('sourceKind' in value) || value['sourceKind'] === undefined)
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('libraryItemId' in value) || value['libraryItemId'] === undefined)
+        return false;
+    if (!('selectedVersionId' in value) || value['selectedVersionId'] === undefined)
+        return false;
+    if (!('selectedVersionNumber' in value) || value['selectedVersionNumber'] === undefined)
         return false;
     if (!('updateAvailable' in value) || value['updateAvailable'] === undefined)
         return false;
@@ -49,6 +48,8 @@ export function instanceOfGetCourseVersionItem(value) {
         return false;
     if (!('isVisible' in value) || value['isVisible'] === undefined)
         return false;
+    if (!('isRequired' in value) || value['isRequired'] === undefined)
+        return false;
     if (!('launchMode' in value) || value['launchMode'] === undefined)
         return false;
     if (!('maxAttempts' in value) || value['maxAttempts'] === undefined)
@@ -68,17 +69,17 @@ export function GetCourseVersionItemFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'id': json['id'],
-        'sourceKind': json['source_kind'],
-        'contentLibraryKind': json['content_library_kind'] == null ? undefined : json['content_library_kind'],
-        'contentLibraryItemId': json['content_library_item_id'] == null ? undefined : json['content_library_item_id'],
-        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
-        'resourceVersionNumber': json['resource_version_number'] == null ? undefined : json['resource_version_number'],
+        'kind': json['kind'],
+        'libraryItemId': json['library_item_id'],
+        'selectedVersionId': json['selected_version_id'],
+        'selectedVersionNumber': json['selected_version_number'],
         'latestPublishedVersionId': json['latest_published_version_id'] == null ? undefined : json['latest_published_version_id'],
         'latestPublishedVersionNumber': json['latest_published_version_number'] == null ? undefined : json['latest_published_version_number'],
         'updateAvailable': json['update_available'],
         'displayName': json['display_name'],
         'displayOrder': json['display_order'],
         'isVisible': json['is_visible'],
+        'isRequired': json['is_required'],
         'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
         'maxAttempts': json['max_attempts'],
         'scoreRollupStrategy': json['score_rollup_strategy'],
@@ -94,17 +95,17 @@ export function GetCourseVersionItemToJSONTyped(value, ignoreDiscriminator = fal
     }
     return {
         'id': value['id'],
-        'source_kind': value['sourceKind'],
-        'content_library_kind': value['contentLibraryKind'],
-        'content_library_item_id': value['contentLibraryItemId'],
-        'content_library_version_id': value['contentLibraryVersionId'],
-        'resource_version_number': value['resourceVersionNumber'],
+        'kind': value['kind'],
+        'library_item_id': value['libraryItemId'],
+        'selected_version_id': value['selectedVersionId'],
+        'selected_version_number': value['selectedVersionNumber'],
         'latest_published_version_id': value['latestPublishedVersionId'],
         'latest_published_version_number': value['latestPublishedVersionNumber'],
         'update_available': value['updateAvailable'],
         'display_name': value['displayName'],
         'display_order': value['displayOrder'],
         'is_visible': value['isVisible'],
+        'is_required': value['isRequired'],
         'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
         'max_attempts': value['maxAttempts'],
         'score_rollup_strategy': value['scoreRollupStrategy'],

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

@@ -0,0 +1,100 @@
+/**
+ * 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 GetCourseVersionItemReporting
+ */
+export interface GetCourseVersionItemReporting {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemReporting
+     */
+    itemId: string;
+    /**
+     *
+     * @type {GetCourseVersionItemReportingKindEnum}
+     * @memberof GetCourseVersionItemReporting
+     */
+    kind: GetCourseVersionItemReportingKindEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionItemReporting
+     */
+    displayName: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetCourseVersionItemReporting
+     */
+    isVisible: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetCourseVersionItemReporting
+     */
+    isRequired: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemReporting
+     */
+    completedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemReporting
+     */
+    inProgressCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemReporting
+     */
+    notStartedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemReporting
+     */
+    completionRatePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemReporting
+     */
+    avgScorePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionItemReporting
+     */
+    totalDurationSeconds: number;
+}
+/**
+ * @export
+ */
+export declare const GetCourseVersionItemReportingKindEnum: {
+    readonly Resource: "resource";
+    readonly Quiz: "quiz";
+};
+export type GetCourseVersionItemReportingKindEnum = typeof GetCourseVersionItemReportingKindEnum[keyof typeof GetCourseVersionItemReportingKindEnum];
+/**
+ * Check if a given object implements the GetCourseVersionItemReporting interface.
+ */
+export declare function instanceOfGetCourseVersionItemReporting(value: object): value is GetCourseVersionItemReporting;
+export declare function GetCourseVersionItemReportingFromJSON(json: any): GetCourseVersionItemReporting;
+export declare function GetCourseVersionItemReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemReporting;
+export declare function GetCourseVersionItemReportingToJSON(json: any): GetCourseVersionItemReporting;
+export declare function GetCourseVersionItemReportingToJSONTyped(value?: GetCourseVersionItemReporting | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersionItemReporting.js

@@ -0,0 +1,90 @@
+/* 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 GetCourseVersionItemReportingKindEnum = {
+    Resource: 'resource',
+    Quiz: 'quiz'
+};
+/**
+ * Check if a given object implements the GetCourseVersionItemReporting interface.
+ */
+export function instanceOfGetCourseVersionItemReporting(value) {
+    if (!('itemId' in value) || value['itemId'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('displayName' in value) || value['displayName'] === undefined)
+        return false;
+    if (!('isVisible' in value) || value['isVisible'] === undefined)
+        return false;
+    if (!('isRequired' in value) || value['isRequired'] === undefined)
+        return false;
+    if (!('completedCount' in value) || value['completedCount'] === undefined)
+        return false;
+    if (!('inProgressCount' in value) || value['inProgressCount'] === undefined)
+        return false;
+    if (!('notStartedCount' in value) || value['notStartedCount'] === undefined)
+        return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined)
+        return false;
+    if (!('avgScorePercentage' in value) || value['avgScorePercentage'] === undefined)
+        return false;
+    if (!('totalDurationSeconds' in value) || value['totalDurationSeconds'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseVersionItemReportingFromJSON(json) {
+    return GetCourseVersionItemReportingFromJSONTyped(json, false);
+}
+export function GetCourseVersionItemReportingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'itemId': json['item_id'],
+        'kind': json['kind'],
+        'displayName': json['display_name'],
+        'isVisible': json['is_visible'],
+        'isRequired': json['is_required'],
+        'completedCount': json['completed_count'],
+        'inProgressCount': json['in_progress_count'],
+        'notStartedCount': json['not_started_count'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+        'avgScorePercentage': json['avg_score_percentage'],
+        'totalDurationSeconds': json['total_duration_seconds'],
+    };
+}
+export function GetCourseVersionItemReportingToJSON(json) {
+    return GetCourseVersionItemReportingToJSONTyped(json, false);
+}
+export function GetCourseVersionItemReportingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'item_id': value['itemId'],
+        'kind': value['kind'],
+        'display_name': value['displayName'],
+        'is_visible': value['isVisible'],
+        'is_required': value['isRequired'],
+        'completed_count': value['completedCount'],
+        'in_progress_count': value['inProgressCount'],
+        'not_started_count': value['notStartedCount'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+        'avg_score_percentage': value['avgScorePercentage'],
+        'total_duration_seconds': value['totalDurationSeconds'],
+    };
+}

package/dist/esm/models/GetCourseVersionModuleReporting.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 GetCourseVersionModuleReporting
+ */
+export interface GetCourseVersionModuleReporting {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    moduleId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    name: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    itemCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    requiredItemCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    enrollmentCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    completedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    inProgressCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    notStartedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    completionRatePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    avgScorePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    totalDurationSeconds: number;
+    /**
+     *
+     * @type {Array<GetCourseVersionItemReporting>}
+     * @memberof GetCourseVersionModuleReporting
+     */
+    items: Array<GetCourseVersionItemReporting>;
+}
+/**
+ * Check if a given object implements the GetCourseVersionModuleReporting interface.
+ */
+export declare function instanceOfGetCourseVersionModuleReporting(value: object): value is GetCourseVersionModuleReporting;
+export declare function GetCourseVersionModuleReportingFromJSON(json: any): GetCourseVersionModuleReporting;
+export declare function GetCourseVersionModuleReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModuleReporting;
+export declare function GetCourseVersionModuleReportingToJSON(json: any): GetCourseVersionModuleReporting;
+export declare function GetCourseVersionModuleReportingToJSONTyped(value?: GetCourseVersionModuleReporting | null, ignoreDiscriminator?: boolean): any;