@easyedu/js-lsm-api 1.66.0 → 1.68.0

package/dist/esm/models/ContentLaunchMode.js

@@ -0,0 +1,44 @@
+/* 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'
+};
+export function instanceOfContentLaunchMode(value) {
+    for (const key in ContentLaunchMode) {
+        if (Object.prototype.hasOwnProperty.call(ContentLaunchMode, key)) {
+            if (ContentLaunchMode[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function ContentLaunchModeFromJSON(json) {
+    return ContentLaunchModeFromJSONTyped(json, false);
+}
+export function ContentLaunchModeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function ContentLaunchModeToJSON(value) {
+    return value;
+}
+export function ContentLaunchModeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { GetContentContentData } from './GetContentContentData';
+import type { ContentLaunchMode } from './ContentLaunchMode';
 /**
  *
  * @export
@@ -46,6 +47,12 @@ export interface GetContent {
      * @memberof GetContent
      */
     contentType: GetContentContentTypeEnum;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof GetContent
+     */
+    launchMode: ContentLaunchMode;
     /**
      *
      * @type {GetContentContentData}

package/dist/esm/models/GetContent.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { GetContentContentDataFromJSON, GetContentContentDataToJSON, } from './GetContentContentData';
+import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
 /**
  * @export
  */
@@ -36,6 +37,8 @@ export function instanceOfGetContent(value) {
         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)
@@ -55,6 +58,7 @@ export function GetContentFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
@@ -77,6 +81,7 @@ export function GetContentToJSONTyped(value, ignoreDiscriminator = false) {
         '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/dist/esm/models/GetContentAttempts.d.ts

@@ -0,0 +1,90 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ContentAttemptRollupScore } from './ContentAttemptRollupScore';
+import type { ContentAttemptItem } 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 declare const GetContentAttemptsScoreRollupStrategyEnum: {
+    readonly Latest: "Latest";
+    readonly Best: "Best";
+};
+export type GetContentAttemptsScoreRollupStrategyEnum = typeof GetContentAttemptsScoreRollupStrategyEnum[keyof typeof GetContentAttemptsScoreRollupStrategyEnum];
+/**
+ * Check if a given object implements the GetContentAttempts interface.
+ */
+export declare function instanceOfGetContentAttempts(value: object): value is GetContentAttempts;
+export declare function GetContentAttemptsFromJSON(json: any): GetContentAttempts;
+export declare function GetContentAttemptsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentAttempts;
+export declare function GetContentAttemptsToJSON(json: any): GetContentAttempts;
+export declare function GetContentAttemptsToJSONTyped(value?: GetContentAttempts | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetContentAttempts.js

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ContentAttemptRollupScoreFromJSON, ContentAttemptRollupScoreToJSON, } from './ContentAttemptRollupScore';
+import { ContentAttemptItemFromJSON, ContentAttemptItemToJSON, } from './ContentAttemptItem';
+/**
+ * @export
+ */
+export const GetContentAttemptsScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+};
+/**
+ * Check if a given object implements the GetContentAttempts interface.
+ */
+export function instanceOfGetContentAttempts(value) {
+    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) {
+    return GetContentAttemptsFromJSONTyped(json, false);
+}
+export function GetContentAttemptsFromJSONTyped(json, ignoreDiscriminator) {
+    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'].map(ContentAttemptItemFromJSON)),
+    };
+}
+export function GetContentAttemptsToJSON(json) {
+    return GetContentAttemptsToJSONTyped(json, false);
+}
+export function GetContentAttemptsToJSONTyped(value, ignoreDiscriminator = false) {
+    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'].map(ContentAttemptItemToJSON)),
+    };
+}

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

@@ -51,6 +51,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;
 }
 /**
  * Check if a given object implements the GetContentSession interface.

package/dist/esm/models/GetContentSession.js

@@ -27,6 +27,10 @@ export function instanceOfGetContentSession(value) {
         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;
 }
 export function GetContentSessionFromJSON(json) {
@@ -43,6 +47,8 @@ export function GetContentSessionFromJSONTyped(json, ignoreDiscriminator) {
         'updatedAt': json['updated_at'],
         'completionStatus': json['completion_status'],
         'gradeStatus': json['grade_status'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
     };
 }
 export function GetContentSessionToJSON(json) {
@@ -59,5 +65,7 @@ export function GetContentSessionToJSONTyped(value, ignoreDiscriminator = false)
         'updated_at': value['updatedAt'],
         'completion_status': value['completionStatus'],
         'grade_status': value['gradeStatus'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
     };
 }

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

@@ -59,6 +59,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}

package/dist/esm/models/GetContentSessionDetail.js

@@ -50,6 +50,10 @@ export function instanceOfGetContentSessionDetail(value) {
         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)
@@ -71,6 +75,8 @@ export function GetContentSessionDetailFromJSONTyped(json, ignoreDiscriminator)
         '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'].map(GetContentSessionDetailScormSessionDataInnerFromJSON)),
     };
@@ -90,6 +96,8 @@ export function GetContentSessionDetailToJSONTyped(value, ignoreDiscriminator =
         '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'].map(GetContentSessionDetailScormSessionDataInnerToJSON)),
     };

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

@@ -41,6 +41,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}

package/dist/esm/models/GetContentSessionListItem.js

@@ -25,6 +25,14 @@ export function instanceOfGetContentSessionListItem(value) {
         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)
@@ -43,6 +51,10 @@ export function GetContentSessionListItemFromJSONTyped(json, ignoreDiscriminator
         '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']),
     };
@@ -59,6 +71,10 @@ export function GetContentSessionListItemToJSONTyped(value, ignoreDiscriminator
         '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/dist/esm/models/GetPortal.d.ts

@@ -46,13 +46,13 @@ export interface GetPortal {
      */
     clientDomain?: string | null;
     /**
-     *
+     * API-proxied portal logo URL when a logo is configured.
      * @type {string}
      * @memberof GetPortal
      */
     logoUrl?: string | null;
     /**
-     *
+     * API-proxied portal favicon URL when a favicon is configured.
      * @type {string}
      * @memberof GetPortal
      */

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

@@ -16,7 +16,7 @@
  */
 export interface GetPortalFaviconUpload {
     /**
-     * Presigned URL for the uploaded favicon image
+     * API-proxied URL for the uploaded favicon image
      * @type {string}
      * @memberof GetPortalFaviconUpload
      */

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

@@ -16,7 +16,7 @@
  */
 export interface GetPortalLogoUpload {
     /**
-     * Presigned URL for the uploaded logo image
+     * API-proxied URL for the uploaded logo image
      * @type {string}
      * @memberof GetPortalLogoUpload
      */

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

@@ -34,13 +34,13 @@ export interface GetPublicPortalBranding {
      */
     slug: string | null;
     /**
-     * Presigned portal logo URL when a logo is configured.
+     * API-proxied portal logo URL when a logo is configured.
      * @type {string}
      * @memberof GetPublicPortalBranding
      */
     logoUrl: string | null;
     /**
-     * Presigned portal favicon URL when a favicon is configured.
+     * API-proxied portal favicon URL when a favicon is configured.
      * @type {string}
      * @memberof GetPublicPortalBranding
      */

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ContentLaunchMode } from './ContentLaunchMode';
 /**
  * A content session
  * @export
@@ -33,6 +34,12 @@ export interface PostContentSession {
      * @memberof PostContentSession
      */
     launchUrl: string;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof PostContentSession
+     */
+    launchMode: ContentLaunchMode;
     /**
      * The date and time the content session was created
      * @type {number}
@@ -45,6 +52,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;
 }
 /**
  * Check if a given object implements the PostContentSession interface.

package/dist/esm/models/PostContentSession.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
 /**
  * Check if a given object implements the PostContentSession interface.
  */
@@ -21,8 +22,14 @@ export function instanceOfPostContentSession(value) {
         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 (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
+        return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined)
+        return false;
     return true;
 }
 export function PostContentSessionFromJSON(json) {
@@ -36,8 +43,11 @@ export function PostContentSessionFromJSONTyped(json, ignoreDiscriminator) {
         'contentId': json['content_id'],
         'userId': json['user_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'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
     };
 }
 export function PostContentSessionToJSON(json) {
@@ -51,7 +61,10 @@ export function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false
         'content_id': value['contentId'],
         'user_id': value['userId'],
         'launch_url': value['launchUrl'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
         'created_at': value['createdAt'],
         'player_session_id': value['playerSessionId'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
     };
 }

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ContentLaunchMode } from './ContentLaunchMode';
 /**
  *
  * @export
@@ -27,6 +28,12 @@ export interface PutContent {
      * @memberof PutContent
      */
     published?: boolean;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof PutContent
+     */
+    launchMode?: ContentLaunchMode;
 }
 /**
  * Check if a given object implements the PutContent interface.

package/dist/esm/models/PutContent.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
 /**
  * Check if a given object implements the PutContent interface.
  */
@@ -27,6 +28,7 @@ export function PutContentFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'name': json['name'] == null ? undefined : json['name'],
         'published': json['published'] == null ? undefined : json['published'],
+        'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
     };
 }
 export function PutContentToJSON(json) {
@@ -39,5 +41,6 @@ export function PutContentToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'name': value['name'],
         'published': value['published'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
     };
 }

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

@@ -1,12 +1,15 @@
 export * from './Certificate';
 export * from './CertificateConfig';
 export * from './CertificatePublic';
+export * from './ContentAttemptItem';
+export * from './ContentAttemptRollupScore';
+export * from './ContentAttemptScore';
+export * from './ContentLaunchMode';
 export * from './CourseCatalog';
 export * from './CourseShare';
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
-export * from './DownloadSupportTicketAttachment200Response';
 export * from './EffectiveCertificateConfig';
 export * from './Essay';
 export * from './Essay1';
@@ -16,6 +19,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';