@easyedu/js-lsm-api 1.82.0 → 1.84.0

package/docs/GetContentLibraryVersion.md

@@ -0,0 +1,64 @@
+
+# GetContentLibraryVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`status` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
+`changeNotes` | string
+`metadata` | { [key: string]: any; }
+`filename` | string
+`mimeType` | string
+`fileSizeBytes` | number
+`checksumSha256` | string
+`linkUrl` | string
+`richText` | [RichTextDocument](RichTextDocument.md)
+`createdBy` | string
+`createdAt` | number
+`updatedAt` | number
+`publishedAt` | number
+`archivedAt` | number
+
+## Example
+
+```typescript
+import type { GetContentLibraryVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "versionNumber": null,
+  "status": null,
+  "changeNotes": null,
+  "metadata": null,
+  "filename": null,
+  "mimeType": null,
+  "fileSizeBytes": null,
+  "checksumSha256": null,
+  "linkUrl": null,
+  "richText": null,
+  "createdBy": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "publishedAt": null,
+  "archivedAt": null,
+} satisfies GetContentLibraryVersion
+
+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 GetContentLibraryVersion
+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/GetCourseVersion.md

@@ -0,0 +1,56 @@
+
+# GetCourseVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`courseId` | string
+`versionNumber` | number
+`status` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
+`name` | string
+`description` | string
+`descriptionRich` | [RichTextDocument](RichTextDocument.md)
+`changeNotes` | string
+`modules` | [Array<GetCourseVersionModule>](GetCourseVersionModule.md)
+`createdAt` | number
+`updatedAt` | number
+`publishedAt` | number
+
+## Example
+
+```typescript
+import type { GetCourseVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "courseId": null,
+  "versionNumber": null,
+  "status": null,
+  "name": null,
+  "description": null,
+  "descriptionRich": null,
+  "changeNotes": null,
+  "modules": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "publishedAt": null,
+} satisfies GetCourseVersion
+
+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 GetCourseVersion
+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/GetCourseVersionItem.md

@@ -0,0 +1,62 @@
+
+# GetCourseVersionItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`sourceKind` | string
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`resourceVersionNumber` | number
+`latestPublishedVersionId` | string
+`latestPublishedVersionNumber` | number
+`updateAvailable` | boolean
+`displayName` | string
+`displayOrder` | number
+`isVisible` | boolean
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`maxAttempts` | number
+`scoreRollupStrategy` | string
+`settings` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetCourseVersionItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "sourceKind": null,
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "resourceVersionNumber": null,
+  "latestPublishedVersionId": null,
+  "latestPublishedVersionNumber": null,
+  "updateAvailable": null,
+  "displayName": null,
+  "displayOrder": null,
+  "isVisible": null,
+  "launchMode": null,
+  "maxAttempts": null,
+  "scoreRollupStrategy": null,
+  "settings": null,
+} satisfies GetCourseVersionItem
+
+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 GetCourseVersionItem
+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/GetCourseVersionItemLaunch.md

@@ -0,0 +1,56 @@
+
+# GetCourseVersionItemLaunch
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseVersionId` | string
+`itemId` | string
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`maxAttempts` | number
+`url` | string
+`filename` | string
+`mimeType` | string
+`richText` | [RichTextDocument](RichTextDocument.md)
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetCourseVersionItemLaunch } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseVersionId": null,
+  "itemId": null,
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "resourceType": null,
+  "launchMode": null,
+  "maxAttempts": null,
+  "url": null,
+  "filename": null,
+  "mimeType": null,
+  "richText": null,
+  "metadata": null,
+} satisfies GetCourseVersionItemLaunch
+
+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 GetCourseVersionItemLaunch
+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/GetCourseVersionItemSession.md

@@ -0,0 +1,65 @@
+
+# GetCourseVersionItemSession
+
+A learner resource attempt pinned to an immutable course and Content Library version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`courseVersionId` | string
+`itemId` | string
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`launchUrl` | string
+`attemptNumber` | number
+`isCurrent` | boolean
+`completionStatus` | string
+`gradeStatus` | string
+`scoreRaw` | number
+`createdAt` | number
+`updatedAt` | number
+`completedAt` | number
+
+## Example
+
+```typescript
+import type { GetCourseVersionItemSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "courseVersionId": null,
+  "itemId": null,
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "resourceType": null,
+  "launchMode": null,
+  "launchUrl": null,
+  "attemptNumber": null,
+  "isCurrent": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "scoreRaw": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "completedAt": null,
+} satisfies GetCourseVersionItemSession
+
+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 GetCourseVersionItemSession
+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/GetCourseVersionList.md

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

@@ -0,0 +1,44 @@
+
+# GetCourseVersionModule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`descriptionRich` | [RichTextDocument](RichTextDocument.md)
+`displayOrder` | number
+`items` | [Array<GetCourseVersionItem>](GetCourseVersionItem.md)
+
+## Example
+
+```typescript
+import type { GetCourseVersionModule } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "descriptionRich": null,
+  "displayOrder": null,
+  "items": null,
+} satisfies GetCourseVersionModule
+
+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 GetCourseVersionModule
+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/GetQuizAttemptQuestionsInner.md

@@ -11,6 +11,7 @@ Name | Type
 `questionOrder` | number
 `points` | number
 `questionText` | string
+`questionTextRich` | [RichTextDocument](RichTextDocument.md)
 `questionType` | string
 `answerChoices` | [Array<GetQuizAttemptQuestionsInnerAnswerChoicesInner>](GetQuizAttemptQuestionsInnerAnswerChoicesInner.md)
 `isAnswered` | boolean
@@ -29,6 +30,7 @@ const example = {
   "questionOrder": null,
   "points": null,
   "questionText": null,
+  "questionTextRich": null,
   "questionType": null,
   "answerChoices": null,
   "isAnswered": null,

package/docs/GetQuizAttemptQuestionsInnerAnswerChoicesInner.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `text` | string
+`textRich` | [RichTextDocument](RichTextDocument.md)
 `displayOrder` | number
 
 ## Example
@@ -19,6 +20,7 @@ import type { GetQuizAttemptQuestionsInnerAnswerChoicesInner } from '@easyedu/js
 const example = {
   "id": null,
   "text": null,
+  "textRich": null,
   "displayOrder": null,
 } satisfies GetQuizAttemptQuestionsInnerAnswerChoicesInner
 

package/docs/GetQuizResultsQuestionsInner.md

@@ -9,10 +9,12 @@ Name | Type
 `questionId` | string
 `questionOrder` | number
 `questionText` | string
+`questionTextRich` | [RichTextDocument](RichTextDocument.md)
 `questionType` | string
 `answerChoices` | [Array<GetQuizResultsQuestionsInnerAnswerChoicesInner>](GetQuizResultsQuestionsInnerAnswerChoicesInner.md)
 `studentAnswer` | [GetQuizResultsQuestionsInnerStudentAnswer](GetQuizResultsQuestionsInnerStudentAnswer.md)
 `explanation` | string
+`explanationRich` | [RichTextDocument](RichTextDocument.md)
 `timeSpent` | number
 `wasFlagged` | boolean
 
@@ -26,10 +28,12 @@ const example = {
   "questionId": null,
   "questionOrder": null,
   "questionText": null,
+  "questionTextRich": null,
   "questionType": null,
   "answerChoices": null,
   "studentAnswer": null,
   "explanation": null,
+  "explanationRich": null,
   "timeSpent": null,
   "wasFlagged": null,
 } satisfies GetQuizResultsQuestionsInner

package/docs/GetQuizResultsQuestionsInnerAnswerChoicesInner.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `text` | string
+`textRich` | [RichTextDocument](RichTextDocument.md)
 `isCorrect` | boolean
 `wasSelected` | boolean
 
@@ -20,6 +21,7 @@ import type { GetQuizResultsQuestionsInnerAnswerChoicesInner } from '@easyedu/js
 const example = {
   "id": null,
   "text": null,
+  "textRich": null,
   "isCorrect": null,
   "wasSelected": null,
 } satisfies GetQuizResultsQuestionsInnerAnswerChoicesInner

package/docs/GetResource.md

@@ -0,0 +1,62 @@
+
+# GetResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`ownerId` | string
+`latestPublishedVersion` | [GetContentLibraryVersion](GetContentLibraryVersion.md)
+`draftVersion` | [GetContentLibraryVersion](GetContentLibraryVersion.md)
+`versions` | [Array<GetContentLibraryVersion>](GetContentLibraryVersion.md)
+`publishedCourseCount` | number
+`draftCourseCount` | number
+`historicalCourseCount` | number
+`activeLearnerCount` | number
+`createdAt` | number
+`updatedAt` | number
+`archivedAt` | number
+
+## Example
+
+```typescript
+import type { GetResource } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "resourceType": null,
+  "ownerId": null,
+  "latestPublishedVersion": null,
+  "draftVersion": null,
+  "versions": null,
+  "publishedCourseCount": null,
+  "draftCourseCount": null,
+  "historicalCourseCount": null,
+  "activeLearnerCount": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "archivedAt": null,
+} satisfies GetResource
+
+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 GetResource
+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/GetResourceList.md

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

@@ -0,0 +1,44 @@
+
+# GetResourceUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`resourceId` | string
+`publishedCourseCount` | number
+`draftCourseCount` | number
+`historicalCourseCount` | number
+`activeLearnerCount` | number
+`courses` | [Array<GetResourceUsageCoursesInner>](GetResourceUsageCoursesInner.md)
+
+## Example
+
+```typescript
+import type { GetResourceUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "resourceId": null,
+  "publishedCourseCount": null,
+  "draftCourseCount": null,
+  "historicalCourseCount": null,
+  "activeLearnerCount": null,
+  "courses": null,
+} satisfies GetResourceUsage
+
+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 GetResourceUsage
+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/GetResourceUsageCoursesInner.md

@@ -0,0 +1,44 @@
+
+# GetResourceUsageCoursesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`courseVersionId` | string
+`courseVersionNumber` | number
+`courseStatus` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
+`resourceVersionId` | string
+`resourceVersionNumber` | number
+
+## Example
+
+```typescript
+import type { GetResourceUsageCoursesInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "courseVersionId": null,
+  "courseVersionNumber": null,
+  "courseStatus": null,
+  "resourceVersionId": null,
+  "resourceVersionNumber": null,
+} satisfies GetResourceUsageCoursesInner
+
+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 GetResourceUsageCoursesInner
+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/GetResourceVersionUpload.md

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