@easyedu/js-lsm-api 1.93.0 → 1.95.0

package/docs/GetQuizResultsFeedback.md

@@ -1,39 +0,0 @@
-
-# GetQuizResultsFeedback
-
-Detailed feedback and analytics
-
-## Properties
-
-Name | Type
------------- | -------------
-`overallFeedback` | string
-`topicPerformance` | [Array<GetQuizResultsFeedbackTopicPerformanceInner>](GetQuizResultsFeedbackTopicPerformanceInner.md)
-`difficultyPerformance` | [Array<GetQuizResultsFeedbackDifficultyPerformanceInner>](GetQuizResultsFeedbackDifficultyPerformanceInner.md)
-
-## Example
-
-```typescript
-import type { GetQuizResultsFeedback } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "overallFeedback": null,
-  "topicPerformance": null,
-  "difficultyPerformance": null,
-} satisfies GetQuizResultsFeedback
-
-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 GetQuizResultsFeedback
-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/GetQuizResultsFeedbackDifficultyPerformanceInner.md

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

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

@@ -1,54 +0,0 @@
-
-# GetQuizResultsQuestionsInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`questionId` | string
-`questionOrder` | number
-`questionText` | string
-`questionTextRich` | [RichTextDocument](RichTextDocument.md)
-`questionType` | string
-`answerChoices` | [Array<GetQuizResultsQuestionsInnerAnswerChoicesInner>](GetQuizResultsQuestionsInnerAnswerChoicesInner.md)
-`studentAnswer` | [GetQuizResultsQuestionsInnerStudentAnswer](GetQuizResultsQuestionsInnerStudentAnswer.md)
-`explanation` | string
-`explanationRich` | [RichTextDocument](RichTextDocument.md)
-`timeSpent` | number
-`wasFlagged` | boolean
-
-## Example
-
-```typescript
-import type { GetQuizResultsQuestionsInner } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "questionId": null,
-  "questionOrder": null,
-  "questionText": null,
-  "questionTextRich": null,
-  "questionType": null,
-  "answerChoices": null,
-  "studentAnswer": null,
-  "explanation": null,
-  "explanationRich": null,
-  "timeSpent": null,
-  "wasFlagged": null,
-} satisfies GetQuizResultsQuestionsInner
-
-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 GetQuizResultsQuestionsInner
-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/GetQuizResultsQuestionsInnerAnswerChoicesInner.md

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

@@ -1,43 +0,0 @@
-
-# GetQuizResultsQuestionsInnerStudentAnswer
-
-Student\'s answer and scoring
-
-## Properties
-
-Name | Type
------------- | -------------
-`selectedChoices` | Array<string>
-`textAnswer` | string
-`isCorrect` | boolean
-`pointsEarned` | number
-`pointsPossible` | number
-
-## Example
-
-```typescript
-import type { GetQuizResultsQuestionsInnerStudentAnswer } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "selectedChoices": null,
-  "textAnswer": null,
-  "isCorrect": null,
-  "pointsEarned": null,
-  "pointsPossible": null,
-} satisfies GetQuizResultsQuestionsInnerStudentAnswer
-
-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 GetQuizResultsQuestionsInnerStudentAnswer
-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/GetQuizResultsScore.md

@@ -1,41 +0,0 @@
-
-# GetQuizResultsScore
-
-Scoring information
-
-## Properties
-
-Name | Type
------------- | -------------
-`pointsEarned` | number
-`totalPoints` | number
-`percentage` | number
-`passed` | boolean
-
-## Example
-
-```typescript
-import type { GetQuizResultsScore } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "pointsEarned": null,
-  "totalPoints": null,
-  "percentage": null,
-  "passed": null,
-} satisfies GetQuizResultsScore
-
-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 GetQuizResultsScore
-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/GetQuizResultsTiming.md

@@ -1,43 +0,0 @@
-
-# GetQuizResultsTiming
-
-Timing information
-
-## Properties
-
-Name | Type
------------- | -------------
-`startedAt` | Date
-`submittedAt` | Date
-`timeLimit` | number
-`timeSpent` | number
-`timeRemaining` | number
-
-## Example
-
-```typescript
-import type { GetQuizResultsTiming } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "startedAt": null,
-  "submittedAt": null,
-  "timeLimit": null,
-  "timeSpent": null,
-  "timeRemaining": null,
-} satisfies GetQuizResultsTiming
-
-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 GetQuizResultsTiming
-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/GetQuizStatistics.md

@@ -1,43 +0,0 @@
-
-# GetQuizStatistics
-
-Quiz performance statistics
-
-## Properties
-
-Name | Type
------------- | -------------
-`totalAttempts` | number
-`totalCompletions` | number
-`averageScore` | number
-`passRate` | number
-`averageTime` | number
-
-## Example
-
-```typescript
-import type { GetQuizStatistics } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "totalAttempts": null,
-  "totalCompletions": null,
-  "averageScore": null,
-  "passRate": null,
-  "averageTime": null,
-} satisfies GetQuizStatistics
-
-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 GetQuizStatistics
-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/GetScormApiLogItem.md

@@ -1,45 +0,0 @@
-
-# GetScormApiLogItem
-
-A SCORM API call log entry
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | number
-`createdAt` | number
-`method` | string
-`element` | string
-`value` | string
-`errorCode` | string
-
-## Example
-
-```typescript
-import type { GetScormApiLogItem } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "createdAt": null,
-  "method": null,
-  "element": null,
-  "value": null,
-  "errorCode": null,
-} satisfies GetScormApiLogItem
-
-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 GetScormApiLogItem
-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/GetScormApiLogs.md

@@ -1,43 +0,0 @@
-
-# GetScormApiLogs
-
-A list of SCORM API logs with pagination information
-
-## Properties
-
-Name | Type
------------- | -------------
-`page` | number
-`pageSize` | number
-`totalPages` | number
-`totalItems` | number
-`items` | [Array<GetScormApiLogItem>](GetScormApiLogItem.md)
-
-## Example
-
-```typescript
-import type { GetScormApiLogs } 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 GetScormApiLogs
-
-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 GetScormApiLogs
-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/GetScormPackage.md

@@ -1,37 +0,0 @@
-
-# GetScormPackage
-
-Details of a SCORM package
-
-## Properties
-
-Name | Type
------------- | -------------
-`packageInfo` | [GetScormPackagePackageInfo](GetScormPackagePackageInfo.md)
-`tableOfContents` | object
-
-## Example
-
-```typescript
-import type { GetScormPackage } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "packageInfo": null,
-  "tableOfContents": null,
-} satisfies GetScormPackage
-
-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 GetScormPackage
-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/GetScormPackagePackageInfo.md

@@ -1,59 +0,0 @@
-
-# GetScormPackagePackageInfo
-
-Information about the SCORM package
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`version` | number
-`isActive` | boolean
-`manifestIdentifier` | string
-`manifestVersion` | string
-`organizationIdentifier` | string
-`organizationTitle` | string
-`scormVersion` | string
-`storageKey` | string
-`totalFileCount` | number
-`packageSizeBytes` | number
-`createdAt` | Date
-`updatedAt` | Date
-
-## Example
-
-```typescript
-import type { GetScormPackagePackageInfo } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "version": null,
-  "isActive": null,
-  "manifestIdentifier": null,
-  "manifestVersion": null,
-  "organizationIdentifier": null,
-  "organizationTitle": null,
-  "scormVersion": null,
-  "storageKey": null,
-  "totalFileCount": null,
-  "packageSizeBytes": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies GetScormPackagePackageInfo
-
-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 GetScormPackagePackageInfo
-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/GetScormSessionData.md

@@ -1,43 +0,0 @@
-
-# GetScormSessionData
-
-SCORM session data with CMI information
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`createdAt` | number
-`updatedAt` | number
-`cmiData` | { [key: string]: any; }
-`activity` | [GetScormSessionDataActivity](GetScormSessionDataActivity.md)
-
-## Example
-
-```typescript
-import type { GetScormSessionData } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "createdAt": null,
-  "updatedAt": null,
-  "cmiData": null,
-  "activity": null,
-} satisfies GetScormSessionData
-
-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 GetScormSessionData
-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/GetScormSessionDataActivity.md

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