@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/PostContentQuizQuestionSelection.md

@@ -0,0 +1,43 @@
+
+# PostContentQuizQuestionSelection
+
+How questions are selected for this quiz
+
+## Properties
+
+Name | Type
+------------ | -------------
+`method` | string
+`questionIds` | Array<string>
+`criteria` | [CriteriaBasedSelectionCriteria](CriteriaBasedSelectionCriteria.md)
+`questionCount` | number
+`distribution` | [CriteriaBasedSelectionDistribution](CriteriaBasedSelectionDistribution.md)
+
+## Example
+
+```typescript
+import type { PostContentQuizQuestionSelection } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "method": null,
+  "questionIds": null,
+  "criteria": null,
+  "questionCount": null,
+  "distribution": null,
+} satisfies PostContentQuizQuestionSelection
+
+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 PostContentQuizQuestionSelection
+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/PostContentQuizSettings.md

@@ -0,0 +1,51 @@
+
+# PostContentQuizSettings
+
+Quiz configuration settings
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timeLimit` | number
+`maxAttempts` | number
+`passingScore` | number
+`showCorrectAnswers` | boolean
+`showExplanations` | boolean
+`randomizeQuestions` | boolean
+`randomizeAnswers` | boolean
+`allowReview` | boolean
+`instantFeedback` | boolean
+
+## Example
+
+```typescript
+import type { PostContentQuizSettings } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timeLimit": null,
+  "maxAttempts": null,
+  "passingScore": null,
+  "showCorrectAnswers": null,
+  "showExplanations": null,
+  "randomizeQuestions": null,
+  "randomizeAnswers": null,
+  "allowReview": null,
+  "instantFeedback": null,
+} satisfies PostContentQuizSettings
+
+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 PostContentQuizSettings
+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/PostContentSession.md

@@ -0,0 +1,43 @@
+
+# PostContentSession
+
+A content session
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contentId` | string
+`userId` | string
+`launchUrl` | string
+`createdAt` | number
+`playerSessionId` | string
+
+## Example
+
+```typescript
+import type { PostContentSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contentId": null,
+  "userId": null,
+  "launchUrl": null,
+  "createdAt": null,
+  "playerSessionId": null,
+} satisfies PostContentSession
+
+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 PostContentSession
+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/PostContentUpload.md

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

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

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

@@ -0,0 +1,35 @@
+
+# PostCourseExport
+
+Request to create a new SCORM export for a course
+
+## Properties
+
+Name | Type
+------------ | -------------
+`scormVersion` | string
+
+## Example
+
+```typescript
+import type { PostCourseExport } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "scormVersion": null,
+} satisfies PostCourseExport
+
+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 PostCourseExport
+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/PostLogin.md

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

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

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

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

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

@@ -0,0 +1,52 @@
+
+# PostQuestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questionText` | string
+`questionType` | string
+`answerChoices` | [Array<PostQuestionAnswerChoicesInner>](PostQuestionAnswerChoicesInner.md)
+`correctAnswer` | string
+`explanation` | string
+`topic` | string
+`course` | string
+`difficultyLevel` | string
+`tags` | Array<string>
+`version` | string
+
+## Example
+
+```typescript
+import type { PostQuestion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "questionText": null,
+  "questionType": null,
+  "answerChoices": null,
+  "correctAnswer": null,
+  "explanation": null,
+  "topic": null,
+  "course": null,
+  "difficultyLevel": null,
+  "tags": null,
+  "version": null,
+} satisfies PostQuestion
+
+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 PostQuestion
+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/PostQuestionAnswerChoicesInner.md

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

@@ -0,0 +1,58 @@
+
+# PostQuiz
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contentId` | string
+`questionSelectionMethod` | string
+`maxQuestions` | number
+`maxAttempts` | number
+`passingScore` | number
+`timeLimitMinutes` | number
+`randomizeQuestions` | boolean
+`randomizeAnswers` | boolean
+`showResults` | boolean
+`showCorrectAnswers` | boolean
+`allowReview` | boolean
+`requireAllQuestions` | boolean
+`settings` | [PostQuizSettings](PostQuizSettings.md)
+
+## Example
+
+```typescript
+import type { PostQuiz } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contentId": null,
+  "questionSelectionMethod": null,
+  "maxQuestions": null,
+  "maxAttempts": null,
+  "passingScore": null,
+  "timeLimitMinutes": null,
+  "randomizeQuestions": null,
+  "randomizeAnswers": null,
+  "showResults": null,
+  "showCorrectAnswers": null,
+  "allowReview": null,
+  "requireAllQuestions": null,
+  "settings": null,
+} satisfies PostQuiz
+
+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 PostQuiz
+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/PostQuizAttempt.md

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