@easyedu/js-lsm-api 1.102.0 → 1.104.0

package/docs/ChatUserIdentity.md

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

@@ -15,7 +15,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getLibraryQuizSessionResults**](ContentLibraryQuizApi.md#getlibraryquizsessionresults) | **GET** /quiz/sessions/{sessionId}/results | Get reusable quiz session results |
 | [**getLibraryQuizUsage**](ContentLibraryQuizApi.md#getlibraryquizusage) | **GET** /content-library/quizzes/{quizId}/usage | Get course and learner usage for a reusable quiz |
 | [**getLibraryQuizVersion**](ContentLibraryQuizApi.md#getlibraryquizversion) | **GET** /content-library/quizzes/{quizId}/versions/{versionId} | Get a reusable quiz version |
-| [**postCourseLibraryQuizSession**](ContentLibraryQuizApi.md#postcourselibraryquizsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions | Start or resume a live attempt for a course-pinned quiz version |
+| [**postCourseLibraryQuizSession**](ContentLibraryQuizApi.md#postcourselibraryquizsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions | Start or resume a live or sandbox-preview attempt for a course-pinned quiz version |
 | [**postLibraryQuiz**](ContentLibraryQuizApi.md#postlibraryquiz) | **POST** /content-library/quizzes | Create a reusable quiz and its first draft version |
 | [**postLibraryQuizArchive**](ContentLibraryQuizApi.md#postlibraryquizarchive) | **POST** /content-library/quizzes/{quizId}/archive | Archive a reusable quiz |
 | [**postLibraryQuizCriteriaPreview**](ContentLibraryQuizApi.md#postlibraryquizcriteriapreview) | **POST** /content-library/quizzes/{quizId}/versions/{versionId}/criteria/preview | Preview questions matching unsaved quiz-selection criteria |
@@ -810,9 +810,9 @@ No authorization required
 
 ## postCourseLibraryQuizSession
 
-> GetLibraryQuizSession postCourseLibraryQuizSession(courseId, courseVersionId, itemId, postCourseLibraryQuizSession)
+> GetLibraryQuizSession postCourseLibraryQuizSession(courseId, courseVersionId, itemId, preview, postCourseLibraryQuizSession)
 
-Start or resume a live attempt for a course-pinned quiz version
+Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
 
 ### Example
 
@@ -834,6 +834,8 @@ async function example() {
     courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string
     itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Start or resume an isolated sandbox quiz attempt for course preview. (optional)
+    preview: true,
     // PostCourseLibraryQuizSession (optional)
     postCourseLibraryQuizSession: ...,
   } satisfies PostCourseLibraryQuizSessionRequest;
@@ -858,6 +860,7 @@ example().catch(console.error);
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **courseVersionId** | `string` |  | [Defaults to `undefined`] |
 | **itemId** | `string` |  | [Defaults to `undefined`] |
+| **preview** | `boolean` | Start or resume an isolated sandbox quiz attempt for course preview. | [Optional] [Defaults to `false`] |
 | **postCourseLibraryQuizSession** | [PostCourseLibraryQuizSession](PostCourseLibraryQuizSession.md) |  | [Optional] |
 
 ### Return type
@@ -877,7 +880,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Current or newly created live quiz session |  -  |
+| **200** | Current or newly created live or sandbox-preview quiz session |  -  |
 | **403** | Learner is not assigned to the pinned course version |  -  |
 | **409** | Maximum attempts reached |  -  |
 

package/docs/CourseApi.md

@@ -1107,7 +1107,7 @@ No authorization required
 
 ## getCourseVersion
 
-> GetCourseVersion getCourseVersion(courseId, courseVersionId)
+> GetCourseVersion getCourseVersion(courseId, courseVersionId, preview)
 
 Get one immutable course version or preview the owned draft
 
@@ -1129,6 +1129,8 @@ async function example() {
     courseId: courseId_example,
     // string
     courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Return the owning portal\'s draft or historical version with student visibility rules applied. (optional)
+    preview: true,
   } satisfies GetCourseVersionRequest;
 
   try {
@@ -1150,6 +1152,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **courseVersionId** | `string` |  | [Defaults to `undefined`] |
+| **preview** | `boolean` | Return the owning portal\'s draft or historical version with student visibility rules applied. | [Optional] [Defaults to `false`] |
 
 ### Return type
 
@@ -1176,7 +1179,7 @@ No authorization required
 
 ## getCourseVersionItemLaunch
 
-> GetCourseVersionItemLaunch getCourseVersionItemLaunch(courseId, courseVersionId, itemId)
+> GetCourseVersionItemLaunch getCourseVersionItemLaunch(courseId, courseVersionId, itemId, preview)
 
 Resolve the exact immutable resource launch selected by a course version
 
@@ -1200,6 +1203,8 @@ async function example() {
     courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string
     itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Resolve this placement in isolated student-view preview mode. (optional)
+    preview: true,
   } satisfies GetCourseVersionItemLaunchRequest;
 
   try {
@@ -1222,6 +1227,7 @@ example().catch(console.error);
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **courseVersionId** | `string` |  | [Defaults to `undefined`] |
 | **itemId** | `string` |  | [Defaults to `undefined`] |
+| **preview** | `boolean` | Resolve this placement in isolated student-view preview mode. | [Optional] [Defaults to `false`] |
 
 ### Return type
 
@@ -1314,7 +1320,7 @@ No authorization required
 
 ## getCourseVersionProgression
 
-> GetCourseVersionProgression getCourseVersionProgression(courseId, courseVersionId)
+> GetCourseVersionProgression getCourseVersionProgression(courseId, courseVersionId, preview)
 
 Get learner-specific completion and section lock state
 
@@ -1336,6 +1342,8 @@ async function example() {
     courseId: courseId_example,
     // string
     courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Read isolated sandbox progress while previewing an owned draft or historical version. (optional)
+    preview: true,
   } satisfies GetCourseVersionProgressionRequest;
 
   try {
@@ -1357,6 +1365,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **courseVersionId** | `string` |  | [Defaults to `undefined`] |
+| **preview** | `boolean` | Read isolated sandbox progress while previewing an owned draft or historical version. | [Optional] [Defaults to `false`] |
 
 ### Return type
 
@@ -2085,7 +2094,7 @@ No authorization required
 
 ## postCourseVersionItemSession
 
-> GetCourseVersionItemSession postCourseVersionItemSession(courseId, courseVersionId, itemId, postCourseVersionItemSession)
+> GetCourseVersionItemSession postCourseVersionItemSession(courseId, courseVersionId, itemId, preview, postCourseVersionItemSession)
 
 Start or resume a version-pinned resource attempt
 
@@ -2109,6 +2118,8 @@ async function example() {
     courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string
     itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Start or resume an isolated sandbox attempt for course preview. (optional)
+    preview: true,
     // PostCourseVersionItemSession (optional)
     postCourseVersionItemSession: ...,
   } satisfies PostCourseVersionItemSessionRequest;
@@ -2133,6 +2144,7 @@ example().catch(console.error);
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **courseVersionId** | `string` |  | [Defaults to `undefined`] |
 | **itemId** | `string` |  | [Defaults to `undefined`] |
+| **preview** | `boolean` | Start or resume an isolated sandbox attempt for course preview. | [Optional] [Defaults to `false`] |
 | **postCourseVersionItemSession** | [PostCourseVersionItemSession](PostCourseVersionItemSession.md) |  | [Optional] |
 
 ### Return type

package/docs/GetChatSettings.md

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

@@ -0,0 +1,42 @@
+
+# GetChatUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`from` | number
+`to` | number
+`totals` | [ChatUsageTotals](ChatUsageTotals.md)
+`daily` | [Array<ChatDailyUsage>](ChatDailyUsage.md)
+`modelUsage` | [Array<ChatModelUsage>](ChatModelUsage.md)
+
+## Example
+
+```typescript
+import type { GetChatUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "from": null,
+  "to": null,
+  "totals": null,
+  "daily": null,
+  "modelUsage": null,
+} satisfies GetChatUsage
+
+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 GetChatUsage
+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/GetCourseVersionProgression.md

@@ -1,7 +1,7 @@
 
 # GetCourseVersionProgression
 
-Learner-specific completion and lock state for an enrollment-pinned course version.
+Learner-specific live completion state, or isolated sandbox completion state during an authorized course preview.
 
 ## Properties
 

package/docs/PostCourseVersionItemSession.md

@@ -1,7 +1,7 @@
 
 # PostCourseVersionItemSession
 
-Start or resume a learner attempt for an exact course resource version.
+Start or resume a learner attempt, or an isolated sandbox preview attempt, for an exact course resource version.
 
 ## Properties
 

package/docs/PutChatSettings.md

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

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.102.0",
+  "version": "1.104.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {