@easyedu/js-lsm-api 1.90.0 → 1.92.0

package/docs/GetCourseVersionItem.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `sourceKind` | string
+`contentLibraryKind` | string
 `contentLibraryItemId` | string
 `contentLibraryVersionId` | string
 `resourceVersionNumber` | number
@@ -31,6 +32,7 @@ import type { GetCourseVersionItem } from '@easyedu/js-lsm-api'
 const example = {
   "id": null,
   "sourceKind": null,
+  "contentLibraryKind": null,
   "contentLibraryItemId": null,
   "contentLibraryVersionId": null,
   "resourceVersionNumber": null,

package/docs/GetLibraryQuiz.md

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

@@ -0,0 +1,46 @@
+
+# GetLibraryQuizAnalytics
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`quizId` | string
+`totalAttempts` | number
+`completedAttempts` | number
+`pendingReviewAttempts` | number
+`averageScore` | number
+`passRate` | number
+`averageDurationSeconds` | number
+
+## Example
+
+```typescript
+import type { GetLibraryQuizAnalytics } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "quizId": null,
+  "totalAttempts": null,
+  "completedAttempts": null,
+  "pendingReviewAttempts": null,
+  "averageScore": null,
+  "passRate": null,
+  "averageDurationSeconds": null,
+} satisfies GetLibraryQuizAnalytics
+
+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 GetLibraryQuizAnalytics
+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/GetLibraryQuizList.md

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

@@ -0,0 +1,54 @@
+
+# GetLibraryQuizResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sessionId` | string
+`status` | string
+`totalQuestions` | number
+`questionsAnswered` | number
+`correctAnswers` | number
+`totalPoints` | number
+`pointsEarned` | number
+`scorePercentage` | number
+`passed` | boolean
+`pendingManualGrading` | boolean
+`questions` | Array<{ [key: string]: any; }>
+
+## Example
+
+```typescript
+import type { GetLibraryQuizResult } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sessionId": null,
+  "status": null,
+  "totalQuestions": null,
+  "questionsAnswered": null,
+  "correctAnswers": null,
+  "totalPoints": null,
+  "pointsEarned": null,
+  "scorePercentage": null,
+  "passed": null,
+  "pendingManualGrading": null,
+  "questions": null,
+} satisfies GetLibraryQuizResult
+
+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 GetLibraryQuizResult
+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/GetLibraryQuizSession.md

@@ -0,0 +1,78 @@
+
+# GetLibraryQuizSession
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`userId` | string
+`environment` | [ResourceSessionEnvironment](ResourceSessionEnvironment.md)
+`courseId` | string
+`courseVersionId` | string
+`itemId` | string
+`quizId` | string
+`quizVersionId` | string
+`quizVersionNumber` | number
+`quizName` | string
+`attemptNumber` | number
+`isCurrent` | boolean
+`status` | string
+`questionsAnswered` | number
+`totalQuestions` | number
+`scorePercentage` | number
+`passed` | boolean
+`timeLimitAt` | number
+`launchUrl` | string
+`questions` | [Array<LibraryQuizSessionQuestion>](LibraryQuizSessionQuestion.md)
+`createdAt` | number
+`updatedAt` | number
+`completedAt` | number
+
+## Example
+
+```typescript
+import type { GetLibraryQuizSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "userId": null,
+  "environment": null,
+  "courseId": null,
+  "courseVersionId": null,
+  "itemId": null,
+  "quizId": null,
+  "quizVersionId": null,
+  "quizVersionNumber": null,
+  "quizName": null,
+  "attemptNumber": null,
+  "isCurrent": null,
+  "status": null,
+  "questionsAnswered": null,
+  "totalQuestions": null,
+  "scorePercentage": null,
+  "passed": null,
+  "timeLimitAt": null,
+  "launchUrl": null,
+  "questions": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "completedAt": null,
+} satisfies GetLibraryQuizSession
+
+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 GetLibraryQuizSession
+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/GetLibraryQuizSessionList.md

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

@@ -0,0 +1,42 @@
+
+# GetLibraryQuizUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`quizId` | string
+`publishedCourseCount` | number
+`draftCourseCount` | number
+`historicalCourseCount` | number
+`activeLearnerCount` | number
+
+## Example
+
+```typescript
+import type { GetLibraryQuizUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "quizId": null,
+  "publishedCourseCount": null,
+  "draftCourseCount": null,
+  "historicalCourseCount": null,
+  "activeLearnerCount": null,
+} satisfies GetLibraryQuizUsage
+
+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 GetLibraryQuizUsage
+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/GetLibraryQuizVersion.md

@@ -0,0 +1,78 @@
+
+# GetLibraryQuizVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`status` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
+`changeNotes` | string
+`questionSelectionMethod` | [QuestionSelectionMethod](QuestionSelectionMethod.md)
+`maxQuestions` | number
+`passingScore` | number
+`timeLimitMinutes` | number
+`randomizeQuestions` | boolean
+`randomizeAnswers` | boolean
+`showResults` | boolean
+`showCorrectAnswers` | boolean
+`allowReview` | boolean
+`requireAllQuestions` | boolean
+`settings` | { [key: string]: any; }
+`questions` | [Array<LibraryQuizQuestion>](LibraryQuizQuestion.md)
+`criteria` | [Array<LibraryQuizCriterion>](LibraryQuizCriterion.md)
+`questionCount` | number
+`createdBy` | string
+`createdAt` | number
+`updatedAt` | number
+`publishedAt` | number
+`archivedAt` | number
+
+## Example
+
+```typescript
+import type { GetLibraryQuizVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "versionNumber": null,
+  "status": null,
+  "changeNotes": null,
+  "questionSelectionMethod": null,
+  "maxQuestions": null,
+  "passingScore": null,
+  "timeLimitMinutes": null,
+  "randomizeQuestions": null,
+  "randomizeAnswers": null,
+  "showResults": null,
+  "showCorrectAnswers": null,
+  "allowReview": null,
+  "requireAllQuestions": null,
+  "settings": null,
+  "questions": null,
+  "criteria": null,
+  "questionCount": null,
+  "createdBy": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "publishedAt": null,
+  "archivedAt": null,
+} satisfies GetLibraryQuizVersion
+
+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 GetLibraryQuizVersion
+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/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)
+
+