@easyedu/js-lsm-api 1.29.0 → 1.31.0

package/docs/PostVerifyManifestResourcesInner.md

@@ -0,0 +1,42 @@
+
+# PostVerifyManifestResourcesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identifier` | string
+`resourceType` | string
+`scormType` | string
+`href` | string
+`files` | Array<string>
+
+## Example
+
+```typescript
+import type { PostVerifyManifestResourcesInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "identifier": null,
+  "resourceType": null,
+  "scormType": null,
+  "href": null,
+  "files": null,
+} satisfies PostVerifyManifestResourcesInner
+
+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 PostVerifyManifestResourcesInner
+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/PutContent.md

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

@@ -0,0 +1,35 @@
+
+# PutContentVersion
+
+Request to update a content version
+
+## Properties
+
+Name | Type
+------------ | -------------
+`isActive` | boolean
+
+## Example
+
+```typescript
+import type { PutContentVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "isActive": null,
+} satisfies PutContentVersion
+
+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 PutContentVersion
+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/PutCourse.md

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

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

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

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

@@ -0,0 +1,52 @@
+
+# PutQuestion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`questionText` | string
+`questionType` | string
+`answerChoices` | [Array<PutQuestionAnswerChoicesInner>](PutQuestionAnswerChoicesInner.md)
+`correctAnswer` | string
+`explanation` | string
+`topic` | string
+`course` | string
+`difficultyLevel` | string
+`tags` | Array<string>
+`version` | string
+
+## Example
+
+```typescript
+import type { PutQuestion } 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 PutQuestion
+
+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 PutQuestion
+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/PutQuestionAnswerChoicesInner.md

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

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

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

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

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

@@ -0,0 +1,42 @@
+
+# PutUser
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`firstName` | string
+`lastName` | string
+`email` | string
+`lastUpdated` | string
+
+## Example
+
+```typescript
+import type { PutUser } 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 PutUser
+
+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 PutUser
+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)
+
+