@easyedu/js-lsm-api 1.30.0 → 1.32.0

package/docs/GetQuizResultsQuestionsInnerAnswerChoicesInner.md

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

@@ -0,0 +1,43 @@
+
+# GetQuizResultsQuestionsInnerStudentAnswer
+
+Student\'s answer and scoring
+
+## Properties
+
+Name | Type
+------------ | -------------
+`selectedChoices` | Array<string>
+`textAnswer` | string
+`isCorrect` | boolean
+`pointsEarned` | number
+`pointsPossible` | number
+
+## Example
+
+```typescript
+import type { GetQuizResultsQuestionsInnerStudentAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "selectedChoices": null,
+  "textAnswer": null,
+  "isCorrect": null,
+  "pointsEarned": null,
+  "pointsPossible": null,
+} satisfies GetQuizResultsQuestionsInnerStudentAnswer
+
+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 GetQuizResultsQuestionsInnerStudentAnswer
+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/GetQuizResultsScore.md

@@ -0,0 +1,41 @@
+
+# GetQuizResultsScore
+
+Scoring information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pointsEarned` | number
+`totalPoints` | number
+`percentage` | number
+`passed` | boolean
+
+## Example
+
+```typescript
+import type { GetQuizResultsScore } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pointsEarned": null,
+  "totalPoints": null,
+  "percentage": null,
+  "passed": null,
+} satisfies GetQuizResultsScore
+
+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 GetQuizResultsScore
+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/GetQuizResultsTiming.md

@@ -0,0 +1,43 @@
+
+# GetQuizResultsTiming
+
+Timing information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`startedAt` | Date
+`submittedAt` | Date
+`timeLimit` | number
+`timeSpent` | number
+`timeRemaining` | number
+
+## Example
+
+```typescript
+import type { GetQuizResultsTiming } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "startedAt": null,
+  "submittedAt": null,
+  "timeLimit": null,
+  "timeSpent": null,
+  "timeRemaining": null,
+} satisfies GetQuizResultsTiming
+
+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 GetQuizResultsTiming
+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/GetQuizStatistics.md

@@ -0,0 +1,43 @@
+
+# GetQuizStatistics
+
+Quiz performance statistics
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalAttempts` | number
+`totalCompletions` | number
+`averageScore` | number
+`passRate` | number
+`averageTime` | number
+
+## Example
+
+```typescript
+import type { GetQuizStatistics } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalAttempts": null,
+  "totalCompletions": null,
+  "averageScore": null,
+  "passRate": null,
+  "averageTime": null,
+} satisfies GetQuizStatistics
+
+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 GetQuizStatistics
+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/GetScormApiLogItem.md

@@ -0,0 +1,45 @@
+
+# GetScormApiLogItem
+
+A SCORM API call log entry
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`createdAt` | number
+`method` | string
+`element` | string
+`value` | string
+`errorCode` | string
+
+## Example
+
+```typescript
+import type { GetScormApiLogItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdAt": null,
+  "method": null,
+  "element": null,
+  "value": null,
+  "errorCode": null,
+} satisfies GetScormApiLogItem
+
+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 GetScormApiLogItem
+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/GetScormApiLogs.md

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

@@ -0,0 +1,37 @@
+
+# GetScormPackage
+
+Details of a SCORM package
+
+## Properties
+
+Name | Type
+------------ | -------------
+`packageInfo` | [GetScormPackagePackageInfo](GetScormPackagePackageInfo.md)
+`tableOfContents` | object
+
+## Example
+
+```typescript
+import type { GetScormPackage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "packageInfo": null,
+  "tableOfContents": null,
+} satisfies GetScormPackage
+
+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 GetScormPackage
+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/GetScormPackagePackageInfo.md

@@ -0,0 +1,59 @@
+
+# GetScormPackagePackageInfo
+
+Information about the SCORM package
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`version` | number
+`isActive` | boolean
+`manifestIdentifier` | string
+`manifestVersion` | string
+`organizationIdentifier` | string
+`organizationTitle` | string
+`scormVersion` | string
+`storageKey` | string
+`totalFileCount` | number
+`packageSizeBytes` | number
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { GetScormPackagePackageInfo } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "version": null,
+  "isActive": null,
+  "manifestIdentifier": null,
+  "manifestVersion": null,
+  "organizationIdentifier": null,
+  "organizationTitle": null,
+  "scormVersion": null,
+  "storageKey": null,
+  "totalFileCount": null,
+  "packageSizeBytes": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies GetScormPackagePackageInfo
+
+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 GetScormPackagePackageInfo
+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/GetScormSessionData.md

@@ -0,0 +1,43 @@
+
+# GetScormSessionData
+
+SCORM session data with CMI information
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`createdAt` | number
+`updatedAt` | number
+`cmiData` | { [key: string]: any; }
+`activity` | [GetScormSessionDataActivity](GetScormSessionDataActivity.md)
+
+## Example
+
+```typescript
+import type { GetScormSessionData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "cmiData": null,
+  "activity": null,
+} satisfies GetScormSessionData
+
+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 GetScormSessionData
+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/GetScormSessionDataActivity.md

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

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

@@ -0,0 +1,46 @@
+
+# GetUserQuizAttempts
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`attempts` | [Array<GetUserQuizAttemptsAllOfAttempts>](GetUserQuizAttemptsAllOfAttempts.md)
+`filters` | [GetUserQuizAttemptsAllOfFilters](GetUserQuizAttemptsAllOfFilters.md)
+`summary` | [GetUserQuizAttemptsAllOfSummary](GetUserQuizAttemptsAllOfSummary.md)
+
+## Example
+
+```typescript
+import type { GetUserQuizAttempts } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "attempts": null,
+  "filters": null,
+  "summary": null,
+} satisfies GetUserQuizAttempts
+
+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 GetUserQuizAttempts
+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/GetUserQuizAttemptsAllOfAttempts.md

@@ -0,0 +1,70 @@
+
+# GetUserQuizAttemptsAllOfAttempts
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`quizId` | string
+`contentId` | string
+`contentName` | string
+`moduleName` | string
+`courseName` | string
+`attemptNumber` | number
+`status` | string
+`startedAt` | Date
+`completedAt` | Date
+`totalQuestions` | number
+`questionsAnswered` | number
+`correctAnswers` | number
+`scorePercentage` | number
+`passed` | boolean
+`timeSpentSeconds` | number
+`canRetake` | boolean
+`attemptsRemaining` | number
+
+## Example
+
+```typescript
+import type { GetUserQuizAttemptsAllOfAttempts } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "quizId": null,
+  "contentId": null,
+  "contentName": null,
+  "moduleName": null,
+  "courseName": null,
+  "attemptNumber": null,
+  "status": null,
+  "startedAt": null,
+  "completedAt": null,
+  "totalQuestions": null,
+  "questionsAnswered": null,
+  "correctAnswers": null,
+  "scorePercentage": null,
+  "passed": null,
+  "timeSpentSeconds": null,
+  "canRetake": null,
+  "attemptsRemaining": null,
+} satisfies GetUserQuizAttemptsAllOfAttempts
+
+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 GetUserQuizAttemptsAllOfAttempts
+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/GetUserQuizAttemptsAllOfFilters.md

@@ -0,0 +1,47 @@
+
+# GetUserQuizAttemptsAllOfFilters
+
+Available filters
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`moduleId` | string
+`quizId` | string
+`status` | string
+`passed` | boolean
+`dateRange` | [GetQuizAttemptListAllOfFiltersDateRange](GetQuizAttemptListAllOfFiltersDateRange.md)
+`search` | string
+
+## Example
+
+```typescript
+import type { GetUserQuizAttemptsAllOfFilters } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "moduleId": null,
+  "quizId": null,
+  "status": null,
+  "passed": null,
+  "dateRange": null,
+  "search": null,
+} satisfies GetUserQuizAttemptsAllOfFilters
+
+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 GetUserQuizAttemptsAllOfFilters
+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)
+
+