@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/PostQuizAttemptAttempt.md

@@ -0,0 +1,55 @@
+
+# PostQuizAttemptAttempt
+
+Created quiz attempt details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`userId` | string
+`quizId` | string
+`contentId` | string
+`attemptNumber` | number
+`status` | string
+`startedAt` | Date
+`timeLimitAt` | Date
+`totalQuestions` | number
+`totalPoints` | number
+
+## Example
+
+```typescript
+import type { PostQuizAttemptAttempt } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "userId": null,
+  "quizId": null,
+  "contentId": null,
+  "attemptNumber": null,
+  "status": null,
+  "startedAt": null,
+  "timeLimitAt": null,
+  "totalQuestions": null,
+  "totalPoints": null,
+} satisfies PostQuizAttemptAttempt
+
+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 PostQuizAttemptAttempt
+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/PostQuizAttemptQuestionsInner.md

@@ -0,0 +1,48 @@
+
+# PostQuizAttemptQuestionsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`questionId` | string
+`questionOrder` | number
+`points` | number
+`questionText` | string
+`questionType` | string
+`answerChoices` | [Array<PostQuizAttemptQuestionsInnerAnswerChoicesInner>](PostQuizAttemptQuestionsInnerAnswerChoicesInner.md)
+`isAnswered` | boolean
+
+## Example
+
+```typescript
+import type { PostQuizAttemptQuestionsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "questionId": null,
+  "questionOrder": null,
+  "points": null,
+  "questionText": null,
+  "questionType": null,
+  "answerChoices": null,
+  "isAnswered": null,
+} satisfies PostQuizAttemptQuestionsInner
+
+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 PostQuizAttemptQuestionsInner
+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/PostQuizAttemptQuestionsInnerAnswerChoicesInner.md

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

@@ -0,0 +1,45 @@
+
+# PostQuizAttemptQuizSettings
+
+Quiz settings for this attempt
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timeLimitMinutes` | number
+`randomizeQuestions` | boolean
+`randomizeAnswers` | boolean
+`allowReview` | boolean
+`requireAllQuestions` | boolean
+`autoSaveEnabled` | boolean
+
+## Example
+
+```typescript
+import type { PostQuizAttemptQuizSettings } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timeLimitMinutes": null,
+  "randomizeQuestions": null,
+  "randomizeAnswers": null,
+  "allowReview": null,
+  "requireAllQuestions": null,
+  "autoSaveEnabled": null,
+} satisfies PostQuizAttemptQuizSettings
+
+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 PostQuizAttemptQuizSettings
+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/PostQuizAttemptSubmit.md

@@ -0,0 +1,38 @@
+
+# PostQuizAttemptSubmit
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`submissionType` | string
+`finalAnswers` | [Array<PostQuizAttemptSubmitFinalAnswersInner>](PostQuizAttemptSubmitFinalAnswersInner.md)
+`submittedAt` | Date
+
+## Example
+
+```typescript
+import type { PostQuizAttemptSubmit } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "submissionType": null,
+  "finalAnswers": null,
+  "submittedAt": null,
+} satisfies PostQuizAttemptSubmit
+
+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 PostQuizAttemptSubmit
+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/PostQuizAttemptSubmitFinalAnswersInner.md

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

@@ -0,0 +1,41 @@
+
+# PostQuizAttemptSubmitFinalAnswersInnerAnswer
+
+Final answer for this question
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`answerChoiceId` | string
+`answerChoiceIds` | Array<string>
+`textAnswer` | string
+
+## Example
+
+```typescript
+import type { PostQuizAttemptSubmitFinalAnswersInnerAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "answerChoiceId": null,
+  "answerChoiceIds": null,
+  "textAnswer": null,
+} satisfies PostQuizAttemptSubmitFinalAnswersInnerAnswer
+
+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 PostQuizAttemptSubmitFinalAnswersInnerAnswer
+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/PostQuizCriteria.md

@@ -0,0 +1,36 @@
+
+# PostQuizCriteria
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`criteria` | [Array<PostQuizCriteriaCriteriaInner>](PostQuizCriteriaCriteriaInner.md)
+`replaceExisting` | boolean
+
+## Example
+
+```typescript
+import type { PostQuizCriteria } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "criteria": null,
+  "replaceExisting": null,
+} satisfies PostQuizCriteria
+
+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 PostQuizCriteria
+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/PostQuizCriteriaCriteriaInner.md

@@ -0,0 +1,49 @@
+
+# PostQuizCriteriaCriteriaInner
+
+Question selection criteria
+
+## Properties
+
+Name | Type
+------------ | -------------
+`topic` | string
+`difficultyLevel` | string
+`questionType` | string
+`tags` | Array<string>
+`course` | string
+`minQuestions` | number
+`maxQuestions` | number
+`priority` | number
+
+## Example
+
+```typescript
+import type { PostQuizCriteriaCriteriaInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "topic": null,
+  "difficultyLevel": null,
+  "questionType": null,
+  "tags": null,
+  "course": null,
+  "minQuestions": null,
+  "maxQuestions": null,
+  "priority": null,
+} satisfies PostQuizCriteriaCriteriaInner
+
+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 PostQuizCriteriaCriteriaInner
+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/PostQuizQuestions.md

@@ -0,0 +1,36 @@
+
+# PostQuizQuestions
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questions` | [Array<PostQuizQuestionsQuestionsInner>](PostQuizQuestionsQuestionsInner.md)
+`replaceExisting` | boolean
+
+## Example
+
+```typescript
+import type { PostQuizQuestions } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "questions": null,
+  "replaceExisting": null,
+} satisfies PostQuizQuestions
+
+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 PostQuizQuestions
+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/PostQuizQuestionsQuestionsInner.md

@@ -0,0 +1,40 @@
+
+# PostQuizQuestionsQuestionsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questionId` | string
+`points` | number
+`questionOrder` | number
+`versionLocked` | boolean
+
+## Example
+
+```typescript
+import type { PostQuizQuestionsQuestionsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "questionId": null,
+  "points": null,
+  "questionOrder": null,
+  "versionLocked": null,
+} satisfies PostQuizQuestionsQuestionsInner
+
+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 PostQuizQuestionsQuestionsInner
+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/PostQuizSettings.md

@@ -0,0 +1,41 @@
+
+# PostQuizSettings
+
+Additional quiz settings as JSON
+
+## Properties
+
+Name | Type
+------------ | -------------
+`autoSaveInterval` | number
+`showQuestionNumbers` | boolean
+`allowBacktrack` | boolean
+`showProgress` | boolean
+
+## Example
+
+```typescript
+import type { PostQuizSettings } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "autoSaveInterval": null,
+  "showQuestionNumbers": null,
+  "allowBacktrack": null,
+  "showProgress": null,
+} satisfies PostQuizSettings
+
+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 PostQuizSettings
+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/PostResetPassword.md

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

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

@@ -0,0 +1,59 @@
+
+# PostVerifyManifest
+
+Response from parsing and verifying a SCORM manifest
+
+## Properties
+
+Name | Type
+------------ | -------------
+`valid` | boolean
+`errors` | Array<string>
+`warnings` | Array<string>
+`scormVersion` | string
+`identifier` | string
+`version` | string
+`title` | string
+`schema` | string
+`schemaVersion` | string
+`defaultOrganization` | string
+`items` | [Array<PostVerifyManifestItemsInner>](PostVerifyManifestItemsInner.md)
+`resources` | [Array<PostVerifyManifestResourcesInner>](PostVerifyManifestResourcesInner.md)
+`entryPoints` | Array<string>
+
+## Example
+
+```typescript
+import type { PostVerifyManifest } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "valid": null,
+  "errors": null,
+  "warnings": null,
+  "scormVersion": null,
+  "identifier": null,
+  "version": null,
+  "title": null,
+  "schema": null,
+  "schemaVersion": null,
+  "defaultOrganization": null,
+  "items": null,
+  "resources": null,
+  "entryPoints": null,
+} satisfies PostVerifyManifest
+
+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 PostVerifyManifest
+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/PostVerifyManifestItemsInner.md

@@ -0,0 +1,48 @@
+
+# PostVerifyManifestItemsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identifier` | string
+`identifierRef` | string
+`title` | string
+`masteryScore` | string
+`maxTimeAllowed` | string
+`timeLimitAction` | string
+`dataFromLms` | string
+`minNormalizedMeasure` | string
+
+## Example
+
+```typescript
+import type { PostVerifyManifestItemsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "identifier": null,
+  "identifierRef": null,
+  "title": null,
+  "masteryScore": null,
+  "maxTimeAllowed": null,
+  "timeLimitAction": null,
+  "dataFromLms": null,
+  "minNormalizedMeasure": null,
+} satisfies PostVerifyManifestItemsInner
+
+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 PostVerifyManifestItemsInner
+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)
+
+