@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/docs/EmailTemplateDefinition.md

@@ -0,0 +1,44 @@
+
+# EmailTemplateDefinition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`displayName` | string
+`description` | string
+`scope` | [EmailTemplateScope](EmailTemplateScope.md)
+`variables` | [Array<EmailTemplateVariable>](EmailTemplateVariable.md)
+`requiredBlockTypes` | Array<string>
+
+## Example
+
+```typescript
+import type { EmailTemplateDefinition } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "displayName": null,
+  "description": null,
+  "scope": null,
+  "variables": null,
+  "requiredBlockTypes": null,
+} satisfies EmailTemplateDefinition
+
+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 EmailTemplateDefinition
+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/EmailTemplateScope.md

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

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

@@ -0,0 +1,56 @@
+
+# EmailTemplateVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`status` | string
+`subjectTemplate` | string
+`preheaderTemplate` | string
+`fromNameTemplate` | string
+`replyTo` | string
+`designDocument` | { [key: string]: any; }
+`changeNotes` | string
+`createdAt` | number
+`updatedAt` | number
+`publishedAt` | number
+
+## Example
+
+```typescript
+import type { EmailTemplateVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "versionNumber": null,
+  "status": null,
+  "subjectTemplate": null,
+  "preheaderTemplate": null,
+  "fromNameTemplate": null,
+  "replyTo": null,
+  "designDocument": null,
+  "changeNotes": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "publishedAt": null,
+} satisfies EmailTemplateVersion
+
+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 EmailTemplateVersion
+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/GetContentLibraryVersion.md

@@ -0,0 +1,64 @@
+
+# GetContentLibraryVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`versionNumber` | number
+`status` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
+`changeNotes` | string
+`metadata` | { [key: string]: any; }
+`filename` | string
+`mimeType` | string
+`fileSizeBytes` | number
+`checksumSha256` | string
+`linkUrl` | string
+`richText` | [RichTextDocument](RichTextDocument.md)
+`createdBy` | string
+`createdAt` | number
+`updatedAt` | number
+`publishedAt` | number
+`archivedAt` | number
+
+## Example
+
+```typescript
+import type { GetContentLibraryVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "versionNumber": null,
+  "status": null,
+  "changeNotes": null,
+  "metadata": null,
+  "filename": null,
+  "mimeType": null,
+  "fileSizeBytes": null,
+  "checksumSha256": null,
+  "linkUrl": null,
+  "richText": null,
+  "createdBy": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "publishedAt": null,
+  "archivedAt": null,
+} satisfies GetContentLibraryVersion
+
+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 GetContentLibraryVersion
+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/GetCourseVersion.md

@@ -0,0 +1,56 @@
+
+# GetCourseVersion
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`courseId` | string
+`versionNumber` | number
+`status` | [ContentLibraryVersionStatus](ContentLibraryVersionStatus.md)
+`name` | string
+`description` | string
+`descriptionRich` | [RichTextDocument](RichTextDocument.md)
+`changeNotes` | string
+`modules` | [Array<GetCourseVersionModule>](GetCourseVersionModule.md)
+`createdAt` | number
+`updatedAt` | number
+`publishedAt` | number
+
+## Example
+
+```typescript
+import type { GetCourseVersion } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "courseId": null,
+  "versionNumber": null,
+  "status": null,
+  "name": null,
+  "description": null,
+  "descriptionRich": null,
+  "changeNotes": null,
+  "modules": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "publishedAt": null,
+} satisfies GetCourseVersion
+
+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 GetCourseVersion
+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/GetCourseVersionItem.md

@@ -0,0 +1,62 @@
+
+# GetCourseVersionItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`sourceKind` | string
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`resourceVersionNumber` | number
+`latestPublishedVersionId` | string
+`latestPublishedVersionNumber` | number
+`updateAvailable` | boolean
+`displayName` | string
+`displayOrder` | number
+`isVisible` | boolean
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`maxAttempts` | number
+`scoreRollupStrategy` | string
+`settings` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetCourseVersionItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "sourceKind": null,
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "resourceVersionNumber": null,
+  "latestPublishedVersionId": null,
+  "latestPublishedVersionNumber": null,
+  "updateAvailable": null,
+  "displayName": null,
+  "displayOrder": null,
+  "isVisible": null,
+  "launchMode": null,
+  "maxAttempts": null,
+  "scoreRollupStrategy": null,
+  "settings": null,
+} satisfies GetCourseVersionItem
+
+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 GetCourseVersionItem
+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/GetCourseVersionItemLaunch.md

@@ -0,0 +1,56 @@
+
+# GetCourseVersionItemLaunch
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseVersionId` | string
+`itemId` | string
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`maxAttempts` | number
+`url` | string
+`filename` | string
+`mimeType` | string
+`richText` | [RichTextDocument](RichTextDocument.md)
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GetCourseVersionItemLaunch } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseVersionId": null,
+  "itemId": null,
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "resourceType": null,
+  "launchMode": null,
+  "maxAttempts": null,
+  "url": null,
+  "filename": null,
+  "mimeType": null,
+  "richText": null,
+  "metadata": null,
+} satisfies GetCourseVersionItemLaunch
+
+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 GetCourseVersionItemLaunch
+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/GetCourseVersionItemSession.md

@@ -0,0 +1,65 @@
+
+# GetCourseVersionItemSession
+
+A learner resource attempt pinned to an immutable course and Content Library version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`courseVersionId` | string
+`itemId` | string
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`launchUrl` | string
+`attemptNumber` | number
+`isCurrent` | boolean
+`completionStatus` | string
+`gradeStatus` | string
+`scoreRaw` | number
+`createdAt` | number
+`updatedAt` | number
+`completedAt` | number
+
+## Example
+
+```typescript
+import type { GetCourseVersionItemSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "courseVersionId": null,
+  "itemId": null,
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "resourceType": null,
+  "launchMode": null,
+  "launchUrl": null,
+  "attemptNumber": null,
+  "isCurrent": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "scoreRaw": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "completedAt": null,
+} satisfies GetCourseVersionItemSession
+
+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 GetCourseVersionItemSession
+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/GetCourseVersionList.md

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

@@ -0,0 +1,44 @@
+
+# GetCourseVersionModule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`descriptionRich` | [RichTextDocument](RichTextDocument.md)
+`displayOrder` | number
+`items` | [Array<GetCourseVersionItem>](GetCourseVersionItem.md)
+
+## Example
+
+```typescript
+import type { GetCourseVersionModule } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "descriptionRich": null,
+  "displayOrder": null,
+  "items": null,
+} satisfies GetCourseVersionModule
+
+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 GetCourseVersionModule
+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/GetEmailAssetUpload.md

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

@@ -0,0 +1,60 @@
+
+# GetEmailDelivery
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`templateKey` | string
+`templateVersionId` | string
+`recipient` | string
+`isTest` | boolean
+`status` | string
+`attempts` | number
+`providerMessageId` | string
+`lastErrorCode` | string
+`lastErrorMessage` | string
+`createdAt` | number
+`acceptedAt` | number
+`deliveredAt` | number
+`failedAt` | number
+
+## Example
+
+```typescript
+import type { GetEmailDelivery } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "templateKey": null,
+  "templateVersionId": null,
+  "recipient": null,
+  "isTest": null,
+  "status": null,
+  "attempts": null,
+  "providerMessageId": null,
+  "lastErrorCode": null,
+  "lastErrorMessage": null,
+  "createdAt": null,
+  "acceptedAt": null,
+  "deliveredAt": null,
+  "failedAt": null,
+} satisfies GetEmailDelivery
+
+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 GetEmailDelivery
+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/GetEmailDeliveryList.md

@@ -0,0 +1,40 @@
+
+# GetEmailDeliveryList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<GetEmailDelivery>](GetEmailDelivery.md)
+`total` | number
+`page` | number
+`pageSize` | number
+
+## Example
+
+```typescript
+import type { GetEmailDeliveryList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "page": null,
+  "pageSize": null,
+} satisfies GetEmailDeliveryList
+
+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 GetEmailDeliveryList
+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)
+
+