@easyedu/js-lsm-api 1.117.0 → 1.119.0

package/docs/PostDispatchItemLaunchResponse.md

@@ -0,0 +1,42 @@
+
+# PostDispatchItemLaunchResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`itemId` | string
+`kind` | string
+`sessionId` | string
+`attemptNumber` | number
+`launchUrl` | string
+
+## Example
+
+```typescript
+import type { PostDispatchItemLaunchResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "itemId": null,
+  "kind": null,
+  "sessionId": null,
+  "attemptNumber": null,
+  "launchUrl": null,
+} satisfies PostDispatchItemLaunchResponse
+
+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 PostDispatchItemLaunchResponse
+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/PostDispatchLaunch.md

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

@@ -0,0 +1,44 @@
+
+# PostDispatchLaunchResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runtimeMode` | string
+`launchUrl` | string
+`token` | string
+`launchCode` | string
+`registrationId` | string
+`expiresAt` | number
+
+## Example
+
+```typescript
+import type { PostDispatchLaunchResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runtimeMode": null,
+  "launchUrl": null,
+  "token": null,
+  "launchCode": null,
+  "registrationId": null,
+  "expiresAt": null,
+} satisfies PostDispatchLaunchResponse
+
+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 PostDispatchLaunchResponse
+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/PostDispatchTokenExchange.md

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

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

@@ -9,6 +9,8 @@ Name | Type
 ------------ | -------------
 `success` | boolean
 `value` | string
+`errorCode` | string
+`diagnostic` | string
 
 ## Example
 
@@ -19,6 +21,8 @@ import type { ScormGetValueResponse } from '@easyedu/js-lsm-api'
 const example = {
   "success": null,
   "value": null,
+  "errorCode": null,
+  "diagnostic": null,
 } satisfies ScormGetValueResponse
 
 console.log(example)

package/docs/ScormNavigationDelivery.md

@@ -0,0 +1,43 @@
+
+# ScormNavigationDelivery
+
+Activity selected exclusively by the sequencing engine
+
+## Properties
+
+Name | Type
+------------ | -------------
+`activityIdentifier` | string
+`trackingUuid` | string
+`launchUrl` | string
+`title` | string
+`activityType` | string
+
+## Example
+
+```typescript
+import type { ScormNavigationDelivery } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "activityIdentifier": null,
+  "trackingUuid": null,
+  "launchUrl": null,
+  "title": null,
+  "activityType": null,
+} satisfies ScormNavigationDelivery
+
+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 ScormNavigationDelivery
+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/ScormNavigationRequest.md

@@ -0,0 +1,37 @@
+
+# ScormNavigationRequest
+
+A SCORM 2004 navigation request
+
+## Properties
+
+Name | Type
+------------ | -------------
+`request` | string
+`targetIdentifier` | string
+
+## Example
+
+```typescript
+import type { ScormNavigationRequest } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "request": null,
+  "targetIdentifier": null,
+} satisfies ScormNavigationRequest
+
+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 ScormNavigationRequest
+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/ScormNavigationResponse.md

@@ -0,0 +1,47 @@
+
+# ScormNavigationResponse
+
+Result of a SCORM 2004 sequencing transition
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`delivery` | [ScormNavigationDelivery](ScormNavigationDelivery.md)
+`sequencingEnded` | boolean
+`suspended` | boolean
+`valid` | [ScormNavigationValidity](ScormNavigationValidity.md)
+`errorCode` | string
+`diagnostic` | string
+
+## Example
+
+```typescript
+import type { ScormNavigationResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "delivery": null,
+  "sequencingEnded": null,
+  "suspended": null,
+  "valid": null,
+  "errorCode": null,
+  "diagnostic": null,
+} satisfies ScormNavigationResponse
+
+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 ScormNavigationResponse
+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/ScormNavigationValidity.md

@@ -0,0 +1,55 @@
+
+# ScormNavigationValidity
+
+Navigation requests valid in the resulting sequencing state
+
+## Properties
+
+Name | Type
+------------ | -------------
+`start` | boolean
+`resumeAll` | boolean
+`_continue` | boolean
+`previous` | boolean
+`exit` | boolean
+`exitAll` | boolean
+`abandon` | boolean
+`abandonAll` | boolean
+`suspendAll` | boolean
+`choiceTargets` | Array<string>
+`jumpTargets` | Array<string>
+
+## Example
+
+```typescript
+import type { ScormNavigationValidity } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "start": null,
+  "resumeAll": null,
+  "_continue": null,
+  "previous": null,
+  "exit": null,
+  "exitAll": null,
+  "abandon": null,
+  "abandonAll": null,
+  "suspendAll": null,
+  "choiceTargets": null,
+  "jumpTargets": null,
+} satisfies ScormNavigationValidity
+
+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 ScormNavigationValidity
+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/ScormRuntimeResponse.md

@@ -0,0 +1,39 @@
+
+# ScormRuntimeResponse
+
+Typed result of a SCORM runtime API operation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`errorCode` | string
+`diagnostic` | string
+
+## Example
+
+```typescript
+import type { ScormRuntimeResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "errorCode": null,
+  "diagnostic": null,
+} satisfies ScormRuntimeResponse
+
+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 ScormRuntimeResponse
+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

@@ -8,6 +8,8 @@ Response from setting a SCORM CMI data element value
 Name | Type
 ------------ | -------------
 `success` | boolean
+`errorCode` | string
+`diagnostic` | string
 
 ## Example
 
@@ -17,6 +19,8 @@ import type { ScormSetValueResponse } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "success": null,
+  "errorCode": null,
+  "diagnostic": null,
 } satisfies ScormSetValueResponse
 
 console.log(example)

package/docs/ScormTerminateResponse.md

@@ -0,0 +1,44 @@
+
+# ScormTerminateResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`errorCode` | string
+`diagnostic` | string
+`delivery` | [ScormNavigationDelivery](ScormNavigationDelivery.md)
+`sequencingEnded` | boolean
+`suspended` | boolean
+
+## Example
+
+```typescript
+import type { ScormTerminateResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "errorCode": null,
+  "diagnostic": null,
+  "delivery": null,
+  "sequencingEnded": null,
+  "suspended": null,
+} satisfies ScormTerminateResponse
+
+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 ScormTerminateResponse
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.117.0",
+  "version": "1.119.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {