@easyedu/js-lsm-api 1.94.0 → 1.95.0

package/docs/PlayerApi.md

@@ -6,14 +6,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 |------------- | ------------- | -------------|
 | [**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 |
-| [**getImagePlayer**](PlayerApi.md#getimageplayer) | **GET** /image/session/{sessionId}/player | Image player HTML page |
 | [**getLibraryQuizSessionPlayer**](PlayerApi.md#getlibraryquizsessionplayer) | **GET** /quiz/sessions/{sessionId}/player | Serve the player for a reusable quiz session |
-| [**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 |
 | [**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 |
@@ -22,10 +15,6 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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 |
-| [**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 |
 | [**postResourceSessionComplete**](PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session |
 | [**setResourceScormValue**](PlayerApi.md#setresourcescormvalue) | **POST** /resource/sessions/{sessionId}/set-value | Store a CMI value in a reusable SCORM resource session |
@@ -170,478 +159,11 @@ 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)
 
 
-## getDispatchScormPlayer
-
-> getDispatchScormPlayer(sessionId)
-
-Dispatch SCORM player HTML page
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetDispatchScormPlayerRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    sessionId: sessionId_example,
-  } satisfies GetDispatchScormPlayerRequest;
-
-  try {
-    const data = await api.getDispatchScormPlayer(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** | HTML player page |  -  |
-| **401** | Dispatch token required |  -  |
-| **404** | 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)
-
-
-## getFileAsset
-
-> getFileAsset(contentId)
-
-File asset
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetFileAssetRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    contentId: contentId_example,
-  } satisfies GetFileAssetRequest;
-
-  try {
-    const data = await api.getFileAsset(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`] |
-
-### 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 |
-|-------------|-------------|------------------|
-| **302** | Redirect to asset URL |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **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)
-
-
-## getFilePlayer
-
-> getFilePlayer(sessionId)
-
-File player HTML page
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetFilePlayerRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    sessionId: sessionId_example,
-  } satisfies GetFilePlayerRequest;
-
-  try {
-    const data = await api.getFilePlayer(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** | HTML player page |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **404** | 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)
-
-
-## getImagePlayer
-
-> getImagePlayer(sessionId)
-
-Image player HTML page
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetImagePlayerRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    sessionId: sessionId_example,
-  } satisfies GetImagePlayerRequest;
-
-  try {
-    const data = await api.getImagePlayer(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** | HTML player page |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **404** | 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)
-
-
-## getLibraryQuizSessionPlayer
-
-> string getLibraryQuizSessionPlayer(sessionId)
-
-Serve the player for a reusable quiz session
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetLibraryQuizSessionPlayerRequest } 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 GetLibraryQuizSessionPlayerRequest;
-
-  try {
-    const data = await api.getLibraryQuizSessionPlayer(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** | Quiz player HTML |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## getPdfAsset
-
-> getPdfAsset(contentId)
-
-PDF asset
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetPdfAssetRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    contentId: contentId_example,
-  } satisfies GetPdfAssetRequest;
-
-  try {
-    const data = await api.getPdfAsset(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`] |
-
-### 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 |
-|-------------|-------------|------------------|
-| **302** | Redirect to asset URL |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **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)
-
-
-## getPdfPlayer
-
-> getPdfPlayer(sessionId)
-
-PDF player HTML page
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetPdfPlayerRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    sessionId: sessionId_example,
-  } satisfies GetPdfPlayerRequest;
-
-  try {
-    const data = await api.getPdfPlayer(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** | HTML player page |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **404** | 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)
-
-
-## getQuizPlayer
+## getLibraryQuizSessionPlayer
 
-> getQuizPlayer(sessionId)
+> string getLibraryQuizSessionPlayer(sessionId)
 
-Quiz player HTML page
+Serve the player for a reusable quiz session
 
 ### Example
 
@@ -650,7 +172,7 @@ import {
   Configuration,
   PlayerApi,
 } from '@easyedu/js-lsm-api';
-import type { GetQuizPlayerRequest } from '@easyedu/js-lsm-api';
+import type { GetLibraryQuizSessionPlayerRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
@@ -658,11 +180,11 @@ async function example() {
 
   const body = {
     // string
-    sessionId: sessionId_example,
-  } satisfies GetQuizPlayerRequest;
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetLibraryQuizSessionPlayerRequest;
 
   try {
-    const data = await api.getQuizPlayer(body);
+    const data = await api.getLibraryQuizSessionPlayer(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -682,7 +204,7 @@ example().catch(console.error);
 
 ### Return type
 
-`void` (Empty response body)
+**string**
 
 ### Authorization
 
@@ -691,15 +213,13 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `text/html`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | HTML player page |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **404** | Session not found |  -  |
+| **200** | Quiz player HTML |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -1313,278 +833,6 @@ 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)
 
 
-## getScormAsset
-
-> getScormAsset(contentId, assetPath)
-
-SCORM package asset
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetScormAssetRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    contentId: contentId_example,
-    // string
-    assetPath: assetPath_example,
-  } satisfies GetScormAssetRequest;
-
-  try {
-    const data = await api.getScormAsset(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`] |
-| **assetPath** | `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** | SCORM asset content |  -  |
-| **302** | Redirect to asset URL |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **404** | Content or asset 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)
-
-
-## getScormPlayer
-
-> getScormPlayer(sessionId)
-
-SCORM player HTML page
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetScormPlayerRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    sessionId: sessionId_example,
-  } satisfies GetScormPlayerRequest;
-
-  try {
-    const data = await api.getScormPlayer(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** | HTML player page |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **404** | 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)
-
-
-## getVideoAsset
-
-> getVideoAsset(contentId)
-
-Video asset
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetVideoAssetRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    contentId: contentId_example,
-  } satisfies GetVideoAssetRequest;
-
-  try {
-    const data = await api.getVideoAsset(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`] |
-
-### 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 |
-|-------------|-------------|------------------|
-| **302** | Redirect to asset URL |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **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)
-
-
-## getVideoPlayer
-
-> getVideoPlayer(sessionId)
-
-Video player HTML page
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PlayerApi,
-} from '@easyedu/js-lsm-api';
-import type { GetVideoPlayerRequest } from '@easyedu/js-lsm-api';
-
-async function example() {
-  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new PlayerApi();
-
-  const body = {
-    // string
-    sessionId: sessionId_example,
-  } satisfies GetVideoPlayerRequest;
-
-  try {
-    const data = await api.getVideoPlayer(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** | HTML player page |  -  |
-| **403** | Forbidden - enrollment is expired, suspended, or otherwise not launchable |  -  |
-| **404** | 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)
-
-
 ## initializeResourceScormSession
 
 > initializeResourceScormSession(sessionId)