@easyedu/js-lsm-api 1.118.0 → 1.120.0

package/docs/GetDispatchRollup.md

@@ -0,0 +1,52 @@
+
+# GetDispatchRollup
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completionStatus` | string
+`successStatus` | string
+`scoreRaw` | number
+`scoreScaled` | number
+`progressMeasure` | number
+`totalItems` | number
+`completedItems` | number
+`requiredItems` | number
+`completedRequiredItems` | number
+`pendingManualGrading` | boolean
+
+## Example
+
+```typescript
+import type { GetDispatchRollup } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completionStatus": null,
+  "successStatus": null,
+  "scoreRaw": null,
+  "scoreScaled": null,
+  "progressMeasure": null,
+  "totalItems": null,
+  "completedItems": null,
+  "requiredItems": null,
+  "completedRequiredItems": null,
+  "pendingManualGrading": null,
+} satisfies GetDispatchRollup
+
+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 GetDispatchRollup
+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/GetHostedScormRegistration.md

@@ -0,0 +1,50 @@
+
+# GetHostedScormRegistration
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`learnerId` | string
+`learnerName` | string
+`active` | boolean
+`launchCount` | number
+`firstLaunchAt` | number
+`lastLaunchAt` | number
+`lastOrigin` | string
+`lastItemId` | string
+
+## Example
+
+```typescript
+import type { GetHostedScormRegistration } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "learnerId": null,
+  "learnerName": null,
+  "active": null,
+  "launchCount": null,
+  "firstLaunchAt": null,
+  "lastLaunchAt": null,
+  "lastOrigin": null,
+  "lastItemId": null,
+} satisfies GetHostedScormRegistration
+
+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 GetHostedScormRegistration
+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/GetHostedScormRegistrationList.md

@@ -0,0 +1,42 @@
+
+# GetHostedScormRegistrationList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetHostedScormRegistration>](GetHostedScormRegistration.md)
+
+## Example
+
+```typescript
+import type { GetHostedScormRegistrationList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetHostedScormRegistrationList
+
+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 GetHostedScormRegistrationList
+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/GetResourceSessionDiagnostics.md

@@ -14,6 +14,7 @@ Name | Type
 `version` | [GetResourceSessionDiagnosticsVersion](GetResourceSessionDiagnosticsVersion.md)
 `courseContext` | [GetResourceSessionDiagnosticsCourseContext](GetResourceSessionDiagnosticsCourseContext.md)
 `scormSummary` | [GetResourceSessionDiagnosticsScormSummary](GetResourceSessionDiagnosticsScormSummary.md)
+`sequencing` | { [key: string]: any; }
 
 ## Example
 
@@ -29,6 +30,7 @@ const example = {
   "version": null,
   "courseContext": null,
   "scormSummary": null,
+  "sequencing": null,
 } satisfies GetResourceSessionDiagnostics
 
 console.log(example)

package/docs/HostedScormAccessPolicy.md

@@ -0,0 +1,41 @@
+
+# HostedScormAccessPolicy
+
+Mutable reseller access controls for a hosted SCORM export.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`learnerCap` | number
+`validFrom` | number
+`validUntil` | number
+`allowedLmsOrigins` | Array<string>
+
+## Example
+
+```typescript
+import type { HostedScormAccessPolicy } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "learnerCap": null,
+  "validFrom": null,
+  "validUntil": null,
+  "allowedLmsOrigins": null,
+} satisfies HostedScormAccessPolicy
+
+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 HostedScormAccessPolicy
+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/HostedScormOutlineEntry.md

@@ -0,0 +1,54 @@
+
+# HostedScormOutlineEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`entryType` | string
+`id` | string
+`parentSectionId` | string
+`title` | string
+`displayOrder` | number
+`kind` | string
+`required` | boolean
+`completed` | boolean
+`locked` | boolean
+`attemptNumber` | number
+`maxAttempts` | number
+
+## Example
+
+```typescript
+import type { HostedScormOutlineEntry } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "entryType": null,
+  "id": null,
+  "parentSectionId": null,
+  "title": null,
+  "displayOrder": null,
+  "kind": null,
+  "required": null,
+  "completed": null,
+  "locked": null,
+  "attemptNumber": null,
+  "maxAttempts": null,
+} satisfies HostedScormOutlineEntry
+
+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 HostedScormOutlineEntry
+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/HostedScormRollupPolicy.md

@@ -0,0 +1,41 @@
+
+# HostedScormRollupPolicy
+
+Immutable course aggregate rules captured by a hosted SCORM export.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`successRule` | string
+`passingScorePercent` | number
+`scoreAggregation` | string
+`scoredItems` | [Array<HostedScormScoreItem>](HostedScormScoreItem.md)
+
+## Example
+
+```typescript
+import type { HostedScormRollupPolicy } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "successRule": null,
+  "passingScorePercent": null,
+  "scoreAggregation": null,
+  "scoredItems": null,
+} satisfies HostedScormRollupPolicy
+
+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 HostedScormRollupPolicy
+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/HostedScormScoreItem.md

@@ -0,0 +1,36 @@
+
+# HostedScormScoreItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`itemId` | string
+`weight` | number
+
+## Example
+
+```typescript
+import type { HostedScormScoreItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "itemId": null,
+  "weight": null,
+} satisfies HostedScormScoreItem
+
+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 HostedScormScoreItem
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PlayerApi.md

@@ -18,6 +18,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getResourceSessionScormApiLogs**](PlayerApi.md#getresourcesessionscormapilogs) | **GET** /resource/sessions/{sessionId}/api-logs | Get SCORM runtime logs for a resource session |
 | [**getResourceSessionScormData**](PlayerApi.md#getresourcesessionscormdata) | **GET** /resource/sessions/{sessionId}/scorm-data | Get SCORM CMI data for a resource session |
 | [**initializeResourceScormSession**](PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session |
+| [**navigateResourceScormSession**](PlayerApi.md#navigateresourcescormsession) | **POST** /resource/sessions/{sessionId}/navigation | Process a SCORM 2004 sequencing and navigation request |
 | [**postResourceSessionActivityEvent**](PlayerApi.md#postresourcesessionactivityevent) | **POST** /resource/sessions/{sessionId}/activities/{activityId}/events | Record learner activity and update active time |
 | [**postResourceSessionComplete**](PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session |
 | [**putResourceSessionOverride**](PlayerApi.md#putresourcesessionoverride) | **PUT** /resource/sessions/{sessionId}/override | Override a learner\'s live resource-session progress |
@@ -28,7 +29,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 ## commitResourceScormSession
 
-> commitResourceScormSession(sessionId, activityId)
+> ScormRuntimeResponse commitResourceScormSession(sessionId, activityId)
 
 Commit a reusable SCORM resource session
 
@@ -74,7 +75,7 @@ example().catch(console.error);
 
 ### Return type
 
-`void` (Empty response body)
+[**ScormRuntimeResponse**](ScormRuntimeResponse.md)
 
 ### Authorization
 
@@ -83,7 +84,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details
@@ -980,7 +981,7 @@ No authorization required
 
 ## initializeResourceScormSession
 
-> initializeResourceScormSession(sessionId, activityId)
+> ScormRuntimeResponse initializeResourceScormSession(sessionId, activityId)
 
 Initialize a reusable SCORM resource session
 
@@ -1026,7 +1027,7 @@ example().catch(console.error);
 
 ### Return type
 
-`void` (Empty response body)
+[**ScormRuntimeResponse**](ScormRuntimeResponse.md)
 
 ### Authorization
 
@@ -1035,7 +1036,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details
@@ -1047,6 +1048,76 @@ 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)
 
 
+## navigateResourceScormSession
+
+> ScormNavigationResponse navigateResourceScormSession(sessionId, scormNavigationRequest)
+
+Process a SCORM 2004 sequencing and navigation request
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { NavigateResourceScormSessionRequest } 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,
+    // ScormNavigationRequest
+    scormNavigationRequest: ...,
+  } satisfies NavigateResourceScormSessionRequest;
+
+  try {
+    const data = await api.navigateResourceScormSession(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`] |
+| **scormNavigationRequest** | [ScormNavigationRequest](ScormNavigationRequest.md) |  | |
+
+### Return type
+
+[**ScormNavigationResponse**](ScormNavigationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Sequencing transition result, including SCORM process errors |  -  |
+| **403** | Session access denied |  -  |
+| **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)
+
+
 ## postResourceSessionActivityEvent
 
 > GetResourceSessionActivity postResourceSessionActivityEvent(sessionId, activityId, postResourceSessionActivityEvent)
@@ -1330,7 +1401,7 @@ No authorization required
 
 ## terminateResourceScormSession
 
-> terminateResourceScormSession(sessionId, activityId)
+> ScormTerminateResponse terminateResourceScormSession(sessionId, activityId)
 
 Terminate a reusable SCORM resource session
 
@@ -1376,7 +1447,7 @@ example().catch(console.error);
 
 ### Return type
 
-`void` (Empty response body)
+[**ScormTerminateResponse**](ScormTerminateResponse.md)
 
 ### Authorization
 
@@ -1385,7 +1456,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details

package/docs/PostCourseExport.md

@@ -10,6 +10,9 @@ Name | Type
 `courseVersionId` | string
 `exportType` | string
 `sectionIds` | Array<string>
+`deliveryMode` | string
+`rollupPolicy` | [HostedScormRollupPolicy](HostedScormRollupPolicy.md)
+`accessPolicy` | [HostedScormAccessPolicy](HostedScormAccessPolicy.md)
 
 ## Example
 
@@ -21,6 +24,9 @@ const example = {
   "courseVersionId": null,
   "exportType": null,
   "sectionIds": null,
+  "deliveryMode": null,
+  "rollupPolicy": null,
+  "accessPolicy": null,
 } satisfies PostCourseExport
 
 console.log(example)

package/docs/PostDispatchItemLaunch.md

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

@@ -0,0 +1,42 @@
+
+# PostDispatchItemLaunchResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`itemId` | string
+`kind` | string
+`sessionId` | string
+`attemptNumber` | number
+`launchUrl` | string
+
+## Example
+
+```typescript
+import type { PostDispatchItemLaunchResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "itemId": null,
+  "kind": null,
+  "sessionId": null,
+  "attemptNumber": null,
+  "launchUrl": null,
+} satisfies PostDispatchItemLaunchResponse
+
+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 PostDispatchItemLaunchResponse
+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/PostDispatchLaunch.md

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

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