@easyedu/js-lsm-api 1.29.0 → 1.31.0

package/docs/CriteriaBasedSelection.md

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

@@ -0,0 +1,42 @@
+
+# CriteriaBasedSelectionCriteria
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`topics` | Array<string>
+`difficultyLevels` | Array<string>
+`questionTypes` | Array<string>
+`tags` | Array<string>
+`course` | string
+
+## Example
+
+```typescript
+import type { CriteriaBasedSelectionCriteria } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "topics": null,
+  "difficultyLevels": null,
+  "questionTypes": null,
+  "tags": null,
+  "course": null,
+} satisfies CriteriaBasedSelectionCriteria
+
+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 CriteriaBasedSelectionCriteria
+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/CriteriaBasedSelectionDistribution.md

@@ -0,0 +1,37 @@
+
+# CriteriaBasedSelectionDistribution
+
+How to distribute selected questions
+
+## Properties
+
+Name | Type
+------------ | -------------
+`byTopic` | { [key: string]: number; }
+`byDifficulty` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { CriteriaBasedSelectionDistribution } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "byTopic": null,
+  "byDifficulty": null,
+} satisfies CriteriaBasedSelectionDistribution
+
+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 CriteriaBasedSelectionDistribution
+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/FillInBlank.md

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

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

@@ -0,0 +1,58 @@
+
+# GetContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`moduleId` | string
+`name` | string
+`description` | string
+`contentType` | string
+`contentData` | [GetContentContentData](GetContentContentData.md)
+`order` | number
+`published` | boolean
+`createdDate` | Date
+`updatedDate` | Date
+`activeVersionNumber` | number
+`activeVersionId` | string
+`hasMultipleVersions` | boolean
+
+## Example
+
+```typescript
+import type { GetContent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "moduleId": null,
+  "name": null,
+  "description": null,
+  "contentType": null,
+  "contentData": null,
+  "order": null,
+  "published": null,
+  "createdDate": null,
+  "updatedDate": null,
+  "activeVersionNumber": null,
+  "activeVersionId": null,
+  "hasMultipleVersions": null,
+} satisfies GetContent
+
+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 GetContent
+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/GetContentContentData.md

@@ -0,0 +1,53 @@
+
+# GetContentContentData
+
+Content-specific data based on content_type
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`fileSize` | number
+`mimeType` | string
+`scormVersion` | string
+`launchUrl` | string
+`manifestData` | object
+`quizType` | string
+`questionCount` | number
+`settings` | [QuizContentSettings](QuizContentSettings.md)
+`assignment` | [QuizContentAssignment](QuizContentAssignment.md)
+
+## Example
+
+```typescript
+import type { GetContentContentData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+  "fileSize": null,
+  "mimeType": null,
+  "scormVersion": null,
+  "launchUrl": null,
+  "manifestData": null,
+  "quizType": null,
+  "questionCount": null,
+  "settings": null,
+  "assignment": null,
+} satisfies GetContentContentData
+
+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 GetContentContentData
+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/GetContentGradeDetail.md

@@ -0,0 +1,50 @@
+
+# GetContentGradeDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`user` | [GetContentGradesItemsInnerUser](GetContentGradesItemsInnerUser.md)
+`completion` | string
+`gradeStatus` | string
+`createdAt` | number
+`updatedAt` | number
+`contentType` | string
+`attemptCount` | number
+`scormData` | [ScormSessionData](ScormSessionData.md)
+
+## Example
+
+```typescript
+import type { GetContentGradeDetail } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "user": null,
+  "completion": null,
+  "gradeStatus": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "contentType": null,
+  "attemptCount": null,
+  "scormData": null,
+} satisfies GetContentGradeDetail
+
+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 GetContentGradeDetail
+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/GetContentGrades.md

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

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

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

@@ -0,0 +1,38 @@
+
+# GetContentInstructorBasicReporting
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contentInfo` | [GetContentInstructorBasicReportingContentInfo](GetContentInstructorBasicReportingContentInfo.md)
+`engagement` | [GetContentInstructorBasicReportingEngagement](GetContentInstructorBasicReportingEngagement.md)
+`performance` | [GetContentInstructorBasicReportingPerformance](GetContentInstructorBasicReportingPerformance.md)
+
+## Example
+
+```typescript
+import type { GetContentInstructorBasicReporting } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contentInfo": null,
+  "engagement": null,
+  "performance": null,
+} satisfies GetContentInstructorBasicReporting
+
+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 GetContentInstructorBasicReporting
+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/GetContentInstructorBasicReportingContentInfo.md

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

@@ -0,0 +1,42 @@
+
+# GetContentInstructorBasicReportingEngagement
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`avgTimeSpentHours` | number
+`studentsCompletedCount` | number
+`studentsInProgressCount` | number
+`studentsNotStartedCount` | number
+`totalStudentsCount` | number
+
+## Example
+
+```typescript
+import type { GetContentInstructorBasicReportingEngagement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "avgTimeSpentHours": null,
+  "studentsCompletedCount": null,
+  "studentsInProgressCount": null,
+  "studentsNotStartedCount": null,
+  "totalStudentsCount": null,
+} satisfies GetContentInstructorBasicReportingEngagement
+
+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 GetContentInstructorBasicReportingEngagement
+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/GetContentInstructorBasicReportingPerformance.md

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

@@ -0,0 +1,43 @@
+
+# GetContentList
+
+A list of content within a module
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetContent>](GetContent.md)
+
+## Example
+
+```typescript
+import type { GetContentList } 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 GetContentList
+
+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 GetContentList
+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)
+
+