@easyedu/js-lsm-api 1.76.0 → 1.78.0

package/docs/GetRole.md

@@ -16,33 +16,6 @@ Name | Type
 `isActive` | boolean
 `permissions` | [Array<GetPermission>](GetPermission.md)
 
-## Example
-
-```typescript
-import type { GetRole } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "name": null,
-  "description": null,
-  "baseType": null,
-  "portalId": null,
-  "isSystem": null,
-  "isActive": null,
-  "permissions": null,
-} satisfies GetRole
-
-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 GetRole
-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

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

@@ -13,30 +13,6 @@ Name | Type
 `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

@@ -10,27 +10,6 @@ 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

@@ -18,41 +18,9 @@ Name | Type
 `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)
-```
+`createdAt` | string
+`updatedAt` | string
+
 
 [[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

@@ -13,30 +13,6 @@ Name | Type
 `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

@@ -9,27 +9,6 @@ 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/GetSupportTicket.md

@@ -21,39 +21,6 @@ Name | Type
 `updatedAt` | number
 `closedAt` | number
 
-## Example
-
-```typescript
-import type { GetSupportTicket } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "portalId": null,
-  "subject": null,
-  "description": null,
-  "status": null,
-  "priority": null,
-  "category": null,
-  "reporter": null,
-  "assignedTo": null,
-  "commentCount": null,
-  "attachments": null,
-  "createdAt": null,
-  "updatedAt": null,
-  "closedAt": null,
-} satisfies GetSupportTicket
-
-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 GetSupportTicket
-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/GetSupportTicketAttachment.md

@@ -13,31 +13,6 @@ Name | Type
 `downloadUrl` | string
 `createdAt` | number
 
-## Example
-
-```typescript
-import type { GetSupportTicketAttachment } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "fileName": null,
-  "fileSize": null,
-  "mimeType": null,
-  "downloadUrl": null,
-  "createdAt": null,
-} satisfies GetSupportTicketAttachment
-
-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 GetSupportTicketAttachment
-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/GetSupportTicketComment.md

@@ -12,30 +12,6 @@ Name | Type
 `isInternal` | boolean
 `createdAt` | number
 
-## Example
-
-```typescript
-import type { GetSupportTicketComment } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "id": null,
-  "user": null,
-  "content": null,
-  "isInternal": null,
-  "createdAt": null,
-} satisfies GetSupportTicketComment
-
-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 GetSupportTicketComment
-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/GetSupportTicketList.md

@@ -12,30 +12,6 @@ Name | Type
 `totalItems` | number
 `items` | [Array<GetSupportTicket>](GetSupportTicket.md)
 
-## Example
-
-```typescript
-import type { GetSupportTicketList } 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 GetSupportTicketList
-
-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 GetSupportTicketList
-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/GetSystemBillingItem.md

@@ -17,34 +17,6 @@ Name | Type
 `currency` | string
 `renewalAt` | number
 
-## Example
-
-```typescript
-import type { GetSystemBillingItem } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "portalId": null,
-  "portalName": null,
-  "plan": null,
-  "status": null,
-  "seatLimit": null,
-  "activeEnrollmentCount": null,
-  "monthlyAmountCents": null,
-  "currency": null,
-  "renewalAt": null,
-} satisfies GetSystemBillingItem
-
-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 GetSystemBillingItem
-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/GetSystemBillingList.md

@@ -12,30 +12,6 @@ Name | Type
 `totalItems` | number
 `items` | [Array<GetSystemBillingItem>](GetSystemBillingItem.md)
 
-## Example
-
-```typescript
-import type { GetSystemBillingList } 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 GetSystemBillingList
-
-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 GetSystemBillingList
-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/GetSystemMetrics.md

@@ -12,29 +12,6 @@ Name | Type
 `courseCount` | number
 `openSupportTicketCount` | number
 
-## Example
-
-```typescript
-import type { GetSystemMetrics } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "portalCount": null,
-  "userCount": null,
-  "courseCount": null,
-  "openSupportTicketCount": null,
-} satisfies GetSystemMetrics
-
-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 GetSystemMetrics
-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

@@ -13,31 +13,6 @@ Name | Type
 `avatarUrl` | 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,
-  "avatarUrl": 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/GetUserAvatarUpload.md

@@ -8,26 +8,6 @@ Name | Type
 ------------ | -------------
 `avatarUrl` | string
 
-## Example
-
-```typescript
-import type { GetUserAvatarUpload } from '@easyedu/js-lsm-api'
-
-// TODO: Update the object below with actual values
-const example = {
-  "avatarUrl": null,
-} satisfies GetUserAvatarUpload
-
-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 GetUserAvatarUpload
-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,32 +14,6 @@ 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` | Date
-`completedAt` | Date
+`startedAt` | string
+`completedAt` | string
 `totalQuestions` | number
 `questionsAnswered` | number
 `correctAnswers` | number
@@ -26,44 +26,6 @@ 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,32 +15,6 @@ 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,32 +15,6 @@ 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)