@easyedu/js-lsm-api 1.104.0 → 1.106.0

package/dist/models/PortalBrandThemeV1.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+import type { PortalBrandColorsV1 } from './PortalBrandColorsV1';
+import type { PortalBrandTypographyV1 } from './PortalBrandTypographyV1';
+/**
+ * Complete version 1 portal application theme. Updates replace this object as a whole.
+ * @export
+ * @interface PortalBrandThemeV1
+ */
+export interface PortalBrandThemeV1 {
+    /**
+     *
+     * @type {PortalBrandThemeV1SchemaVersionEnum}
+     * @memberof PortalBrandThemeV1
+     */
+    schemaVersion: PortalBrandThemeV1SchemaVersionEnum;
+    /**
+     *
+     * @type {PortalBrandTypographyV1}
+     * @memberof PortalBrandThemeV1
+     */
+    typography: PortalBrandTypographyV1;
+    /**
+     *
+     * @type {PortalBrandColorsV1}
+     * @memberof PortalBrandThemeV1
+     */
+    colors: PortalBrandColorsV1;
+}
+/**
+ * @export
+ */
+export declare const PortalBrandThemeV1SchemaVersionEnum: {
+    readonly V1: "v1";
+};
+export type PortalBrandThemeV1SchemaVersionEnum = typeof PortalBrandThemeV1SchemaVersionEnum[keyof typeof PortalBrandThemeV1SchemaVersionEnum];
+/**
+ * Check if a given object implements the PortalBrandThemeV1 interface.
+ */
+export declare function instanceOfPortalBrandThemeV1(value: object): value is PortalBrandThemeV1;
+export declare function PortalBrandThemeV1FromJSON(json: any): PortalBrandThemeV1;
+export declare function PortalBrandThemeV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandThemeV1;
+export declare function PortalBrandThemeV1ToJSON(json: any): PortalBrandThemeV1;
+export declare function PortalBrandThemeV1ToJSONTyped(value?: PortalBrandThemeV1 | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PortalBrandThemeV1.js

@@ -0,0 +1,67 @@
+"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.PortalBrandThemeV1SchemaVersionEnum = void 0;
+exports.instanceOfPortalBrandThemeV1 = instanceOfPortalBrandThemeV1;
+exports.PortalBrandThemeV1FromJSON = PortalBrandThemeV1FromJSON;
+exports.PortalBrandThemeV1FromJSONTyped = PortalBrandThemeV1FromJSONTyped;
+exports.PortalBrandThemeV1ToJSON = PortalBrandThemeV1ToJSON;
+exports.PortalBrandThemeV1ToJSONTyped = PortalBrandThemeV1ToJSONTyped;
+const PortalBrandColorsV1_1 = require("./PortalBrandColorsV1");
+const PortalBrandTypographyV1_1 = require("./PortalBrandTypographyV1");
+/**
+ * @export
+ */
+exports.PortalBrandThemeV1SchemaVersionEnum = {
+    V1: 'v1'
+};
+/**
+ * Check if a given object implements the PortalBrandThemeV1 interface.
+ */
+function instanceOfPortalBrandThemeV1(value) {
+    if (!('schemaVersion' in value) || value['schemaVersion'] === undefined)
+        return false;
+    if (!('typography' in value) || value['typography'] === undefined)
+        return false;
+    if (!('colors' in value) || value['colors'] === undefined)
+        return false;
+    return true;
+}
+function PortalBrandThemeV1FromJSON(json) {
+    return PortalBrandThemeV1FromJSONTyped(json, false);
+}
+function PortalBrandThemeV1FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'schemaVersion': json['schema_version'],
+        'typography': (0, PortalBrandTypographyV1_1.PortalBrandTypographyV1FromJSON)(json['typography']),
+        'colors': (0, PortalBrandColorsV1_1.PortalBrandColorsV1FromJSON)(json['colors']),
+    };
+}
+function PortalBrandThemeV1ToJSON(json) {
+    return PortalBrandThemeV1ToJSONTyped(json, false);
+}
+function PortalBrandThemeV1ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'schema_version': value['schemaVersion'],
+        'typography': (0, PortalBrandTypographyV1_1.PortalBrandTypographyV1ToJSON)(value['typography']),
+        'colors': (0, PortalBrandColorsV1_1.PortalBrandColorsV1ToJSON)(value['colors']),
+    };
+}

package/dist/models/PortalBrandTypographyV1.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+/**
+ * Typography settings for a portal-owned light application theme.
+ * @export
+ * @interface PortalBrandTypographyV1
+ */
+export interface PortalBrandTypographyV1 {
+    /**
+     * Curated application font family. Values map to bundled frontend fonts.
+     * @type {PortalBrandTypographyV1FontFamilyEnum}
+     * @memberof PortalBrandTypographyV1
+     */
+    fontFamily: PortalBrandTypographyV1FontFamilyEnum;
+    /**
+     * Base application font size in CSS pixels.
+     * @type {number}
+     * @memberof PortalBrandTypographyV1
+     */
+    baseFontSizePx: number;
+    /**
+     * Regular text weight. Supported values are 300 through 800 in increments of 100.
+     * @type {number}
+     * @memberof PortalBrandTypographyV1
+     */
+    fontWeightRegular: number;
+    /**
+     * Emphasized text weight. Supported values are 300 through 800 in increments of 100.
+     * @type {number}
+     * @memberof PortalBrandTypographyV1
+     */
+    fontWeightMedium: number;
+    /**
+     * Heading and bold text weight. Supported values are 300 through 800 in increments of 100.
+     * @type {number}
+     * @memberof PortalBrandTypographyV1
+     */
+    fontWeightBold: number;
+    /**
+     * Unitless line-height multiplier for normal application text.
+     * @type {number}
+     * @memberof PortalBrandTypographyV1
+     */
+    lineHeight: number;
+    /**
+     * Letter spacing for normal application text, in em units.
+     * @type {number}
+     * @memberof PortalBrandTypographyV1
+     */
+    letterSpacingEm: number;
+}
+/**
+ * @export
+ */
+export declare const PortalBrandTypographyV1FontFamilyEnum: {
+    readonly Inter: "Inter";
+    readonly Roboto: "Roboto";
+    readonly OpenSans: "Open Sans";
+    readonly Montserrat: "Montserrat";
+    readonly SourceSans3: "Source Sans 3";
+    readonly NunitoSans: "Nunito Sans";
+};
+export type PortalBrandTypographyV1FontFamilyEnum = typeof PortalBrandTypographyV1FontFamilyEnum[keyof typeof PortalBrandTypographyV1FontFamilyEnum];
+/**
+ * Check if a given object implements the PortalBrandTypographyV1 interface.
+ */
+export declare function instanceOfPortalBrandTypographyV1(value: object): value is PortalBrandTypographyV1;
+export declare function PortalBrandTypographyV1FromJSON(json: any): PortalBrandTypographyV1;
+export declare function PortalBrandTypographyV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandTypographyV1;
+export declare function PortalBrandTypographyV1ToJSON(json: any): PortalBrandTypographyV1;
+export declare function PortalBrandTypographyV1ToJSONTyped(value?: PortalBrandTypographyV1 | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PortalBrandTypographyV1.js

@@ -0,0 +1,86 @@
+"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.PortalBrandTypographyV1FontFamilyEnum = void 0;
+exports.instanceOfPortalBrandTypographyV1 = instanceOfPortalBrandTypographyV1;
+exports.PortalBrandTypographyV1FromJSON = PortalBrandTypographyV1FromJSON;
+exports.PortalBrandTypographyV1FromJSONTyped = PortalBrandTypographyV1FromJSONTyped;
+exports.PortalBrandTypographyV1ToJSON = PortalBrandTypographyV1ToJSON;
+exports.PortalBrandTypographyV1ToJSONTyped = PortalBrandTypographyV1ToJSONTyped;
+/**
+ * @export
+ */
+exports.PortalBrandTypographyV1FontFamilyEnum = {
+    Inter: 'Inter',
+    Roboto: 'Roboto',
+    OpenSans: 'Open Sans',
+    Montserrat: 'Montserrat',
+    SourceSans3: 'Source Sans 3',
+    NunitoSans: 'Nunito Sans'
+};
+/**
+ * Check if a given object implements the PortalBrandTypographyV1 interface.
+ */
+function instanceOfPortalBrandTypographyV1(value) {
+    if (!('fontFamily' in value) || value['fontFamily'] === undefined)
+        return false;
+    if (!('baseFontSizePx' in value) || value['baseFontSizePx'] === undefined)
+        return false;
+    if (!('fontWeightRegular' in value) || value['fontWeightRegular'] === undefined)
+        return false;
+    if (!('fontWeightMedium' in value) || value['fontWeightMedium'] === undefined)
+        return false;
+    if (!('fontWeightBold' in value) || value['fontWeightBold'] === undefined)
+        return false;
+    if (!('lineHeight' in value) || value['lineHeight'] === undefined)
+        return false;
+    if (!('letterSpacingEm' in value) || value['letterSpacingEm'] === undefined)
+        return false;
+    return true;
+}
+function PortalBrandTypographyV1FromJSON(json) {
+    return PortalBrandTypographyV1FromJSONTyped(json, false);
+}
+function PortalBrandTypographyV1FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fontFamily': json['font_family'],
+        'baseFontSizePx': json['base_font_size_px'],
+        'fontWeightRegular': json['font_weight_regular'],
+        'fontWeightMedium': json['font_weight_medium'],
+        'fontWeightBold': json['font_weight_bold'],
+        'lineHeight': json['line_height'],
+        'letterSpacingEm': json['letter_spacing_em'],
+    };
+}
+function PortalBrandTypographyV1ToJSON(json) {
+    return PortalBrandTypographyV1ToJSONTyped(json, false);
+}
+function PortalBrandTypographyV1ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'font_family': value['fontFamily'],
+        'base_font_size_px': value['baseFontSizePx'],
+        'font_weight_regular': value['fontWeightRegular'],
+        'font_weight_medium': value['fontWeightMedium'],
+        'font_weight_bold': value['fontWeightBold'],
+        'line_height': value['lineHeight'],
+        'letter_spacing_em': value['letterSpacingEm'],
+    };
+}

package/dist/models/PostPortal.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
 /**
  *
  * @export
@@ -25,14 +26,22 @@ export interface PostPortal {
      * Hex color value for portal background (e.g.,
      * @type {string}
      * @memberof PostPortal
+     * @deprecated
      */
     headerBackgroundColor?: string;
     /**
      * Hex color value for portal text (e.g.,
      * @type {string}
      * @memberof PostPortal
+     * @deprecated
      */
     headerTextColor?: string;
+    /**
+     *
+     * @type {PortalBrandThemeV1}
+     * @memberof PostPortal
+     */
+    brandingTheme?: PortalBrandThemeV1;
     /**
      * Platform subdomain slug used for '{slug}.edaxu.com'
      * @type {string}

package/dist/models/PostPortal.js

@@ -18,6 +18,7 @@ exports.PostPortalFromJSON = PostPortalFromJSON;
 exports.PostPortalFromJSONTyped = PostPortalFromJSONTyped;
 exports.PostPortalToJSON = PostPortalToJSON;
 exports.PostPortalToJSONTyped = PostPortalToJSONTyped;
+const PortalBrandThemeV1_1 = require("./PortalBrandThemeV1");
 /**
  * Check if a given object implements the PostPortal interface.
  */
@@ -37,6 +38,7 @@ function PostPortalFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
         'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
+        'brandingTheme': json['branding_theme'] == null ? undefined : (0, PortalBrandThemeV1_1.PortalBrandThemeV1FromJSON)(json['branding_theme']),
         'slug': json['slug'] == null ? undefined : json['slug'],
         'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
     };
@@ -52,6 +54,7 @@ function PostPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': (0, PortalBrandThemeV1_1.PortalBrandThemeV1ToJSON)(value['brandingTheme']),
         'slug': value['slug'],
         'client_domain': value['clientDomain'],
     };

package/dist/models/PutPortalBranding.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
 /**
  *
  * @export
@@ -25,14 +26,22 @@ export interface PutPortalBranding {
      * Hex color value for portal background (e.g.,
      * @type {string}
      * @memberof PutPortalBranding
+     * @deprecated
      */
     headerBackgroundColor?: string;
     /**
      * Hex color value for portal text (e.g.,
      * @type {string}
      * @memberof PutPortalBranding
+     * @deprecated
      */
     headerTextColor?: string;
+    /**
+     *
+     * @type {PortalBrandThemeV1}
+     * @memberof PutPortalBranding
+     */
+    brandingTheme?: PortalBrandThemeV1;
     /**
      * Platform subdomain slug used for '{slug}.edaxu.com'. Set null to inherit from an ancestor.
      * @type {string}

package/dist/models/PutPortalBranding.js

@@ -18,6 +18,7 @@ exports.PutPortalBrandingFromJSON = PutPortalBrandingFromJSON;
 exports.PutPortalBrandingFromJSONTyped = PutPortalBrandingFromJSONTyped;
 exports.PutPortalBrandingToJSON = PutPortalBrandingToJSON;
 exports.PutPortalBrandingToJSONTyped = PutPortalBrandingToJSONTyped;
+const PortalBrandThemeV1_1 = require("./PortalBrandThemeV1");
 /**
  * Check if a given object implements the PutPortalBranding interface.
  */
@@ -35,6 +36,7 @@ function PutPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'] == null ? undefined : json['name'],
         'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
         'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
+        'brandingTheme': json['branding_theme'] == null ? undefined : (0, PortalBrandThemeV1_1.PortalBrandThemeV1FromJSON)(json['branding_theme']),
         'slug': json['slug'] == null ? undefined : json['slug'],
         'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
     };
@@ -50,6 +52,7 @@ function PutPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': (0, PortalBrandThemeV1_1.PortalBrandThemeV1ToJSON)(value['brandingTheme']),
         'slug': value['slug'],
         'client_domain': value['clientDomain'],
     };

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';
@@ -156,6 +157,9 @@ export * from './LoginResAuthData';
 export * from './LoginResUserData';
 export * from './LoginResUserDataSelectedPortal';
 export * from './Paginated';
+export * from './PortalBrandColorsV1';
+export * from './PortalBrandThemeV1';
+export * from './PortalBrandTypographyV1';
 export * from './PortalSublicense';
 export * from './PortalUserFieldConfig';
 export * from './PortalUserFieldDefinition';

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);
@@ -174,6 +175,9 @@ __exportStar(require("./LoginResAuthData"), exports);
 __exportStar(require("./LoginResUserData"), exports);
 __exportStar(require("./LoginResUserDataSelectedPortal"), exports);
 __exportStar(require("./Paginated"), exports);
+__exportStar(require("./PortalBrandColorsV1"), exports);
+__exportStar(require("./PortalBrandThemeV1"), exports);
+__exportStar(require("./PortalBrandTypographyV1"), exports);
 __exportStar(require("./PortalSublicense"), exports);
 __exportStar(require("./PortalUserFieldConfig"), exports);
 __exportStar(require("./PortalUserFieldDefinition"), 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/GetPortal.md

@@ -15,6 +15,7 @@ Name | Type
 `faviconUrl` | string
 `headerBackgroundColor` | string
 `headerTextColor` | string
+`brandingTheme` | [PortalBrandThemeV1](PortalBrandThemeV1.md)
 `baseType` | string
 
 ## Example
@@ -33,6 +34,7 @@ const example = {
   "faviconUrl": null,
   "headerBackgroundColor": null,
   "headerTextColor": null,
+  "brandingTheme": null,
   "baseType": null,
 } satisfies GetPortal
 

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)