@easyedu/js-lsm-api 1.94.0 → 1.95.0

package/src/apis/index.ts

@@ -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/src/models/CertificateConfig.ts

@@ -84,11 +84,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}
@@ -156,7 +156,7 @@ export function CertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: b
         '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']),
@@ -184,7 +184,7 @@ export function CertificateConfigToJSONTyped(value?: CertificateConfig | null, i
         '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/src/models/EffectiveCertificateConfig.ts

@@ -70,7 +70,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}
@@ -162,7 +162,7 @@ export function EffectiveCertificateConfigFromJSONTyped(json: any, ignoreDiscrim
         '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'],
@@ -189,7 +189,7 @@ export function EffectiveCertificateConfigToJSONTyped(value?: EffectiveCertifica
         '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/src/models/GetCourseExport.ts

@@ -31,6 +31,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}
@@ -130,6 +136,7 @@ export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         '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'],
@@ -154,6 +161,7 @@ export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignor
         
         '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/src/models/GetCourseVersionItem.ts

@@ -35,34 +35,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}
@@ -99,6 +93,12 @@ export interface GetCourseVersionItem {
      * @memberof GetCourseVersionItem
      */
     isVisible: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetCourseVersionItem
+     */
+    isRequired: boolean;
     /**
      * 
      * @type {ContentLaunchMode}
@@ -129,20 +129,11 @@ export interface GetCourseVersionItem {
 /**
  * @export
  */
-export const GetCourseVersionItemSourceKindEnum = {
-    Library: 'library',
-    QuizSnapshot: 'quiz_snapshot'
-} as const;
-export type GetCourseVersionItemSourceKindEnum = typeof GetCourseVersionItemSourceKindEnum[keyof typeof GetCourseVersionItemSourceKindEnum];
-
-/**
- * @export
- */
-export const GetCourseVersionItemContentLibraryKindEnum = {
+export const GetCourseVersionItemKindEnum = {
     Resource: 'resource',
     Quiz: 'quiz'
 } as const;
-export type GetCourseVersionItemContentLibraryKindEnum = typeof GetCourseVersionItemContentLibraryKindEnum[keyof typeof GetCourseVersionItemContentLibraryKindEnum];
+export type GetCourseVersionItemKindEnum = typeof GetCourseVersionItemKindEnum[keyof typeof GetCourseVersionItemKindEnum];
 
 /**
  * @export
@@ -159,11 +150,15 @@ export type GetCourseVersionItemScoreRollupStrategyEnum = typeof GetCourseVersio
  */
 export function instanceOfGetCourseVersionItem(value: object): value is GetCourseVersionItem {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('sourceKind' in value) || value['sourceKind'] === undefined) return false;
+    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;
     if (!('displayName' in value) || value['displayName'] === undefined) return false;
     if (!('displayOrder' in value) || value['displayOrder'] === undefined) 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) return false;
     if (!('scoreRollupStrategy' in value) || value['scoreRollupStrategy'] === undefined) return false;
@@ -182,17 +177,17 @@ export function GetCourseVersionItemFromJSONTyped(json: any, 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'],
@@ -212,17 +207,17 @@ export function GetCourseVersionItemToJSONTyped(value?: GetCourseVersionItem | n
     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/src/models/GetCourseVersionItemReporting.ts

@@ -0,0 +1,167 @@
+/* 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 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 const GetCourseVersionItemReportingKindEnum = {
+    Resource: 'resource',
+    Quiz: 'quiz'
+} as const;
+export type GetCourseVersionItemReportingKindEnum = typeof GetCourseVersionItemReportingKindEnum[keyof typeof GetCourseVersionItemReportingKindEnum];
+
+
+/**
+ * Check if a given object implements the GetCourseVersionItemReporting interface.
+ */
+export function instanceOfGetCourseVersionItemReporting(value: object): value is GetCourseVersionItemReporting {
+    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: any): GetCourseVersionItemReporting {
+    return GetCourseVersionItemReportingFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemReporting {
+    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: any): GetCourseVersionItemReporting {
+    return GetCourseVersionItemReportingToJSONTyped(json, false);
+}
+
+export function GetCourseVersionItemReportingToJSONTyped(value?: GetCourseVersionItemReporting | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetCourseVersionModuleReporting.ts

@@ -0,0 +1,173 @@
+/* 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 { GetCourseVersionItemReporting } from './GetCourseVersionItemReporting';
+import {
+    GetCourseVersionItemReportingFromJSON,
+    GetCourseVersionItemReportingFromJSONTyped,
+    GetCourseVersionItemReportingToJSON,
+    GetCourseVersionItemReportingToJSONTyped,
+} 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 function instanceOfGetCourseVersionModuleReporting(value: object): value is GetCourseVersionModuleReporting {
+    if (!('moduleId' in value) || value['moduleId'] === 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;
+    if (!('enrollmentCount' in value) || value['enrollmentCount'] === 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;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionModuleReportingFromJSON(json: any): GetCourseVersionModuleReporting {
+    return GetCourseVersionModuleReportingFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionModuleReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModuleReporting {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'moduleId': json['module_id'],
+        'name': json['name'],
+        'itemCount': json['item_count'],
+        'requiredItemCount': json['required_item_count'],
+        'enrollmentCount': json['enrollment_count'],
+        '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'],
+        'items': ((json['items'] as Array<any>).map(GetCourseVersionItemReportingFromJSON)),
+    };
+}
+
+export function GetCourseVersionModuleReportingToJSON(json: any): GetCourseVersionModuleReporting {
+    return GetCourseVersionModuleReportingToJSONTyped(json, false);
+}
+
+export function GetCourseVersionModuleReportingToJSONTyped(value?: GetCourseVersionModuleReporting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'module_id': value['moduleId'],
+        'name': value['name'],
+        'item_count': value['itemCount'],
+        'required_item_count': value['requiredItemCount'],
+        'enrollment_count': value['enrollmentCount'],
+        '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'],
+        'items': ((value['items'] as Array<any>).map(GetCourseVersionItemReportingToJSON)),
+    };
+}
+