@easyedu/js-lsm-api 1.94.0 → 1.96.0

package/dist/esm/models/GetCourseVersionModuleReporting.js

@@ -0,0 +1,88 @@
+/* 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 { GetCourseVersionItemReportingFromJSON, GetCourseVersionItemReportingToJSON, } from './GetCourseVersionItemReporting';
+/**
+ * Check if a given object implements the GetCourseVersionModuleReporting interface.
+ */
+export function instanceOfGetCourseVersionModuleReporting(value) {
+    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) {
+    return GetCourseVersionModuleReportingFromJSONTyped(json, false);
+}
+export function GetCourseVersionModuleReportingFromJSONTyped(json, ignoreDiscriminator) {
+    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'].map(GetCourseVersionItemReportingFromJSON)),
+    };
+}
+export function GetCourseVersionModuleReportingToJSON(json) {
+    return GetCourseVersionModuleReportingToJSONTyped(json, false);
+}
+export function GetCourseVersionModuleReportingToJSONTyped(value, ignoreDiscriminator = false) {
+    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'].map(GetCourseVersionItemReportingToJSON)),
+    };
+}

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

@@ -0,0 +1,93 @@
+/**
+ * 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 { GetCourseVersionModuleReporting } from './GetCourseVersionModuleReporting';
+/**
+ *
+ * @export
+ * @interface GetCourseVersionReporting
+ */
+export interface GetCourseVersionReporting {
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionReporting
+     */
+    courseId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetCourseVersionReporting
+     */
+    courseVersionId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    versionNumber: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    enrollmentCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    completedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    inProgressCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    notStartedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    completionRatePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    avgScorePercentage: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetCourseVersionReporting
+     */
+    totalDurationSeconds: number;
+    /**
+     *
+     * @type {Array<GetCourseVersionModuleReporting>}
+     * @memberof GetCourseVersionReporting
+     */
+    modules: Array<GetCourseVersionModuleReporting>;
+}
+/**
+ * Check if a given object implements the GetCourseVersionReporting interface.
+ */
+export declare function instanceOfGetCourseVersionReporting(value: object): value is GetCourseVersionReporting;
+export declare function GetCourseVersionReportingFromJSON(json: any): GetCourseVersionReporting;
+export declare function GetCourseVersionReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionReporting;
+export declare function GetCourseVersionReportingToJSON(json: any): GetCourseVersionReporting;
+export declare function GetCourseVersionReportingToJSONTyped(value?: GetCourseVersionReporting | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseVersionReporting.js

@@ -0,0 +1,84 @@
+/* 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 { GetCourseVersionModuleReportingFromJSON, GetCourseVersionModuleReportingToJSON, } from './GetCourseVersionModuleReporting';
+/**
+ * Check if a given object implements the GetCourseVersionReporting interface.
+ */
+export function instanceOfGetCourseVersionReporting(value) {
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
+        return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === 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 (!('modules' in value) || value['modules'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseVersionReportingFromJSON(json) {
+    return GetCourseVersionReportingFromJSONTyped(json, false);
+}
+export function GetCourseVersionReportingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'],
+        'versionNumber': json['version_number'],
+        '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'],
+        'modules': (json['modules'].map(GetCourseVersionModuleReportingFromJSON)),
+    };
+}
+export function GetCourseVersionReportingToJSON(json) {
+    return GetCourseVersionReportingToJSONTyped(json, false);
+}
+export function GetCourseVersionReportingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'version_number': value['versionNumber'],
+        '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'],
+        'modules': (value['modules'].map(GetCourseVersionModuleReportingToJSON)),
+    };
+}

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

@@ -27,18 +27,6 @@ export interface GetQuestionQuizzesInner {
      * @memberof GetQuestionQuizzesInner
      */
     quizName: string;
-    /**
-     * Module external identifier
-     * @type {string}
-     * @memberof GetQuestionQuizzesInner
-     */
-    moduleId: string;
-    /**
-     * Course external identifier
-     * @type {string}
-     * @memberof GetQuestionQuizzesInner
-     */
-    courseId: string;
 }
 /**
  * Check if a given object implements the GetQuestionQuizzesInner interface.

package/dist/esm/models/GetQuestionQuizzesInner.js

@@ -19,10 +19,6 @@ export function instanceOfGetQuestionQuizzesInner(value) {
         return false;
     if (!('quizName' in value) || value['quizName'] === undefined)
         return false;
-    if (!('moduleId' in value) || value['moduleId'] === undefined)
-        return false;
-    if (!('courseId' in value) || value['courseId'] === undefined)
-        return false;
     return true;
 }
 export function GetQuestionQuizzesInnerFromJSON(json) {
@@ -35,8 +31,6 @@ export function GetQuestionQuizzesInnerFromJSONTyped(json, ignoreDiscriminator)
     return {
         'quizId': json['quiz_id'],
         'quizName': json['quiz_name'],
-        'moduleId': json['module_id'],
-        'courseId': json['course_id'],
     };
 }
 export function GetQuestionQuizzesInnerToJSON(json) {
@@ -49,7 +43,5 @@ export function GetQuestionQuizzesInnerToJSONTyped(value, ignoreDiscriminator =
     return {
         'quiz_id': value['quizId'],
         'quiz_name': value['quizName'],
-        'module_id': value['moduleId'],
-        'course_id': value['courseId'],
     };
 }

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

@@ -53,7 +53,7 @@ export interface PostCertificateConfig {
      * @type {string}
      * @memberof PostCertificateConfig
      */
-    quizConfigId?: string | null;
+    quizId?: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/PostCertificateConfig.js

@@ -35,7 +35,7 @@ export function PostCertificateConfigFromJSONTyped(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']),
@@ -55,7 +55,7 @@ export function PostCertificateConfigToJSONTyped(value, ignoreDiscriminator = fa
         '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/PostCourseExport.d.ts

@@ -15,6 +15,12 @@
  * @interface PostCourseExport
  */
 export interface PostCourseExport {
+    /**
+     * Immutable course version to export
+     * @type {string}
+     * @memberof PostCourseExport
+     */
+    courseVersionId: string;
     /**
      * The export format type
      * @type {PostCourseExportExportTypeEnum}

package/dist/esm/models/PostCourseExport.js

@@ -23,6 +23,8 @@ export const PostCourseExportExportTypeEnum = {
  * Check if a given object implements the PostCourseExport interface.
  */
 export function instanceOfPostCourseExport(value) {
+    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)
@@ -37,6 +39,7 @@ export function PostCourseExportFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'courseVersionId': json['course_version_id'],
         'exportType': json['export_type'],
         'moduleIds': json['module_ids'],
     };
@@ -49,6 +52,7 @@ export function PostCourseExportToJSONTyped(value, ignoreDiscriminator = false)
         return value;
     }
     return {
+        'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'module_ids': value['moduleIds'],
     };

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

@@ -9,80 +9,89 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { ContentLaunchMode } from './ContentLaunchMode';
 /**
- * Launch-ready course resume target for the current learner.
+ * Version-pinned next placement for the current learner.
  * @export
  * @interface PostCourseResume
  */
 export interface PostCourseResume {
     /**
-     * The external ID of the course.
+     *
      * @type {string}
      * @memberof PostCourseResume
      */
     courseId: string;
     /**
-     * The external ID of the module containing the resume content.
-     * @type {string}
-     * @memberof PostCourseResume
-     */
-    moduleId: string;
-    /**
-     * The external ID of the selected content.
+     *
      * @type {string}
      * @memberof PostCourseResume
      */
-    contentId: string;
+    courseVersionId: string;
     /**
-     * The external ID of the content session used for launch.
+     *
      * @type {string}
      * @memberof PostCourseResume
      */
-    contentSessionId: string;
+    moduleId: string;
     /**
-     * The URL to open for the selected content.
+     *
      * @type {string}
      * @memberof PostCourseResume
      */
-    launchUrl: string;
+    itemId: string;
     /**
      *
-     * @type {ContentLaunchMode}
+     * @type {PostCourseResumeKindEnum}
      * @memberof PostCourseResume
      */
-    launchMode: ContentLaunchMode;
+    kind: PostCourseResumeKindEnum;
     /**
-     * The date and time the content session was created.
-     * @type {number}
+     *
+     * @type {string}
      * @memberof PostCourseResume
      */
-    createdAt: number;
+    sessionId: string;
     /**
-     * The player session ID, when a content-specific player session exists.
+     *
      * @type {string}
      * @memberof PostCourseResume
      */
-    playerSessionId?: string | null;
+    resourceLaunchUrl: string | null;
     /**
-     * The learner attempt number for this content session.
+     *
      * @type {number}
      * @memberof PostCourseResume
      */
     attemptNumber: number;
     /**
-     * Whether this is the current attempt used for learner progress display.
-     * @type {boolean}
+     *
+     * @type {number}
      * @memberof PostCourseResume
      */
-    isCurrent: boolean;
+    maxAttempts: number;
     /**
-     * Why this content was selected. Values are resume_incomplete_session or start_next_content.
-     * @type {string}
+     *
+     * @type {PostCourseResumeActionEnum}
      * @memberof PostCourseResume
      */
-    selectionReason: string;
+    action: PostCourseResumeActionEnum;
 }
+/**
+ * @export
+ */
+export declare const PostCourseResumeKindEnum: {
+    readonly Resource: "resource";
+    readonly Quiz: "quiz";
+};
+export type PostCourseResumeKindEnum = typeof PostCourseResumeKindEnum[keyof typeof PostCourseResumeKindEnum];
+/**
+ * @export
+ */
+export declare const PostCourseResumeActionEnum: {
+    readonly ResumeIncompleteSession: "resume_incomplete_session";
+    readonly StartNextItem: "start_next_item";
+};
+export type PostCourseResumeActionEnum = typeof PostCourseResumeActionEnum[keyof typeof PostCourseResumeActionEnum];
 /**
  * Check if a given object implements the PostCourseResume interface.
  */

package/dist/esm/models/PostCourseResume.js

@@ -11,30 +11,43 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
+/**
+ * @export
+ */
+export const PostCourseResumeKindEnum = {
+    Resource: 'resource',
+    Quiz: 'quiz'
+};
+/**
+ * @export
+ */
+export const PostCourseResumeActionEnum = {
+    ResumeIncompleteSession: 'resume_incomplete_session',
+    StartNextItem: 'start_next_item'
+};
 /**
  * Check if a given object implements the PostCourseResume interface.
  */
 export function instanceOfPostCourseResume(value) {
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
-    if (!('moduleId' in value) || value['moduleId'] === undefined)
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
         return false;
-    if (!('contentId' in value) || value['contentId'] === undefined)
+    if (!('moduleId' in value) || value['moduleId'] === undefined)
         return false;
-    if (!('contentSessionId' in value) || value['contentSessionId'] === undefined)
+    if (!('itemId' in value) || value['itemId'] === undefined)
         return false;
-    if (!('launchUrl' in value) || value['launchUrl'] === undefined)
+    if (!('kind' in value) || value['kind'] === undefined)
         return false;
-    if (!('launchMode' in value) || value['launchMode'] === undefined)
+    if (!('sessionId' in value) || value['sessionId'] === undefined)
         return false;
-    if (!('createdAt' in value) || value['createdAt'] === undefined)
+    if (!('resourceLaunchUrl' in value) || value['resourceLaunchUrl'] === undefined)
         return false;
     if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
         return false;
-    if (!('isCurrent' in value) || value['isCurrent'] === undefined)
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined)
         return false;
-    if (!('selectionReason' in value) || value['selectionReason'] === undefined)
+    if (!('action' in value) || value['action'] === undefined)
         return false;
     return true;
 }
@@ -47,16 +60,15 @@ export function PostCourseResumeFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'],
         'moduleId': json['module_id'],
-        'contentId': json['content_id'],
-        'contentSessionId': json['content_session_id'],
-        'launchUrl': json['launch_url'],
-        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
-        'createdAt': json['created_at'],
-        'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
+        'itemId': json['item_id'],
+        'kind': json['kind'],
+        'sessionId': json['session_id'],
+        'resourceLaunchUrl': json['resource_launch_url'],
         'attemptNumber': json['attempt_number'],
-        'isCurrent': json['is_current'],
-        'selectionReason': json['selection_reason'],
+        'maxAttempts': json['max_attempts'],
+        'action': json['action'],
     };
 }
 export function PostCourseResumeToJSON(json) {
@@ -68,15 +80,14 @@ export function PostCourseResumeToJSONTyped(value, ignoreDiscriminator = false)
     }
     return {
         'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
         'module_id': value['moduleId'],
-        'content_id': value['contentId'],
-        'content_session_id': value['contentSessionId'],
-        'launch_url': value['launchUrl'],
-        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
-        'created_at': value['createdAt'],
-        'player_session_id': value['playerSessionId'],
+        'item_id': value['itemId'],
+        'kind': value['kind'],
+        'session_id': value['sessionId'],
+        'resource_launch_url': value['resourceLaunchUrl'],
         'attempt_number': value['attemptNumber'],
-        'is_current': value['isCurrent'],
-        'selection_reason': value['selectionReason'],
+        'max_attempts': value['maxAttempts'],
+        'action': value['action'],
     };
 }

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

@@ -21,37 +21,37 @@ export interface PostCourseVersionItem {
      * @type {string}
      * @memberof PostCourseVersionItem
      */
-    contentLibraryItemId: string;
+    libraryItemId: string;
     /**
      *
      * @type {string}
      * @memberof PostCourseVersionItem
      */
-    contentLibraryVersionId?: string;
+    libraryVersionId?: string;
     /**
      *
      * @type {string}
      * @memberof PostCourseVersionItem
      */
-    moduleId: string;
+    displayName?: string;
     /**
      *
-     * @type {string}
+     * @type {number}
      * @memberof PostCourseVersionItem
      */
-    displayName?: string;
+    position?: number;
     /**
      *
-     * @type {number}
+     * @type {boolean}
      * @memberof PostCourseVersionItem
      */
-    displayOrder?: number;
+    isVisible?: boolean;
     /**
      *
      * @type {boolean}
      * @memberof PostCourseVersionItem
      */
-    isVisible?: boolean;
+    isRequired?: boolean;
     /**
      *
      * @type {ContentLaunchMode}