@easyedu/js-lsm-api 1.90.0 → 1.91.0

package/docs/PlayerApi.md

@@ -16,8 +16,11 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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 |
 | [**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 |
 | [**getResourceSessionPlayer**](PlayerApi.md#getresourcesessionplayer) | **GET** /resource/sessions/{sessionId}/player | Serve the player for a version-pinned reusable resource session |
+| [**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 |
 | [**getScormAsset**](PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset |
 | [**getScormPlayer**](PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page |
 | [**getVideoAsset**](PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset |
@@ -838,9 +841,75 @@ 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)
 
 
+## getResourceSessionDiagnostics
+
+> GetResourceSessionDiagnostics getResourceSessionDiagnostics(sessionId)
+
+Get administrator diagnostics for a resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionDiagnosticsRequest } 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 GetResourceSessionDiagnosticsRequest;
+
+  try {
+    const data = await api.getResourceSessionDiagnostics(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
+
+[**GetResourceSessionDiagnostics**](GetResourceSessionDiagnostics.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 diagnostics |  -  |
+| **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)
+
+
 ## getResourceSessionList
 
-> GetResourceSessionList getResourceSessionList(userId, resourceId, versionId, courseId, environment, completionStatus, createdFrom, createdTo, page, pageSize)
+> GetResourceSessionList getResourceSessionList(userId, resourceId, versionId, courseId, courseVersionId, itemId, resourceType, environment, completionStatus, gradeStatus, isCurrent, attemptNumber, createdFrom, createdTo, updatedFrom, updatedTo, hasScormErrors, sortBy, sortDirection, page, pageSize)
 
 List resource sessions for the selected portal
 
@@ -866,15 +935,37 @@ async function example() {
     versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
     courseId: courseId_example,
+    // string (optional)
+    courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ResourceType (optional)
+    resourceType: ...,
     // ResourceSessionEnvironment (optional)
     environment: ...,
-    // string (optional)
+    // 'not_attempted' | 'in_progress' | 'completed' (optional)
     completionStatus: completionStatus_example,
+    // 'ungraded' | 'passed' | 'failed' | 'points_earned' | 'percentage_earned' | 'not_applicable' (optional)
+    gradeStatus: gradeStatus_example,
+    // boolean (optional)
+    isCurrent: true,
+    // number (optional)
+    attemptNumber: 56,
     // number (optional)
     createdFrom: 789,
     // number (optional)
     createdTo: 789,
     // number (optional)
+    updatedFrom: 789,
+    // number (optional)
+    updatedTo: 789,
+    // boolean (optional)
+    hasScormErrors: true,
+    // 'created_at' | 'updated_at' | 'attempt_number' (optional)
+    sortBy: sortBy_example,
+    // 'asc' | 'desc' (optional)
+    sortDirection: sortDirection_example,
+    // number (optional)
     page: 56,
     // number (optional)
     pageSize: 56,
@@ -901,10 +992,21 @@ example().catch(console.error);
 | **resourceId** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **versionId** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **courseId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **courseVersionId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **itemId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **resourceType** | `ResourceType` |  | [Optional] [Defaults to `undefined`] [Enum: scorm, video, audio, image, pdf, powerpoint, file, link, rich_text] |
 | **environment** | `ResourceSessionEnvironment` |  | [Optional] [Defaults to `undefined`] [Enum: live, demo] |
-| **completionStatus** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **completionStatus** | `not_attempted`, `in_progress`, `completed` |  | [Optional] [Defaults to `undefined`] [Enum: not_attempted, in_progress, completed] |
+| **gradeStatus** | `ungraded`, `passed`, `failed`, `points_earned`, `percentage_earned`, `not_applicable` |  | [Optional] [Defaults to `undefined`] [Enum: ungraded, passed, failed, points_earned, percentage_earned, not_applicable] |
+| **isCurrent** | `boolean` |  | [Optional] [Defaults to `undefined`] |
+| **attemptNumber** | `number` |  | [Optional] [Defaults to `undefined`] |
 | **createdFrom** | `number` |  | [Optional] [Defaults to `undefined`] |
 | **createdTo** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **updatedFrom** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **updatedTo** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **hasScormErrors** | `boolean` |  | [Optional] [Defaults to `undefined`] |
+| **sortBy** | `created_at`, `updated_at`, `attempt_number` |  | [Optional] [Defaults to `'updated_at'`] [Enum: created_at, updated_at, attempt_number] |
+| **sortDirection** | `asc`, `desc` |  | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
 | **page** | `number` |  | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 
@@ -996,6 +1098,155 @@ 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)
 
 
+## getResourceSessionScormApiLogs
+
+> GetResourceSessionScormApiLogs getResourceSessionScormApiLogs(sessionId, method, element, errorsOnly, page, pageSize)
+
+Get SCORM runtime logs for a resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionScormApiLogsRequest } 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,
+    // 'Initialize' | 'GetValue' | 'SetValue' | 'Commit' | 'Terminate' (optional)
+    method: method_example,
+    // string (optional)
+    element: element_example,
+    // boolean (optional)
+    errorsOnly: true,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetResourceSessionScormApiLogsRequest;
+
+  try {
+    const data = await api.getResourceSessionScormApiLogs(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`] |
+| **method** | `Initialize`, `GetValue`, `SetValue`, `Commit`, `Terminate` |  | [Optional] [Defaults to `undefined`] [Enum: Initialize, GetValue, SetValue, Commit, Terminate] |
+| **element** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **errorsOnly** | `boolean` |  | [Optional] [Defaults to `false`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `50`] |
+
+### Return type
+
+[**GetResourceSessionScormApiLogs**](GetResourceSessionScormApiLogs.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 SCORM runtime logs |  -  |
+| **400** | Resource session is not SCORM |  -  |
+| **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)
+
+
+## getResourceSessionScormData
+
+> GetResourceSessionScormData getResourceSessionScormData(sessionId)
+
+Get SCORM CMI data for a resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionScormDataRequest } 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 GetResourceSessionScormDataRequest;
+
+  try {
+    const data = await api.getResourceSessionScormData(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
+
+[**GetResourceSessionScormData**](GetResourceSessionScormData.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 SCORM data |  -  |
+| **400** | Resource session is not SCORM |  -  |
+| **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)
+
+
 ## getScormAsset
 
 > getScormAsset(contentId, assetPath)

package/docs/ResourceSessionScormApiLogItem.md

@@ -0,0 +1,47 @@
+
+# ResourceSessionScormApiLogItem
+
+A recorded SCORM runtime call for a resource session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`createdAt` | number
+`method` | string
+`element` | string
+`value` | string
+`valueTruncated` | boolean
+`errorCode` | string
+
+## Example
+
+```typescript
+import type { ResourceSessionScormApiLogItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdAt": null,
+  "method": null,
+  "element": null,
+  "value": null,
+  "valueTruncated": null,
+  "errorCode": null,
+} satisfies ResourceSessionScormApiLogItem
+
+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 ResourceSessionScormApiLogItem
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.90.0",
+  "version": "1.91.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {