@easyedu/js-lsm-api 1.28.0 → 1.30.0

package/src/apis/ContentApi.ts

@@ -18,10 +18,14 @@ import type {
   GetContent,
   GetContentList,
   GetContentSession,
+  GetContentSessionDetail,
+  GetContentSessionList,
   GetContentUpload,
   GetContentVersion,
   GetContentVersionList,
+  GetScormApiLogs,
   GetScormPackage,
+  GetScormSessionData,
   PostContentQuiz,
   PostContentSession,
   PostContentUpload,
@@ -35,14 +39,22 @@ import {
     GetContentListToJSON,
     GetContentSessionFromJSON,
     GetContentSessionToJSON,
+    GetContentSessionDetailFromJSON,
+    GetContentSessionDetailToJSON,
+    GetContentSessionListFromJSON,
+    GetContentSessionListToJSON,
     GetContentUploadFromJSON,
     GetContentUploadToJSON,
     GetContentVersionFromJSON,
     GetContentVersionToJSON,
     GetContentVersionListFromJSON,
     GetContentVersionListToJSON,
+    GetScormApiLogsFromJSON,
+    GetScormApiLogsToJSON,
     GetScormPackageFromJSON,
     GetScormPackageToJSON,
+    GetScormSessionDataFromJSON,
+    GetScormSessionDataToJSON,
     PostContentQuizFromJSON,
     PostContentQuizToJSON,
     PostContentSessionFromJSON,
@@ -72,6 +84,13 @@ export interface GetContentSessionRequest {
     courseId: string;
 }
 
+export interface GetContentSessionDetailRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    sessionId: string;
+}
+
 export interface GetContentVersionRequest {
     contentId: string;
     moduleId: string;
@@ -87,10 +106,29 @@ export interface GetContentVersionListRequest {
     pageSize?: number;
 }
 
+export interface GetScormApiLogsRequest {
+    sessionId: string;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface GetScormPackageRequest {
     packageId: string;
 }
 
+export interface GetScormSessionDataRequest {
+    scormSessionId: string;
+}
+
+export interface ListContentSessionsRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    sessionType?: ListContentSessionsSessionTypeEnum;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface PostContentProcessRequest {
     moduleId: string;
     courseId: string;
@@ -269,6 +307,62 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get detailed information about a specific content session
+     * Get content session details (instructor only)
+     */
+    async getContentSessionDetailRaw(requestParameters: GetContentSessionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentSessionDetail>> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getContentSessionDetail().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling getContentSessionDetail().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getContentSessionDetail().'
+            );
+        }
+
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getContentSessionDetail().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId}`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))).replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetContentSessionDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Get detailed information about a specific content session
+     * Get content session details (instructor only)
+     */
+    async getContentSessionDetail(requestParameters: GetContentSessionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionDetail> {
+        const response = await this.getContentSessionDetailRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns detailed information about a specific version of the content, including sandbox launch URL and SCORM-specific data (package info and table of contents) if applicable.
      * Get details of a specific content version
@@ -382,6 +476,49 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
+     * Get SCORM API call logs (instructor only)
+     */
+    async getScormApiLogsRaw(requestParameters: GetScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormApiLogs>> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getScormApiLogs().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/scorm/sessions/{sessionId}/api-logs`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetScormApiLogsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
+     * Get SCORM API call logs (instructor only)
+     */
+    async getScormApiLogs(requestParameters: GetScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormApiLogs> {
+        const response = await this.getScormApiLogsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns package information and table of contents for a SCORM package
      * Get details of a SCORM package
@@ -417,6 +554,102 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get detailed SCORM session data including CMI data dump for debugging
+     * Get SCORM session data (instructor only)
+     */
+    async getScormSessionDataRaw(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetScormSessionData>> {
+        if (requestParameters['scormSessionId'] == null) {
+            throw new runtime.RequiredError(
+                'scormSessionId',
+                'Required parameter "scormSessionId" was null or undefined when calling getScormSessionData().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/scorm/sessions/{scormSessionId}/session-data`.replace(`{${"scormSessionId"}}`, encodeURIComponent(String(requestParameters['scormSessionId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetScormSessionDataFromJSON(jsonValue));
+    }
+
+    /**
+     * Get detailed SCORM session data including CMI data dump for debugging
+     * Get SCORM session data (instructor only)
+     */
+    async getScormSessionData(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormSessionData> {
+        const response = await this.getScormSessionDataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get a paginated list of all content sessions for a specific content item
+     * List content sessions (instructor only)
+     */
+    async listContentSessionsRaw(requestParameters: ListContentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentSessionList>> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling listContentSessions().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling listContentSessions().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling listContentSessions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['sessionType'] != null) {
+            queryParameters['sessionType'] = requestParameters['sessionType'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions`.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId']))).replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetContentSessionListFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a paginated list of all content sessions for a specific content item
+     * List content sessions (instructor only)
+     */
+    async listContentSessions(requestParameters: ListContentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionList> {
+        const response = await this.listContentSessionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Post a new content process
      */
@@ -737,3 +970,12 @@ export class ContentApi extends runtime.BaseAPI {
     }
 
 }
+
+/**
+ * @export
+ */
+export const ListContentSessionsSessionTypeEnum = {
+    Sandbox: 'SANDBOX',
+    Live: 'LIVE'
+} as const;
+export type ListContentSessionsSessionTypeEnum = typeof ListContentSessionsSessionTypeEnum[keyof typeof ListContentSessionsSessionTypeEnum];

package/src/models/GetContentSessionDetail.ts

@@ -0,0 +1,178 @@
+/* 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 { GetContentSessionDetailScormSessionDataInner } from './GetContentSessionDetailScormSessionDataInner';
+import {
+    GetContentSessionDetailScormSessionDataInnerFromJSON,
+    GetContentSessionDetailScormSessionDataInnerFromJSONTyped,
+    GetContentSessionDetailScormSessionDataInnerToJSON,
+    GetContentSessionDetailScormSessionDataInnerToJSONTyped,
+} from './GetContentSessionDetailScormSessionDataInner';
+import type { GetContentSessionDetailUserData } from './GetContentSessionDetailUserData';
+import {
+    GetContentSessionDetailUserDataFromJSON,
+    GetContentSessionDetailUserDataFromJSONTyped,
+    GetContentSessionDetailUserDataToJSON,
+    GetContentSessionDetailUserDataToJSONTyped,
+} from './GetContentSessionDetailUserData';
+
+/**
+ * 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;
+    /**
+     * SCORM session data if this is a SCORM session, null otherwise
+     * @type {Array<GetContentSessionDetailScormSessionDataInner>}
+     * @memberof GetContentSessionDetail
+     */
+    scormSessionData: Array<GetContentSessionDetailScormSessionDataInner> | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetContentSessionDetailCompletionStatusEnum = {
+    NotAttempted: 'NotAttempted',
+    InProgress: 'InProgress',
+    Completed: 'Completed'
+} as const;
+export type GetContentSessionDetailCompletionStatusEnum = typeof GetContentSessionDetailCompletionStatusEnum[keyof typeof GetContentSessionDetailCompletionStatusEnum];
+
+/**
+ * @export
+ */
+export const GetContentSessionDetailGradeStatusEnum = {
+    Ungraded: 'Ungraded',
+    Passed: 'Passed',
+    Failed: 'Failed',
+    PointsEarned: 'PointsEarned',
+    PercentageEarned: 'PercentageEarned',
+    NotApplicable: 'NotApplicable'
+} as const;
+export type GetContentSessionDetailGradeStatusEnum = typeof GetContentSessionDetailGradeStatusEnum[keyof typeof GetContentSessionDetailGradeStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetContentSessionDetail interface.
+ */
+export function instanceOfGetContentSessionDetail(value: object): value is GetContentSessionDetail {
+    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 (!('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 (!('durationInSeconds' in value) || value['durationInSeconds'] === undefined) return false;
+    if (!('userData' in value) || value['userData'] === undefined) return false;
+    if (!('scormSessionData' in value) || value['scormSessionData'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionDetailFromJSON(json: any): GetContentSessionDetail {
+    return GetContentSessionDetailFromJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'contentId': json['content_id'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'durationInSeconds': json['duration_in_seconds'],
+        'userData': GetContentSessionDetailUserDataFromJSON(json['user_data']),
+        'scormSessionData': (json['scorm_session_data'] == null ? null : (json['scorm_session_data'] as Array<any>).map(GetContentSessionDetailScormSessionDataInnerFromJSON)),
+    };
+}
+
+export function GetContentSessionDetailToJSON(json: any): GetContentSessionDetail {
+    return GetContentSessionDetailToJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailToJSONTyped(value?: GetContentSessionDetail | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'content_id': value['contentId'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'duration_in_seconds': value['durationInSeconds'],
+        'user_data': GetContentSessionDetailUserDataToJSON(value['userData']),
+        'scorm_session_data': (value['scormSessionData'] == null ? null : (value['scormSessionData'] as Array<any>).map(GetContentSessionDetailScormSessionDataInnerToJSON)),
+    };
+}
+

package/src/models/GetContentSessionDetailScormSessionDataInner.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';
+/**
+ * 
+ * @export
+ * @interface GetContentSessionDetailScormSessionDataInner
+ */
+export interface GetContentSessionDetailScormSessionDataInner {
+    /**
+     * The external ID of the SCORM session
+     * @type {string}
+     * @memberof GetContentSessionDetailScormSessionDataInner
+     */
+    scormSessionId: string;
+    /**
+     * The name of the SCORM activity
+     * @type {string}
+     * @memberof GetContentSessionDetailScormSessionDataInner
+     */
+    activityName: string;
+}
+
+/**
+ * Check if a given object implements the GetContentSessionDetailScormSessionDataInner interface.
+ */
+export function instanceOfGetContentSessionDetailScormSessionDataInner(value: object): value is GetContentSessionDetailScormSessionDataInner {
+    if (!('scormSessionId' in value) || value['scormSessionId'] === undefined) return false;
+    if (!('activityName' in value) || value['activityName'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionDetailScormSessionDataInnerFromJSON(json: any): GetContentSessionDetailScormSessionDataInner {
+    return GetContentSessionDetailScormSessionDataInnerFromJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailScormSessionDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionDetailScormSessionDataInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scormSessionId': json['scorm_session_id'],
+        'activityName': json['activity_name'],
+    };
+}
+
+export function GetContentSessionDetailScormSessionDataInnerToJSON(json: any): GetContentSessionDetailScormSessionDataInner {
+    return GetContentSessionDetailScormSessionDataInnerToJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailScormSessionDataInnerToJSONTyped(value?: GetContentSessionDetailScormSessionDataInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scorm_session_id': value['scormSessionId'],
+        'activity_name': value['activityName'],
+    };
+}
+

package/src/models/GetContentSessionDetailUserData.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';
+/**
+ * 
+ * @export
+ * @interface GetContentSessionDetailUserData
+ */
+export interface GetContentSessionDetailUserData {
+    /**
+     * The external ID of the user
+     * @type {string}
+     * @memberof GetContentSessionDetailUserData
+     */
+    userId: string;
+    /**
+     * The name of the user
+     * @type {string}
+     * @memberof GetContentSessionDetailUserData
+     */
+    userName: string;
+}
+
+/**
+ * Check if a given object implements the GetContentSessionDetailUserData interface.
+ */
+export function instanceOfGetContentSessionDetailUserData(value: object): value is GetContentSessionDetailUserData {
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('userName' in value) || value['userName'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionDetailUserDataFromJSON(json: any): GetContentSessionDetailUserData {
+    return GetContentSessionDetailUserDataFromJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailUserDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSessionDetailUserData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userId': json['user_id'],
+        'userName': json['user_name'],
+    };
+}
+
+export function GetContentSessionDetailUserDataToJSON(json: any): GetContentSessionDetailUserData {
+    return GetContentSessionDetailUserDataToJSONTyped(json, false);
+}
+
+export function GetContentSessionDetailUserDataToJSONTyped(value?: GetContentSessionDetailUserData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_id': value['userId'],
+        'user_name': value['userName'],
+    };
+}
+