@easyedu/js-lsm-api 1.104.0 → 1.105.0

package/dist/models/GetEmailDelivery.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
 /**
  *
  * @export
@@ -39,6 +40,12 @@ export interface GetEmailDelivery {
      * @memberof GetEmailDelivery
      */
     recipient: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    subject?: string | null;
     /**
      *
      * @type {boolean}
@@ -99,6 +106,30 @@ export interface GetEmailDelivery {
      * @memberof GetEmailDelivery
      */
     failedAt?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    resendOfDeliveryId?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetEmailDelivery
+     */
+    canResend: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    resendBlockedReason?: string | null;
+    /**
+     *
+     * @type {GetPortalInvitationSummary}
+     * @memberof GetEmailDelivery
+     */
+    invitation?: GetPortalInvitationSummary | null;
 }
 /**
  * @export

package/dist/models/GetEmailDelivery.js

@@ -19,6 +19,7 @@ exports.GetEmailDeliveryFromJSON = GetEmailDeliveryFromJSON;
 exports.GetEmailDeliveryFromJSONTyped = GetEmailDeliveryFromJSONTyped;
 exports.GetEmailDeliveryToJSON = GetEmailDeliveryToJSON;
 exports.GetEmailDeliveryToJSONTyped = GetEmailDeliveryToJSONTyped;
+const GetPortalInvitationSummary_1 = require("./GetPortalInvitationSummary");
 /**
  * @export
  */
@@ -49,6 +50,8 @@ function instanceOfGetEmailDelivery(value) {
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
+    if (!('canResend' in value) || value['canResend'] === undefined)
+        return false;
     return true;
 }
 function GetEmailDeliveryFromJSON(json) {
@@ -63,6 +66,7 @@ function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
         'templateKey': json['template_key'],
         'templateVersionId': json['template_version_id'] == null ? undefined : json['template_version_id'],
         'recipient': json['recipient'],
+        'subject': json['subject'] == null ? undefined : json['subject'],
         'isTest': json['is_test'],
         'status': json['status'],
         'attempts': json['attempts'],
@@ -73,6 +77,10 @@ function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
         'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
         'deliveredAt': json['delivered_at'] == null ? undefined : json['delivered_at'],
         'failedAt': json['failed_at'] == null ? undefined : json['failed_at'],
+        'resendOfDeliveryId': json['resend_of_delivery_id'] == null ? undefined : json['resend_of_delivery_id'],
+        'canResend': json['can_resend'],
+        'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
+        'invitation': json['invitation'] == null ? undefined : (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryFromJSON)(json['invitation']),
     };
 }
 function GetEmailDeliveryToJSON(json) {
@@ -87,6 +95,7 @@ function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false) {
         'template_key': value['templateKey'],
         'template_version_id': value['templateVersionId'],
         'recipient': value['recipient'],
+        'subject': value['subject'],
         'is_test': value['isTest'],
         'status': value['status'],
         'attempts': value['attempts'],
@@ -97,5 +106,9 @@ function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false) {
         'accepted_at': value['acceptedAt'],
         'delivered_at': value['deliveredAt'],
         'failed_at': value['failedAt'],
+        'resend_of_delivery_id': value['resendOfDeliveryId'],
+        'can_resend': value['canResend'],
+        'resend_blocked_reason': value['resendBlockedReason'],
+        'invitation': (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryToJSON)(value['invitation']),
     };
 }

package/dist/models/GetPortalInvitationSummary.d.ts

@@ -0,0 +1,102 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Invitation lifecycle and latest email delivery state for a portal user.
+ * @export
+ * @interface GetPortalInvitationSummary
+ */
+export interface GetPortalInvitationSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    id: string;
+    /**
+     *
+     * @type {GetPortalInvitationSummaryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    status: GetPortalInvitationSummaryStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    invitedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    expiresAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    acceptedAt?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    lastSentAt?: number | null;
+    /**
+     *
+     * @type {GetPortalInvitationSummaryLatestDeliveryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    latestDeliveryStatus?: GetPortalInvitationSummaryLatestDeliveryStatusEnum | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetPortalInvitationSummary
+     */
+    canResend: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    resendBlockedReason?: string | null;
+}
+/**
+ * @export
+ */
+export declare const GetPortalInvitationSummaryStatusEnum: {
+    readonly Pending: "pending";
+    readonly Expired: "expired";
+    readonly Accepted: "accepted";
+};
+export type GetPortalInvitationSummaryStatusEnum = typeof GetPortalInvitationSummaryStatusEnum[keyof typeof GetPortalInvitationSummaryStatusEnum];
+/**
+ * @export
+ */
+export declare const GetPortalInvitationSummaryLatestDeliveryStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Accepted: "accepted";
+    readonly Delivered: "delivered";
+    readonly Deferred: "deferred";
+    readonly Failed: "failed";
+    readonly Complained: "complained";
+};
+export type GetPortalInvitationSummaryLatestDeliveryStatusEnum = typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum[keyof typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum];
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+export declare function instanceOfGetPortalInvitationSummary(value: object): value is GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryFromJSON(json: any): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryToJSON(json: any): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryToJSONTyped(value?: GetPortalInvitationSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetPortalInvitationSummary.js

@@ -0,0 +1,95 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetPortalInvitationSummaryLatestDeliveryStatusEnum = exports.GetPortalInvitationSummaryStatusEnum = void 0;
+exports.instanceOfGetPortalInvitationSummary = instanceOfGetPortalInvitationSummary;
+exports.GetPortalInvitationSummaryFromJSON = GetPortalInvitationSummaryFromJSON;
+exports.GetPortalInvitationSummaryFromJSONTyped = GetPortalInvitationSummaryFromJSONTyped;
+exports.GetPortalInvitationSummaryToJSON = GetPortalInvitationSummaryToJSON;
+exports.GetPortalInvitationSummaryToJSONTyped = GetPortalInvitationSummaryToJSONTyped;
+/**
+ * @export
+ */
+exports.GetPortalInvitationSummaryStatusEnum = {
+    Pending: 'pending',
+    Expired: 'expired',
+    Accepted: 'accepted'
+};
+/**
+ * @export
+ */
+exports.GetPortalInvitationSummaryLatestDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+};
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+function instanceOfGetPortalInvitationSummary(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('invitedAt' in value) || value['invitedAt'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    if (!('canResend' in value) || value['canResend'] === undefined)
+        return false;
+    return true;
+}
+function GetPortalInvitationSummaryFromJSON(json) {
+    return GetPortalInvitationSummaryFromJSONTyped(json, false);
+}
+function GetPortalInvitationSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'invitedAt': json['invited_at'],
+        'expiresAt': json['expires_at'],
+        'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
+        'lastSentAt': json['last_sent_at'] == null ? undefined : json['last_sent_at'],
+        'latestDeliveryStatus': json['latest_delivery_status'] == null ? undefined : json['latest_delivery_status'],
+        'canResend': json['can_resend'],
+        'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
+    };
+}
+function GetPortalInvitationSummaryToJSON(json) {
+    return GetPortalInvitationSummaryToJSONTyped(json, false);
+}
+function GetPortalInvitationSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'invited_at': value['invitedAt'],
+        'expires_at': value['expiresAt'],
+        'accepted_at': value['acceptedAt'],
+        'last_sent_at': value['lastSentAt'],
+        'latest_delivery_status': value['latestDeliveryStatus'],
+        'can_resend': value['canResend'],
+        'resend_blocked_reason': value['resendBlockedReason'],
+    };
+}

package/dist/models/GetPortalUser.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
 /**
  * A user with their portal access information
  * @export
@@ -51,6 +52,12 @@ export interface GetPortalUser {
      * @memberof GetPortalUser
      */
     isActive: boolean;
+    /**
+     *
+     * @type {GetPortalInvitationSummary}
+     * @memberof GetPortalUser
+     */
+    invitation?: GetPortalInvitationSummary | null;
 }
 /**
  * Check if a given object implements the GetPortalUser interface.

package/dist/models/GetPortalUser.js

@@ -18,6 +18,7 @@ exports.GetPortalUserFromJSON = GetPortalUserFromJSON;
 exports.GetPortalUserFromJSONTyped = GetPortalUserFromJSONTyped;
 exports.GetPortalUserToJSON = GetPortalUserToJSON;
 exports.GetPortalUserToJSONTyped = GetPortalUserToJSONTyped;
+const GetPortalInvitationSummary_1 = require("./GetPortalInvitationSummary");
 /**
  * Check if a given object implements the GetPortalUser interface.
  */
@@ -50,6 +51,7 @@ function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
         'lastName': json['last_name'],
         'role': json['role'],
         'isActive': json['is_active'],
+        'invitation': json['invitation'] == null ? undefined : (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryFromJSON)(json['invitation']),
     };
 }
 function GetPortalUserToJSON(json) {
@@ -66,5 +68,6 @@ function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
         'last_name': value['lastName'],
         'role': value['role'],
         'is_active': value['isActive'],
+        'invitation': (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryToJSON)(value['invitation']),
     };
 }

package/dist/models/index.d.ts

@@ -94,6 +94,7 @@ export * from './GetLibraryQuizVersion';
 export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalFaviconUpload';
+export * from './GetPortalInvitationSummary';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalUser';

package/dist/models/index.js

@@ -112,6 +112,7 @@ __exportStar(require("./GetLibraryQuizVersion"), exports);
 __exportStar(require("./GetPermission"), exports);
 __exportStar(require("./GetPortal"), exports);
 __exportStar(require("./GetPortalFaviconUpload"), exports);
+__exportStar(require("./GetPortalInvitationSummary"), exports);
 __exportStar(require("./GetPortalList"), exports);
 __exportStar(require("./GetPortalLogoUpload"), exports);
 __exportStar(require("./GetPortalUser"), exports);

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/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/package.json

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