@easyedu/js-lsm-api 1.110.0 → 1.112.0

package/docs/GetEffectiveLearnerExperience.md

@@ -0,0 +1,40 @@
+
+# GetEffectiveLearnerExperience
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`effectiveSource` | string
+`effectiveSourcePortalId` | string
+`versionId` | string
+`designDocument` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetEffectiveLearnerExperience } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "effectiveSource": null,
+  "effectiveSourcePortalId": null,
+  "versionId": null,
+  "designDocument": null,
+} satisfies GetEffectiveLearnerExperience
+
+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 GetEffectiveLearnerExperience
+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/GetLearnerDashboard.md

@@ -0,0 +1,38 @@
+
+# GetLearnerDashboard
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`experience` | [GetEffectiveLearnerExperience](GetEffectiveLearnerExperience.md)
+`summary` | [GetLearnerDashboardSummary](GetLearnerDashboardSummary.md)
+`courseLists` | [Array<GetLearnerDashboardCourseList>](GetLearnerDashboardCourseList.md)
+
+## Example
+
+```typescript
+import type { GetLearnerDashboard } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "experience": null,
+  "summary": null,
+  "courseLists": null,
+} satisfies GetLearnerDashboard
+
+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 GetLearnerDashboard
+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/GetLearnerDashboardCourseList.md

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

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

@@ -0,0 +1,42 @@
+
+# GetLearnerExperience
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`effectiveSource` | string
+`effectiveSourcePortalId` | string
+`effectiveVersion` | [LearnerExperienceVersion](LearnerExperienceVersion.md)
+`draftVersion` | [LearnerExperienceVersion](LearnerExperienceVersion.md)
+`versions` | [Array<LearnerExperienceVersion>](LearnerExperienceVersion.md)
+
+## Example
+
+```typescript
+import type { GetLearnerExperience } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "effectiveSource": null,
+  "effectiveSourcePortalId": null,
+  "effectiveVersion": null,
+  "draftVersion": null,
+  "versions": null,
+} satisfies GetLearnerExperience
+
+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 GetLearnerExperience
+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/GetLearnerExperiencePreview.md

@@ -0,0 +1,36 @@
+
+# GetLearnerExperiencePreview
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`designDocument` | { [key: string]: any; }
+`assetIds` | Array<string>
+
+## Example
+
+```typescript
+import type { GetLearnerExperiencePreview } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "designDocument": null,
+  "assetIds": null,
+} satisfies GetLearnerExperiencePreview
+
+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 GetLearnerExperiencePreview
+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

@@ -20,6 +20,7 @@ Name | Type
 `createdBy` | string
 `quizCount` | number
 `quizzes` | [Array<GetQuestionQuizzesInner>](GetQuestionQuizzesInner.md)
+`importSource` | [QuestionImportSourceSummary](QuestionImportSourceSummary.md)
 
 ## Example
 
@@ -42,6 +43,7 @@ const example = {
   "createdBy": null,
   "quizCount": null,
   "quizzes": null,
+  "importSource": null,
 } satisfies GetQuestion
 
 console.log(example)