@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/GetCourseEnrollmentListItem.md

@@ -0,0 +1,53 @@
+
+# GetCourseEnrollmentListItem
+
+A course enrollment in a list view
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`courseId` | string
+`userId` | string
+`firstName` | string
+`lastName` | string
+`enrollmentDateStart` | number
+`enrollmentDateEnd` | number
+`status` | string
+`userType` | string
+`completionDate` | number
+
+## Example
+
+```typescript
+import type { GetCourseEnrollmentListItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "courseId": null,
+  "userId": null,
+  "firstName": null,
+  "lastName": null,
+  "enrollmentDateStart": null,
+  "enrollmentDateEnd": null,
+  "status": null,
+  "userType": null,
+  "completionDate": null,
+} satisfies GetCourseEnrollmentListItem
+
+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 GetCourseEnrollmentListItem
+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/GetCourseExport.md

@@ -0,0 +1,49 @@
+
+# GetCourseExport
+
+Details of a course SCORM export
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`courseId` | string
+`scormVersion` | string
+`status` | string
+`downloadUrl` | string
+`fileSize` | number
+`errorMessage` | string
+`createdAt` | number
+
+## Example
+
+```typescript
+import type { GetCourseExport } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "courseId": null,
+  "scormVersion": null,
+  "status": null,
+  "downloadUrl": null,
+  "fileSize": null,
+  "errorMessage": null,
+  "createdAt": null,
+} satisfies GetCourseExport
+
+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 GetCourseExport
+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/GetCourseExportList.md

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

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

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

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

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

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

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

@@ -0,0 +1,48 @@
+
+# GetManualQuestionSelectionItem
+
+
+## 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 { GetManualQuestionSelectionItem } 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 GetManualQuestionSelectionItem
+
+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 GetManualQuestionSelectionItem
+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/GetManualQuestionSelectionList.md

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

@@ -0,0 +1,44 @@
+
+# GetModule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`order` | number
+`lastUpdated` | number
+`published` | boolean
+
+## Example
+
+```typescript
+import type { GetModule } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "order": null,
+  "lastUpdated": null,
+  "published": null,
+} satisfies GetModule
+
+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 GetModule
+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/GetModuleInstructorBasicReporting.md

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

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

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

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