@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/GetQuestionList.md

@@ -0,0 +1,44 @@
+
+# GetQuestionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`filters` | [GetQuestionListFilters](GetQuestionListFilters.md)
+`items` | [Array<GetQuestion>](GetQuestion.md)
+
+## Example
+
+```typescript
+import type { GetQuestionList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "filters": null,
+  "items": null,
+} satisfies GetQuestionList
+
+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 GetQuestionList
+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/GetQuestionListFilters.md

@@ -0,0 +1,48 @@
+
+# GetQuestionListFilters
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`topic` | string
+`course` | string
+`questionType` | string
+`difficultyLevel` | string
+`tags` | Array<string>
+`search` | string
+`createdAfter` | Date
+`createdBefore` | Date
+
+## Example
+
+```typescript
+import type { GetQuestionListFilters } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "topic": null,
+  "course": null,
+  "questionType": null,
+  "difficultyLevel": null,
+  "tags": null,
+  "search": null,
+  "createdAfter": null,
+  "createdBefore": null,
+} satisfies GetQuestionListFilters
+
+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 GetQuestionListFilters
+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/GetQuiz.md

@@ -0,0 +1,68 @@
+
+# GetQuiz
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`contentId` | string
+`questionSelectionMethod` | string
+`maxQuestions` | number
+`maxAttempts` | number
+`passingScore` | number
+`timeLimitMinutes` | number
+`randomizeQuestions` | boolean
+`randomizeAnswers` | boolean
+`showResults` | boolean
+`showCorrectAnswers` | boolean
+`allowReview` | boolean
+`requireAllQuestions` | boolean
+`settings` | object
+`statistics` | [GetQuizStatistics](GetQuizStatistics.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { GetQuiz } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "contentId": null,
+  "questionSelectionMethod": null,
+  "maxQuestions": null,
+  "maxAttempts": null,
+  "passingScore": null,
+  "timeLimitMinutes": null,
+  "randomizeQuestions": null,
+  "randomizeAnswers": null,
+  "showResults": null,
+  "showCorrectAnswers": null,
+  "allowReview": null,
+  "requireAllQuestions": null,
+  "settings": null,
+  "statistics": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies GetQuiz
+
+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 GetQuiz
+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/GetQuizAttempt.md

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

@@ -0,0 +1,46 @@
+
+# GetQuizAttemptAnalytics
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`attemptId` | string
+`userId` | string
+`quizId` | string
+`basicInfo` | [GetQuizAttemptAnalyticsBasicInfo](GetQuizAttemptAnalyticsBasicInfo.md)
+`scoring` | [GetQuizAttemptAnalyticsScoring](GetQuizAttemptAnalyticsScoring.md)
+`questionAnalysis` | [Array<GetQuizAttemptAnalyticsQuestionAnalysisInner>](GetQuizAttemptAnalyticsQuestionAnalysisInner.md)
+`performanceBreakdown` | [GetQuizAttemptAnalyticsPerformanceBreakdown](GetQuizAttemptAnalyticsPerformanceBreakdown.md)
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAnalytics } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "attemptId": null,
+  "userId": null,
+  "quizId": null,
+  "basicInfo": null,
+  "scoring": null,
+  "questionAnalysis": null,
+  "performanceBreakdown": null,
+} satisfies GetQuizAttemptAnalytics
+
+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 GetQuizAttemptAnalytics
+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/GetQuizAttemptAnalyticsBasicInfo.md

@@ -0,0 +1,49 @@
+
+# GetQuizAttemptAnalyticsBasicInfo
+
+Basic attempt information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userName` | string
+`userEmail` | string
+`quizName` | string
+`attemptNumber` | number
+`status` | string
+`startedAt` | Date
+`completedAt` | Date
+`timeSpentSeconds` | number
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAnalyticsBasicInfo } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userName": null,
+  "userEmail": null,
+  "quizName": null,
+  "attemptNumber": null,
+  "status": null,
+  "startedAt": null,
+  "completedAt": null,
+  "timeSpentSeconds": null,
+} satisfies GetQuizAttemptAnalyticsBasicInfo
+
+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 GetQuizAttemptAnalyticsBasicInfo
+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/GetQuizAttemptAnalyticsPerformanceBreakdown.md

@@ -0,0 +1,39 @@
+
+# GetQuizAttemptAnalyticsPerformanceBreakdown
+
+Performance breakdown analysis
+
+## Properties
+
+Name | Type
+------------ | -------------
+`byTopic` | [Array<GetQuizAttemptAnalyticsPerformanceBreakdownByTopicInner>](GetQuizAttemptAnalyticsPerformanceBreakdownByTopicInner.md)
+`byDifficulty` | [Array<GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner>](GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.md)
+`byQuestionType` | [Array<GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner>](GetQuizAttemptAnalyticsPerformanceBreakdownByQuestionTypeInner.md)
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAnalyticsPerformanceBreakdown } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "byTopic": null,
+  "byDifficulty": null,
+  "byQuestionType": null,
+} satisfies GetQuizAttemptAnalyticsPerformanceBreakdown
+
+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 GetQuizAttemptAnalyticsPerformanceBreakdown
+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/GetQuizAttemptAnalyticsPerformanceBreakdownByDifficultyInner.md

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

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

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

@@ -0,0 +1,58 @@
+
+# GetQuizAttemptAnalyticsQuestionAnalysisInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questionId` | string
+`questionOrder` | number
+`questionText` | string
+`questionType` | string
+`topic` | string
+`difficultyLevel` | string
+`pointsPossible` | number
+`pointsEarned` | number
+`isCorrect` | boolean
+`userAnswer` | [GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer](GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer.md)
+`correctAnswer` | [GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer](GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer.md)
+`timeSpentSeconds` | number
+`answeredAt` | Date
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAnalyticsQuestionAnalysisInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "questionId": null,
+  "questionOrder": null,
+  "questionText": null,
+  "questionType": null,
+  "topic": null,
+  "difficultyLevel": null,
+  "pointsPossible": null,
+  "pointsEarned": null,
+  "isCorrect": null,
+  "userAnswer": null,
+  "correctAnswer": null,
+  "timeSpentSeconds": null,
+  "answeredAt": null,
+} satisfies GetQuizAttemptAnalyticsQuestionAnalysisInner
+
+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 GetQuizAttemptAnalyticsQuestionAnalysisInner
+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/GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer.md

@@ -0,0 +1,39 @@
+
+# GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer
+
+Correct answer information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`correctChoices` | Array<string>
+`correctText` | string
+`explanation` | string
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "correctChoices": null,
+  "correctText": null,
+  "explanation": null,
+} satisfies GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer
+
+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 GetQuizAttemptAnalyticsQuestionAnalysisInnerCorrectAnswer
+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/GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer.md

@@ -0,0 +1,39 @@
+
+# GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer
+
+User\'s answer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`selectedChoices` | Array<string>
+`textAnswer` | string
+`answerText` | string
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "selectedChoices": null,
+  "textAnswer": null,
+  "answerText": null,
+} satisfies GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer
+
+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 GetQuizAttemptAnalyticsQuestionAnalysisInnerUserAnswer
+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/GetQuizAttemptAnalyticsScoring.md

@@ -0,0 +1,49 @@
+
+# GetQuizAttemptAnalyticsScoring
+
+Scoring information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalQuestions` | number
+`questionsAnswered` | number
+`correctAnswers` | number
+`totalPoints` | number
+`pointsEarned` | number
+`scorePercentage` | number
+`passingScore` | number
+`passed` | boolean
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAnalyticsScoring } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalQuestions": null,
+  "questionsAnswered": null,
+  "correctAnswers": null,
+  "totalPoints": null,
+  "pointsEarned": null,
+  "scorePercentage": null,
+  "passingScore": null,
+  "passed": null,
+} satisfies GetQuizAttemptAnalyticsScoring
+
+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 GetQuizAttemptAnalyticsScoring
+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)
+
+