@easyedu/js-lsm-api 1.118.0 → 1.119.0

package/docs/DispatchApi.md

@@ -4,14 +4,144 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**getDispatchCourse**](DispatchApi.md#getdispatchcourse) | **GET** /dispatch/runtime/course | Get the registration-scoped hosted course snapshot |
+| [**getDispatchQuizSession**](DispatchApi.md#getdispatchquizsession) | **GET** /dispatch/runtime/quiz-sessions/{sessionId} | Get a registration-owned native quiz session |
 | [**getDispatchRollup**](DispatchApi.md#getdispatchrollup) | **GET** /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data |
+| [**postDispatchItemLaunch**](DispatchApi.md#postdispatchitemlaunch) | **POST** /dispatch/runtime/items/{itemId}/launch | Start or resume a selected hosted course item |
 | [**postDispatchLaunch**](DispatchApi.md#postdispatchlaunch) | **POST** /dispatch/launch | Launch a dispatch package |
+| [**postDispatchQuizSessionSubmit**](DispatchApi.md#postdispatchquizsessionsubmit) | **POST** /dispatch/runtime/quiz-sessions/{sessionId}/submit | Submit a registration-owned native quiz session |
+| [**postDispatchTokenExchange**](DispatchApi.md#postdispatchtokenexchange) | **POST** /dispatch/runtime/token | Exchange a one-time hosted SCORM launch code |
+| [**postDispatchTokenRefresh**](DispatchApi.md#postdispatchtokenrefresh) | **POST** /dispatch/runtime/token/refresh | Rotate a valid hosted SCORM access token |
+| [**putDispatchQuizSessionAnswer**](DispatchApi.md#putdispatchquizsessionanswer) | **PUT** /dispatch/runtime/quiz-sessions/{sessionId}/answers/{sessionQuestionId} | Save a registration-owned native quiz answer |
 
 
 
+## getDispatchCourse
+
+> GetDispatchCourse getDispatchCourse()
+
+Get the registration-scoped hosted course snapshot
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { GetDispatchCourseRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  try {
+    const data = await api.getDispatchCourse();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetDispatchCourse**](GetDispatchCourse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Hosted course snapshot |  -  |
+| **401** | Dispatch token required |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDispatchQuizSession
+
+> GetLibraryQuizSession getDispatchQuizSession(sessionId)
+
+Get a registration-owned native quiz session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { GetDispatchQuizSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetDispatchQuizSessionRequest;
+
+  try {
+    const data = await api.getDispatchQuizSession(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
+
+[**GetLibraryQuizSession**](GetLibraryQuizSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Quiz session |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getDispatchRollup
 
-> getDispatchRollup(dispatchPackageId)
+> GetDispatchRollup getDispatchRollup(dispatchPackageId)
 
 Get dispatch package rollup data
 
@@ -54,7 +184,7 @@ example().catch(console.error);
 
 ### Return type
 
-`void` (Empty response body)
+[**GetDispatchRollup**](GetDispatchRollup.md)
 
 ### Authorization
 
@@ -63,7 +193,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: `application/json`
 
 
 ### HTTP response details
@@ -75,9 +205,79 @@ 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)
 
 
+## postDispatchItemLaunch
+
+> PostDispatchItemLaunchResponse postDispatchItemLaunch(itemId, postDispatchItemLaunch)
+
+Start or resume a selected hosted course item
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { PostDispatchItemLaunchRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  const body = {
+    // string
+    itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PostDispatchItemLaunch (optional)
+    postDispatchItemLaunch: ...,
+  } satisfies PostDispatchItemLaunchRequest;
+
+  try {
+    const data = await api.postDispatchItemLaunch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **itemId** | `string` |  | [Defaults to `undefined`] |
+| **postDispatchItemLaunch** | [PostDispatchItemLaunch](PostDispatchItemLaunch.md) |  | [Optional] |
+
+### Return type
+
+[**PostDispatchItemLaunchResponse**](PostDispatchItemLaunchResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Item session |  -  |
+| **403** | Item is not accessible to this registration |  -  |
+| **409** | Progression or attempt limit prevents launch |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postDispatchLaunch
 
-> postDispatchLaunch()
+> PostDispatchLaunchResponse postDispatchLaunch(postDispatchLaunch)
 
 Launch a dispatch package
 
@@ -94,8 +294,13 @@ async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new DispatchApi();
 
+  const body = {
+    // PostDispatchLaunch
+    postDispatchLaunch: ...,
+  } satisfies PostDispatchLaunchRequest;
+
   try {
-    const data = await api.postDispatchLaunch();
+    const data = await api.postDispatchLaunch(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -108,11 +313,14 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postDispatchLaunch** | [PostDispatchLaunch](PostDispatchLaunch.md) |  | |
 
 ### Return type
 
-`void` (Empty response body)
+[**PostDispatchLaunchResponse**](PostDispatchLaunchResponse.md)
 
 ### Authorization
 
@@ -120,8 +328,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
 
 
 ### HTTP response details
@@ -129,6 +337,269 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | Dispatch launch response |  -  |
 | **400** | Invalid launch request |  -  |
+| **403** | Origin, validity window, or learner cap denied launch |  -  |
+| **410** | Package revoked |  -  |
+| **503** | Hosted player is not configured |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postDispatchQuizSessionSubmit
+
+> GetLibraryQuizResult postDispatchQuizSessionSubmit(sessionId)
+
+Submit a registration-owned native quiz session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { PostDispatchQuizSessionSubmitRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PostDispatchQuizSessionSubmitRequest;
+
+  try {
+    const data = await api.postDispatchQuizSessionSubmit(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
+
+[**GetLibraryQuizResult**](GetLibraryQuizResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Quiz result |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postDispatchTokenExchange
+
+> DispatchTokenResponse postDispatchTokenExchange(postDispatchTokenExchange)
+
+Exchange a one-time hosted SCORM launch code
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { PostDispatchTokenExchangeRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  const body = {
+    // PostDispatchTokenExchange
+    postDispatchTokenExchange: ...,
+  } satisfies PostDispatchTokenExchangeRequest;
+
+  try {
+    const data = await api.postDispatchTokenExchange(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postDispatchTokenExchange** | [PostDispatchTokenExchange](PostDispatchTokenExchange.md) |  | |
+
+### Return type
+
+[**DispatchTokenResponse**](DispatchTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Dispatch access token |  -  |
+| **401** | Invalid, expired, or consumed launch code |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postDispatchTokenRefresh
+
+> DispatchTokenResponse postDispatchTokenRefresh()
+
+Rotate a valid hosted SCORM access token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { PostDispatchTokenRefreshRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  try {
+    const data = await api.postDispatchTokenRefresh();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DispatchTokenResponse**](DispatchTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Replacement access token |  -  |
+| **401** | Dispatch token required |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putDispatchQuizSessionAnswer
+
+> GetLibraryQuizSession putDispatchQuizSessionAnswer(sessionId, sessionQuestionId, putLibraryQuizSessionAnswer)
+
+Save a registration-owned native quiz answer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DispatchApi,
+} from '@easyedu/js-lsm-api';
+import type { PutDispatchQuizSessionAnswerRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new DispatchApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    sessionQuestionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PutLibraryQuizSessionAnswer
+    putLibraryQuizSessionAnswer: ...,
+  } satisfies PutDispatchQuizSessionAnswerRequest;
+
+  try {
+    const data = await api.putDispatchQuizSessionAnswer(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`] |
+| **sessionQuestionId** | `string` |  | [Defaults to `undefined`] |
+| **putLibraryQuizSessionAnswer** | [PutLibraryQuizSessionAnswer](PutLibraryQuizSessionAnswer.md) |  | |
+
+### Return type
+
+[**GetLibraryQuizSession**](GetLibraryQuizSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Quiz session |  -  |
 
 [[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/DispatchTokenResponse.md

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

@@ -19,6 +19,13 @@ Name | Type
 `fileSize` | number
 `errorMessage` | string
 `createdAt` | number
+`deliveryMode` | string
+`rollupPolicy` | [HostedScormRollupPolicy](HostedScormRollupPolicy.md)
+`accessPolicy` | [HostedScormAccessPolicy](HostedScormAccessPolicy.md)
+`runtimeStatus` | string
+`registeredLearners` | number
+`totalLaunches` | number
+`lastLaunchAt` | number
 
 ## Example
 
@@ -39,6 +46,13 @@ const example = {
   "fileSize": null,
   "errorMessage": null,
   "createdAt": null,
+  "deliveryMode": null,
+  "rollupPolicy": null,
+  "accessPolicy": null,
+  "runtimeStatus": null,
+  "registeredLearners": null,
+  "totalLaunches": null,
+  "lastLaunchAt": null,
 } satisfies GetCourseExport
 
 console.log(example)

package/docs/GetDispatchCourse.md

@@ -0,0 +1,50 @@
+
+# GetDispatchCourse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`dispatchId` | string
+`registrationId` | string
+`courseId` | string
+`courseVersionId` | string
+`title` | string
+`progressionMode` | string
+`currentItemId` | string
+`outline` | [Array<HostedScormOutlineEntry>](HostedScormOutlineEntry.md)
+`rollup` | [GetDispatchRollup](GetDispatchRollup.md)
+
+## Example
+
+```typescript
+import type { GetDispatchCourse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "dispatchId": null,
+  "registrationId": null,
+  "courseId": null,
+  "courseVersionId": null,
+  "title": null,
+  "progressionMode": null,
+  "currentItemId": null,
+  "outline": null,
+  "rollup": null,
+} satisfies GetDispatchCourse
+
+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 GetDispatchCourse
+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)
+
+