@easyedu/js-lsm-api 1.91.0 → 1.93.0

package/docs/LibraryQuizSessionQuestion.md

@@ -0,0 +1,50 @@
+
+# LibraryQuizSessionQuestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`displayOrder` | number
+`points` | number
+`questionType` | string
+`questionText` | string
+`questionTextRich` | [RichTextDocument](RichTextDocument.md)
+`answerChoices` | [Array<LibraryQuizSessionAnswerChoice>](LibraryQuizSessionAnswerChoice.md)
+`isAnswered` | boolean
+`answer` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { LibraryQuizSessionQuestion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "displayOrder": null,
+  "points": null,
+  "questionType": null,
+  "questionText": null,
+  "questionTextRich": null,
+  "answerChoices": null,
+  "isAnswered": null,
+  "answer": null,
+} satisfies LibraryQuizSessionQuestion
+
+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 LibraryQuizSessionQuestion
+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

@@ -10,6 +10,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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 |
@@ -437,6 +438,71 @@ 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)
 
 
+## 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)

package/docs/PostCourseLibraryQuizSession.md

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

@@ -0,0 +1,58 @@
+
+# PostLibraryQuiz
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`questionSelectionMethod` | [QuestionSelectionMethod](QuestionSelectionMethod.md)
+`maxQuestions` | number
+`passingScore` | number
+`timeLimitMinutes` | number
+`randomizeQuestions` | boolean
+`randomizeAnswers` | boolean
+`showResults` | boolean
+`showCorrectAnswers` | boolean
+`allowReview` | boolean
+`requireAllQuestions` | boolean
+`settings` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PostLibraryQuiz } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "questionSelectionMethod": null,
+  "maxQuestions": null,
+  "passingScore": null,
+  "timeLimitMinutes": null,
+  "randomizeQuestions": null,
+  "randomizeAnswers": null,
+  "showResults": null,
+  "showCorrectAnswers": null,
+  "allowReview": null,
+  "requireAllQuestions": null,
+  "settings": null,
+} satisfies PostLibraryQuiz
+
+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 PostLibraryQuiz
+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/PostLibraryQuizSession.md

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

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

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

@@ -0,0 +1,34 @@
+
+# PutLibraryQuizCriteria
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`criteria` | [Array<LibraryQuizCriterion>](LibraryQuizCriterion.md)
+
+## Example
+
+```typescript
+import type { PutLibraryQuizCriteria } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "criteria": null,
+} satisfies PutLibraryQuizCriteria
+
+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 PutLibraryQuizCriteria
+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/PutLibraryQuizQuestions.md

@@ -0,0 +1,34 @@
+
+# PutLibraryQuizQuestions
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questions` | [Array<LibraryQuizQuestionInput>](LibraryQuizQuestionInput.md)
+
+## Example
+
+```typescript
+import type { PutLibraryQuizQuestions } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "questions": null,
+} satisfies PutLibraryQuizQuestions
+
+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 PutLibraryQuizQuestions
+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/PutLibraryQuizSessionAnswer.md

@@ -0,0 +1,36 @@
+
+# PutLibraryQuizSessionAnswer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`answer` | { [key: string]: any; }
+`autoSave` | boolean
+
+## Example
+
+```typescript
+import type { PutLibraryQuizSessionAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "answer": null,
+  "autoSave": null,
+} satisfies PutLibraryQuizSessionAnswer
+
+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 PutLibraryQuizSessionAnswer
+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/PutLibraryQuizSessionGrade.md

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

@@ -0,0 +1,56 @@
+
+# PutLibraryQuizVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`changeNotes` | string
+`questionSelectionMethod` | [QuestionSelectionMethod](QuestionSelectionMethod.md)
+`maxQuestions` | number
+`passingScore` | number
+`timeLimitMinutes` | number
+`randomizeQuestions` | boolean
+`randomizeAnswers` | boolean
+`showResults` | boolean
+`showCorrectAnswers` | boolean
+`allowReview` | boolean
+`requireAllQuestions` | boolean
+`settings` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PutLibraryQuizVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "changeNotes": null,
+  "questionSelectionMethod": null,
+  "maxQuestions": null,
+  "passingScore": null,
+  "timeLimitMinutes": null,
+  "randomizeQuestions": null,
+  "randomizeAnswers": null,
+  "showResults": null,
+  "showCorrectAnswers": null,
+  "allowReview": null,
+  "requireAllQuestions": null,
+  "settings": null,
+} satisfies PutLibraryQuizVersion
+
+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 PutLibraryQuizVersion
+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/QuestionSelectionMethod.md

@@ -0,0 +1,32 @@
+
+# QuestionSelectionMethod
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { QuestionSelectionMethod } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies QuestionSelectionMethod
+
+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 QuestionSelectionMethod
+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.91.0",
+  "version": "1.93.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {