@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/GetContentSession.md

@@ -0,0 +1,45 @@
+
+# GetContentSession
+
+A content session
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contentId` | string
+`userId` | string
+`createdAt` | number
+`updatedAt` | number
+`completionStatus` | string
+`gradeStatus` | string
+
+## Example
+
+```typescript
+import type { GetContentSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contentId": null,
+  "userId": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+} satisfies GetContentSession
+
+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 GetContentSession
+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/GetContentSessionDetail.md

@@ -0,0 +1,51 @@
+
+# GetContentSessionDetail
+
+Detailed content session information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`createdAt` | number
+`updatedAt` | number
+`contentId` | string
+`completionStatus` | string
+`gradeStatus` | string
+`durationInSeconds` | number
+`userData` | [GetContentSessionDetailUserData](GetContentSessionDetailUserData.md)
+`scormSessionData` | [Array<GetContentSessionDetailScormSessionDataInner>](GetContentSessionDetailScormSessionDataInner.md)
+
+## Example
+
+```typescript
+import type { GetContentSessionDetail } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "contentId": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "durationInSeconds": null,
+  "userData": null,
+  "scormSessionData": null,
+} satisfies GetContentSessionDetail
+
+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 GetContentSessionDetail
+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/GetContentSessionDetailScormSessionDataInner.md

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

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

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

@@ -0,0 +1,45 @@
+
+# GetContentSessionListItem
+
+A content session list item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`createdAt` | number
+`updatedAt` | number
+`contentId` | string
+`userData` | [GetContentSessionDetailUserData](GetContentSessionDetailUserData.md)
+`scormSessionData` | [GetContentSessionListItemScormSessionData](GetContentSessionListItemScormSessionData.md)
+
+## Example
+
+```typescript
+import type { GetContentSessionListItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "contentId": null,
+  "userData": null,
+  "scormSessionData": null,
+} satisfies GetContentSessionListItem
+
+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 GetContentSessionListItem
+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/GetContentSessionListItemScormSessionData.md

@@ -0,0 +1,35 @@
+
+# GetContentSessionListItemScormSessionData
+
+SCORM session data if this is a SCORM session, null otherwise
+
+## Properties
+
+Name | Type
+------------ | -------------
+`scormSessionId` | string
+
+## Example
+
+```typescript
+import type { GetContentSessionListItemScormSessionData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "scormSessionId": null,
+} satisfies GetContentSessionListItemScormSessionData
+
+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 GetContentSessionListItemScormSessionData
+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/GetContentUpload.md

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

@@ -0,0 +1,49 @@
+
+# GetContentVersion
+
+Details of a specific content version
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`contentId` | string
+`version` | number
+`isActive` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+`sandbox` | [GetContentVersionSandbox](GetContentVersionSandbox.md)
+`scormData` | [GetContentVersionScormData](GetContentVersionScormData.md)
+
+## Example
+
+```typescript
+import type { GetContentVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "contentId": null,
+  "version": null,
+  "isActive": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "sandbox": null,
+  "scormData": null,
+} satisfies GetContentVersion
+
+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 GetContentVersion
+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/GetContentVersionList.md

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

@@ -0,0 +1,42 @@
+
+# GetContentVersionListItemsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`version` | number
+`isActive` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { GetContentVersionListItemsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "version": null,
+  "isActive": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies GetContentVersionListItemsInner
+
+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 GetContentVersionListItemsInner
+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/GetContentVersionSandbox.md

@@ -0,0 +1,35 @@
+
+# GetContentVersionSandbox
+
+Sandbox data for this version
+
+## Properties
+
+Name | Type
+------------ | -------------
+`launchUrl` | string
+
+## Example
+
+```typescript
+import type { GetContentVersionSandbox } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "launchUrl": null,
+} satisfies GetContentVersionSandbox
+
+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 GetContentVersionSandbox
+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/GetContentVersionScormData.md

@@ -0,0 +1,35 @@
+
+# GetContentVersionScormData
+
+SCORM-specific data (only present for SCORM content type)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`scormPackageId` | string
+
+## Example
+
+```typescript
+import type { GetContentVersionScormData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "scormPackageId": null,
+} satisfies GetContentVersionScormData
+
+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 GetContentVersionScormData
+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/GetCourse.md

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

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

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