@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/docs/PlayerApi.md

@@ -4,6 +4,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**commitResourceScormSession**](PlayerApi.md#commitresourcescormsession) | **POST** /resource/sessions/{sessionId}/commit | Commit a reusable SCORM resource session |
+| [**getCourseVersionResourceAsset**](PlayerApi.md#getcourseversionresourceasset) | **GET** /resource/course-versions/{courseVersionId}/items/{itemId}/asset/{assetPath} | Stream an asset from an exact course and resource version |
 | [**getDispatchScormPlayer**](PlayerApi.md#getdispatchscormplayer) | **GET** /scorm/dispatch/session/{sessionId}/player | Dispatch SCORM player HTML page |
 | [**getFileAsset**](PlayerApi.md#getfileasset) | **GET** /file/{contentId}/asset | File asset |
 | [**getFilePlayer**](PlayerApi.md#getfileplayer) | **GET** /file/session/{sessionId}/player | File player HTML page |
@@ -11,13 +13,155 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getPdfAsset**](PlayerApi.md#getpdfasset) | **GET** /pdf/{contentId}/asset | PDF asset |
 | [**getPdfPlayer**](PlayerApi.md#getpdfplayer) | **GET** /pdf/session/{sessionId}/player | PDF player HTML page |
 | [**getQuizPlayer**](PlayerApi.md#getquizplayer) | **GET** /quiz/session/{sessionId}/player | Quiz player HTML page |
+| [**getResourceScormValue**](PlayerApi.md#getresourcescormvalue) | **GET** /resource/sessions/{sessionId}/get-value | Read a CMI value from a reusable SCORM resource session |
+| [**getResourceSessionPlayer**](PlayerApi.md#getresourcesessionplayer) | **GET** /resource/sessions/{sessionId}/player | Serve the player for a version-pinned reusable 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 |
 | [**getVideoPlayer**](PlayerApi.md#getvideoplayer) | **GET** /video/session/{sessionId}/player | Video player HTML page |
+| [**initializeResourceScormSession**](PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session |
+| [**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 |
 
 
 
+## commitResourceScormSession
+
+> commitResourceScormSession(sessionId)
+
+Commit a reusable SCORM resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { CommitResourceScormSessionRequest } 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 CommitResourceScormSessionRequest;
+
+  try {
+    const data = await api.commitResourceScormSession(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
+
+`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** | Session committed |  -  |
+| **403** | Session access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCourseVersionResourceAsset
+
+> Blob getCourseVersionResourceAsset(courseVersionId, itemId, assetPath)
+
+Stream an asset from an exact course and resource version
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCourseVersionResourceAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    assetPath: assetPath_example,
+  } satisfies GetCourseVersionResourceAssetRequest;
+
+  try {
+    const data = await api.getCourseVersionResourceAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseVersionId** | `string` |  | [Defaults to `undefined`] |
+| **itemId** | `string` |  | [Defaults to `undefined`] |
+| **assetPath** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resource bytes |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getDispatchScormPlayer
 
 > getDispatchScormPlayer(sessionId)
@@ -487,6 +631,141 @@ 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)
 
 
+## getResourceScormValue
+
+> ScormGetValueResponse getResourceScormValue(sessionId, key)
+
+Read a CMI value from a reusable SCORM resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceScormValueRequest } 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
+    key: key_example,
+  } satisfies GetResourceScormValueRequest;
+
+  try {
+    const data = await api.getResourceScormValue(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`] |
+| **key** | `string` |  | [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** | CMI value |  -  |
+| **403** | Session access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getResourceSessionPlayer
+
+> string getResourceSessionPlayer(sessionId)
+
+Serve the player for a version-pinned reusable resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionPlayerRequest } 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 GetResourceSessionPlayerRequest;
+
+  try {
+    const data = await api.getResourceSessionPlayer(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
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/html`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resource player HTML |  -  |
+| **403** | Session does not belong to the user or enrollment is no longer active |  -  |
+
+[[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)
@@ -758,3 +1037,204 @@ 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)
 
+
+## initializeResourceScormSession
+
+> initializeResourceScormSession(sessionId)
+
+Initialize a reusable SCORM resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { InitializeResourceScormSessionRequest } 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 InitializeResourceScormSessionRequest;
+
+  try {
+    const data = await api.initializeResourceScormSession(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
+
+`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** | Session initialized |  -  |
+| **403** | Session access denied |  -  |
+
+[[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)
+
+Store a CMI value in a reusable SCORM resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { SetResourceScormValueRequest } 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,
+    // ScormSetValueRequest
+    scormSetValueRequest: ...,
+  } satisfies SetResourceScormValueRequest;
+
+  try {
+    const data = await api.setResourceScormValue(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`] |
+| **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** | CMI value stored |  -  |
+| **403** | Session access denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## terminateResourceScormSession
+
+> terminateResourceScormSession(sessionId)
+
+Terminate a reusable SCORM resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { TerminateResourceScormSessionRequest } 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 TerminateResourceScormSessionRequest;
+
+  try {
+    const data = await api.terminateResourceScormSession(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
+
+`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** | Session terminated |  -  |
+| **403** | Session access denied |  -  |
+
+[[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/PostCourseDraft.md

@@ -0,0 +1,34 @@
+
+# PostCourseDraft
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`changeNotes` | string
+
+## Example
+
+```typescript
+import type { PostCourseDraft } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "changeNotes": null,
+} satisfies PostCourseDraft
+
+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 PostCourseDraft
+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/PostCourseVersionItem.md

@@ -0,0 +1,52 @@
+
+# PostCourseVersionItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`moduleId` | string
+`displayName` | string
+`displayOrder` | number
+`isVisible` | boolean
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`maxAttempts` | number
+`scoreRollupStrategy` | string
+`settings` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PostCourseVersionItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "moduleId": null,
+  "displayName": null,
+  "displayOrder": null,
+  "isVisible": null,
+  "launchMode": null,
+  "maxAttempts": null,
+  "scoreRollupStrategy": null,
+  "settings": null,
+} satisfies PostCourseVersionItem
+
+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 PostCourseVersionItem
+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/PostCourseVersionItemSession.md

@@ -0,0 +1,35 @@
+
+# PostCourseVersionItemSession
+
+Start or resume a learner attempt for an exact course resource version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`retake` | boolean
+
+## Example
+
+```typescript
+import type { PostCourseVersionItemSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "retake": null,
+} satisfies PostCourseVersionItemSession
+
+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 PostCourseVersionItemSession
+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/PostCourseVersionPublish.md

@@ -0,0 +1,34 @@
+
+# PostCourseVersionPublish
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`changeNotes` | string
+
+## Example
+
+```typescript
+import type { PostCourseVersionPublish } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "changeNotes": null,
+} satisfies PostCourseVersionPublish
+
+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 PostCourseVersionPublish
+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/PostEmailAssetComplete.md

@@ -0,0 +1,34 @@
+
+# PostEmailAssetComplete
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checksumSha256` | string
+
+## Example
+
+```typescript
+import type { PostEmailAssetComplete } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "checksumSha256": null,
+} satisfies PostEmailAssetComplete
+
+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 PostEmailAssetComplete
+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)
+
+