@easyedu/js-lsm-api 1.103.0 → 1.105.0

package/docs/ChatUserIdentity.md

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

@@ -35,6 +35,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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 |
+| [**resendEmailDelivery**](EmailTemplateApi.md#resendemaildelivery) | **POST** /email-deliveries/{deliveryId}/resend | Regenerate and queue a portal email from its current business source |
 
 
 
@@ -172,7 +173,7 @@ No authorization required
 
 ## getEmailDeliveryList
 
-> GetEmailDeliveryList getEmailDeliveryList(page, pageSize)
+> GetEmailDeliveryList getEmailDeliveryList(page, pageSize, templateKey, status, recipient, isTest)
 
 List selected-portal email delivery activity
 
@@ -194,6 +195,14 @@ async function example() {
     page: 56,
     // number (optional)
     pageSize: 56,
+    // string (optional)
+    templateKey: templateKey_example,
+    // 'queued' | 'processing' | 'accepted' | 'delivered' | 'deferred' | 'failed' | 'complained' (optional)
+    status: status_example,
+    // string | Case-insensitive recipient substring search (optional)
+    recipient: recipient_example,
+    // boolean (optional)
+    isTest: true,
   } satisfies GetEmailDeliveryListRequest;
 
   try {
@@ -215,6 +224,10 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **page** | `number` |  | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **templateKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **status** | `queued`, `processing`, `accepted`, `delivered`, `deferred`, `failed`, `complained` |  | [Optional] [Defaults to `undefined`] [Enum: queued, processing, accepted, delivered, deferred, failed, complained] |
+| **recipient** | `string` | Case-insensitive recipient substring search | [Optional] [Defaults to `undefined`] |
+| **isTest** | `boolean` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -2095,3 +2108,71 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## resendEmailDelivery
+
+> GetEmailDelivery resendEmailDelivery(deliveryId)
+
+Regenerate and queue a portal email from its current business source
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EmailTemplateApi,
+} from '@easyedu/js-lsm-api';
+import type { ResendEmailDeliveryRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new EmailTemplateApi();
+
+  const body = {
+    // string
+    deliveryId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ResendEmailDeliveryRequest;
+
+  try {
+    const data = await api.resendEmailDelivery(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deliveryId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetEmailDelivery**](GetEmailDelivery.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Newly queued delivery |  -  |
+| **404** | Delivery not found in the selected portal |  -  |
+| **409** | Delivery source is no longer eligible or another send is active |  -  |
+| **429** | Delivery source resend cooldown is active |  -  |
+
+[[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/GetChatSettings.md

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

@@ -0,0 +1,42 @@
+
+# GetChatUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`from` | number
+`to` | number
+`totals` | [ChatUsageTotals](ChatUsageTotals.md)
+`daily` | [Array<ChatDailyUsage>](ChatDailyUsage.md)
+`modelUsage` | [Array<ChatModelUsage>](ChatModelUsage.md)
+
+## Example
+
+```typescript
+import type { GetChatUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "from": null,
+  "to": null,
+  "totals": null,
+  "daily": null,
+  "modelUsage": null,
+} satisfies GetChatUsage
+
+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 GetChatUsage
+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

@@ -10,6 +10,7 @@ Name | Type
 `templateKey` | string
 `templateVersionId` | string
 `recipient` | string
+`subject` | string
 `isTest` | boolean
 `status` | string
 `attempts` | number
@@ -20,6 +21,10 @@ Name | Type
 `acceptedAt` | number
 `deliveredAt` | number
 `failedAt` | number
+`resendOfDeliveryId` | string
+`canResend` | boolean
+`resendBlockedReason` | string
+`invitation` | [GetPortalInvitationSummary](GetPortalInvitationSummary.md)
 
 ## Example
 
@@ -32,6 +37,7 @@ const example = {
   "templateKey": null,
   "templateVersionId": null,
   "recipient": null,
+  "subject": null,
   "isTest": null,
   "status": null,
   "attempts": null,
@@ -42,6 +48,10 @@ const example = {
   "acceptedAt": null,
   "deliveredAt": null,
   "failedAt": null,
+  "resendOfDeliveryId": null,
+  "canResend": null,
+  "resendBlockedReason": null,
+  "invitation": null,
 } satisfies GetEmailDelivery
 
 console.log(example)

package/docs/GetPortalInvitationSummary.md

@@ -0,0 +1,51 @@
+
+# GetPortalInvitationSummary
+
+Invitation lifecycle and latest email delivery state for a portal user.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`invitedAt` | number
+`expiresAt` | number
+`acceptedAt` | number
+`lastSentAt` | number
+`latestDeliveryStatus` | string
+`canResend` | boolean
+`resendBlockedReason` | string
+
+## Example
+
+```typescript
+import type { GetPortalInvitationSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "invitedAt": null,
+  "expiresAt": null,
+  "acceptedAt": null,
+  "lastSentAt": null,
+  "latestDeliveryStatus": null,
+  "canResend": null,
+  "resendBlockedReason": null,
+} satisfies GetPortalInvitationSummary
+
+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 GetPortalInvitationSummary
+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/GetPortalUser.md

@@ -13,6 +13,7 @@ Name | Type
 `lastName` | string
 `role` | string
 `isActive` | boolean
+`invitation` | [GetPortalInvitationSummary](GetPortalInvitationSummary.md)
 
 ## Example
 
@@ -27,6 +28,7 @@ const example = {
   "lastName": null,
   "role": null,
   "isActive": null,
+  "invitation": null,
 } satisfies GetPortalUser
 
 console.log(example)

package/docs/PutChatSettings.md

@@ -0,0 +1,34 @@
+
+# PutChatSettings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`learnerDailyMessageLimit` | number
+
+## Example
+
+```typescript
+import type { PutChatSettings } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "learnerDailyMessageLimit": null,
+} satisfies PutChatSettings
+
+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 PutChatSettings
+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.103.0",
+  "version": "1.105.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {