@easyedu/js-lsm-api 1.27.0 → 1.29.0

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

@@ -0,0 +1,73 @@
+/**
+ * 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.
+ */
+/**
+ * A SCORM API call log entry
+ * @export
+ * @interface GetScormApiLogItem
+ */
+export interface GetScormApiLogItem {
+    /**
+     * The ID of the log entry
+     * @type {number}
+     * @memberof GetScormApiLogItem
+     */
+    id: number;
+    /**
+     * The date and time the API call was made (Unix timestamp)
+     * @type {number}
+     * @memberof GetScormApiLogItem
+     */
+    createdAt: number;
+    /**
+     * The SCORM API method that was called
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    method: GetScormApiLogItemMethodEnum;
+    /**
+     * The CMI element (e.g., 'cmi.score.raw') - nullable for Initialize, Commit, Terminate
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    element: string | null;
+    /**
+     * The value set or returned - nullable for some operations
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    value: string | null;
+    /**
+     * The SCORM error code ('0' for success, '301', '401', etc.')
+     * @type {string}
+     * @memberof GetScormApiLogItem
+     */
+    errorCode: string;
+}
+/**
+ * @export
+ */
+export declare const GetScormApiLogItemMethodEnum: {
+    readonly Initialize: "Initialize";
+    readonly SetValue: "SetValue";
+    readonly GetValue: "GetValue";
+    readonly Commit: "Commit";
+    readonly Terminate: "Terminate";
+};
+export type GetScormApiLogItemMethodEnum = typeof GetScormApiLogItemMethodEnum[keyof typeof GetScormApiLogItemMethodEnum];
+/**
+ * Check if a given object implements the GetScormApiLogItem interface.
+ */
+export declare function instanceOfGetScormApiLogItem(value: object): value is GetScormApiLogItem;
+export declare function GetScormApiLogItemFromJSON(json: any): GetScormApiLogItem;
+export declare function GetScormApiLogItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetScormApiLogItem;
+export declare function GetScormApiLogItemToJSON(json: any): GetScormApiLogItem;
+export declare function GetScormApiLogItemToJSONTyped(value?: GetScormApiLogItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetScormApiLogItem.js

@@ -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.
+ */
+/**
+ * @export
+ */
+export const GetScormApiLogItemMethodEnum = {
+    Initialize: 'Initialize',
+    SetValue: 'SetValue',
+    GetValue: 'GetValue',
+    Commit: 'Commit',
+    Terminate: 'Terminate'
+};
+/**
+ * Check if a given object implements the GetScormApiLogItem interface.
+ */
+export function instanceOfGetScormApiLogItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('method' in value) || value['method'] === undefined)
+        return false;
+    if (!('element' in value) || value['element'] === undefined)
+        return false;
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    return true;
+}
+export function GetScormApiLogItemFromJSON(json) {
+    return GetScormApiLogItemFromJSONTyped(json, false);
+}
+export function GetScormApiLogItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'method': json['method'],
+        'element': json['element'],
+        'value': json['value'],
+        'errorCode': json['error_code'],
+    };
+}
+export function GetScormApiLogItemToJSON(json) {
+    return GetScormApiLogItemToJSONTyped(json, false);
+}
+export function GetScormApiLogItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'method': value['method'],
+        'element': value['element'],
+        'value': value['value'],
+        'error_code': value['errorCode'],
+    };
+}

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

@@ -0,0 +1,57 @@
+/**
+ * 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 { GetScormApiLogItem } from './GetScormApiLogItem';
+/**
+ * A list of SCORM API logs with pagination information
+ * @export
+ * @interface GetScormApiLogs
+ */
+export interface GetScormApiLogs {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetScormApiLogs
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetScormApiLogs
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetScormApiLogs
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetScormApiLogs
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetScormApiLogItem>}
+     * @memberof GetScormApiLogs
+     */
+    items: Array<GetScormApiLogItem>;
+}
+/**
+ * Check if a given object implements the GetScormApiLogs interface.
+ */
+export declare function instanceOfGetScormApiLogs(value: object): value is GetScormApiLogs;
+export declare function GetScormApiLogsFromJSON(json: any): GetScormApiLogs;
+export declare function GetScormApiLogsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetScormApiLogs;
+export declare function GetScormApiLogsToJSON(json: any): GetScormApiLogs;
+export declare function GetScormApiLogsToJSONTyped(value?: GetScormApiLogs | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetScormApiLogs.js

@@ -0,0 +1,60 @@
+/* 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 { GetScormApiLogItemFromJSON, GetScormApiLogItemToJSON, } from './GetScormApiLogItem';
+/**
+ * Check if a given object implements the GetScormApiLogs interface.
+ */
+export function instanceOfGetScormApiLogs(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetScormApiLogsFromJSON(json) {
+    return GetScormApiLogsFromJSONTyped(json, false);
+}
+export function GetScormApiLogsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(GetScormApiLogItemFromJSON)),
+    };
+}
+export function GetScormApiLogsToJSON(json) {
+    return GetScormApiLogsToJSONTyped(json, false);
+}
+export function GetScormApiLogsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(GetScormApiLogItemToJSON)),
+    };
+}

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

@@ -0,0 +1,59 @@
+/**
+ * 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 { GetScormSessionDataActivity } from './GetScormSessionDataActivity';
+/**
+ * SCORM session data with CMI information
+ * @export
+ * @interface GetScormSessionData
+ */
+export interface GetScormSessionData {
+    /**
+     * The external ID of the SCORM session
+     * @type {string}
+     * @memberof GetScormSessionData
+     */
+    id: string;
+    /**
+     * The date and time the SCORM session was created (Unix timestamp)
+     * @type {number}
+     * @memberof GetScormSessionData
+     */
+    createdAt: number;
+    /**
+     * The date and time the SCORM session was updated (Unix timestamp)
+     * @type {number}
+     * @memberof GetScormSessionData
+     */
+    updatedAt: number;
+    /**
+     * The SCORM CMI data (complete dump of scorm_data)
+     * @type {{ [key: string]: any; }}
+     * @memberof GetScormSessionData
+     */
+    cmiData: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {GetScormSessionDataActivity}
+     * @memberof GetScormSessionData
+     */
+    activity: GetScormSessionDataActivity;
+}
+/**
+ * Check if a given object implements the GetScormSessionData interface.
+ */
+export declare function instanceOfGetScormSessionData(value: object): value is GetScormSessionData;
+export declare function GetScormSessionDataFromJSON(json: any): GetScormSessionData;
+export declare function GetScormSessionDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetScormSessionData;
+export declare function GetScormSessionDataToJSON(json: any): GetScormSessionData;
+export declare function GetScormSessionDataToJSONTyped(value?: GetScormSessionData | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetScormSessionData.js

@@ -0,0 +1,60 @@
+/* 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 { GetScormSessionDataActivityFromJSON, GetScormSessionDataActivityToJSON, } from './GetScormSessionDataActivity';
+/**
+ * Check if a given object implements the GetScormSessionData interface.
+ */
+export function instanceOfGetScormSessionData(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    if (!('cmiData' in value) || value['cmiData'] === undefined)
+        return false;
+    if (!('activity' in value) || value['activity'] === undefined)
+        return false;
+    return true;
+}
+export function GetScormSessionDataFromJSON(json) {
+    return GetScormSessionDataFromJSONTyped(json, false);
+}
+export function GetScormSessionDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'cmiData': json['cmi_data'],
+        'activity': GetScormSessionDataActivityFromJSON(json['activity']),
+    };
+}
+export function GetScormSessionDataToJSON(json) {
+    return GetScormSessionDataToJSONTyped(json, false);
+}
+export function GetScormSessionDataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'cmi_data': value['cmiData'],
+        'activity': GetScormSessionDataActivityToJSON(value['activity']),
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface GetScormSessionDataActivity
+ */
+export interface GetScormSessionDataActivity {
+    /**
+     * The external ID of the SCORM activity
+     * @type {string}
+     * @memberof GetScormSessionDataActivity
+     */
+    activityId: string;
+    /**
+     * The name/title of the SCORM activity
+     * @type {string}
+     * @memberof GetScormSessionDataActivity
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the GetScormSessionDataActivity interface.
+ */
+export declare function instanceOfGetScormSessionDataActivity(value: object): value is GetScormSessionDataActivity;
+export declare function GetScormSessionDataActivityFromJSON(json: any): GetScormSessionDataActivity;
+export declare function GetScormSessionDataActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetScormSessionDataActivity;
+export declare function GetScormSessionDataActivityToJSON(json: any): GetScormSessionDataActivity;
+export declare function GetScormSessionDataActivityToJSONTyped(value?: GetScormSessionDataActivity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetScormSessionDataActivity.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetScormSessionDataActivity interface.
+ */
+export function instanceOfGetScormSessionDataActivity(value) {
+    if (!('activityId' in value) || value['activityId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function GetScormSessionDataActivityFromJSON(json) {
+    return GetScormSessionDataActivityFromJSONTyped(json, false);
+}
+export function GetScormSessionDataActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'activityId': json['activity_id'],
+        'name': json['name'],
+    };
+}
+export function GetScormSessionDataActivityToJSON(json) {
+    return GetScormSessionDataActivityToJSONTyped(json, false);
+}
+export function GetScormSessionDataActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'activity_id': value['activityId'],
+        'name': value['name'],
+    };
+}

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

@@ -15,6 +15,11 @@ export * from './GetContentInstructorBasicReportingEngagement';
 export * from './GetContentInstructorBasicReportingPerformance';
 export * from './GetContentList';
 export * from './GetContentSession';
+export * from './GetContentSessionDetail';
+export * from './GetContentSessionDetailScormSessionData';
+export * from './GetContentSessionDetailUserData';
+export * from './GetContentSessionList';
+export * from './GetContentSessionListItem';
 export * from './GetContentUpload';
 export * from './GetContentVersion';
 export * from './GetContentVersionList';
@@ -103,8 +108,12 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetScormApiLogItem';
+export * from './GetScormApiLogs';
 export * from './GetScormPackage';
 export * from './GetScormPackagePackageInfo';
+export * from './GetScormSessionData';
+export * from './GetScormSessionDataActivity';
 export * from './GetUser';
 export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';

package/dist/esm/models/index.js

@@ -17,6 +17,11 @@ export * from './GetContentInstructorBasicReportingEngagement';
 export * from './GetContentInstructorBasicReportingPerformance';
 export * from './GetContentList';
 export * from './GetContentSession';
+export * from './GetContentSessionDetail';
+export * from './GetContentSessionDetailScormSessionData';
+export * from './GetContentSessionDetailUserData';
+export * from './GetContentSessionList';
+export * from './GetContentSessionListItem';
 export * from './GetContentUpload';
 export * from './GetContentVersion';
 export * from './GetContentVersionList';
@@ -105,8 +110,12 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetScormApiLogItem';
+export * from './GetScormApiLogs';
 export * from './GetScormPackage';
 export * from './GetScormPackagePackageInfo';
+export * from './GetScormSessionData';
+export * from './GetScormSessionDataActivity';
 export * from './GetUser';
 export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';

package/dist/models/GetContent.d.ts

@@ -76,6 +76,24 @@ export interface GetContent {
      * @memberof GetContent
      */
     readonly updatedDate?: Date;
+    /**
+     * Active version number for versioned content types (SCORM, Video, PDF, File)
+     * @type {number}
+     * @memberof GetContent
+     */
+    readonly activeVersionNumber?: number;
+    /**
+     * Active version ID for versioned content types
+     * @type {string}
+     * @memberof GetContent
+     */
+    readonly activeVersionId?: string;
+    /**
+     * Whether this content has multiple versions
+     * @type {boolean}
+     * @memberof GetContent
+     */
+    readonly hasMultipleVersions?: boolean;
 }
 /**
  * @export
@@ -97,4 +115,4 @@ export declare function instanceOfGetContent(value: object): value is GetContent
 export declare function GetContentFromJSON(json: any): GetContent;
 export declare function GetContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContent;
 export declare function GetContentToJSON(json: any): GetContent;
-export declare function GetContentToJSONTyped(value?: Omit<GetContent, 'id' | 'created_date' | 'updated_date'> | null, ignoreDiscriminator?: boolean): any;
+export declare function GetContentToJSONTyped(value?: Omit<GetContent, 'id' | 'created_date' | 'updated_date' | 'active_version_number' | 'active_version_id' | 'has_multiple_versions'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetContent.js

@@ -68,6 +68,9 @@ function GetContentFromJSONTyped(json, ignoreDiscriminator) {
         'published': json['published'],
         'createdDate': json['created_date'] == null ? undefined : (new Date(json['created_date'])),
         'updatedDate': json['updated_date'] == null ? undefined : (new Date(json['updated_date'])),
+        'activeVersionNumber': json['active_version_number'] == null ? undefined : json['active_version_number'],
+        'activeVersionId': json['active_version_id'] == null ? undefined : json['active_version_id'],
+        'hasMultipleVersions': json['has_multiple_versions'] == null ? undefined : json['has_multiple_versions'],
     };
 }
 function GetContentToJSON(json) {

package/dist/models/GetContentSessionDetail.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 { GetContentSessionDetailUserData } from './GetContentSessionDetailUserData';
+import type { GetContentSessionDetailScormSessionData } from './GetContentSessionDetailScormSessionData';
+/**
+ * Detailed content session information
+ * @export
+ * @interface GetContentSessionDetail
+ */
+export interface GetContentSessionDetail {
+    /**
+     * The external ID of the content session
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    id: string;
+    /**
+     * The date and time the content session was created (Unix timestamp)
+     * @type {number}
+     * @memberof GetContentSessionDetail
+     */
+    createdAt: number;
+    /**
+     * The date and time the content session was updated (Unix timestamp)
+     * @type {number}
+     * @memberof GetContentSessionDetail
+     */
+    updatedAt: number;
+    /**
+     * The external ID of the content
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    contentId: string;
+    /**
+     * The completion status of the content session
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    completionStatus: GetContentSessionDetailCompletionStatusEnum;
+    /**
+     * The grade status of the content session
+     * @type {string}
+     * @memberof GetContentSessionDetail
+     */
+    gradeStatus: GetContentSessionDetailGradeStatusEnum;
+    /**
+     * The total duration of the session in seconds
+     * @type {number}
+     * @memberof GetContentSessionDetail
+     */
+    durationInSeconds: number;
+    /**
+     *
+     * @type {GetContentSessionDetailUserData}
+     * @memberof GetContentSessionDetail
+     */
+    userData: GetContentSessionDetailUserData;
+    /**
+     *
+     * @type {GetContentSessionDetailScormSessionData}
+     * @memberof GetContentSessionDetail
+     */
+    scormSessionData: GetContentSessionDetailScormSessionData | null;
+}
+/**
+ * @export
+ */
+export declare const GetContentSessionDetailCompletionStatusEnum: {
+    readonly NotAttempted: "NotAttempted";
+    readonly InProgress: "InProgress";
+    readonly Completed: "Completed";
+};
+export type GetContentSessionDetailCompletionStatusEnum = typeof GetContentSessionDetailCompletionStatusEnum[keyof typeof GetContentSessionDetailCompletionStatusEnum];
+/**
+ * @export
+ */
+export declare const GetContentSessionDetailGradeStatusEnum: {
+    readonly Ungraded: "Ungraded";
+    readonly Passed: "Passed";
+    readonly Failed: "Failed";
+    readonly PointsEarned: "PointsEarned";
+    readonly PercentageEarned: "PercentageEarned";
+    readonly NotApplicable: "NotApplicable";
+};
+export type GetContentSessionDetailGradeStatusEnum = typeof GetContentSessionDetailGradeStatusEnum[keyof typeof GetContentSessionDetailGradeStatusEnum];
+/**
+ * Check if a given object implements the GetContentSessionDetail interface.
+ */
+export declare function instanceOfGetContentSessionDetail(value: object): value is GetContentSessionDetail;
+export declare function GetContentSessionDetailFromJSON(json: any): GetContentSessionDetail;
+export declare function GetContentSessionDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionDetail;
+export declare function GetContentSessionDetailToJSON(json: any): GetContentSessionDetail;
+export declare function GetContentSessionDetailToJSONTyped(value?: GetContentSessionDetail | null, ignoreDiscriminator?: boolean): any;