@easyedu/js-lsm-api 1.94.0 → 1.96.0

package/src/models/GetCourseVersionReporting.ts

@@ -0,0 +1,164 @@
+/* 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 { GetCourseVersionModuleReporting } from './GetCourseVersionModuleReporting';
+import {
+    GetCourseVersionModuleReportingFromJSON,
+    GetCourseVersionModuleReportingFromJSONTyped,
+    GetCourseVersionModuleReportingToJSON,
+    GetCourseVersionModuleReportingToJSONTyped,
+} 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 function instanceOfGetCourseVersionReporting(value: object): value is GetCourseVersionReporting {
+    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: any): GetCourseVersionReporting {
+    return GetCourseVersionReportingFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionReporting {
+    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'] as Array<any>).map(GetCourseVersionModuleReportingFromJSON)),
+    };
+}
+
+export function GetCourseVersionReportingToJSON(json: any): GetCourseVersionReporting {
+    return GetCourseVersionReportingToJSONTyped(json, false);
+}
+
+export function GetCourseVersionReportingToJSONTyped(value?: GetCourseVersionReporting | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).map(GetCourseVersionModuleReportingToJSON)),
+    };
+}
+

package/src/models/GetQuestionQuizzesInner.ts

@@ -31,18 +31,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;
 }
 
 /**
@@ -51,8 +39,6 @@ export interface GetQuestionQuizzesInner {
 export function instanceOfGetQuestionQuizzesInner(value: object): value is GetQuestionQuizzesInner {
     if (!('quizId' in value) || value['quizId'] === undefined) 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;
 }
 
@@ -68,8 +54,6 @@ export function GetQuestionQuizzesInnerFromJSONTyped(json: any, ignoreDiscrimina
         
         'quizId': json['quiz_id'],
         'quizName': json['quiz_name'],
-        'moduleId': json['module_id'],
-        'courseId': json['course_id'],
     };
 }
 
@@ -86,8 +70,6 @@ export function GetQuestionQuizzesInnerToJSONTyped(value?: GetQuestionQuizzesInn
         
         'quiz_id': value['quizId'],
         'quiz_name': value['quizName'],
-        'module_id': value['moduleId'],
-        'course_id': value['courseId'],
     };
 }
 

package/src/models/PostCertificateConfig.ts

@@ -76,7 +76,7 @@ export interface PostCertificateConfig {
      * @type {string}
      * @memberof PostCertificateConfig
      */
-    quizConfigId?: string | null;
+    quizId?: string | null;
     /**
      * 
      * @type {string}
@@ -126,7 +126,7 @@ export function PostCertificateConfigFromJSONTyped(json: any, ignoreDiscriminato
         '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']),
@@ -150,7 +150,7 @@ export function PostCertificateConfigToJSONTyped(value?: PostCertificateConfig |
         '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/PostCourseExport.ts

@@ -19,6 +19,12 @@ import { mapValues } from '../runtime';
  * @interface PostCourseExport
  */
 export interface PostCourseExport {
+    /**
+     * Immutable course version to export
+     * @type {string}
+     * @memberof PostCourseExport
+     */
+    courseVersionId: string;
     /**
      * The export format type
      * @type {PostCourseExportExportTypeEnum}
@@ -49,6 +55,7 @@ export type PostCourseExportExportTypeEnum = typeof PostCourseExportExportTypeEn
  * Check if a given object implements the PostCourseExport interface.
  */
 export function instanceOfPostCourseExport(value: object): value is PostCourseExport {
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
     if (!('exportType' in value) || value['exportType'] === undefined) return false;
     if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
     return true;
@@ -64,6 +71,7 @@ export function PostCourseExportFromJSONTyped(json: any, ignoreDiscriminator: bo
     }
     return {
         
+        'courseVersionId': json['course_version_id'],
         'exportType': json['export_type'],
         'moduleIds': json['module_ids'],
     };
@@ -80,6 +88,7 @@ export function PostCourseExportToJSONTyped(value?: PostCourseExport | null, ign
 
     return {
         
+        'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'module_ids': value['moduleIds'],
     };

package/src/models/PostCourseResume.ts

@@ -13,104 +13,108 @@
  */
 
 import { mapValues } from '../runtime';
-import type { ContentLaunchMode } from './ContentLaunchMode';
-import {
-    ContentLaunchModeFromJSON,
-    ContentLaunchModeFromJSONTyped,
-    ContentLaunchModeToJSON,
-    ContentLaunchModeToJSONTyped,
-} 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 const PostCourseResumeKindEnum = {
+    Resource: 'resource',
+    Quiz: 'quiz'
+} as const;
+export type PostCourseResumeKindEnum = typeof PostCourseResumeKindEnum[keyof typeof PostCourseResumeKindEnum];
+
+/**
+ * @export
+ */
+export const PostCourseResumeActionEnum = {
+    ResumeIncompleteSession: 'resume_incomplete_session',
+    StartNextItem: 'start_next_item'
+} as const;
+export type PostCourseResumeActionEnum = typeof PostCourseResumeActionEnum[keyof typeof PostCourseResumeActionEnum];
+
 
 /**
  * Check if a given object implements the PostCourseResume interface.
  */
 export function instanceOfPostCourseResume(value: object): value is PostCourseResume {
     if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
     if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
-    if (!('contentId' in value) || value['contentId'] === undefined) return false;
-    if (!('contentSessionId' in value) || value['contentSessionId'] === undefined) return false;
-    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
-    if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
-    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    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) return false;
-    if (!('selectionReason' in value) || value['selectionReason'] === undefined) return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
+    if (!('action' in value) || value['action'] === undefined) return false;
     return true;
 }
 
@@ -125,16 +129,15 @@ export function PostCourseResumeFromJSONTyped(json: any, ignoreDiscriminator: bo
     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'],
     };
 }
 
@@ -150,16 +153,15 @@ export function PostCourseResumeToJSONTyped(value?: PostCourseResume | null, ign
     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/src/models/PostCourseVersionItem.ts

@@ -32,37 +32,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}
@@ -104,8 +104,7 @@ export type PostCourseVersionItemScoreRollupStrategyEnum = typeof PostCourseVers
  * Check if a given object implements the PostCourseVersionItem interface.
  */
 export function instanceOfPostCourseVersionItem(value: object): value is PostCourseVersionItem {
-    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
-    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    if (!('libraryItemId' in value) || value['libraryItemId'] === undefined) return false;
     return true;
 }
 
@@ -119,12 +118,12 @@ export function PostCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminato
     }
     return {
         
-        'contentLibraryItemId': json['content_library_item_id'],
-        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
-        'moduleId': json['module_id'],
+        'libraryItemId': json['library_item_id'],
+        'libraryVersionId': json['library_version_id'] == null ? undefined : json['library_version_id'],
         'displayName': json['display_name'] == null ? undefined : json['display_name'],
-        'displayOrder': json['display_order'] == null ? undefined : json['display_order'],
+        'position': json['position'] == null ? undefined : json['position'],
         'isVisible': json['is_visible'] == null ? undefined : json['is_visible'],
+        'isRequired': json['is_required'] == null ? undefined : json['is_required'],
         'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
         'maxAttempts': json['max_attempts'] == null ? undefined : json['max_attempts'],
         'scoreRollupStrategy': json['score_rollup_strategy'] == null ? undefined : json['score_rollup_strategy'],
@@ -143,12 +142,12 @@ export function PostCourseVersionItemToJSONTyped(value?: PostCourseVersionItem |
 
     return {
         
-        'content_library_item_id': value['contentLibraryItemId'],
-        'content_library_version_id': value['contentLibraryVersionId'],
-        'module_id': value['moduleId'],
+        'library_item_id': value['libraryItemId'],
+        'library_version_id': value['libraryVersionId'],
         'display_name': value['displayName'],
-        'display_order': value['displayOrder'],
+        'position': value['position'],
         '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/PostCourseVersionModule.ts

@@ -0,0 +1,98 @@
+/* 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 { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
+/**
+ * 
+ * @export
+ * @interface PostCourseVersionModule
+ */
+export interface PostCourseVersionModule {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionModule
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionModule
+     */
+    description?: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof PostCourseVersionModule
+     */
+    descriptionRich?: RichTextDocument;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCourseVersionModule
+     */
+    position?: number;
+}
+
+/**
+ * Check if a given object implements the PostCourseVersionModule interface.
+ */
+export function instanceOfPostCourseVersionModule(value: object): value is PostCourseVersionModule {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function PostCourseVersionModuleFromJSON(json: any): PostCourseVersionModule {
+    return PostCourseVersionModuleFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionModule {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'descriptionRich': json['description_rich'] == null ? undefined : RichTextDocumentFromJSON(json['description_rich']),
+        'position': json['position'] == null ? undefined : json['position'],
+    };
+}
+
+export function PostCourseVersionModuleToJSON(json: any): PostCourseVersionModule {
+    return PostCourseVersionModuleToJSONTyped(json, false);
+}
+
+export function PostCourseVersionModuleToJSONTyped(value?: PostCourseVersionModule | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
+        'position': value['position'],
+    };
+}
+