@easyedu/js-lsm-api 1.90.0 → 1.92.0

package/docs/GetResourceSessionDiagnosticsUser.md

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

@@ -0,0 +1,52 @@
+
+# GetResourceSessionDiagnosticsVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`status` | string
+`changeNotes` | string
+`metadata` | { [key: string]: any; }
+`filename` | string
+`mimeType` | string
+`fileSizeBytes` | number
+`checksumSha256` | string
+`linkUrl` | string
+
+## Example
+
+```typescript
+import type { GetResourceSessionDiagnosticsVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "versionNumber": null,
+  "status": null,
+  "changeNotes": null,
+  "metadata": null,
+  "filename": null,
+  "mimeType": null,
+  "fileSizeBytes": null,
+  "checksumSha256": null,
+  "linkUrl": null,
+} satisfies GetResourceSessionDiagnosticsVersion
+
+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 GetResourceSessionDiagnosticsVersion
+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/GetResourceSessionScormApiLogs.md

@@ -0,0 +1,43 @@
+
+# GetResourceSessionScormApiLogs
+
+A filtered page of SCORM runtime calls for a resource session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<ResourceSessionScormApiLogItem>](ResourceSessionScormApiLogItem.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionScormApiLogs } 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 GetResourceSessionScormApiLogs
+
+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 GetResourceSessionScormApiLogs
+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/GetResourceSessionScormData.md

@@ -0,0 +1,49 @@
+
+# GetResourceSessionScormData
+
+Current SCORM CMI state for a reusable resource session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`scormVersion` | string
+`createdAt` | number
+`updatedAt` | number
+`initializedAt` | number
+`terminatedAt` | number
+`activity` | [GetResourceSessionScormDataActivity](GetResourceSessionScormDataActivity.md)
+`cmiData` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { GetResourceSessionScormData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "scormVersion": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "initializedAt": null,
+  "terminatedAt": null,
+  "activity": null,
+  "cmiData": null,
+} satisfies GetResourceSessionScormData
+
+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 GetResourceSessionScormData
+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/GetResourceSessionScormDataActivity.md

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

@@ -0,0 +1,48 @@
+
+# LibraryQuizCriterion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`topic` | string
+`difficultyLevel` | string
+`questionType` | string
+`tags` | Array<string>
+`minQuestions` | number
+`maxQuestions` | number
+`priority` | number
+
+## Example
+
+```typescript
+import type { LibraryQuizCriterion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "topic": null,
+  "difficultyLevel": null,
+  "questionType": null,
+  "tags": null,
+  "minQuestions": null,
+  "maxQuestions": null,
+  "priority": null,
+} satisfies LibraryQuizCriterion
+
+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 LibraryQuizCriterion
+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/LibraryQuizQuestion.md

@@ -0,0 +1,46 @@
+
+# LibraryQuizQuestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`questionId` | string
+`questionGroupId` | string
+`displayOrder` | number
+`points` | number
+`versionLocked` | boolean
+`snapshot` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { LibraryQuizQuestion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "questionId": null,
+  "questionGroupId": null,
+  "displayOrder": null,
+  "points": null,
+  "versionLocked": null,
+  "snapshot": null,
+} satisfies LibraryQuizQuestion
+
+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 LibraryQuizQuestion
+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/LibraryQuizQuestionInput.md

@@ -0,0 +1,40 @@
+
+# LibraryQuizQuestionInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questionId` | string
+`displayOrder` | number
+`points` | number
+`versionLocked` | boolean
+
+## Example
+
+```typescript
+import type { LibraryQuizQuestionInput } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "questionId": null,
+  "displayOrder": null,
+  "points": null,
+  "versionLocked": null,
+} satisfies LibraryQuizQuestionInput
+
+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 LibraryQuizQuestionInput
+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/LibraryQuizSessionAnswerChoice.md

@@ -0,0 +1,40 @@
+
+# LibraryQuizSessionAnswerChoice
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`text` | string
+`textRich` | [RichTextDocument](RichTextDocument.md)
+`displayOrder` | number
+
+## Example
+
+```typescript
+import type { LibraryQuizSessionAnswerChoice } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "text": null,
+  "textRich": null,
+  "displayOrder": null,
+} satisfies LibraryQuizSessionAnswerChoice
+
+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 LibraryQuizSessionAnswerChoice
+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/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)
+
+