@easyedu/js-lsm-api 1.66.0 → 1.68.0

package/src/models/ContentAttemptItem.ts

@@ -0,0 +1,128 @@
+/* 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 { ContentAttemptScore } from './ContentAttemptScore';
+import {
+    ContentAttemptScoreFromJSON,
+    ContentAttemptScoreFromJSONTyped,
+    ContentAttemptScoreToJSON,
+    ContentAttemptScoreToJSONTyped,
+} from './ContentAttemptScore';
+
+/**
+ * A single learner attempt for a content item
+ * @export
+ * @interface ContentAttemptItem
+ */
+export interface ContentAttemptItem {
+    /**
+     * Content session UUID for this attempt
+     * @type {string}
+     * @memberof ContentAttemptItem
+     */
+    sessionId: string;
+    /**
+     * Learner attempt number for this content item
+     * @type {number}
+     * @memberof ContentAttemptItem
+     */
+    attemptNumber: number;
+    /**
+     * Completion status for this attempt
+     * @type {string}
+     * @memberof ContentAttemptItem
+     */
+    completionStatus: string;
+    /**
+     * Grade status for this attempt
+     * @type {string}
+     * @memberof ContentAttemptItem
+     */
+    gradeStatus: string;
+    /**
+     * 
+     * @type {ContentAttemptScore}
+     * @memberof ContentAttemptItem
+     */
+    score: ContentAttemptScore | null;
+    /**
+     * Attempt creation time as a Unix timestamp in seconds
+     * @type {number}
+     * @memberof ContentAttemptItem
+     */
+    createdAt: number;
+    /**
+     * Attempt update time as a Unix timestamp in seconds
+     * @type {number}
+     * @memberof ContentAttemptItem
+     */
+    updatedAt: number;
+}
+
+/**
+ * Check if a given object implements the ContentAttemptItem interface.
+ */
+export function instanceOfContentAttemptItem(value: object): value is ContentAttemptItem {
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('score' in value) || value['score'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function ContentAttemptItemFromJSON(json: any): ContentAttemptItem {
+    return ContentAttemptItemFromJSONTyped(json, false);
+}
+
+export function ContentAttemptItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sessionId': json['session_id'],
+        'attemptNumber': json['attempt_number'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'score': ContentAttemptScoreFromJSON(json['score']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function ContentAttemptItemToJSON(json: any): ContentAttemptItem {
+    return ContentAttemptItemToJSONTyped(json, false);
+}
+
+export function ContentAttemptItemToJSONTyped(value?: ContentAttemptItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'session_id': value['sessionId'],
+        'attempt_number': value['attemptNumber'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score': ContentAttemptScoreToJSON(value['score']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/ContentAttemptRollupScore.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * Rolled-up score for a content item
+ * @export
+ * @interface ContentAttemptRollupScore
+ */
+export interface ContentAttemptRollupScore {
+    /**
+     * Rolled-up score normalized to a 0-100 percentage
+     * @type {number}
+     * @memberof ContentAttemptRollupScore
+     */
+    percentage: number;
+    /**
+     * Attempt number that supplied the rolled-up score
+     * @type {number}
+     * @memberof ContentAttemptRollupScore
+     */
+    sourceAttemptNumber: number;
+}
+
+/**
+ * Check if a given object implements the ContentAttemptRollupScore interface.
+ */
+export function instanceOfContentAttemptRollupScore(value: object): value is ContentAttemptRollupScore {
+    if (!('percentage' in value) || value['percentage'] === undefined) return false;
+    if (!('sourceAttemptNumber' in value) || value['sourceAttemptNumber'] === undefined) return false;
+    return true;
+}
+
+export function ContentAttemptRollupScoreFromJSON(json: any): ContentAttemptRollupScore {
+    return ContentAttemptRollupScoreFromJSONTyped(json, false);
+}
+
+export function ContentAttemptRollupScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptRollupScore {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'percentage': json['percentage'],
+        'sourceAttemptNumber': json['source_attempt_number'],
+    };
+}
+
+export function ContentAttemptRollupScoreToJSON(json: any): ContentAttemptRollupScore {
+    return ContentAttemptRollupScoreToJSONTyped(json, false);
+}
+
+export function ContentAttemptRollupScoreToJSONTyped(value?: ContentAttemptRollupScore | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'percentage': value['percentage'],
+        'source_attempt_number': value['sourceAttemptNumber'],
+    };
+}
+

package/src/models/ContentAttemptScore.ts

@@ -0,0 +1,89 @@
+/* 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';
+/**
+ * Normalized score data for a content attempt
+ * @export
+ * @interface ContentAttemptScore
+ */
+export interface ContentAttemptScore {
+    /**
+     * Raw score reported by the content, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    raw?: number | null;
+    /**
+     * Minimum possible score, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    min?: number | null;
+    /**
+     * Maximum possible score, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    max?: number | null;
+    /**
+     * Score normalized to a 0-100 percentage, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    percentage?: number | null;
+}
+
+/**
+ * Check if a given object implements the ContentAttemptScore interface.
+ */
+export function instanceOfContentAttemptScore(value: object): value is ContentAttemptScore {
+    return true;
+}
+
+export function ContentAttemptScoreFromJSON(json: any): ContentAttemptScore {
+    return ContentAttemptScoreFromJSONTyped(json, false);
+}
+
+export function ContentAttemptScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptScore {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'raw': json['raw'] == null ? undefined : json['raw'],
+        'min': json['min'] == null ? undefined : json['min'],
+        'max': json['max'] == null ? undefined : json['max'],
+        'percentage': json['percentage'] == null ? undefined : json['percentage'],
+    };
+}
+
+export function ContentAttemptScoreToJSON(json: any): ContentAttemptScore {
+    return ContentAttemptScoreToJSONTyped(json, false);
+}
+
+export function ContentAttemptScoreToJSONTyped(value?: ContentAttemptScore | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'raw': value['raw'],
+        'min': value['min'],
+        'max': value['max'],
+        'percentage': value['percentage'],
+    };
+}
+

package/src/models/ContentLaunchMode.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+/**
+ * How the learner player should present the launched content.
+ * @export
+ */
+export const ContentLaunchMode = {
+    Embedded: 'embedded',
+    Fullscreen: 'fullscreen',
+    NewWindow: 'new_window'
+} as const;
+export type ContentLaunchMode = typeof ContentLaunchMode[keyof typeof ContentLaunchMode];
+
+
+export function instanceOfContentLaunchMode(value: any): boolean {
+    for (const key in ContentLaunchMode) {
+        if (Object.prototype.hasOwnProperty.call(ContentLaunchMode, key)) {
+            if (ContentLaunchMode[key as keyof typeof ContentLaunchMode] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ContentLaunchModeFromJSON(json: any): ContentLaunchMode {
+    return ContentLaunchModeFromJSONTyped(json, false);
+}
+
+export function ContentLaunchModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentLaunchMode {
+    return json as ContentLaunchMode;
+}
+
+export function ContentLaunchModeToJSON(value?: ContentLaunchMode | null): any {
+    return value as any;
+}
+
+export function ContentLaunchModeToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentLaunchMode {
+    return value as ContentLaunchMode;
+}
+

package/src/models/GetContent.ts

@@ -20,6 +20,13 @@ import {
     GetContentContentDataToJSON,
     GetContentContentDataToJSONTyped,
 } from './GetContentContentData';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} from './ContentLaunchMode';
 
 /**
  * 
@@ -57,6 +64,12 @@ export interface GetContent {
      * @memberof GetContent
      */
     contentType: GetContentContentTypeEnum;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof GetContent
+     */
+    launchMode: ContentLaunchMode;
     /**
      * 
      * @type {GetContentContentData}
@@ -131,6 +144,7 @@ export function instanceOfGetContent(value: object): value is GetContent {
     if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
     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 (!('contentData' in value) || value['contentData'] === undefined) return false;
     if (!('published' in value) || value['published'] === undefined) return false;
     return true;
@@ -151,6 +165,7 @@ export function GetContentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'contentType': json['content_type'],
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
         'contentData': GetContentContentDataFromJSON(json['content_data']),
         'order': json['order'] == null ? undefined : json['order'],
         'published': json['published'],
@@ -177,6 +192,7 @@ export function GetContentToJSONTyped(value?: Omit<GetContent, 'id'|'created_dat
         'name': value['name'],
         'description': value['description'],
         'content_type': value['contentType'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
         '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)),
     };