@easyedu/js-lsm-api 1.29.0 → 1.31.0

package/docs/GetQuizAttemptAttempt.md

@@ -0,0 +1,61 @@
+
+# GetQuizAttemptAttempt
+
+Current attempt status
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`userId` | string
+`quizId` | string
+`contentId` | string
+`attemptNumber` | number
+`status` | string
+`startedAt` | Date
+`completedAt` | Date
+`timeLimitAt` | Date
+`totalQuestions` | number
+`questionsAnswered` | number
+`totalPoints` | number
+`currentScore` | number
+
+## Example
+
+```typescript
+import type { GetQuizAttemptAttempt } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "userId": null,
+  "quizId": null,
+  "contentId": null,
+  "attemptNumber": null,
+  "status": null,
+  "startedAt": null,
+  "completedAt": null,
+  "timeLimitAt": null,
+  "totalQuestions": null,
+  "questionsAnswered": null,
+  "totalPoints": null,
+  "currentScore": null,
+} satisfies GetQuizAttemptAttempt
+
+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 GetQuizAttemptAttempt
+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/GetQuizAttemptList.md

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

@@ -0,0 +1,68 @@
+
+# GetQuizAttemptListAllOfAttempts
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`userId` | string
+`userName` | string
+`userEmail` | string
+`quizId` | string
+`contentId` | string
+`contentName` | string
+`attemptNumber` | number
+`status` | string
+`startedAt` | Date
+`completedAt` | Date
+`totalQuestions` | number
+`questionsAnswered` | number
+`correctAnswers` | number
+`scorePercentage` | number
+`passed` | boolean
+`timeSpentSeconds` | number
+
+## Example
+
+```typescript
+import type { GetQuizAttemptListAllOfAttempts } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "userId": null,
+  "userName": null,
+  "userEmail": null,
+  "quizId": null,
+  "contentId": null,
+  "contentName": null,
+  "attemptNumber": null,
+  "status": null,
+  "startedAt": null,
+  "completedAt": null,
+  "totalQuestions": null,
+  "questionsAnswered": null,
+  "correctAnswers": null,
+  "scorePercentage": null,
+  "passed": null,
+  "timeSpentSeconds": null,
+} satisfies GetQuizAttemptListAllOfAttempts
+
+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 GetQuizAttemptListAllOfAttempts
+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/GetQuizAttemptListAllOfFilters.md

@@ -0,0 +1,45 @@
+
+# GetQuizAttemptListAllOfFilters
+
+Available filters for attempt listing
+
+## Properties
+
+Name | Type
+------------ | -------------
+`quizId` | string
+`userId` | string
+`status` | string
+`passed` | boolean
+`dateRange` | [GetQuizAttemptListAllOfFiltersDateRange](GetQuizAttemptListAllOfFiltersDateRange.md)
+`search` | string
+
+## Example
+
+```typescript
+import type { GetQuizAttemptListAllOfFilters } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "quizId": null,
+  "userId": null,
+  "status": null,
+  "passed": null,
+  "dateRange": null,
+  "search": null,
+} satisfies GetQuizAttemptListAllOfFilters
+
+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 GetQuizAttemptListAllOfFilters
+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/GetQuizAttemptListAllOfFiltersDateRange.md

@@ -0,0 +1,37 @@
+
+# GetQuizAttemptListAllOfFiltersDateRange
+
+Date range filter
+
+## Properties
+
+Name | Type
+------------ | -------------
+`startDate` | Date
+`endDate` | Date
+
+## Example
+
+```typescript
+import type { GetQuizAttemptListAllOfFiltersDateRange } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "startDate": null,
+  "endDate": null,
+} satisfies GetQuizAttemptListAllOfFiltersDateRange
+
+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 GetQuizAttemptListAllOfFiltersDateRange
+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/GetQuizAttemptListAllOfSummary.md

@@ -0,0 +1,45 @@
+
+# GetQuizAttemptListAllOfSummary
+
+Summary statistics
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalAttempts` | number
+`completedAttempts` | number
+`inProgressAttempts` | number
+`averageScore` | number
+`passRate` | number
+`averageTimeMinutes` | number
+
+## Example
+
+```typescript
+import type { GetQuizAttemptListAllOfSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalAttempts": null,
+  "completedAttempts": null,
+  "inProgressAttempts": null,
+  "averageScore": null,
+  "passRate": null,
+  "averageTimeMinutes": null,
+} satisfies GetQuizAttemptListAllOfSummary
+
+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 GetQuizAttemptListAllOfSummary
+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/GetQuizAttemptQuestionsInner.md

@@ -0,0 +1,52 @@
+
+# GetQuizAttemptQuestionsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`questionId` | string
+`questionOrder` | number
+`points` | number
+`questionText` | string
+`questionType` | string
+`answerChoices` | [Array<GetQuizAttemptQuestionsInnerAnswerChoicesInner>](GetQuizAttemptQuestionsInnerAnswerChoicesInner.md)
+`isAnswered` | boolean
+`currentAnswer` | [GetQuizAttemptQuestionsInnerCurrentAnswer](GetQuizAttemptQuestionsInnerCurrentAnswer.md)
+`answeredAt` | Date
+
+## Example
+
+```typescript
+import type { GetQuizAttemptQuestionsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "questionId": null,
+  "questionOrder": null,
+  "points": null,
+  "questionText": null,
+  "questionType": null,
+  "answerChoices": null,
+  "isAnswered": null,
+  "currentAnswer": null,
+  "answeredAt": null,
+} satisfies GetQuizAttemptQuestionsInner
+
+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 GetQuizAttemptQuestionsInner
+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/GetQuizAttemptQuestionsInnerAnswerChoicesInner.md

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

@@ -0,0 +1,41 @@
+
+# GetQuizAttemptQuestionsInnerCurrentAnswer
+
+Current saved answer (if any)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`answerChoiceId` | string
+`multipleAnswers` | Array<string>
+`textAnswer` | string
+`answeredAt` | Date
+
+## Example
+
+```typescript
+import type { GetQuizAttemptQuestionsInnerCurrentAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "answerChoiceId": null,
+  "multipleAnswers": null,
+  "textAnswer": null,
+  "answeredAt": null,
+} satisfies GetQuizAttemptQuestionsInnerCurrentAnswer
+
+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 GetQuizAttemptQuestionsInnerCurrentAnswer
+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/GetQuizAttemptQuizSettings.md

@@ -0,0 +1,45 @@
+
+# GetQuizAttemptQuizSettings
+
+Quiz settings and current state
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timeLimitMinutes` | number
+`timeRemaining` | number
+`allowReview` | boolean
+`requireAllQuestions` | boolean
+`autoSaveEnabled` | boolean
+`canSubmit` | boolean
+
+## Example
+
+```typescript
+import type { GetQuizAttemptQuizSettings } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timeLimitMinutes": null,
+  "timeRemaining": null,
+  "allowReview": null,
+  "requireAllQuestions": null,
+  "autoSaveEnabled": null,
+  "canSubmit": null,
+} satisfies GetQuizAttemptQuizSettings
+
+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 GetQuizAttemptQuizSettings
+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/GetQuizCriteria.md

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

@@ -0,0 +1,39 @@
+
+# GetQuizCriteriaEstimatedQuestions
+
+Estimated question selection counts
+
+## Properties
+
+Name | Type
+------------ | -------------
+`minQuestions` | number
+`maxQuestions` | number
+`availableQuestions` | number
+
+## Example
+
+```typescript
+import type { GetQuizCriteriaEstimatedQuestions } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "minQuestions": null,
+  "maxQuestions": null,
+  "availableQuestions": null,
+} satisfies GetQuizCriteriaEstimatedQuestions
+
+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 GetQuizCriteriaEstimatedQuestions
+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/GetQuizCriteriaItem.md

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

@@ -0,0 +1,42 @@
+
+# GetQuizCriteriaList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetQuizCriteriaListItemsInner>](GetQuizCriteriaListItemsInner.md)
+
+## Example
+
+```typescript
+import type { GetQuizCriteriaList } 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 GetQuizCriteriaList
+
+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 GetQuizCriteriaList
+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)
+
+