@easyedu/js-lsm-api 1.78.0 → 1.80.0

package/docs/GetUserCourseListItemProgress.md

@@ -0,0 +1,39 @@
+
+# GetUserCourseListItemProgress
+
+Learner progress for an enrolled user\'s course list item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completionPercentage` | number
+`completedContentCount` | number
+`totalContentCount` | number
+
+## Example
+
+```typescript
+import type { GetUserCourseListItemProgress } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completionPercentage": null,
+  "completedContentCount": null,
+  "totalContentCount": null,
+} satisfies GetUserCourseListItemProgress
+
+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 GetUserCourseListItemProgress
+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

@@ -14,6 +14,32 @@ Name | Type
 `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

@@ -15,8 +15,8 @@ Name | Type
 `courseName` | string
 `attemptNumber` | number
 `status` | string
-`startedAt` | string
-`completedAt` | string
+`startedAt` | Date
+`completedAt` | Date
 `totalQuestions` | number
 `questionsAnswered` | number
 `correctAnswers` | number
@@ -26,6 +26,44 @@ Name | Type
 `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

@@ -15,6 +15,32 @@ Name | Type
 `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)
 

package/docs/GetUserQuizAttemptsAllOfSummary.md

@@ -15,6 +15,32 @@ Name | Type
 `averageScore` | number
 `totalTimeHours` | number
 
+## Example
+
+```typescript
+import type { GetUserQuizAttemptsAllOfSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalAttempts": null,
+  "completedAttempts": null,
+  "inProgressAttempts": null,
+  "passedAttempts": null,
+  "failedAttempts": null,
+  "averageScore": null,
+  "totalTimeHours": null,
+} satisfies GetUserQuizAttemptsAllOfSummary
+
+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 GetUserQuizAttemptsAllOfSummary
+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/GetUserRole.md

@@ -12,6 +12,29 @@ Name | Type
 `baseType` | string
 `isSystem` | boolean
 
+## Example
+
+```typescript
+import type { GetUserRole } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "baseType": null,
+  "isSystem": null,
+} satisfies GetUserRole
+
+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 GetUserRole
+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/LoginRes.md

@@ -9,6 +9,27 @@ Name | Type
 `authData` | [LoginResAuthData](LoginResAuthData.md)
 `userData` | [LoginResUserData](LoginResUserData.md)
 
+## Example
+
+```typescript
+import type { LoginRes } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "authData": null,
+  "userData": null,
+} satisfies LoginRes
+
+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 LoginRes
+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/LoginResAuthData.md

@@ -9,6 +9,27 @@ Name | Type
 `token` | string
 `exp` | number
 
+## Example
+
+```typescript
+import type { LoginResAuthData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "token": null,
+  "exp": null,
+} satisfies LoginResAuthData
+
+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 LoginResAuthData
+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/LoginResUserData.md

@@ -11,6 +11,29 @@ Name | Type
 `userRole` | string
 `selectedPortal` | [LoginResUserDataSelectedPortal](LoginResUserDataSelectedPortal.md)
 
+## Example
+
+```typescript
+import type { LoginResUserData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "userFullName": null,
+  "userRole": null,
+  "selectedPortal": null,
+} satisfies LoginResUserData
+
+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 LoginResUserData
+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/LoginResUserDataSelectedPortal.md

@@ -9,6 +9,27 @@ Name | Type
 `portalName` | string
 `portalId` | string
 
+## Example
+
+```typescript
+import type { LoginResUserDataSelectedPortal } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portalName": null,
+  "portalId": null,
+} satisfies LoginResUserDataSelectedPortal
+
+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 LoginResUserDataSelectedPortal
+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/ManualSelection.md

@@ -9,6 +9,27 @@ Name | Type
 `method` | string
 `questionIds` | Array<string>
 
+## Example
+
+```typescript
+import type { ManualSelection } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "method": null,
+  "questionIds": null,
+} satisfies ManualSelection
+
+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 ManualSelection
+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/Matching.md

@@ -9,6 +9,27 @@ Name | Type
 `type` | string
 `pairs` | [Array<MatchingPairsInner>](MatchingPairsInner.md)
 
+## Example
+
+```typescript
+import type { Matching } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "pairs": null,
+} satisfies Matching
+
+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 Matching
+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/Matching1.md

@@ -9,6 +9,27 @@ Name | Type
 `type` | string
 `pairs` | [Array<Matching1PairsInner>](Matching1PairsInner.md)
 
+## Example
+
+```typescript
+import type { Matching1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "pairs": null,
+} satisfies Matching1
+
+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 Matching1
+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/Matching1PairsInner.md

@@ -9,6 +9,27 @@ Name | Type
 `premiseId` | number
 `responseId` | number
 
+## Example
+
+```typescript
+import type { Matching1PairsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "premiseId": null,
+  "responseId": null,
+} satisfies Matching1PairsInner
+
+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 Matching1PairsInner
+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/MatchingPairsInner.md

@@ -9,6 +9,27 @@ Name | Type
 `premiseId` | number
 `responseId` | number
 
+## Example
+
+```typescript
+import type { MatchingPairsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "premiseId": null,
+  "responseId": null,
+} satisfies MatchingPairsInner
+
+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 MatchingPairsInner
+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/MediaContent.md

@@ -10,6 +10,28 @@ Name | Type
 `fileSize` | number
 `mimeType` | string
 
+## Example
+
+```typescript
+import type { MediaContent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+  "fileSize": null,
+  "mimeType": null,
+} satisfies MediaContent
+
+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 MediaContent
+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/MultipleAnswer.md

@@ -9,6 +9,27 @@ Name | Type
 `type` | string
 `answerChoiceIds` | Array<string>
 
+## Example
+
+```typescript
+import type { MultipleAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "answerChoiceIds": null,
+} satisfies MultipleAnswer
+
+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 MultipleAnswer
+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/MultipleAnswer1.md

@@ -9,6 +9,27 @@ Name | Type
 `type` | string
 `answerChoiceIds` | Array<string>
 
+## Example
+
+```typescript
+import type { MultipleAnswer1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "answerChoiceIds": null,
+} satisfies MultipleAnswer1
+
+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 MultipleAnswer1
+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/NoAnswer.md

@@ -8,6 +8,26 @@ Name | Type
 ------------ | -------------
 `type` | string
 
+## Example
+
+```typescript
+import type { NoAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+} satisfies NoAnswer
+
+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 NoAnswer
+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/Paginated.md

@@ -11,6 +11,29 @@ Name | Type
 `totalPages` | number
 `totalItems` | number
 
+## Example
+
+```typescript
+import type { Paginated } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+} satisfies Paginated
+
+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 Paginated
+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/PortalApi.md

@@ -974,7 +974,7 @@ async function example() {
   const body = {
     // string
     portalId: portalId_example,
-    // Blob | Avatar image file (PNG, JPEG, or SVG). Max 2MB.
+    // Blob | Favicon image file (PNG, ICO, or SVG). Max 1MB.
     file: BINARY_DATA_HERE,
   } satisfies PostPortalFaviconUploadRequest;
 
@@ -996,7 +996,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **portalId** | `string` |  | [Defaults to `undefined`] |
-| **file** | `Blob` | Avatar image file (PNG, JPEG, or SVG). Max 2MB. | [Defaults to `undefined`] |
+| **file** | `Blob` | Favicon image file (PNG, ICO, or SVG). Max 1MB. | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -1044,7 +1044,7 @@ async function example() {
   const body = {
     // string
     portalId: portalId_example,
-    // Blob | Avatar image file (PNG, JPEG, or SVG). Max 2MB.
+    // Blob | Logo image file (PNG, JPEG, or SVG). Max 5MB.
     file: BINARY_DATA_HERE,
   } satisfies PostPortalLogoUploadRequest;
 
@@ -1066,7 +1066,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **portalId** | `string` |  | [Defaults to `undefined`] |
-| **file** | `Blob` | Avatar image file (PNG, JPEG, or SVG). Max 2MB. | [Defaults to `undefined`] |
+| **file** | `Blob` | Logo image file (PNG, JPEG, or SVG). Max 5MB. | [Defaults to `undefined`] |
 
 ### Return type