@easyedu/js-lsm-api 1.66.0 → 1.68.0

package/docs/ContentAttemptItem.md

@@ -0,0 +1,47 @@
+
+# ContentAttemptItem
+
+A single learner attempt for a content item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sessionId` | string
+`attemptNumber` | number
+`completionStatus` | string
+`gradeStatus` | string
+`score` | [ContentAttemptScore](ContentAttemptScore.md)
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { ContentAttemptItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sessionId": null,
+  "attemptNumber": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "score": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ContentAttemptItem
+
+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 ContentAttemptItem
+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/ContentAttemptRollupScore.md

@@ -0,0 +1,37 @@
+
+# ContentAttemptRollupScore
+
+Rolled-up score for a content item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`percentage` | number
+`sourceAttemptNumber` | number
+
+## Example
+
+```typescript
+import type { ContentAttemptRollupScore } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "percentage": null,
+  "sourceAttemptNumber": null,
+} satisfies ContentAttemptRollupScore
+
+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 ContentAttemptRollupScore
+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/ContentAttemptScore.md

@@ -0,0 +1,41 @@
+
+# ContentAttemptScore
+
+Normalized score data for a content attempt
+
+## Properties
+
+Name | Type
+------------ | -------------
+`raw` | number
+`min` | number
+`max` | number
+`percentage` | number
+
+## Example
+
+```typescript
+import type { ContentAttemptScore } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "raw": null,
+  "min": null,
+  "max": null,
+  "percentage": null,
+} satisfies ContentAttemptScore
+
+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 ContentAttemptScore
+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/{DownloadSupportTicketAttachment200Response.md → ContentLaunchMode.md}

@@ -1,22 +1,21 @@
 
-# DownloadSupportTicketAttachment200Response
+# ContentLaunchMode
 
+How the learner player should present the launched content.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`downloadUrl` | string
 
 ## Example
 
 ```typescript
-import type { DownloadSupportTicketAttachment200Response } from '@easyedu/js-lsm-api'
+import type { ContentLaunchMode } from '@easyedu/js-lsm-api'
 
 // TODO: Update the object below with actual values
 const example = {
-  "downloadUrl": null,
-} satisfies DownloadSupportTicketAttachment200Response
+} satisfies ContentLaunchMode
 
 console.log(example)
 
@@ -25,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as DownloadSupportTicketAttachment200Response
+const exampleParsed = JSON.parse(exampleJSON) as ContentLaunchMode
 console.log(exampleParsed)
 ```
 

package/docs/CourseApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deleteCourseEnrollment**](CourseApi.md#deletecourseenrollment) | **DELETE** /courses/{courseId}/enrollments/{enrollmentId} | Remove a course enrollment |
 | [**deleteCourseExport**](CourseApi.md#deletecourseexport) | **DELETE** /courses/{courseId}/exports/{exportId} | Delete a course export |
 | [**deleteCourseImage**](CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image |
+| [**downloadCourseExport**](CourseApi.md#downloadcourseexport) | **GET** /courses/{courseId}/exports/{exportId}/download | Download a completed course export |
 | [**getCourse**](CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course |
 | [**getCourseEnrollment**](CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment |
 | [**getCourseEnrollments**](CourseApi.md#getcourseenrollments) | **GET** /courses/{courseId}/enrollments | Get course enrollments |
@@ -299,6 +300,77 @@ 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)
 
 
+## downloadCourseExport
+
+> Blob downloadCourseExport(courseId, exportId)
+
+Download a completed course export
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { DownloadCourseExportRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    exportId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DownloadCourseExportRequest;
+
+  try {
+    const data = await api.downloadCourseExport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **exportId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/zip`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Export ZIP |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Export or course 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)
+
+
 ## getCourse
 
 > GetCourse getCourse(courseId)

package/docs/GetContent.md

@@ -11,6 +11,7 @@ Name | Type
 `name` | string
 `description` | string
 `contentType` | string
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `contentData` | [GetContentContentData](GetContentContentData.md)
 `order` | number
 `published` | boolean
@@ -32,6 +33,7 @@ const example = {
   "name": null,
   "description": null,
   "contentType": null,
+  "launchMode": null,
   "contentData": null,
   "order": null,
   "published": null,

package/docs/GetContentAttempts.md

@@ -0,0 +1,51 @@
+
+# GetContentAttempts
+
+Learner attempt history and rollup for a content item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contentId` | string
+`userId` | string
+`maxAttempts` | number
+`attemptsUsed` | number
+`attemptsRemaining` | number
+`canStartNewAttempt` | boolean
+`scoreRollupStrategy` | string
+`rollupScore` | [ContentAttemptRollupScore](ContentAttemptRollupScore.md)
+`attempts` | [Array<ContentAttemptItem>](ContentAttemptItem.md)
+
+## Example
+
+```typescript
+import type { GetContentAttempts } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contentId": null,
+  "userId": null,
+  "maxAttempts": null,
+  "attemptsUsed": null,
+  "attemptsRemaining": null,
+  "canStartNewAttempt": null,
+  "scoreRollupStrategy": null,
+  "rollupScore": null,
+  "attempts": null,
+} satisfies GetContentAttempts
+
+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 GetContentAttempts
+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/GetContentSession.md

@@ -13,6 +13,8 @@ Name | Type
 `updatedAt` | number
 `completionStatus` | string
 `gradeStatus` | string
+`attemptNumber` | number
+`isCurrent` | boolean
 
 ## Example
 
@@ -27,6 +29,8 @@ const example = {
   "updatedAt": null,
   "completionStatus": null,
   "gradeStatus": null,
+  "attemptNumber": null,
+  "isCurrent": null,
 } satisfies GetContentSession
 
 console.log(example)

package/docs/GetContentSessionDetail.md

@@ -14,6 +14,8 @@ Name | Type
 `completionStatus` | string
 `gradeStatus` | string
 `durationInSeconds` | number
+`attemptNumber` | number
+`isCurrent` | boolean
 `userData` | [GetContentSessionDetailUserData](GetContentSessionDetailUserData.md)
 `scormSessionData` | [Array<GetContentSessionDetailScormSessionDataInner>](GetContentSessionDetailScormSessionDataInner.md)
 
@@ -31,6 +33,8 @@ const example = {
   "completionStatus": null,
   "gradeStatus": null,
   "durationInSeconds": null,
+  "attemptNumber": null,
+  "isCurrent": null,
   "userData": null,
   "scormSessionData": null,
 } satisfies GetContentSessionDetail

package/docs/GetContentSessionListItem.md

@@ -11,6 +11,10 @@ Name | Type
 `createdAt` | number
 `updatedAt` | number
 `contentId` | string
+`completionStatus` | string
+`gradeStatus` | string
+`attemptNumber` | number
+`isCurrent` | boolean
 `userData` | [GetContentSessionDetailUserData](GetContentSessionDetailUserData.md)
 `scormSessionData` | [GetContentSessionListItemScormSessionData](GetContentSessionListItemScormSessionData.md)
 
@@ -25,6 +29,10 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "contentId": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "attemptNumber": null,
+  "isCurrent": null,
   "userData": null,
   "scormSessionData": null,
 } satisfies GetContentSessionListItem

package/docs/PortalApi.md

@@ -7,9 +7,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deletePortalFavicon**](PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon |
 | [**deletePortalLogo**](PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo |
 | [**getPortalById**](PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal) |
+| [**getPortalFaviconAsset**](PortalApi.md#getportalfaviconasset) | **GET** /portals/{portalId}/branding/favicon | Stream the configured portal favicon |
 | [**getPortalList**](PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to |
+| [**getPortalLogoAsset**](PortalApi.md#getportallogoasset) | **GET** /portals/{portalId}/branding/logo | Stream the configured portal logo |
 | [**getPortalUsers**](PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering |
 | [**getPublicPortalBranding**](PortalApi.md#getpublicportalbranding) | **GET** /public/portal/branding | Public portal branding resolved from the request host |
+| [**getPublicPortalFaviconAsset**](PortalApi.md#getpublicportalfaviconasset) | **GET** /public/portal/branding/favicon | Public portal favicon resolved from the request host |
+| [**getPublicPortalLogoAsset**](PortalApi.md#getpublicportallogoasset) | **GET** /public/portal/branding/logo | Public portal logo resolved from the request host |
 | [**inviteUserToPortal**](PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal |
 | [**postPortal**](PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal |
 | [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
@@ -217,6 +221,72 @@ 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)
 
 
+## getPortalFaviconAsset
+
+> Blob getPortalFaviconAsset(portalId)
+
+Stream the configured portal favicon
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalFaviconAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetPortalFaviconAssetRequest;
+
+  try {
+    const data = await api.getPortalFaviconAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `image/x-icon`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal favicon image |  -  |
+| **404** | Portal or favicon 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)
+
+
 ## getPortalList
 
 > GetPortalList getPortalList()
@@ -274,6 +344,72 @@ 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)
 
 
+## getPortalLogoAsset
+
+> Blob getPortalLogoAsset(portalId)
+
+Stream the configured portal logo
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalLogoAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetPortalLogoAssetRequest;
+
+  try {
+    const data = await api.getPortalLogoAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal logo image |  -  |
+| **404** | Portal or logo 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)
+
+
 ## getPortalUsers
 
 > GetPortalUserList getPortalUsers(portalId, type, roles, search, page, pageSize)
@@ -417,6 +553,128 @@ 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)
 
 
+## getPublicPortalFaviconAsset
+
+> Blob getPublicPortalFaviconAsset()
+
+Public portal favicon resolved from the request host
+
+Resolves the browser Origin/Referer/Host to a portal and streams its configured favicon.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicPortalFaviconAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  try {
+    const data = await api.getPublicPortalFaviconAsset();
+    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
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `image/x-icon`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Public portal favicon image |  -  |
+| **400** | Invalid portal host |  -  |
+| **404** | Portal host or favicon 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)
+
+
+## getPublicPortalLogoAsset
+
+> Blob getPublicPortalLogoAsset()
+
+Public portal logo resolved from the request host
+
+Resolves the browser Origin/Referer/Host to a portal and streams its configured logo.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicPortalLogoAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  try {
+    const data = await api.getPublicPortalLogoAsset();
+    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
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `image/png`, `image/jpeg`, `image/svg+xml`, `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Public portal logo image |  -  |
+| **400** | Invalid portal host |  -  |
+| **404** | Portal host or logo 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)
+
+
 ## inviteUserToPortal
 
 > inviteUserToPortal(portalId, postPortalInvite)

package/docs/PostContentSession.md

@@ -10,8 +10,11 @@ Name | Type
 `contentId` | string
 `userId` | string
 `launchUrl` | string
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `createdAt` | number
 `playerSessionId` | string
+`attemptNumber` | number
+`isCurrent` | boolean
 
 ## Example
 
@@ -23,8 +26,11 @@ const example = {
   "contentId": null,
   "userId": null,
   "launchUrl": null,
+  "launchMode": null,
   "createdAt": null,
   "playerSessionId": null,
+  "attemptNumber": null,
+  "isCurrent": null,
 } satisfies PostContentSession
 
 console.log(example)