@easyedu/js-lsm-api 1.93.0 → 1.95.0

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'],
+    };
+}
+

package/src/models/PostCourseVersionModuleDuplicate.ts

@@ -0,0 +1,73 @@
+/* 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 PostCourseVersionModuleDuplicate
+ */
+export interface PostCourseVersionModuleDuplicate {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCourseVersionModuleDuplicate
+     */
+    name?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCourseVersionModuleDuplicate
+     */
+    position?: number;
+}
+
+/**
+ * Check if a given object implements the PostCourseVersionModuleDuplicate interface.
+ */
+export function instanceOfPostCourseVersionModuleDuplicate(value: object): value is PostCourseVersionModuleDuplicate {
+    return true;
+}
+
+export function PostCourseVersionModuleDuplicateFromJSON(json: any): PostCourseVersionModuleDuplicate {
+    return PostCourseVersionModuleDuplicateFromJSONTyped(json, false);
+}
+
+export function PostCourseVersionModuleDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionModuleDuplicate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'position': json['position'] == null ? undefined : json['position'],
+    };
+}
+
+export function PostCourseVersionModuleDuplicateToJSON(json: any): PostCourseVersionModuleDuplicate {
+    return PostCourseVersionModuleDuplicateToJSONTyped(json, false);
+}
+
+export function PostCourseVersionModuleDuplicateToJSONTyped(value?: PostCourseVersionModuleDuplicate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'position': value['position'],
+    };
+}
+

package/src/models/PutCertificateConfig.ts

@@ -70,7 +70,7 @@ export interface PutCertificateConfig {
      * @type {string}
      * @memberof PutCertificateConfig
      */
-    quizConfigId?: string | null;
+    quizId?: string | null;
     /**
      * 
      * @type {string}
@@ -118,7 +118,7 @@ export function PutCertificateConfigFromJSONTyped(json: any, 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']),
@@ -141,7 +141,7 @@ export function PutCertificateConfigToJSONTyped(value?: PutCertificateConfig | n
         '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/PutCourseVersionItem.ts

@@ -32,7 +32,13 @@ export interface PutCourseVersionItem {
      * @type {string}
      * @memberof PutCourseVersionItem
      */
-    contentLibraryVersionId?: string;
+    libraryVersionId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutCourseVersionItem
+     */
+    targetModuleId?: string;
     /**
      * 
      * @type {string}
@@ -44,13 +50,19 @@ export interface PutCourseVersionItem {
      * @type {number}
      * @memberof PutCourseVersionItem
      */
-    displayOrder?: number;
+    position?: number;
     /**
      * 
      * @type {boolean}
      * @memberof PutCourseVersionItem
      */
     isVisible?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutCourseVersionItem
+     */
+    isRequired?: boolean;
     /**
      * 
      * @type {ContentLaunchMode}
@@ -105,10 +117,12 @@ export function PutCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator
     }
     return {
         
-        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
+        'libraryVersionId': json['library_version_id'] == null ? undefined : json['library_version_id'],
+        'targetModuleId': json['target_module_id'] == null ? undefined : json['target_module_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'],
@@ -127,10 +141,12 @@ export function PutCourseVersionItemToJSONTyped(value?: PutCourseVersionItem | n
 
     return {
         
-        'content_library_version_id': value['contentLibraryVersionId'],
+        'library_version_id': value['libraryVersionId'],
+        'target_module_id': value['targetModuleId'],
         '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/PutCourseVersionItemReorder.ts

@@ -0,0 +1,66 @@
+/* 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 PutCourseVersionItemReorder
+ */
+export interface PutCourseVersionItemReorder {
+    /**
+     * 
+     * @type {Set<string>}
+     * @memberof PutCourseVersionItemReorder
+     */
+    itemIds: Set<string>;
+}
+
+/**
+ * Check if a given object implements the PutCourseVersionItemReorder interface.
+ */
+export function instanceOfPutCourseVersionItemReorder(value: object): value is PutCourseVersionItemReorder {
+    if (!('itemIds' in value) || value['itemIds'] === undefined) return false;
+    return true;
+}
+
+export function PutCourseVersionItemReorderFromJSON(json: any): PutCourseVersionItemReorder {
+    return PutCourseVersionItemReorderFromJSONTyped(json, false);
+}
+
+export function PutCourseVersionItemReorderFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionItemReorder {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'itemIds': new Set(json['item_ids']),
+    };
+}
+
+export function PutCourseVersionItemReorderToJSON(json: any): PutCourseVersionItemReorder {
+    return PutCourseVersionItemReorderToJSONTyped(json, false);
+}
+
+export function PutCourseVersionItemReorderToJSONTyped(value?: PutCourseVersionItemReorder | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'item_ids': Array.from(value['itemIds'] as Set<any>),
+    };
+}
+