@easyedu/js-lsm-api 1.84.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/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)
+
+

package/docs/GetEmailTemplate.md

@@ -0,0 +1,44 @@
+
+# GetEmailTemplate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`definition` | [EmailTemplateDefinition](EmailTemplateDefinition.md)
+`effectiveSource` | string
+`effectiveSourcePortalId` | string
+`effectiveVersion` | [EmailTemplateVersion](EmailTemplateVersion.md)
+`draftVersion` | [EmailTemplateVersion](EmailTemplateVersion.md)
+`versions` | [Array<EmailTemplateVersion>](EmailTemplateVersion.md)
+
+## Example
+
+```typescript
+import type { GetEmailTemplate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "definition": null,
+  "effectiveSource": null,
+  "effectiveSourcePortalId": null,
+  "effectiveVersion": null,
+  "draftVersion": null,
+  "versions": null,
+} satisfies GetEmailTemplate
+
+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 GetEmailTemplate
+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/GetEmailTemplateList.md

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

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

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

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

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

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

@@ -0,0 +1,44 @@
+
+# PutEmailTemplateDraft
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subjectTemplate` | string
+`preheaderTemplate` | string
+`fromNameTemplate` | string
+`replyTo` | string
+`designDocument` | { [key: string]: any; }
+`changeNotes` | string
+
+## Example
+
+```typescript
+import type { PutEmailTemplateDraft } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subjectTemplate": null,
+  "preheaderTemplate": null,
+  "fromNameTemplate": null,
+  "replyTo": null,
+  "designDocument": null,
+  "changeNotes": null,
+} satisfies PutEmailTemplateDraft
+
+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 PutEmailTemplateDraft
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.84.0",
+  "version": "1.85.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {