@easyedu/js-lsm-api 1.98.0 → 1.99.0

package/src/apis/PlayerApi.ts

@@ -18,6 +18,21 @@ import {
     GetResourceSessionFromJSON,
     GetResourceSessionToJSON,
 } from '../models/GetResourceSession';
+import {
+    type GetResourceSessionActivity,
+    GetResourceSessionActivityFromJSON,
+    GetResourceSessionActivityToJSON,
+} from '../models/GetResourceSessionActivity';
+import {
+    type GetResourceSessionActivityEventList,
+    GetResourceSessionActivityEventListFromJSON,
+    GetResourceSessionActivityEventListToJSON,
+} from '../models/GetResourceSessionActivityEventList';
+import {
+    type GetResourceSessionActivityList,
+    GetResourceSessionActivityListFromJSON,
+    GetResourceSessionActivityListToJSON,
+} from '../models/GetResourceSessionActivityList';
 import {
     type GetResourceSessionDiagnostics,
     GetResourceSessionDiagnosticsFromJSON,
@@ -38,6 +53,11 @@ import {
     GetResourceSessionScormDataFromJSON,
     GetResourceSessionScormDataToJSON,
 } from '../models/GetResourceSessionScormData';
+import {
+    type PostResourceSessionActivityEvent,
+    PostResourceSessionActivityEventFromJSON,
+    PostResourceSessionActivityEventToJSON,
+} from '../models/PostResourceSessionActivityEvent';
 import {
     type ResourceSessionEnvironment,
     ResourceSessionEnvironmentFromJSON,
@@ -66,6 +86,7 @@ import {
 
 export interface CommitResourceScormSessionRequest {
     sessionId: string;
+    activityId?: string;
 }
 
 export interface GetCourseVersionResourceAssetRequest {
@@ -81,12 +102,21 @@ export interface GetLibraryQuizSessionPlayerRequest {
 export interface GetResourceScormValueRequest {
     sessionId: string;
     key: string;
+    activityId?: string;
 }
 
 export interface GetResourceSessionRequest {
     sessionId: string;
 }
 
+export interface GetResourceSessionActivitiesRequest {
+    sessionId: string;
+}
+
+export interface GetResourceSessionActivityEventsRequest {
+    sessionId: string;
+}
+
 export interface GetResourceSessionAssetRequest {
     sessionId: string;
     assetPath: string;
@@ -135,10 +165,18 @@ export interface GetResourceSessionScormApiLogsRequest {
 
 export interface GetResourceSessionScormDataRequest {
     sessionId: string;
+    activityId?: string;
 }
 
 export interface InitializeResourceScormSessionRequest {
     sessionId: string;
+    activityId?: string;
+}
+
+export interface PostResourceSessionActivityEventRequest {
+    sessionId: string;
+    activityId: string;
+    postResourceSessionActivityEvent: PostResourceSessionActivityEvent;
 }
 
 export interface PostResourceSessionCompleteRequest {
@@ -148,10 +186,12 @@ export interface PostResourceSessionCompleteRequest {
 export interface SetResourceScormValueRequest {
     sessionId: string;
     scormSetValueRequest: ScormSetValueRequest;
+    activityId?: string;
 }
 
 export interface TerminateResourceScormSessionRequest {
     sessionId: string;
+    activityId?: string;
 }
 
 /**
@@ -172,6 +212,10 @@ export class PlayerApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['activityId'] != null) {
+            queryParameters['activity_id'] = requestParameters['activityId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -337,6 +381,10 @@ export class PlayerApi extends runtime.BaseAPI {
             queryParameters['key'] = requestParameters['key'];
         }
 
+        if (requestParameters['activityId'] != null) {
+            queryParameters['activity_id'] = requestParameters['activityId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -414,6 +462,96 @@ export class PlayerApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getResourceSessionActivities without sending the request
+     */
+    async getResourceSessionActivitiesRequestOpts(requestParameters: GetResourceSessionActivitiesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getResourceSessionActivities().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/activities`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List tracked activities for a resource session
+     */
+    async getResourceSessionActivitiesRaw(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityList>> {
+        const requestOptions = await this.getResourceSessionActivitiesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionActivityListFromJSON(jsonValue));
+    }
+
+    /**
+     * List tracked activities for a resource session
+     */
+    async getResourceSessionActivities(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityList> {
+        const response = await this.getResourceSessionActivitiesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getResourceSessionActivityEvents without sending the request
+     */
+    async getResourceSessionActivityEventsRequestOpts(requestParameters: GetResourceSessionActivityEventsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getResourceSessionActivityEvents().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/activity-events`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List recorded learner activity events for a resource session
+     */
+    async getResourceSessionActivityEventsRaw(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityEventList>> {
+        const requestOptions = await this.getResourceSessionActivityEventsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionActivityEventListFromJSON(jsonValue));
+    }
+
+    /**
+     * List recorded learner activity events for a resource session
+     */
+    async getResourceSessionActivityEvents(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityEventList> {
+        const response = await this.getResourceSessionActivityEventsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getResourceSessionAsset without sending the request
      */
@@ -760,6 +898,10 @@ export class PlayerApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['activityId'] != null) {
+            queryParameters['activity_id'] = requestParameters['activityId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -805,6 +947,10 @@ export class PlayerApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['activityId'] != null) {
+            queryParameters['activity_id'] = requestParameters['activityId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -836,6 +982,69 @@ export class PlayerApi extends runtime.BaseAPI {
         await this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for postResourceSessionActivityEvent without sending the request
+     */
+    async postResourceSessionActivityEventRequestOpts(requestParameters: PostResourceSessionActivityEventRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling postResourceSessionActivityEvent().'
+            );
+        }
+
+        if (requestParameters['activityId'] == null) {
+            throw new runtime.RequiredError(
+                'activityId',
+                'Required parameter "activityId" was null or undefined when calling postResourceSessionActivityEvent().'
+            );
+        }
+
+        if (requestParameters['postResourceSessionActivityEvent'] == null) {
+            throw new runtime.RequiredError(
+                'postResourceSessionActivityEvent',
+                'Required parameter "postResourceSessionActivityEvent" was null or undefined when calling postResourceSessionActivityEvent().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/resource/sessions/{sessionId}/activities/{activityId}/events`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+        urlPath = urlPath.replace('{activityId}', encodeURIComponent(String(requestParameters['activityId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostResourceSessionActivityEventToJSON(requestParameters['postResourceSessionActivityEvent']),
+        };
+    }
+
+    /**
+     * Record learner activity and update active time
+     */
+    async postResourceSessionActivityEventRaw(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivity>> {
+        const requestOptions = await this.postResourceSessionActivityEventRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionActivityFromJSON(jsonValue));
+    }
+
+    /**
+     * Record learner activity and update active time
+     */
+    async postResourceSessionActivityEvent(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivity> {
+        const response = await this.postResourceSessionActivityEventRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postResourceSessionComplete without sending the request
      */
@@ -901,6 +1110,10 @@ export class PlayerApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['activityId'] != null) {
+            queryParameters['activity_id'] = requestParameters['activityId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         headerParameters['Content-Type'] = 'application/json';
@@ -949,6 +1162,10 @@ export class PlayerApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['activityId'] != null) {
+            queryParameters['activity_id'] = requestParameters['activityId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 

package/src/models/GetCourseVersionItemSession.ts

@@ -125,6 +125,12 @@ export interface GetCourseVersionItemSession {
      * @memberof GetCourseVersionItemSession
      */
     scoreRaw?: number | null;
+    /**
+     * Accumulated active learner time across this session's activities.
+     * @type {number}
+     * @memberof GetCourseVersionItemSession
+     */
+    durationSeconds: number;
     /**
      * 
      * @type {number}
@@ -164,6 +170,7 @@ export function instanceOfGetCourseVersionItemSession(value: object): value is G
     if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
     if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -193,6 +200,7 @@ export function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscri
         'completionStatus': json['completion_status'],
         'gradeStatus': json['grade_status'],
         'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'durationSeconds': json['duration_seconds'],
         'createdAt': json['created_at'],
         'updatedAt': json['updated_at'],
         'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
@@ -224,6 +232,7 @@ export function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionI
         'completion_status': value['completionStatus'],
         'grade_status': value['gradeStatus'],
         'score_raw': value['scoreRaw'],
+        'duration_seconds': value['durationSeconds'],
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],
         'completed_at': value['completedAt'],

package/src/models/GetLibraryQuizSession.ts

@@ -172,6 +172,12 @@ export interface GetLibraryQuizSession {
      * @memberof GetLibraryQuizSession
      */
     completedAt?: number | null;
+    /**
+     * Elapsed attempt time from start through completion, submission, or the latest saved activity.
+     * @type {number}
+     * @memberof GetLibraryQuizSession
+     */
+    durationSeconds: number;
 }
 
 
@@ -208,6 +214,7 @@ export function instanceOfGetLibraryQuizSession(value: object): value is GetLibr
     if (!('questions' in value) || value['questions'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
     return true;
 }
 
@@ -244,6 +251,7 @@ export function GetLibraryQuizSessionFromJSONTyped(json: any, ignoreDiscriminato
         'createdAt': json['created_at'],
         'updatedAt': json['updated_at'],
         'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+        'durationSeconds': json['duration_seconds'],
     };
 }
 
@@ -281,6 +289,7 @@ export function GetLibraryQuizSessionToJSONTyped(value?: GetLibraryQuizSession |
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],
         'completed_at': value['completedAt'],
+        'duration_seconds': value['durationSeconds'],
     };
 }
 

package/src/models/GetResourceSession.ts

@@ -173,6 +173,12 @@ export interface GetResourceSession {
      * @memberof GetResourceSession
      */
     scoreRaw?: number | null;
+    /**
+     * Accumulated active learner time across this session's activities.
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    durationSeconds: number;
     /**
      * 
      * @type {number}
@@ -225,6 +231,7 @@ export function instanceOfGetResourceSession(value: object): value is GetResourc
     if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
     if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
     if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -262,6 +269,7 @@ export function GetResourceSessionFromJSONTyped(json: any, ignoreDiscriminator:
         'completionStatus': json['completion_status'],
         'gradeStatus': json['grade_status'],
         'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'durationSeconds': json['duration_seconds'],
         'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
         'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
         'createdAt': json['created_at'],
@@ -303,6 +311,7 @@ export function GetResourceSessionToJSONTyped(value?: GetResourceSession | null,
         'completion_status': value['completionStatus'],
         'grade_status': value['gradeStatus'],
         'score_raw': value['scoreRaw'],
+        'duration_seconds': value['durationSeconds'],
         'initialized_at': value['initializedAt'],
         'terminated_at': value['terminatedAt'],
         'created_at': value['createdAt'],

package/src/models/GetResourceSessionActivity.ts

@@ -0,0 +1,199 @@
+/* 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';
+/**
+ * Per-activity learner state within a resource-session attempt.
+ * @export
+ * @interface GetResourceSessionActivity
+ */
+export interface GetResourceSessionActivity {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    id: string;
+    /**
+     * Stable source identifier, such as a SCORM activity identifier or resource.
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    identifier: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    title: string;
+    /**
+     * 
+     * @type {GetResourceSessionActivityActivityTypeEnum}
+     * @memberof GetResourceSessionActivity
+     */
+    activityType: GetResourceSessionActivityActivityTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    completionStatus: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSessionActivity
+     */
+    gradeStatus: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    scoreRaw?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    durationSeconds: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetResourceSessionActivity
+     */
+    isActive: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    initializedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    terminatedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    completedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    lastSeenAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSessionActivity
+     */
+    updatedAt: number;
+}
+
+
+/**
+ * @export
+ */
+export const GetResourceSessionActivityActivityTypeEnum = {
+    Resource: 'resource',
+    Sco: 'sco',
+    Asset: 'asset'
+} as const;
+export type GetResourceSessionActivityActivityTypeEnum = typeof GetResourceSessionActivityActivityTypeEnum[keyof typeof GetResourceSessionActivityActivityTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetResourceSessionActivity interface.
+ */
+export function instanceOfGetResourceSessionActivity(value: object): value is GetResourceSessionActivity {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('identifier' in value) || value['identifier'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('activityType' in value) || value['activityType'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('durationSeconds' in value) || value['durationSeconds'] === undefined) return false;
+    if (!('isActive' in value) || value['isActive'] === 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 GetResourceSessionActivityFromJSON(json: any): GetResourceSessionActivity {
+    return GetResourceSessionActivityFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionActivity {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'identifier': json['identifier'],
+        'title': json['title'],
+        'activityType': json['activity_type'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'durationSeconds': json['duration_seconds'],
+        'isActive': json['is_active'],
+        'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
+        'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+        'lastSeenAt': json['last_seen_at'] == null ? undefined : json['last_seen_at'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function GetResourceSessionActivityToJSON(json: any): GetResourceSessionActivity {
+    return GetResourceSessionActivityToJSONTyped(json, false);
+}
+
+export function GetResourceSessionActivityToJSONTyped(value?: GetResourceSessionActivity | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'identifier': value['identifier'],
+        'title': value['title'],
+        'activity_type': value['activityType'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score_raw': value['scoreRaw'],
+        'duration_seconds': value['durationSeconds'],
+        'is_active': value['isActive'],
+        'initialized_at': value['initializedAt'],
+        'terminated_at': value['terminatedAt'],
+        'completed_at': value['completedAt'],
+        'last_seen_at': value['lastSeenAt'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+