@easyedu/js-lsm-api 1.67.0 → 1.69.0

package/src/models/GetContent.ts

@@ -20,6 +20,13 @@ import {
     GetContentContentDataToJSON,
     GetContentContentDataToJSONTyped,
 } from './GetContentContentData';
+import type { ContentAttemptSettings } from './ContentAttemptSettings';
+import {
+    ContentAttemptSettingsFromJSON,
+    ContentAttemptSettingsFromJSONTyped,
+    ContentAttemptSettingsToJSON,
+    ContentAttemptSettingsToJSONTyped,
+} from './ContentAttemptSettings';
 import type { ContentLaunchMode } from './ContentLaunchMode';
 import {
     ContentLaunchModeFromJSON,
@@ -70,6 +77,12 @@ export interface GetContent {
      * @memberof GetContent
      */
     launchMode: ContentLaunchMode;
+    /**
+     * 
+     * @type {ContentAttemptSettings}
+     * @memberof GetContent
+     */
+    attemptSettings: ContentAttemptSettings;
     /**
      * 
      * @type {GetContentContentData}
@@ -145,6 +158,7 @@ export function instanceOfGetContent(value: object): value is GetContent {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('contentType' in value) || value['contentType'] === undefined) return false;
     if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
+    if (!('attemptSettings' in value) || value['attemptSettings'] === undefined) return false;
     if (!('contentData' in value) || value['contentData'] === undefined) return false;
     if (!('published' in value) || value['published'] === undefined) return false;
     return true;
@@ -166,6 +180,7 @@ export function GetContentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'description': json['description'] == null ? undefined : json['description'],
         'contentType': json['content_type'],
         'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
+        'attemptSettings': ContentAttemptSettingsFromJSON(json['attempt_settings']),
         'contentData': GetContentContentDataFromJSON(json['content_data']),
         'order': json['order'] == null ? undefined : json['order'],
         'published': json['published'],
@@ -193,6 +208,7 @@ export function GetContentToJSONTyped(value?: Omit<GetContent, 'id'|'created_dat
         'description': value['description'],
         'content_type': value['contentType'],
         'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'attempt_settings': ContentAttemptSettingsToJSON(value['attemptSettings']),
         'content_data': GetContentContentDataToJSON(value['contentData']),
         'order': value['order'],
         'published': value['published'],

package/src/models/GetContentAttempts.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 { ContentAttemptRollupScore } from './ContentAttemptRollupScore';
+import {
+    ContentAttemptRollupScoreFromJSON,
+    ContentAttemptRollupScoreFromJSONTyped,
+    ContentAttemptRollupScoreToJSON,
+    ContentAttemptRollupScoreToJSONTyped,
+} from './ContentAttemptRollupScore';
+import type { ContentAttemptItem } from './ContentAttemptItem';
+import {
+    ContentAttemptItemFromJSON,
+    ContentAttemptItemFromJSONTyped,
+    ContentAttemptItemToJSON,
+    ContentAttemptItemToJSONTyped,
+} from './ContentAttemptItem';
+
+/**
+ * Learner attempt history and rollup for a content item
+ * @export
+ * @interface GetContentAttempts
+ */
+export interface GetContentAttempts {
+    /**
+     * Content external ID
+     * @type {string}
+     * @memberof GetContentAttempts
+     */
+    contentId: string;
+    /**
+     * User ID these attempts belong to
+     * @type {string}
+     * @memberof GetContentAttempts
+     */
+    userId: string;
+    /**
+     * Maximum content sessions allowed for this learner/content pair
+     * @type {number}
+     * @memberof GetContentAttempts
+     */
+    maxAttempts: number;
+    /**
+     * Number of attempts already created
+     * @type {number}
+     * @memberof GetContentAttempts
+     */
+    attemptsUsed: number;
+    /**
+     * Number of additional attempts that can be created
+     * @type {number}
+     * @memberof GetContentAttempts
+     */
+    attemptsRemaining: number;
+    /**
+     * Whether another attempt may be started under the current policy
+     * @type {boolean}
+     * @memberof GetContentAttempts
+     */
+    canStartNewAttempt: boolean;
+    /**
+     * Strategy used to compute rollup_score from attempts
+     * @type {GetContentAttemptsScoreRollupStrategyEnum}
+     * @memberof GetContentAttempts
+     */
+    scoreRollupStrategy: GetContentAttemptsScoreRollupStrategyEnum;
+    /**
+     * 
+     * @type {ContentAttemptRollupScore}
+     * @memberof GetContentAttempts
+     */
+    rollupScore: ContentAttemptRollupScore | null;
+    /**
+     * 
+     * @type {Array<ContentAttemptItem>}
+     * @memberof GetContentAttempts
+     */
+    attempts: Array<ContentAttemptItem>;
+}
+
+
+/**
+ * @export
+ */
+export const GetContentAttemptsScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type GetContentAttemptsScoreRollupStrategyEnum = typeof GetContentAttemptsScoreRollupStrategyEnum[keyof typeof GetContentAttemptsScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the GetContentAttempts interface.
+ */
+export function instanceOfGetContentAttempts(value: object): value is GetContentAttempts {
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
+    if (!('attemptsUsed' in value) || value['attemptsUsed'] === undefined) return false;
+    if (!('attemptsRemaining' in value) || value['attemptsRemaining'] === undefined) return false;
+    if (!('canStartNewAttempt' in value) || value['canStartNewAttempt'] === undefined) return false;
+    if (!('scoreRollupStrategy' in value) || value['scoreRollupStrategy'] === undefined) return false;
+    if (!('rollupScore' in value) || value['rollupScore'] === undefined) return false;
+    if (!('attempts' in value) || value['attempts'] === undefined) return false;
+    return true;
+}
+
+export function GetContentAttemptsFromJSON(json: any): GetContentAttempts {
+    return GetContentAttemptsFromJSONTyped(json, false);
+}
+
+export function GetContentAttemptsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentAttempts {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentId': json['content_id'],
+        'userId': json['user_id'],
+        'maxAttempts': json['max_attempts'],
+        'attemptsUsed': json['attempts_used'],
+        'attemptsRemaining': json['attempts_remaining'],
+        'canStartNewAttempt': json['can_start_new_attempt'],
+        'scoreRollupStrategy': json['score_rollup_strategy'],
+        'rollupScore': ContentAttemptRollupScoreFromJSON(json['rollup_score']),
+        'attempts': ((json['attempts'] as Array<any>).map(ContentAttemptItemFromJSON)),
+    };
+}
+
+export function GetContentAttemptsToJSON(json: any): GetContentAttempts {
+    return GetContentAttemptsToJSONTyped(json, false);
+}
+
+export function GetContentAttemptsToJSONTyped(value?: GetContentAttempts | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_id': value['contentId'],
+        'user_id': value['userId'],
+        'max_attempts': value['maxAttempts'],
+        'attempts_used': value['attemptsUsed'],
+        'attempts_remaining': value['attemptsRemaining'],
+        'can_start_new_attempt': value['canStartNewAttempt'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+        'rollup_score': ContentAttemptRollupScoreToJSON(value['rollupScore']),
+        'attempts': ((value['attempts'] as Array<any>).map(ContentAttemptItemToJSON)),
+    };
+}
+

package/src/models/GetContentSession.ts

@@ -55,6 +55,18 @@ export interface GetContentSession {
      * @memberof GetContentSession
      */
     gradeStatus: string;
+    /**
+     * The learner attempt number for this content session
+     * @type {number}
+     * @memberof GetContentSession
+     */
+    attemptNumber: number;
+    /**
+     * Whether this is the current attempt used for learner progress display
+     * @type {boolean}
+     * @memberof GetContentSession
+     */
+    isCurrent: boolean;
 }
 
 /**
@@ -67,6 +79,8 @@ export function instanceOfGetContentSession(value: object): value is GetContentS
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
     return true;
 }
 
@@ -86,6 +100,8 @@ export function GetContentSessionFromJSONTyped(json: any, ignoreDiscriminator: b
         'updatedAt': json['updated_at'],
         'completionStatus': json['completion_status'],
         'gradeStatus': json['grade_status'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
     };
 }
 
@@ -106,6 +122,8 @@ export function GetContentSessionToJSONTyped(value?: GetContentSession | null, i
         'updated_at': value['updatedAt'],
         'completion_status': value['completionStatus'],
         'grade_status': value['gradeStatus'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
     };
 }
 

package/src/models/GetContentSessionDetail.ts

@@ -76,6 +76,18 @@ export interface GetContentSessionDetail {
      * @memberof GetContentSessionDetail
      */
     durationInSeconds: number;
+    /**
+     * The learner attempt number for this content session
+     * @type {number}
+     * @memberof GetContentSessionDetail
+     */
+    attemptNumber: number;
+    /**
+     * Whether this is the current attempt used for learner progress display
+     * @type {boolean}
+     * @memberof GetContentSessionDetail
+     */
+    isCurrent: boolean;
     /**
      * 
      * @type {GetContentSessionDetailUserData}
@@ -126,6 +138,8 @@ export function instanceOfGetContentSessionDetail(value: object): value is GetCo
     if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
     if (!('durationInSeconds' in value) || value['durationInSeconds'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
     if (!('userData' in value) || value['userData'] === undefined) return false;
     if (!('scormSessionData' in value) || value['scormSessionData'] === undefined) return false;
     return true;
@@ -148,6 +162,8 @@ export function GetContentSessionDetailFromJSONTyped(json: any, ignoreDiscrimina
         'completionStatus': json['completion_status'],
         'gradeStatus': json['grade_status'],
         'durationInSeconds': json['duration_in_seconds'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
         'userData': GetContentSessionDetailUserDataFromJSON(json['user_data']),
         'scormSessionData': (json['scorm_session_data'] == null ? null : (json['scorm_session_data'] as Array<any>).map(GetContentSessionDetailScormSessionDataInnerFromJSON)),
     };
@@ -171,6 +187,8 @@ export function GetContentSessionDetailToJSONTyped(value?: GetContentSessionDeta
         'completion_status': value['completionStatus'],
         'grade_status': value['gradeStatus'],
         'duration_in_seconds': value['durationInSeconds'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
         'user_data': GetContentSessionDetailUserDataToJSON(value['userData']),
         'scorm_session_data': (value['scormSessionData'] == null ? null : (value['scormSessionData'] as Array<any>).map(GetContentSessionDetailScormSessionDataInnerToJSON)),
     };

package/src/models/GetContentSessionListItem.ts

@@ -58,6 +58,30 @@ export interface GetContentSessionListItem {
      * @memberof GetContentSessionListItem
      */
     contentId: string;
+    /**
+     * The completion status of the content session
+     * @type {string}
+     * @memberof GetContentSessionListItem
+     */
+    completionStatus: string;
+    /**
+     * The grade status of the content session
+     * @type {string}
+     * @memberof GetContentSessionListItem
+     */
+    gradeStatus: string;
+    /**
+     * The learner attempt number for this content session
+     * @type {number}
+     * @memberof GetContentSessionListItem
+     */
+    attemptNumber: number;
+    /**
+     * Whether this is the current attempt used for learner progress display
+     * @type {boolean}
+     * @memberof GetContentSessionListItem
+     */
+    isCurrent: boolean;
     /**
      * 
      * @type {GetContentSessionDetailUserData}
@@ -80,6 +104,10 @@ export function instanceOfGetContentSessionListItem(value: object): value is Get
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
     if (!('userData' in value) || value['userData'] === undefined) return false;
     if (!('scormSessionData' in value) || value['scormSessionData'] === undefined) return false;
     return true;
@@ -99,6 +127,10 @@ export function GetContentSessionListItemFromJSONTyped(json: any, ignoreDiscrimi
         'createdAt': json['created_at'],
         'updatedAt': json['updated_at'],
         'contentId': json['content_id'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
         'userData': GetContentSessionDetailUserDataFromJSON(json['user_data']),
         'scormSessionData': GetContentSessionListItemScormSessionDataFromJSON(json['scorm_session_data']),
     };
@@ -119,6 +151,10 @@ export function GetContentSessionListItemToJSONTyped(value?: GetContentSessionLi
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],
         'content_id': value['contentId'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
         'user_data': GetContentSessionDetailUserDataToJSON(value['userData']),
         'scorm_session_data': GetContentSessionListItemScormSessionDataToJSON(value['scormSessionData']),
     };

package/src/models/PostContentSession.ts

@@ -63,6 +63,18 @@ export interface PostContentSession {
      * @memberof PostContentSession
      */
     playerSessionId?: string | null;
+    /**
+     * The learner attempt number for this content session
+     * @type {number}
+     * @memberof PostContentSession
+     */
+    attemptNumber: number;
+    /**
+     * Whether this is the current attempt used for learner progress display
+     * @type {boolean}
+     * @memberof PostContentSession
+     */
+    isCurrent: boolean;
 }
 
 
@@ -76,6 +88,8 @@ export function instanceOfPostContentSession(value: object): value is PostConten
     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 (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
     return true;
 }
 
@@ -95,6 +109,8 @@ export function PostContentSessionFromJSONTyped(json: any, ignoreDiscriminator:
         'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
         'createdAt': json['created_at'],
         'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
     };
 }
 
@@ -115,6 +131,8 @@ export function PostContentSessionToJSONTyped(value?: PostContentSession | null,
         'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
         'created_at': value['createdAt'],
         'player_session_id': value['playerSessionId'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
     };
 }
 

package/src/models/PutContent.ts

@@ -20,6 +20,13 @@ import {
     ContentLaunchModeToJSON,
     ContentLaunchModeToJSONTyped,
 } from './ContentLaunchMode';
+import type { PutContentAttemptSettings } from './PutContentAttemptSettings';
+import {
+    PutContentAttemptSettingsFromJSON,
+    PutContentAttemptSettingsFromJSONTyped,
+    PutContentAttemptSettingsToJSON,
+    PutContentAttemptSettingsToJSONTyped,
+} from './PutContentAttemptSettings';
 
 /**
  * 
@@ -45,6 +52,12 @@ export interface PutContent {
      * @memberof PutContent
      */
     launchMode?: ContentLaunchMode;
+    /**
+     * 
+     * @type {PutContentAttemptSettings}
+     * @memberof PutContent
+     */
+    attemptSettings?: PutContentAttemptSettings;
 }
 
 
@@ -69,6 +82,7 @@ export function PutContentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'name': json['name'] == null ? undefined : json['name'],
         'published': json['published'] == null ? undefined : json['published'],
         'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
+        'attemptSettings': json['attempt_settings'] == null ? undefined : PutContentAttemptSettingsFromJSON(json['attempt_settings']),
     };
 }
 
@@ -86,6 +100,7 @@ export function PutContentToJSONTyped(value?: PutContent | null, ignoreDiscrimin
         'name': value['name'],
         'published': value['published'],
         'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'attempt_settings': PutContentAttemptSettingsToJSON(value['attemptSettings']),
     };
 }
 

package/src/models/PutContentAttemptSettings.ts

@@ -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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PutContentAttemptSettings
+ */
+export interface PutContentAttemptSettings {
+    /**
+     * Maximum allowed attempts for this content
+     * @type {number}
+     * @memberof PutContentAttemptSettings
+     */
+    maxAttempts?: number;
+    /**
+     * Strategy used to calculate the content rollup score
+     * @type {PutContentAttemptSettingsScoreRollupStrategyEnum}
+     * @memberof PutContentAttemptSettings
+     */
+    scoreRollupStrategy?: PutContentAttemptSettingsScoreRollupStrategyEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PutContentAttemptSettingsScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type PutContentAttemptSettingsScoreRollupStrategyEnum = typeof PutContentAttemptSettingsScoreRollupStrategyEnum[keyof typeof PutContentAttemptSettingsScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the PutContentAttemptSettings interface.
+ */
+export function instanceOfPutContentAttemptSettings(value: object): value is PutContentAttemptSettings {
+    return true;
+}
+
+export function PutContentAttemptSettingsFromJSON(json: any): PutContentAttemptSettings {
+    return PutContentAttemptSettingsFromJSONTyped(json, false);
+}
+
+export function PutContentAttemptSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutContentAttemptSettings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'maxAttempts': json['max_attempts'] == null ? undefined : json['max_attempts'],
+        'scoreRollupStrategy': json['score_rollup_strategy'] == null ? undefined : json['score_rollup_strategy'],
+    };
+}
+
+export function PutContentAttemptSettingsToJSON(json: any): PutContentAttemptSettings {
+    return PutContentAttemptSettingsToJSONTyped(json, false);
+}
+
+export function PutContentAttemptSettingsToJSONTyped(value?: PutContentAttemptSettings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'max_attempts': value['maxAttempts'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+    };
+}
+

package/src/models/index.ts

@@ -3,6 +3,10 @@
 export * from './Certificate';
 export * from './CertificateConfig';
 export * from './CertificatePublic';
+export * from './ContentAttemptItem';
+export * from './ContentAttemptRollupScore';
+export * from './ContentAttemptScore';
+export * from './ContentAttemptSettings';
 export * from './ContentLaunchMode';
 export * from './CourseCatalog';
 export * from './CourseShare';
@@ -18,6 +22,7 @@ export * from './GetCertificateConfigList';
 export * from './GetCertificateList';
 export * from './GetChatMessage';
 export * from './GetContent';
+export * from './GetContentAttempts';
 export * from './GetContentContentData';
 export * from './GetContentGradeDetail';
 export * from './GetContentGrades';
@@ -221,6 +226,7 @@ export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
 export * from './PutCertificateConfig';
 export * from './PutContent';
+export * from './PutContentAttemptSettings';
 export * from './PutContentReorder';
 export * from './PutContentVersion';
 export * from './PutCourse';