@easyedu/js-lsm-api 1.94.0 → 1.96.0

package/docs/GetQuizCriteria.md

@@ -1,38 +0,0 @@
-
-# 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

@@ -1,39 +0,0 @@
-
-# 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

@@ -1,56 +0,0 @@
-
-# GetQuizCriteriaItem
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`externalId` | string
-`topic` | string
-`difficultyLevel` | string
-`questionType` | string
-`tags` | Array<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,
-  "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

@@ -1,42 +0,0 @@
-
-# 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)
-
-

package/docs/GetQuizCriteriaListItemsInner.md

@@ -1,56 +0,0 @@
-
-# GetQuizCriteriaListItemsInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`externalId` | string
-`topic` | string
-`difficultyLevel` | string
-`questionType` | string
-`tags` | Array<string>
-`minQuestions` | number
-`maxQuestions` | number
-`priority` | number
-`matchingQuestionsCount` | number
-`createdAt` | Date
-`updatedAt` | Date
-
-## Example
-
-```typescript
-import type { GetQuizCriteriaListItemsInner } 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,
-  "minQuestions": null,
-  "maxQuestions": null,
-  "priority": null,
-  "matchingQuestionsCount": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies GetQuizCriteriaListItemsInner
-
-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 GetQuizCriteriaListItemsInner
-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/GetQuizList.md

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

@@ -1,43 +0,0 @@
-
-# GetQuizListAllOfFilters
-
-Available filters for quiz listing
-
-## Properties
-
-Name | Type
------------- | -------------
-`courseId` | string
-`moduleId` | string
-`questionSelectionMethod` | string
-`hasAttempts` | boolean
-`search` | string
-
-## Example
-
-```typescript
-import type { GetQuizListAllOfFilters } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "courseId": null,
-  "moduleId": null,
-  "questionSelectionMethod": null,
-  "hasAttempts": null,
-  "search": null,
-} satisfies GetQuizListAllOfFilters
-
-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 GetQuizListAllOfFilters
-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/GetQuizListAllOfQuizzes.md

@@ -1,64 +0,0 @@
-
-# GetQuizListAllOfQuizzes
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`externalId` | string
-`contentId` | string
-`contentName` | string
-`contentDescription` | string
-`moduleId` | string
-`moduleName` | string
-`courseId` | string
-`courseName` | string
-`questionSelectionMethod` | string
-`maxAttempts` | number
-`passingScore` | number
-`timeLimitMinutes` | number
-`statistics` | [GetQuizListAllOfStatistics](GetQuizListAllOfStatistics.md)
-`createdAt` | Date
-`updatedAt` | Date
-
-## Example
-
-```typescript
-import type { GetQuizListAllOfQuizzes } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "externalId": null,
-  "contentId": null,
-  "contentName": null,
-  "contentDescription": null,
-  "moduleId": null,
-  "moduleName": null,
-  "courseId": null,
-  "courseName": null,
-  "questionSelectionMethod": null,
-  "maxAttempts": null,
-  "passingScore": null,
-  "timeLimitMinutes": null,
-  "statistics": null,
-  "createdAt": null,
-  "updatedAt": null,
-} satisfies GetQuizListAllOfQuizzes
-
-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 GetQuizListAllOfQuizzes
-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/GetQuizListAllOfStatistics.md

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

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

@@ -1,48 +0,0 @@
-
-# GetQuizQuestionsItemsInner
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`id` | string
-`questionId` | string
-`questionExternalId` | string
-`questionOrder` | number
-`points` | number
-`versionLocked` | boolean
-`questionDetails` | [GetQuizQuestionsItemsInnerQuestionDetails](GetQuizQuestionsItemsInnerQuestionDetails.md)
-`createdAt` | Date
-
-## Example
-
-```typescript
-import type { GetQuizQuestionsItemsInner } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "questionId": null,
-  "questionExternalId": null,
-  "questionOrder": null,
-  "points": null,
-  "versionLocked": null,
-  "questionDetails": null,
-  "createdAt": null,
-} satisfies GetQuizQuestionsItemsInner
-
-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 GetQuizQuestionsItemsInner
-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/GetQuizQuestionsItemsInnerQuestionDetails.md

@@ -1,51 +0,0 @@
-
-# GetQuizQuestionsItemsInnerQuestionDetails
-
-Question details including all metadata
-
-## Properties
-
-Name | Type
------------- | -------------
-`questionText` | string
-`questionType` | string
-`topic` | string
-`difficultyLevel` | string
-`explanation` | string
-`tags` | Array<string>
-`versionNumber` | number
-`isLatestVersion` | boolean
-`answerChoices` | [Array<GetQuizQuestionsItemsInnerQuestionDetailsAnswerChoicesInner>](GetQuizQuestionsItemsInnerQuestionDetailsAnswerChoicesInner.md)
-
-## Example
-
-```typescript
-import type { GetQuizQuestionsItemsInnerQuestionDetails } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "questionText": null,
-  "questionType": null,
-  "topic": null,
-  "difficultyLevel": null,
-  "explanation": null,
-  "tags": null,
-  "versionNumber": null,
-  "isLatestVersion": null,
-  "answerChoices": null,
-} satisfies GetQuizQuestionsItemsInnerQuestionDetails
-
-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 GetQuizQuestionsItemsInnerQuestionDetails
-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/GetQuizQuestionsItemsInnerQuestionDetailsAnswerChoicesInner.md

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

@@ -1,52 +0,0 @@
-
-# GetQuizResults
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`sessionId` | string
-`attemptId` | string
-`contentId` | string
-`userId` | string
-`attemptNumber` | number
-`status` | string
-`score` | [GetQuizResultsScore](GetQuizResultsScore.md)
-`timing` | [GetQuizResultsTiming](GetQuizResultsTiming.md)
-`questions` | [Array<GetQuizResultsQuestionsInner>](GetQuizResultsQuestionsInner.md)
-`feedback` | [GetQuizResultsFeedback](GetQuizResultsFeedback.md)
-
-## Example
-
-```typescript
-import type { GetQuizResults } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "sessionId": null,
-  "attemptId": null,
-  "contentId": null,
-  "userId": null,
-  "attemptNumber": null,
-  "status": null,
-  "score": null,
-  "timing": null,
-  "questions": null,
-  "feedback": null,
-} satisfies GetQuizResults
-
-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 GetQuizResults
-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)
-
-