@easyedu/js-lsm-api 1.98.0 → 1.100.0

package/docs/GetResourceSessionActivityList.md

@@ -0,0 +1,35 @@
+
+# GetResourceSessionActivityList
+
+Activities belonging to one resource-session attempt.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<GetResourceSessionActivity>](GetResourceSessionActivity.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionActivityList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetResourceSessionActivityList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionActivityList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PlayerApi.md

@@ -9,6 +9,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getLibraryQuizSessionPlayer**](PlayerApi.md#getlibraryquizsessionplayer) | **GET** /quiz/sessions/{sessionId}/player | Serve the player for a reusable quiz session |
 | [**getResourceScormValue**](PlayerApi.md#getresourcescormvalue) | **GET** /resource/sessions/{sessionId}/get-value | Read a CMI value from a reusable SCORM resource session |
 | [**getResourceSession**](PlayerApi.md#getresourcesession) | **GET** /resource/sessions/{sessionId} | Get a resource session |
+| [**getResourceSessionActivities**](PlayerApi.md#getresourcesessionactivities) | **GET** /resource/sessions/{sessionId}/activities | List tracked activities for a resource session |
+| [**getResourceSessionActivityEvents**](PlayerApi.md#getresourcesessionactivityevents) | **GET** /resource/sessions/{sessionId}/activity-events | List recorded learner activity events for a resource session |
 | [**getResourceSessionAsset**](PlayerApi.md#getresourcesessionasset) | **GET** /resource/sessions/{sessionId}/asset/{assetPath} | Stream an asset pinned to a resource session |
 | [**getResourceSessionDiagnostics**](PlayerApi.md#getresourcesessiondiagnostics) | **GET** /resource/sessions/{sessionId}/diagnostics | Get administrator diagnostics for a resource session |
 | [**getResourceSessionList**](PlayerApi.md#getresourcesessionlist) | **GET** /resource/sessions | List resource sessions for the selected portal |
@@ -16,7 +18,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getResourceSessionScormApiLogs**](PlayerApi.md#getresourcesessionscormapilogs) | **GET** /resource/sessions/{sessionId}/api-logs | Get SCORM runtime logs for a resource session |
 | [**getResourceSessionScormData**](PlayerApi.md#getresourcesessionscormdata) | **GET** /resource/sessions/{sessionId}/scorm-data | Get SCORM CMI data for a resource session |
 | [**initializeResourceScormSession**](PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session |
+| [**postResourceSessionActivityEvent**](PlayerApi.md#postresourcesessionactivityevent) | **POST** /resource/sessions/{sessionId}/activities/{activityId}/events | Record learner activity and update active time |
 | [**postResourceSessionComplete**](PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session |
+| [**putResourceSessionOverride**](PlayerApi.md#putresourcesessionoverride) | **PUT** /resource/sessions/{sessionId}/override | Override a learner\'s live resource-session progress |
 | [**setResourceScormValue**](PlayerApi.md#setresourcescormvalue) | **POST** /resource/sessions/{sessionId}/set-value | Store a CMI value in a reusable SCORM resource session |
 | [**terminateResourceScormSession**](PlayerApi.md#terminateresourcescormsession) | **POST** /resource/sessions/{sessionId}/terminate | Terminate a reusable SCORM resource session |
 
@@ -24,7 +28,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 ## commitResourceScormSession
 
-> commitResourceScormSession(sessionId)
+> commitResourceScormSession(sessionId, activityId)
 
 Commit a reusable SCORM resource session
 
@@ -44,6 +48,8 @@ async function example() {
   const body = {
     // string
     sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    activityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies CommitResourceScormSessionRequest;
 
   try {
@@ -64,6 +70,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **activityId** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -226,7 +233,7 @@ No authorization required
 
 ## getResourceScormValue
 
-> ScormGetValueResponse getResourceScormValue(sessionId, key)
+> ScormGetValueResponse getResourceScormValue(sessionId, key, activityId)
 
 Read a CMI value from a reusable SCORM resource session
 
@@ -248,6 +255,8 @@ async function example() {
     sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string
     key: key_example,
+    // string (optional)
+    activityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies GetResourceScormValueRequest;
 
   try {
@@ -269,6 +278,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **sessionId** | `string` |  | [Defaults to `undefined`] |
 | **key** | `string` |  | [Defaults to `undefined`] |
+| **activityId** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -359,6 +369,138 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getResourceSessionActivities
+
+> GetResourceSessionActivityList getResourceSessionActivities(sessionId)
+
+List tracked activities for a resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionActivitiesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetResourceSessionActivitiesRequest;
+
+  try {
+    const data = await api.getResourceSessionActivities(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetResourceSessionActivityList**](GetResourceSessionActivityList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resource-session activities |  -  |
+| **404** | Resource session not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getResourceSessionActivityEvents
+
+> GetResourceSessionActivityEventList getResourceSessionActivityEvents(sessionId)
+
+List recorded learner activity events for a resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionActivityEventsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetResourceSessionActivityEventsRequest;
+
+  try {
+    const data = await api.getResourceSessionActivityEvents(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetResourceSessionActivityEventList**](GetResourceSessionActivityEventList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resource-session activity events |  -  |
+| **404** | Resource session not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getResourceSessionAsset
 
 > Blob getResourceSessionAsset(sessionId, assetPath)
@@ -768,7 +910,7 @@ No authorization required
 
 ## getResourceSessionScormData
 
-> GetResourceSessionScormData getResourceSessionScormData(sessionId)
+> GetResourceSessionScormData getResourceSessionScormData(sessionId, activityId)
 
 Get SCORM CMI data for a resource session
 
@@ -788,6 +930,8 @@ async function example() {
   const body = {
     // string
     sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    activityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies GetResourceSessionScormDataRequest;
 
   try {
@@ -808,6 +952,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **activityId** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -835,7 +980,7 @@ No authorization required
 
 ## initializeResourceScormSession
 
-> initializeResourceScormSession(sessionId)
+> initializeResourceScormSession(sessionId, activityId)
 
 Initialize a reusable SCORM resource session
 
@@ -855,6 +1000,8 @@ async function example() {
   const body = {
     // string
     sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    activityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies InitializeResourceScormSessionRequest;
 
   try {
@@ -875,6 +1022,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **activityId** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -899,6 +1047,78 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## postResourceSessionActivityEvent
+
+> GetResourceSessionActivity postResourceSessionActivityEvent(sessionId, activityId, postResourceSessionActivityEvent)
+
+Record learner activity and update active time
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { PostResourceSessionActivityEventRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    activityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PostResourceSessionActivityEvent
+    postResourceSessionActivityEvent: ...,
+  } satisfies PostResourceSessionActivityEventRequest;
+
+  try {
+    const data = await api.postResourceSessionActivityEvent(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **activityId** | `string` |  | [Defaults to `undefined`] |
+| **postResourceSessionActivityEvent** | [PostResourceSessionActivityEvent](PostResourceSessionActivityEvent.md) |  | |
+
+### Return type
+
+[**GetResourceSessionActivity**](GetResourceSessionActivity.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated resource-session activity |  -  |
+| **404** | Resource session or activity not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postResourceSessionComplete
 
 > GetResourceSession postResourceSessionComplete(sessionId)
@@ -965,9 +1185,79 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## putResourceSessionOverride
+
+> GetResourceSession putResourceSessionOverride(sessionId, putResourceSessionOverride)
+
+Override a learner\'s live resource-session progress
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { PutResourceSessionOverrideRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PutResourceSessionOverride
+    putResourceSessionOverride: ...,
+  } satisfies PutResourceSessionOverrideRequest;
+
+  try {
+    const data = await api.putResourceSessionOverride(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **putResourceSessionOverride** | [PutResourceSessionOverride](PutResourceSessionOverride.md) |  | |
+
+### Return type
+
+[**GetResourceSession**](GetResourceSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated resource session |  -  |
+| **400** | Invalid override values |  -  |
+| **404** | Resource session not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## setResourceScormValue
 
-> ScormSetValueResponse setResourceScormValue(sessionId, scormSetValueRequest)
+> ScormSetValueResponse setResourceScormValue(sessionId, scormSetValueRequest, activityId)
 
 Store a CMI value in a reusable SCORM resource session
 
@@ -989,6 +1279,8 @@ async function example() {
     sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // ScormSetValueRequest
     scormSetValueRequest: ...,
+    // string (optional)
+    activityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies SetResourceScormValueRequest;
 
   try {
@@ -1010,6 +1302,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **sessionId** | `string` |  | [Defaults to `undefined`] |
 | **scormSetValueRequest** | [ScormSetValueRequest](ScormSetValueRequest.md) |  | |
+| **activityId** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -1036,7 +1329,7 @@ No authorization required
 
 ## terminateResourceScormSession
 
-> terminateResourceScormSession(sessionId)
+> terminateResourceScormSession(sessionId, activityId)
 
 Terminate a reusable SCORM resource session
 
@@ -1056,6 +1349,8 @@ async function example() {
   const body = {
     // string
     sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    activityId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies TerminateResourceScormSessionRequest;
 
   try {
@@ -1076,6 +1371,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **activityId** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/docs/PostClearSessions.md

@@ -0,0 +1,34 @@
+
+# PostClearSessions
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reason` | string
+
+## Example
+
+```typescript
+import type { PostClearSessions } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reason": null,
+} satisfies PostClearSessions
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostClearSessions
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PostClearSessionsResponse.md

@@ -0,0 +1,38 @@
+
+# PostClearSessionsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`resourceSessionsDeleted` | number
+`quizSessionsDeleted` | number
+`totalSessionsDeleted` | number
+
+## Example
+
+```typescript
+import type { PostClearSessionsResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "resourceSessionsDeleted": null,
+  "quizSessionsDeleted": null,
+  "totalSessionsDeleted": null,
+} satisfies PostClearSessionsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostClearSessionsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PostResourceSessionActivityEvent.md

@@ -0,0 +1,39 @@
+
+# PostResourceSessionActivityEvent
+
+A learner activity signal. Timing is calculated from server receipt times.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`eventId` | string
+`eventType` | string
+`positionSeconds` | number
+
+## Example
+
+```typescript
+import type { PostResourceSessionActivityEvent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "eventId": null,
+  "eventType": null,
+  "positionSeconds": null,
+} satisfies PostResourceSessionActivityEvent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostResourceSessionActivityEvent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutAttemptAllowance.md

@@ -0,0 +1,36 @@
+
+# PutAttemptAllowance
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`additionalAttempts` | number
+`reason` | string
+
+## Example
+
+```typescript
+import type { PutAttemptAllowance } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "additionalAttempts": null,
+  "reason": null,
+} satisfies PutAttemptAllowance
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutAttemptAllowance
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutLibraryQuizSessionOverride.md

@@ -0,0 +1,41 @@
+
+# PutLibraryQuizSessionOverride
+
+Instructor-entered progress values for an existing live quiz session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`scorePercentage` | number
+`passed` | boolean
+`reason` | string
+
+## Example
+
+```typescript
+import type { PutLibraryQuizSessionOverride } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "scorePercentage": null,
+  "passed": null,
+  "reason": null,
+} satisfies PutLibraryQuizSessionOverride
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutLibraryQuizSessionOverride
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+