@easyedu/js-lsm-api 1.30.0 → 1.32.0

package/docs/ContentApi.md

@@ -0,0 +1,1645 @@
+# ContentApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**commitScormSession**](ContentApi.md#commitscormsession) | **POST** /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data |
+| [**getContent**](ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content |
+| [**getContentList**](ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list |
+| [**getContentSession**](ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session |
+| [**getContentSessionDetail**](ContentApi.md#getcontentsessiondetail) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId} | Get content session details (instructor only) |
+| [**getContentVersion**](ContentApi.md#getcontentversion) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Get details of a specific content version |
+| [**getContentVersionList**](ContentApi.md#getcontentversionlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions | Get all versions of a content |
+| [**getScormApiLogs**](ContentApi.md#getscormapilogs) | **GET** /scorm/sessions/{sessionId}/api-logs | Get SCORM API call logs (instructor only) |
+| [**getScormPackage**](ContentApi.md#getscormpackage) | **GET** /scorm/packages/{packageId} | Get details of a SCORM package |
+| [**getScormSessionData**](ContentApi.md#getscormsessiondata) | **GET** /scorm/sessions/{scormSessionId}/session-data | Get SCORM session data (instructor only) |
+| [**getScormValue**](ContentApi.md#getscormvalue) | **GET** /scorm/sessions/{scormSessionId}/get-value | Get a SCORM CMI data element value |
+| [**initializeScormSession**](ContentApi.md#initializescormsession) | **POST** /scorm/sessions/{scormSessionId}/initialize | Initialize a SCORM session |
+| [**listContentSessions**](ContentApi.md#listcontentsessions) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions | List content sessions (instructor only) |
+| [**postContentProcess**](ContentApi.md#postcontentprocess) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/process | Post a new content process |
+| [**postContentQuiz**](ContentApi.md#postcontentquiz) | **POST** /courses/{courseId}/modules/{moduleId}/contents/quiz | Create a new quiz content |
+| [**postContentSession**](ContentApi.md#postcontentsession) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | Post a new content session |
+| [**postContentUpload**](ContentApi.md#postcontentupload) | **POST** /courses/{courseId}/modules/{moduleId}/contents/upload | Post a new content upload |
+| [**putContent**](ContentApi.md#putcontent) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Update content by id |
+| [**putContentVersion**](ContentApi.md#putcontentversion) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Update a content version |
+| [**setScormValue**](ContentApi.md#setscormvalue) | **POST** /scorm/sessions/{scormSessionId}/set-value | Set a SCORM CMI data element value |
+| [**terminateScormSession**](ContentApi.md#terminatescormsession) | **POST** /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session |
+| [**verifyScormManifest**](ContentApi.md#verifyscormmanifest) | **POST** /scorm/tools/verify-manifest | Parse and verify a SCORM manifest |
+
+
+
+## commitScormSession
+
+> commitScormSession(scormSessionId)
+
+Commit SCORM session data
+
+Commit/persist SCORM CMI data changes to the database
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { CommitScormSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    scormSessionId: scormSessionId_example,
+  } satisfies CommitScormSessionRequest;
+
+  try {
+    const data = await api.commitScormSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scormSessionId** | `string` | The external_id of the SCORM session | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully committed SCORM session data |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | SCORM 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)
+
+
+## getContent
+
+> GetContent getContent(contentId, moduleId, courseId)
+
+get content
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+  } satisfies GetContentRequest;
+
+  try {
+    const data = await api.getContent(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContent**](GetContent.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get content response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getContentList
+
+> GetContentList getContentList(moduleId, courseId)
+
+get content list
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+  } satisfies GetContentListRequest;
+
+  try {
+    const data = await api.getContentList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContentList**](GetContentList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get content list response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getContentSession
+
+> GetContentSession getContentSession(contentId, moduleId, courseId)
+
+get content session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+  } satisfies GetContentSessionRequest;
+
+  try {
+    const data = await api.getContentSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContentSession**](GetContentSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get content session response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getContentSessionDetail
+
+> GetContentSessionDetail getContentSessionDetail(contentId, moduleId, courseId, sessionId)
+
+Get content session details (instructor only)
+
+Get detailed information about a specific content session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentSessionDetailRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // string | The external_id of the content session
+    sessionId: sessionId_example,
+  } satisfies GetContentSessionDetailRequest;
+
+  try {
+    const data = await api.getContentSessionDetail(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **sessionId** | `string` | The external_id of the content session | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContentSessionDetail**](GetContentSessionDetail.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved content session details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden - instructor role required |  -  |
+| **404** | Content 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)
+
+
+## getContentVersion
+
+> GetContentVersion getContentVersion(contentId, moduleId, courseId, versionId)
+
+Get details of a specific content version
+
+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.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentVersionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The content\'s external_id
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // string | The version\'s external_id
+    versionId: versionId_example,
+  } satisfies GetContentVersionRequest;
+
+  try {
+    const data = await api.getContentVersion(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` | The content\'s external_id | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **versionId** | `string` | The version\'s external_id | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContentVersion**](GetContentVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved content version details |  -  |
+| **404** | Content or version not found |  -  |
+| **401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getContentVersionList
+
+> GetContentVersionList getContentVersionList(contentId, moduleId, courseId, page, pageSize)
+
+Get all versions of a content
+
+Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentVersionListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The content\'s external_id
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // number | Page number for pagination (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+  } satisfies GetContentVersionListRequest;
+
+  try {
+    const data = await api.getContentVersionList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` | The content\'s external_id | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetContentVersionList**](GetContentVersionList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved content versions |  -  |
+| **404** | Content not found |  -  |
+| **401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getScormApiLogs
+
+> GetScormApiLogs getScormApiLogs(sessionId, page, pageSize)
+
+Get SCORM API call logs (instructor only)
+
+Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetScormApiLogsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    sessionId: sessionId_example,
+    // number | Page number for pagination (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+  } satisfies GetScormApiLogsRequest;
+
+  try {
+    const data = await api.getScormApiLogs(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` | The external_id of the SCORM session | [Defaults to `undefined`] |
+| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `50`] |
+
+### Return type
+
+[**GetScormApiLogs**](GetScormApiLogs.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved SCORM API logs |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden - instructor role required |  -  |
+| **404** | SCORM 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)
+
+
+## getScormPackage
+
+> GetScormPackage getScormPackage(packageId)
+
+Get details of a SCORM package
+
+Returns package information and table of contents for a SCORM package
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetScormPackageRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM package
+    packageId: packageId_example,
+  } satisfies GetScormPackageRequest;
+
+  try {
+    const data = await api.getScormPackage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **packageId** | `string` | The external_id of the SCORM package | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetScormPackage**](GetScormPackage.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved SCORM package details |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | SCORM package 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)
+
+
+## getScormSessionData
+
+> GetScormSessionData getScormSessionData(scormSessionId)
+
+Get SCORM session data (instructor only)
+
+Get detailed SCORM session data including CMI data dump for debugging
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetScormSessionDataRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    scormSessionId: scormSessionId_example,
+  } satisfies GetScormSessionDataRequest;
+
+  try {
+    const data = await api.getScormSessionData(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scormSessionId** | `string` | The external_id of the SCORM session | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetScormSessionData**](GetScormSessionData.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved SCORM session data |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden - instructor role required |  -  |
+| **404** | SCORM 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)
+
+
+## getScormValue
+
+> ScormGetValueResponse getScormValue(scormSessionId, key)
+
+Get a SCORM CMI data element value
+
+Retrieve the value of a specific SCORM CMI data element from the session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetScormValueRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    scormSessionId: scormSessionId_example,
+    // string | The CMI element key to retrieve (e.g., cmi.core.lesson_status)
+    key: key_example,
+  } satisfies GetScormValueRequest;
+
+  try {
+    const data = await api.getScormValue(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scormSessionId** | `string` | The external_id of the SCORM session | [Defaults to `undefined`] |
+| **key** | `string` | The CMI element key to retrieve (e.g., cmi.core.lesson_status) | [Defaults to `undefined`] |
+
+### Return type
+
+[**ScormGetValueResponse**](ScormGetValueResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved CMI element value |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | SCORM 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)
+
+
+## initializeScormSession
+
+> initializeScormSession(scormSessionId)
+
+Initialize a SCORM session
+
+Initialize a SCORM session for content playback
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { InitializeScormSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    scormSessionId: scormSessionId_example,
+  } satisfies InitializeScormSessionRequest;
+
+  try {
+    const data = await api.initializeScormSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scormSessionId** | `string` | The external_id of the SCORM session | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully initialized SCORM session |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | SCORM 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)
+
+
+## listContentSessions
+
+> GetContentSessionList listContentSessions(contentId, moduleId, courseId, environment, userId, page, pageSize)
+
+List content sessions (instructor only)
+
+Get a paginated list of all content sessions for a specific content item
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { ListContentSessionsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // 'SANDBOX' | 'LIVE' | Filter sessions by environment type (SANDBOX or LIVE) (optional)
+    environment: environment_example,
+    // string | Filter sessions by user ID (external ID) (optional)
+    userId: userId_example,
+    // number | Page number for pagination (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+  } satisfies ListContentSessionsRequest;
+
+  try {
+    const data = await api.listContentSessions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **environment** | `SANDBOX`, `LIVE` | Filter sessions by environment type (SANDBOX or LIVE) | [Optional] [Defaults to `undefined`] [Enum: SANDBOX, LIVE] |
+| **userId** | `string` | Filter sessions by user ID (external ID) | [Optional] [Defaults to `undefined`] |
+| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetContentSessionList**](GetContentSessionList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully retrieved content sessions |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden - instructor role required |  -  |
+| **404** | Content 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)
+
+
+## postContentProcess
+
+> GetContent postContentProcess(moduleId, courseId, contentId)
+
+Post a new content process
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PostContentProcessRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // string
+    contentId: contentId_example,
+  } satisfies PostContentProcessRequest;
+
+  try {
+    const data = await api.postContentProcess(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetContent**](GetContent.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | post content response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postContentQuiz
+
+> GetContent postContentQuiz(moduleId, courseId, postContentQuiz)
+
+Create a new quiz content
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PostContentQuizRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // PostContentQuiz | Quiz content object that needs to be created
+    postContentQuiz: ...,
+  } satisfies PostContentQuizRequest;
+
+  try {
+    const data = await api.postContentQuiz(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **postContentQuiz** | [PostContentQuiz](PostContentQuiz.md) | Quiz content object that needs to be created | |
+
+### Return type
+
+[**GetContent**](GetContent.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | post content quiz response OK |  -  |
+| **400** | post content quiz response error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postContentSession
+
+> PostContentSession postContentSession(contentId, moduleId, courseId, environment)
+
+Post a new content session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PostContentSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // 'sandbox' | 'live' | Environment type for the session (defaults to live) (optional)
+    environment: environment_example,
+  } satisfies PostContentSessionRequest;
+
+  try {
+    const data = await api.postContentSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **environment** | `sandbox`, `live` | Environment type for the session (defaults to live) | [Optional] [Defaults to `'live'`] [Enum: sandbox, live] |
+
+### Return type
+
+[**PostContentSession**](PostContentSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | post session response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postContentUpload
+
+> GetContentUpload postContentUpload(moduleId, courseId, postContentUpload)
+
+Post a new content upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PostContentUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // PostContentUpload | Content object that needs to be added
+    postContentUpload: ...,
+  } satisfies PostContentUploadRequest;
+
+  try {
+    const data = await api.postContentUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **postContentUpload** | [PostContentUpload](PostContentUpload.md) | Content object that needs to be added | |
+
+### Return type
+
+[**GetContentUpload**](GetContentUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | post content upload response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putContent
+
+> GetContent putContent(contentId, moduleId, courseId, putContent)
+
+Update content by id
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PutContentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // PutContent | Content object that needs to be updated
+    putContent: ...,
+  } satisfies PutContentRequest;
+
+  try {
+    const data = await api.putContent(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **putContent** | [PutContent](PutContent.md) | Content object that needs to be updated | |
+
+### Return type
+
+[**GetContent**](GetContent.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | put content response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putContentVersion
+
+> GetContentVersion putContentVersion(contentId, moduleId, courseId, versionId, putContentVersion)
+
+Update a content version
+
+Activates this version by setting is_active to true. Automatically deactivates all other versions of the same content. Only setting is_active to true is allowed.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PutContentVersionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The content\'s external_id
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // string | The version\'s external_id
+    versionId: versionId_example,
+    // PutContentVersion
+    putContentVersion: ...,
+  } satisfies PutContentVersionRequest;
+
+  try {
+    const data = await api.putContentVersion(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` | The content\'s external_id | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **versionId** | `string` | The version\'s external_id | [Defaults to `undefined`] |
+| **putContentVersion** | [PutContentVersion](PutContentVersion.md) |  | |
+
+### Return type
+
+[**GetContentVersion**](GetContentVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully updated content version |  -  |
+| **400** | Bad request (e.g., trying to set is_active to false) |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden - you do not have permission to update this content version |  -  |
+| **404** | Content or version 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)
+
+
+## setScormValue
+
+> ScormSetValueResponse setScormValue(scormSessionId, scormSetValueRequest)
+
+Set a SCORM CMI data element value
+
+Update the value of a specific SCORM CMI data element in the session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { SetScormValueRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    scormSessionId: scormSessionId_example,
+    // ScormSetValueRequest
+    scormSetValueRequest: ...,
+  } satisfies SetScormValueRequest;
+
+  try {
+    const data = await api.setScormValue(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scormSessionId** | `string` | The external_id of the SCORM session | [Defaults to `undefined`] |
+| **scormSetValueRequest** | [ScormSetValueRequest](ScormSetValueRequest.md) |  | |
+
+### Return type
+
+[**ScormSetValueResponse**](ScormSetValueResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully set CMI element value |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | SCORM 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)
+
+
+## terminateScormSession
+
+> terminateScormSession(scormSessionId)
+
+Terminate a SCORM session
+
+Terminate the SCORM session and finalize all data
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { TerminateScormSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string | The external_id of the SCORM session
+    scormSessionId: scormSessionId_example,
+  } satisfies TerminateScormSessionRequest;
+
+  try {
+    const data = await api.terminateScormSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **scormSessionId** | `string` | The external_id of the SCORM session | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successfully terminated SCORM session |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | SCORM 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)
+
+
+## verifyScormManifest
+
+> PostVerifyManifest verifyScormManifest(body)
+
+Parse and verify a SCORM manifest
+
+Takes raw imsmanifest.xml content and returns the parsed manifest structure with validation warnings
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { VerifyScormManifestRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    body: body_example,
+  } satisfies VerifyScormManifestRequest;
+
+  try {
+    const data = await api.verifyScormManifest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **body** | `string` |  | |
+
+### Return type
+
+[**PostVerifyManifest**](PostVerifyManifest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/xml`, `text/xml`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Manifest parsed (check valid field for success) |  -  |
+| **400** | Request body is empty or not XML |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+