@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/ScormGetValueResponse.md

@@ -0,0 +1,37 @@
+
+# ScormGetValueResponse
+
+Response from getting a SCORM CMI data element value
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`value` | string
+
+## Example
+
+```typescript
+import type { ScormGetValueResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "value": null,
+} satisfies ScormGetValueResponse
+
+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 ScormGetValueResponse
+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/ScormSessionData.md

@@ -0,0 +1,43 @@
+
+# ScormSessionData
+
+Detailed SCORM session data
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [ScormSessionDataStatus](ScormSessionDataStatus.md)
+`score` | [ScormSessionDataScore](ScormSessionDataScore.md)
+`time` | [ScormSessionDataTime](ScormSessionDataTime.md)
+`session` | [ScormSessionDataSession](ScormSessionDataSession.md)
+`progress` | [ScormSessionDataProgress](ScormSessionDataProgress.md)
+
+## Example
+
+```typescript
+import type { ScormSessionData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "score": null,
+  "time": null,
+  "session": null,
+  "progress": null,
+} satisfies ScormSessionData
+
+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 ScormSessionData
+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/ScormSessionDataProgress.md

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

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

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

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

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

@@ -0,0 +1,37 @@
+
+# ScormSetValueRequest
+
+Request to set a SCORM CMI data element value
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { ScormSetValueRequest } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": cmi.core.lesson_status,
+  "value": completed,
+} satisfies ScormSetValueRequest
+
+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 ScormSetValueRequest
+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/ScormSetValueResponse.md

@@ -0,0 +1,35 @@
+
+# ScormSetValueResponse
+
+Response from setting a SCORM CMI data element value
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+
+## Example
+
+```typescript
+import type { ScormSetValueResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+} satisfies ScormSetValueResponse
+
+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 ScormSetValueResponse
+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/SingleAnswer.md

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