@easyedu/js-lsm-api 1.84.0 → 1.86.0

package/docs/EmailTemplateApi.md

@@ -0,0 +1,2097 @@
+# EmailTemplateApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteEmailTemplateDraft**](EmailTemplateApi.md#deleteemailtemplatedraft) | **DELETE** /email-templates/{templateKey}/draft | Discard the current portal email template draft |
+| [**deleteSystemEmailTemplateDraft**](EmailTemplateApi.md#deletesystememailtemplatedraft) | **DELETE** /system/email-templates/{templateKey}/draft | Discard the current platform email template draft |
+| [**getEmailDeliveryList**](EmailTemplateApi.md#getemaildeliverylist) | **GET** /email-deliveries | List selected-portal email delivery activity |
+| [**getEmailTemplate**](EmailTemplateApi.md#getemailtemplate) | **GET** /email-templates/{templateKey} | Get an effective portal email template |
+| [**getEmailTemplateList**](EmailTemplateApi.md#getemailtemplatelist) | **GET** /email-templates | List effective email templates for the selected portal |
+| [**getPublicEmailAsset**](EmailTemplateApi.md#getpublicemailasset) | **GET** /public/email-assets/{assetId} | Redirect to a stable public email image |
+| [**getPublicEmailPortalLogo**](EmailTemplateApi.md#getpublicemailportallogo) | **GET** /public/email-branding/portals/{portalId}/logo | Redirect to a portal logo for email rendering |
+| [**getSystemEmailDeliveryList**](EmailTemplateApi.md#getsystememaildeliverylist) | **GET** /system/email-deliveries | List platform email delivery activity |
+| [**getSystemEmailTemplate**](EmailTemplateApi.md#getsystememailtemplate) | **GET** /system/email-templates/{templateKey} | Get a platform email template |
+| [**getSystemEmailTemplateList**](EmailTemplateApi.md#getsystememailtemplatelist) | **GET** /system/email-templates | List platform email templates |
+| [**postEmailAssetComplete**](EmailTemplateApi.md#postemailassetcomplete) | **POST** /email-assets/{assetId}/complete | Complete a selected-portal email image upload |
+| [**postEmailAssetUpload**](EmailTemplateApi.md#postemailassetupload) | **POST** /email-assets/uploads | Create a pending selected-portal email image upload |
+| [**postEmailTemplateDraft**](EmailTemplateApi.md#postemailtemplatedraft) | **POST** /email-templates/{templateKey}/draft | Create a portal draft from the effective template |
+| [**postEmailTemplateInherit**](EmailTemplateApi.md#postemailtemplateinherit) | **POST** /email-templates/{templateKey}/inherit | Disable a portal override and restore inheritance |
+| [**postEmailTemplatePreview**](EmailTemplateApi.md#postemailtemplatepreview) | **POST** /email-templates/{templateKey}/preview | Preview an unsaved portal email template draft |
+| [**postEmailTemplatePublish**](EmailTemplateApi.md#postemailtemplatepublish) | **POST** /email-templates/{templateKey}/publish | Publish the current portal draft |
+| [**postEmailTemplateTestSend**](EmailTemplateApi.md#postemailtemplatetestsend) | **POST** /email-templates/{templateKey}/test-sends | Queue a test of the saved portal draft |
+| [**postEmailTemplateVersionRestore**](EmailTemplateApi.md#postemailtemplateversionrestore) | **POST** /email-templates/{templateKey}/versions/{versionId}/restore | Create a new portal draft from a historical version |
+| [**postMailgunWebhook**](EmailTemplateApi.md#postmailgunwebhook) | **POST** /webhooks/mailgun | Receive signed Mailgun delivery events |
+| [**postSystemEmailAssetComplete**](EmailTemplateApi.md#postsystememailassetcomplete) | **POST** /system/email-assets/{assetId}/complete | Complete a platform email image upload |
+| [**postSystemEmailAssetUpload**](EmailTemplateApi.md#postsystememailassetupload) | **POST** /system/email-assets/uploads | Create a pending platform email image upload |
+| [**postSystemEmailTemplateDraft**](EmailTemplateApi.md#postsystememailtemplatedraft) | **POST** /system/email-templates/{templateKey}/draft | Create a platform email template draft |
+| [**postSystemEmailTemplateInherit**](EmailTemplateApi.md#postsystememailtemplateinherit) | **POST** /system/email-templates/{templateKey}/inherit | Disable a platform override and restore the code fallback |
+| [**postSystemEmailTemplatePreview**](EmailTemplateApi.md#postsystememailtemplatepreview) | **POST** /system/email-templates/{templateKey}/preview | Preview a platform email template |
+| [**postSystemEmailTemplatePublish**](EmailTemplateApi.md#postsystememailtemplatepublish) | **POST** /system/email-templates/{templateKey}/publish | Publish the current platform draft |
+| [**postSystemEmailTemplateTestSend**](EmailTemplateApi.md#postsystememailtemplatetestsend) | **POST** /system/email-templates/{templateKey}/test-sends | Queue a test of the saved platform draft |
+| [**postSystemEmailTemplateVersionRestore**](EmailTemplateApi.md#postsystememailtemplateversionrestore) | **POST** /system/email-templates/{templateKey}/versions/{versionId}/restore | Restore a historical platform email template version |
+| [**putEmailAssetFile**](EmailTemplateApi.md#putemailassetfile) | **PUT** /email-assets/{assetId}/file | Upload a pending selected-portal email image |
+| [**putEmailTemplateDraft**](EmailTemplateApi.md#putemailtemplatedraft) | **PUT** /email-templates/{templateKey}/draft | Update a portal email template draft |
+| [**putSystemEmailAssetFile**](EmailTemplateApi.md#putsystememailassetfile) | **PUT** /system/email-assets/{assetId}/file | Upload a pending platform email image |
+| [**putSystemEmailTemplateDraft**](EmailTemplateApi.md#putsystememailtemplatedraft) | **PUT** /system/email-templates/{templateKey}/draft | Update a platform email template draft |
+
+
+
+## deleteEmailTemplateDraft
+
+> deleteEmailTemplateDraft(templateKey)
+
+Discard the current portal email template draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteEmailTemplateDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies DeleteEmailTemplateDraftRequest;
+
+  try {
+    const data = await api.deleteEmailTemplateDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Draft discarded |  -  |
+| **404** | Draft not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteSystemEmailTemplateDraft
+
+> deleteSystemEmailTemplateDraft(templateKey)
+
+Discard the current platform email template draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteSystemEmailTemplateDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies DeleteSystemEmailTemplateDraftRequest;
+
+  try {
+    const data = await api.deleteSystemEmailTemplateDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Draft discarded |  -  |
+| **404** | Draft not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getEmailDeliveryList
+
+> GetEmailDeliveryList getEmailDeliveryList(page, pageSize)
+
+List selected-portal email delivery activity
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetEmailDeliveryListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetEmailDeliveryListRequest;
+
+  try {
+    const data = await api.getEmailDeliveryList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetEmailDeliveryList**](GetEmailDeliveryList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Delivery activity |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getEmailTemplate
+
+> GetEmailTemplate getEmailTemplate(templateKey)
+
+Get an effective portal email template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetEmailTemplateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies GetEmailTemplateRequest;
+
+  try {
+    const data = await api.getEmailTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetEmailTemplate**](GetEmailTemplate.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Email template |  -  |
+| **404** | Unknown template key |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getEmailTemplateList
+
+> GetEmailTemplateList getEmailTemplateList()
+
+List effective email templates for the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetEmailTemplateListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  try {
+    const data = await api.getEmailTemplateList();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetEmailTemplateList**](GetEmailTemplateList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Email templates |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPublicEmailAsset
+
+> getPublicEmailAsset(assetId)
+
+Redirect to a stable public email image
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicEmailAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPublicEmailAssetRequest;
+
+  try {
+    const data = await api.getPublicEmailAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **302** | Redirect to signed object URL |  -  |
+| **404** | Asset not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPublicEmailPortalLogo
+
+> getPublicEmailPortalLogo(portalId)
+
+Redirect to a portal logo for email rendering
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicEmailPortalLogoRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetPublicEmailPortalLogoRequest;
+
+  try {
+    const data = await api.getPublicEmailPortalLogo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **302** | Redirect to signed object URL |  -  |
+| **404** | Logo not configured |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSystemEmailDeliveryList
+
+> GetEmailDeliveryList getSystemEmailDeliveryList(page, pageSize)
+
+List platform email delivery activity
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemEmailDeliveryListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetSystemEmailDeliveryListRequest;
+
+  try {
+    const data = await api.getSystemEmailDeliveryList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetEmailDeliveryList**](GetEmailDeliveryList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Platform delivery activity |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSystemEmailTemplate
+
+> GetEmailTemplate getSystemEmailTemplate(templateKey)
+
+Get a platform email template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemEmailTemplateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies GetSystemEmailTemplateRequest;
+
+  try {
+    const data = await api.getSystemEmailTemplate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetEmailTemplate**](GetEmailTemplate.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Platform email template |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSystemEmailTemplateList
+
+> GetEmailTemplateList getSystemEmailTemplateList()
+
+List platform email templates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSystemEmailTemplateListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  try {
+    const data = await api.getSystemEmailTemplateList();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetEmailTemplateList**](GetEmailTemplateList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Platform email templates |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailAssetComplete
+
+> postEmailAssetComplete(assetId, postEmailAssetComplete)
+
+Complete a selected-portal email image upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailAssetCompleteRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PostEmailAssetComplete
+    postEmailAssetComplete: ...,
+  } satisfies PostEmailAssetCompleteRequest;
+
+  try {
+    const data = await api.postEmailAssetComplete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **postEmailAssetComplete** | [PostEmailAssetComplete](PostEmailAssetComplete.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Image ready |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailAssetUpload
+
+> GetEmailAssetUpload postEmailAssetUpload(postEmailAssetUpload)
+
+Create a pending selected-portal email image upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailAssetUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // PostEmailAssetUpload
+    postEmailAssetUpload: ...,
+  } satisfies PostEmailAssetUploadRequest;
+
+  try {
+    const data = await api.postEmailAssetUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postEmailAssetUpload** | [PostEmailAssetUpload](PostEmailAssetUpload.md) |  | |
+
+### Return type
+
+[**GetEmailAssetUpload**](GetEmailAssetUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Pending asset |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailTemplateDraft
+
+> EmailTemplateVersion postEmailTemplateDraft(templateKey)
+
+Create a portal draft from the effective template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailTemplateDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies PostEmailTemplateDraftRequest;
+
+  try {
+    const data = await api.postEmailTemplateDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Draft created |  -  |
+| **409** | A draft already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailTemplateInherit
+
+> postEmailTemplateInherit(templateKey)
+
+Disable a portal override and restore inheritance
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailTemplateInheritRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies PostEmailTemplateInheritRequest;
+
+  try {
+    const data = await api.postEmailTemplateInherit(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Portal override disabled |  -  |
+| **409** | Discard the current draft first |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailTemplatePreview
+
+> GetEmailTemplatePreview postEmailTemplatePreview(templateKey, postEmailTemplatePreview)
+
+Preview an unsaved portal email template draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailTemplatePreviewRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // PostEmailTemplatePreview
+    postEmailTemplatePreview: ...,
+  } satisfies PostEmailTemplatePreviewRequest;
+
+  try {
+    const data = await api.postEmailTemplatePreview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **postEmailTemplatePreview** | [PostEmailTemplatePreview](PostEmailTemplatePreview.md) |  | |
+
+### Return type
+
+[**GetEmailTemplatePreview**](GetEmailTemplatePreview.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rendered preview |  -  |
+| **400** | Invalid template |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailTemplatePublish
+
+> EmailTemplateVersion postEmailTemplatePublish(templateKey)
+
+Publish the current portal draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailTemplatePublishRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies PostEmailTemplatePublishRequest;
+
+  try {
+    const data = await api.postEmailTemplatePublish(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Published version |  -  |
+| **400** | Draft is not publishable |  -  |
+| **404** | Draft not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailTemplateTestSend
+
+> GetEmailDelivery postEmailTemplateTestSend(templateKey, postEmailTemplateTestSend)
+
+Queue a test of the saved portal draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailTemplateTestSendRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // PostEmailTemplateTestSend
+    postEmailTemplateTestSend: ...,
+  } satisfies PostEmailTemplateTestSendRequest;
+
+  try {
+    const data = await api.postEmailTemplateTestSend(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **postEmailTemplateTestSend** | [PostEmailTemplateTestSend](PostEmailTemplateTestSend.md) |  | |
+
+### Return type
+
+[**GetEmailDelivery**](GetEmailDelivery.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Test queued |  -  |
+| **429** | Test-send rate limit exceeded |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postEmailTemplateVersionRestore
+
+> EmailTemplateVersion postEmailTemplateVersionRestore(templateKey, versionId)
+
+Create a new portal draft from a historical version
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostEmailTemplateVersionRestoreRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // string
+    versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PostEmailTemplateVersionRestoreRequest;
+
+  try {
+    const data = await api.postEmailTemplateVersionRestore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **versionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Restored draft |  -  |
+| **409** | A draft already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postMailgunWebhook
+
+> postMailgunWebhook(requestBody)
+
+Receive signed Mailgun delivery events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostMailgunWebhookRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // { [key: string]: any; }
+    requestBody: Object,
+  } satisfies PostMailgunWebhookRequest;
+
+  try {
+    const data = await api.postMailgunWebhook(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | `{ [key: string]: any; }` |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Event accepted or already processed |  -  |
+| **401** | Invalid webhook signature |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailAssetComplete
+
+> postSystemEmailAssetComplete(assetId, postEmailAssetComplete)
+
+Complete a platform email image upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailAssetCompleteRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PostEmailAssetComplete
+    postEmailAssetComplete: ...,
+  } satisfies PostSystemEmailAssetCompleteRequest;
+
+  try {
+    const data = await api.postSystemEmailAssetComplete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **postEmailAssetComplete** | [PostEmailAssetComplete](PostEmailAssetComplete.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Image ready |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailAssetUpload
+
+> GetEmailAssetUpload postSystemEmailAssetUpload(postEmailAssetUpload)
+
+Create a pending platform email image upload
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailAssetUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // PostEmailAssetUpload
+    postEmailAssetUpload: ...,
+  } satisfies PostSystemEmailAssetUploadRequest;
+
+  try {
+    const data = await api.postSystemEmailAssetUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postEmailAssetUpload** | [PostEmailAssetUpload](PostEmailAssetUpload.md) |  | |
+
+### Return type
+
+[**GetEmailAssetUpload**](GetEmailAssetUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Pending platform asset |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailTemplateDraft
+
+> EmailTemplateVersion postSystemEmailTemplateDraft(templateKey)
+
+Create a platform email template draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailTemplateDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies PostSystemEmailTemplateDraftRequest;
+
+  try {
+    const data = await api.postSystemEmailTemplateDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Draft created |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailTemplateInherit
+
+> postSystemEmailTemplateInherit(templateKey)
+
+Disable a platform override and restore the code fallback
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailTemplateInheritRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies PostSystemEmailTemplateInheritRequest;
+
+  try {
+    const data = await api.postSystemEmailTemplateInherit(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Platform override disabled |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailTemplatePreview
+
+> GetEmailTemplatePreview postSystemEmailTemplatePreview(templateKey, postEmailTemplatePreview)
+
+Preview a platform email template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailTemplatePreviewRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // PostEmailTemplatePreview
+    postEmailTemplatePreview: ...,
+  } satisfies PostSystemEmailTemplatePreviewRequest;
+
+  try {
+    const data = await api.postSystemEmailTemplatePreview(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **postEmailTemplatePreview** | [PostEmailTemplatePreview](PostEmailTemplatePreview.md) |  | |
+
+### Return type
+
+[**GetEmailTemplatePreview**](GetEmailTemplatePreview.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Rendered preview |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailTemplatePublish
+
+> EmailTemplateVersion postSystemEmailTemplatePublish(templateKey)
+
+Publish the current platform draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailTemplatePublishRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+  } satisfies PostSystemEmailTemplatePublishRequest;
+
+  try {
+    const data = await api.postSystemEmailTemplatePublish(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Published version |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailTemplateTestSend
+
+> GetEmailDelivery postSystemEmailTemplateTestSend(templateKey, postEmailTemplateTestSend)
+
+Queue a test of the saved platform draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailTemplateTestSendRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // PostEmailTemplateTestSend
+    postEmailTemplateTestSend: ...,
+  } satisfies PostSystemEmailTemplateTestSendRequest;
+
+  try {
+    const data = await api.postSystemEmailTemplateTestSend(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **postEmailTemplateTestSend** | [PostEmailTemplateTestSend](PostEmailTemplateTestSend.md) |  | |
+
+### Return type
+
+[**GetEmailDelivery**](GetEmailDelivery.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Test queued |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSystemEmailTemplateVersionRestore
+
+> EmailTemplateVersion postSystemEmailTemplateVersionRestore(templateKey, versionId)
+
+Restore a historical platform email template version
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSystemEmailTemplateVersionRestoreRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // string
+    versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PostSystemEmailTemplateVersionRestoreRequest;
+
+  try {
+    const data = await api.postSystemEmailTemplateVersionRestore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **versionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Restored draft |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putEmailAssetFile
+
+> putEmailAssetFile(assetId, body)
+
+Upload a pending selected-portal email image
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PutEmailAssetFileRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Blob
+    body: BINARY_DATA_HERE,
+  } satisfies PutEmailAssetFileRequest;
+
+  try {
+    const data = await api.putEmailAssetFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **body** | `Blob` |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/octet-stream`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Image uploaded |  -  |
+| **413** | Image too large |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putEmailTemplateDraft
+
+> EmailTemplateVersion putEmailTemplateDraft(templateKey, putEmailTemplateDraft)
+
+Update a portal email template draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PutEmailTemplateDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // PutEmailTemplateDraft
+    putEmailTemplateDraft: ...,
+  } satisfies PutEmailTemplateDraftRequest;
+
+  try {
+    const data = await api.putEmailTemplateDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **putEmailTemplateDraft** | [PutEmailTemplateDraft](PutEmailTemplateDraft.md) |  | |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Draft updated |  -  |
+| **400** | Invalid draft |  -  |
+| **404** | Draft not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putSystemEmailAssetFile
+
+> putSystemEmailAssetFile(assetId, body)
+
+Upload a pending platform email image
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PutSystemEmailAssetFileRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Blob
+    body: BINARY_DATA_HERE,
+  } satisfies PutSystemEmailAssetFileRequest;
+
+  try {
+    const data = await api.putSystemEmailAssetFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **body** | `Blob` |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/octet-stream`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Image uploaded |  -  |
+| **413** | Image too large |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putSystemEmailTemplateDraft
+
+> EmailTemplateVersion putSystemEmailTemplateDraft(templateKey, putEmailTemplateDraft)
+
+Update a platform email template draft
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { PutSystemEmailTemplateDraftRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    templateKey: templateKey_example,
+    // PutEmailTemplateDraft
+    putEmailTemplateDraft: ...,
+  } satisfies PutSystemEmailTemplateDraftRequest;
+
+  try {
+    const data = await api.putSystemEmailTemplateDraft(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **templateKey** | `string` |  | [Defaults to `undefined`] |
+| **putEmailTemplateDraft** | [PutEmailTemplateDraft](PutEmailTemplateDraft.md) |  | |
+
+### Return type
+
+[**EmailTemplateVersion**](EmailTemplateVersion.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Draft updated |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+