@easyedu/js-lsm-api 1.90.0 → 1.91.0

package/dist/models/ResourceSessionScormApiLogItem.js

@@ -0,0 +1,81 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceSessionScormApiLogItemMethodEnum = void 0;
+exports.instanceOfResourceSessionScormApiLogItem = instanceOfResourceSessionScormApiLogItem;
+exports.ResourceSessionScormApiLogItemFromJSON = ResourceSessionScormApiLogItemFromJSON;
+exports.ResourceSessionScormApiLogItemFromJSONTyped = ResourceSessionScormApiLogItemFromJSONTyped;
+exports.ResourceSessionScormApiLogItemToJSON = ResourceSessionScormApiLogItemToJSON;
+exports.ResourceSessionScormApiLogItemToJSONTyped = ResourceSessionScormApiLogItemToJSONTyped;
+/**
+ * @export
+ */
+exports.ResourceSessionScormApiLogItemMethodEnum = {
+    Initialize: 'Initialize',
+    GetValue: 'GetValue',
+    SetValue: 'SetValue',
+    Commit: 'Commit',
+    Terminate: 'Terminate'
+};
+/**
+ * Check if a given object implements the ResourceSessionScormApiLogItem interface.
+ */
+function instanceOfResourceSessionScormApiLogItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('method' in value) || value['method'] === undefined)
+        return false;
+    if (!('valueTruncated' in value) || value['valueTruncated'] === undefined)
+        return false;
+    if (!('errorCode' in value) || value['errorCode'] === undefined)
+        return false;
+    return true;
+}
+function ResourceSessionScormApiLogItemFromJSON(json) {
+    return ResourceSessionScormApiLogItemFromJSONTyped(json, false);
+}
+function ResourceSessionScormApiLogItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'createdAt': json['created_at'],
+        'method': json['method'],
+        'element': json['element'] == null ? undefined : json['element'],
+        'value': json['value'] == null ? undefined : json['value'],
+        'valueTruncated': json['value_truncated'],
+        'errorCode': json['error_code'],
+    };
+}
+function ResourceSessionScormApiLogItemToJSON(json) {
+    return ResourceSessionScormApiLogItemToJSONTyped(json, false);
+}
+function ResourceSessionScormApiLogItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'created_at': value['createdAt'],
+        'method': value['method'],
+        'element': value['element'],
+        'value': value['value'],
+        'value_truncated': value['valueTruncated'],
+        'error_code': value['errorCode'],
+    };
+}

package/dist/models/index.d.ts

@@ -181,7 +181,16 @@ export * from './GetQuizStatistics';
 export * from './GetResource';
 export * from './GetResourceList';
 export * from './GetResourceSession';
+export * from './GetResourceSessionDiagnostics';
+export * from './GetResourceSessionDiagnosticsCourseContext';
+export * from './GetResourceSessionDiagnosticsResource';
+export * from './GetResourceSessionDiagnosticsScormSummary';
+export * from './GetResourceSessionDiagnosticsUser';
+export * from './GetResourceSessionDiagnosticsVersion';
 export * from './GetResourceSessionList';
+export * from './GetResourceSessionScormApiLogs';
+export * from './GetResourceSessionScormData';
+export * from './GetResourceSessionScormDataActivity';
 export * from './GetResourceUsage';
 export * from './GetResourceUsageCoursesInner';
 export * from './GetResourceVersionUpload';
@@ -352,6 +361,7 @@ export * from './QuizContent';
 export * from './QuizContentAssignment';
 export * from './QuizContentSettings';
 export * from './ResourceSessionEnvironment';
+export * from './ResourceSessionScormApiLogItem';
 export * from './ResourceType';
 export * from './RichTextAsset';
 export * from './RichTextDocument';

package/dist/models/index.js

@@ -199,7 +199,16 @@ __exportStar(require("./GetQuizStatistics"), exports);
 __exportStar(require("./GetResource"), exports);
 __exportStar(require("./GetResourceList"), exports);
 __exportStar(require("./GetResourceSession"), exports);
+__exportStar(require("./GetResourceSessionDiagnostics"), exports);
+__exportStar(require("./GetResourceSessionDiagnosticsCourseContext"), exports);
+__exportStar(require("./GetResourceSessionDiagnosticsResource"), exports);
+__exportStar(require("./GetResourceSessionDiagnosticsScormSummary"), exports);
+__exportStar(require("./GetResourceSessionDiagnosticsUser"), exports);
+__exportStar(require("./GetResourceSessionDiagnosticsVersion"), exports);
 __exportStar(require("./GetResourceSessionList"), exports);
+__exportStar(require("./GetResourceSessionScormApiLogs"), exports);
+__exportStar(require("./GetResourceSessionScormData"), exports);
+__exportStar(require("./GetResourceSessionScormDataActivity"), exports);
 __exportStar(require("./GetResourceUsage"), exports);
 __exportStar(require("./GetResourceUsageCoursesInner"), exports);
 __exportStar(require("./GetResourceVersionUpload"), exports);
@@ -370,6 +379,7 @@ __exportStar(require("./QuizContent"), exports);
 __exportStar(require("./QuizContentAssignment"), exports);
 __exportStar(require("./QuizContentSettings"), exports);
 __exportStar(require("./ResourceSessionEnvironment"), exports);
+__exportStar(require("./ResourceSessionScormApiLogItem"), exports);
 __exportStar(require("./ResourceType"), exports);
 __exportStar(require("./RichTextAsset"), exports);
 __exportStar(require("./RichTextDocument"), exports);

package/docs/GetResourceSession.md

@@ -9,12 +9,17 @@ Name | Type
 ------------ | -------------
 `id` | string
 `userId` | string
+`userName` | string
 `environment` | [ResourceSessionEnvironment](ResourceSessionEnvironment.md)
 `courseId` | string
+`courseName` | string
 `courseVersionId` | string
+`courseVersionNumber` | number
 `itemId` | string
 `contentLibraryItemId` | string
 `contentLibraryVersionId` | string
+`contentLibraryVersionNumber` | number
+`contentLibraryVersionStatus` | string
 `resourceName` | string
 `resourceType` | [ResourceType](ResourceType.md)
 `launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
@@ -39,12 +44,17 @@ import type { GetResourceSession } from '@easyedu/js-lsm-api'
 const example = {
   "id": null,
   "userId": null,
+  "userName": null,
   "environment": null,
   "courseId": null,
+  "courseName": null,
   "courseVersionId": null,
+  "courseVersionNumber": null,
   "itemId": null,
   "contentLibraryItemId": null,
   "contentLibraryVersionId": null,
+  "contentLibraryVersionNumber": null,
+  "contentLibraryVersionStatus": null,
   "resourceName": null,
   "resourceType": null,
   "launchMode": null,

package/docs/GetResourceSessionDiagnostics.md

@@ -0,0 +1,47 @@
+
+# GetResourceSessionDiagnostics
+
+Administrator diagnostics for a resource session and its exact resource-version pin.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`session` | [GetResourceSession](GetResourceSession.md)
+`sessionData` | { [key: string]: any; }
+`user` | [GetResourceSessionDiagnosticsUser](GetResourceSessionDiagnosticsUser.md)
+`resource` | [GetResourceSessionDiagnosticsResource](GetResourceSessionDiagnosticsResource.md)
+`version` | [GetResourceSessionDiagnosticsVersion](GetResourceSessionDiagnosticsVersion.md)
+`courseContext` | [GetResourceSessionDiagnosticsCourseContext](GetResourceSessionDiagnosticsCourseContext.md)
+`scormSummary` | [GetResourceSessionDiagnosticsScormSummary](GetResourceSessionDiagnosticsScormSummary.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionDiagnostics } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "session": null,
+  "sessionData": null,
+  "user": null,
+  "resource": null,
+  "version": null,
+  "courseContext": null,
+  "scormSummary": null,
+} satisfies GetResourceSessionDiagnostics
+
+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 GetResourceSessionDiagnostics
+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/GetResourceSessionDiagnosticsCourseContext.md

@@ -0,0 +1,50 @@
+
+# GetResourceSessionDiagnosticsCourseContext
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`courseName` | string
+`courseVersionId` | string
+`courseVersionNumber` | number
+`itemId` | string
+`displayName` | string
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`maxAttempts` | number
+`scoreRollupStrategy` | string
+
+## Example
+
+```typescript
+import type { GetResourceSessionDiagnosticsCourseContext } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "courseName": null,
+  "courseVersionId": null,
+  "courseVersionNumber": null,
+  "itemId": null,
+  "displayName": null,
+  "launchMode": null,
+  "maxAttempts": null,
+  "scoreRollupStrategy": null,
+} satisfies GetResourceSessionDiagnosticsCourseContext
+
+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 GetResourceSessionDiagnosticsCourseContext
+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/GetResourceSessionDiagnosticsResource.md

@@ -0,0 +1,40 @@
+
+# GetResourceSessionDiagnosticsResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`resourceType` | [ResourceType](ResourceType.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionDiagnosticsResource } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "resourceType": null,
+} satisfies GetResourceSessionDiagnosticsResource
+
+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 GetResourceSessionDiagnosticsResource
+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/GetResourceSessionDiagnosticsScormSummary.md

@@ -0,0 +1,48 @@
+
+# GetResourceSessionDiagnosticsScormSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`schemaVersion` | string
+`manifestIdentifier` | string
+`organizationIdentifier` | string
+`organizationTitle` | string
+`activityIdentifier` | string
+`activityTitle` | string
+`cmiElementCount` | number
+`apiLogCount` | number
+
+## Example
+
+```typescript
+import type { GetResourceSessionDiagnosticsScormSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "schemaVersion": null,
+  "manifestIdentifier": null,
+  "organizationIdentifier": null,
+  "organizationTitle": null,
+  "activityIdentifier": null,
+  "activityTitle": null,
+  "cmiElementCount": null,
+  "apiLogCount": null,
+} satisfies GetResourceSessionDiagnosticsScormSummary
+
+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 GetResourceSessionDiagnosticsScormSummary
+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/GetResourceSessionDiagnosticsUser.md

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

@@ -0,0 +1,52 @@
+
+# GetResourceSessionDiagnosticsVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`status` | string
+`changeNotes` | string
+`metadata` | { [key: string]: any; }
+`filename` | string
+`mimeType` | string
+`fileSizeBytes` | number
+`checksumSha256` | string
+`linkUrl` | string
+
+## Example
+
+```typescript
+import type { GetResourceSessionDiagnosticsVersion } 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,
+} satisfies GetResourceSessionDiagnosticsVersion
+
+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 GetResourceSessionDiagnosticsVersion
+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/GetResourceSessionScormApiLogs.md

@@ -0,0 +1,43 @@
+
+# GetResourceSessionScormApiLogs
+
+A filtered page of SCORM runtime calls for a resource session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<ResourceSessionScormApiLogItem>](ResourceSessionScormApiLogItem.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionScormApiLogs } 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 GetResourceSessionScormApiLogs
+
+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 GetResourceSessionScormApiLogs
+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/GetResourceSessionScormData.md

@@ -0,0 +1,49 @@
+
+# GetResourceSessionScormData
+
+Current SCORM CMI state for a reusable resource session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`scormVersion` | string
+`createdAt` | number
+`updatedAt` | number
+`initializedAt` | number
+`terminatedAt` | number
+`activity` | [GetResourceSessionScormDataActivity](GetResourceSessionScormDataActivity.md)
+`cmiData` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { GetResourceSessionScormData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "scormVersion": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "initializedAt": null,
+  "terminatedAt": null,
+  "activity": null,
+  "cmiData": null,
+} satisfies GetResourceSessionScormData
+
+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 GetResourceSessionScormData
+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/GetResourceSessionScormDataActivity.md

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