@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/GetModuleList.md

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

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

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

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

@@ -0,0 +1,48 @@
+
+# GetPortal
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`parentPortalId` | string
+`logoUrl` | string
+`headerBackgroundColor` | string
+`headerTextColor` | string
+`selectedUserRole` | string
+`baseUserRole` | string
+
+## Example
+
+```typescript
+import type { GetPortal } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "parentPortalId": null,
+  "logoUrl": null,
+  "headerBackgroundColor": null,
+  "headerTextColor": null,
+  "selectedUserRole": null,
+  "baseUserRole": null,
+} satisfies GetPortal
+
+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 GetPortal
+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/GetPortalBasicReporting.md

@@ -0,0 +1,36 @@
+
+# GetPortalBasicReporting
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portalInfo` | [GetPortalBasicReportingPortalInfo](GetPortalBasicReportingPortalInfo.md)
+`certificates` | [GetPortalBasicReportingCertificates](GetPortalBasicReportingCertificates.md)
+
+## Example
+
+```typescript
+import type { GetPortalBasicReporting } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portalInfo": null,
+  "certificates": null,
+} satisfies GetPortalBasicReporting
+
+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 GetPortalBasicReporting
+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/GetPortalBasicReportingCertificates.md

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

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

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

@@ -0,0 +1,36 @@
+
+# GetPortalStudentReporting
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portalInfo` | [GetPortalStudentReportingPortalInfo](GetPortalStudentReportingPortalInfo.md)
+`certificates` | [GetPortalStudentReportingCertificates](GetPortalStudentReportingCertificates.md)
+
+## Example
+
+```typescript
+import type { GetPortalStudentReporting } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portalInfo": null,
+  "certificates": null,
+} satisfies GetPortalStudentReporting
+
+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 GetPortalStudentReporting
+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/GetPortalStudentReportingCertificates.md

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

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

@@ -0,0 +1,45 @@
+
+# GetPortalUser
+
+A user with their portal access information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`email` | string
+`firstName` | string
+`lastName` | string
+`role` | string
+`isActive` | boolean
+
+## Example
+
+```typescript
+import type { GetPortalUser } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "email": null,
+  "firstName": null,
+  "lastName": null,
+  "role": null,
+  "isActive": null,
+} satisfies GetPortalUser
+
+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 GetPortalUser
+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/GetPortalUserList.md

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

@@ -0,0 +1,62 @@
+
+# GetQuestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`questionText` | string
+`questionType` | string
+`answerChoices` | [Array<GetQuestionAnswerChoicesInner>](GetQuestionAnswerChoicesInner.md)
+`correctAnswer` | string
+`explanation` | string
+`topic` | string
+`course` | string
+`difficultyLevel` | string
+`tags` | Array<string>
+`version` | string
+`createdDate` | Date
+`updatedDate` | Date
+`createdBy` | string
+`quizCount` | number
+
+## Example
+
+```typescript
+import type { GetQuestion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "questionText": null,
+  "questionType": null,
+  "answerChoices": null,
+  "correctAnswer": null,
+  "explanation": null,
+  "topic": null,
+  "course": null,
+  "difficultyLevel": null,
+  "tags": null,
+  "version": null,
+  "createdDate": null,
+  "updatedDate": null,
+  "createdBy": null,
+  "quizCount": null,
+} satisfies GetQuestion
+
+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 GetQuestion
+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/GetQuestionAnswerChoicesInner.md

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