@easyedu/js-lsm-api 1.104.0 → 1.106.0

package/docs/GetPublicPortalBranding.md

@@ -14,6 +14,7 @@ Name | Type
 `faviconUrl` | string
 `headerBackgroundColor` | string
 `headerTextColor` | string
+`brandingTheme` | [PortalBrandThemeV1](PortalBrandThemeV1.md)
 
 ## Example
 
@@ -29,6 +30,7 @@ const example = {
   "faviconUrl": null,
   "headerBackgroundColor": null,
   "headerTextColor": null,
+  "brandingTheme": null,
 } satisfies GetPublicPortalBranding
 
 console.log(example)

package/docs/PortalApi.md

@@ -20,7 +20,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postPortal**](PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal |
 | [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
 | [**postPortalLogoUpload**](PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding |
-| [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color) |
+| [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding and complete application theme |
 | [**putPortalUserFieldConfig**](PortalApi.md#putportaluserfieldconfig) | **PUT** /portals/{portalId}/user-field-config | Replace portal user field configuration |
 | [**putPortalUserFieldValues**](PortalApi.md#putportaluserfieldvalues) | **PUT** /portals/{portalId}/users/{userId}/user-field-values | Bulk upsert a user\'s portal field values |
 | [**removePortalUser**](PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal |
@@ -1096,7 +1096,7 @@ No authorization required
 
 > GetPortal putPortalBranding(portalId, putPortalBranding)
 
-Update portal branding (name, background color, text color)
+Update portal branding and complete application theme
 
 ### Example
 

package/docs/PortalBrandColorsV1.md

@@ -0,0 +1,89 @@
+
+# PortalBrandColorsV1
+
+Semantic colors for a portal-owned light application theme. Every value is an opaque hexadecimal color.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`headerBackground` | string
+`headerForeground` | string
+`navigationBackground` | string
+`navigationForeground` | string
+`primaryAction` | string
+`onPrimaryAction` | string
+`secondaryAction` | string
+`onSecondaryAction` | string
+`pageBackground` | string
+`surfaceBackground` | string
+`textPrimary` | string
+`textSecondary` | string
+`divider` | string
+`link` | string
+`linkHover` | string
+`active` | string
+`onActive` | string
+`focusRing` | string
+`progress` | string
+`progressTrack` | string
+`success` | string
+`onSuccess` | string
+`warning` | string
+`onWarning` | string
+`error` | string
+`onError` | string
+`info` | string
+`onInfo` | string
+
+## Example
+
+```typescript
+import type { PortalBrandColorsV1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "headerBackground": null,
+  "headerForeground": null,
+  "navigationBackground": null,
+  "navigationForeground": null,
+  "primaryAction": null,
+  "onPrimaryAction": null,
+  "secondaryAction": null,
+  "onSecondaryAction": null,
+  "pageBackground": null,
+  "surfaceBackground": null,
+  "textPrimary": null,
+  "textSecondary": null,
+  "divider": null,
+  "link": null,
+  "linkHover": null,
+  "active": null,
+  "onActive": null,
+  "focusRing": null,
+  "progress": null,
+  "progressTrack": null,
+  "success": null,
+  "onSuccess": null,
+  "warning": null,
+  "onWarning": null,
+  "error": null,
+  "onError": null,
+  "info": null,
+  "onInfo": null,
+} satisfies PortalBrandColorsV1
+
+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 PortalBrandColorsV1
+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/PortalBrandThemeV1.md

@@ -0,0 +1,39 @@
+
+# PortalBrandThemeV1
+
+Complete version 1 portal application theme. Updates replace this object as a whole.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`schemaVersion` | string
+`typography` | [PortalBrandTypographyV1](PortalBrandTypographyV1.md)
+`colors` | [PortalBrandColorsV1](PortalBrandColorsV1.md)
+
+## Example
+
+```typescript
+import type { PortalBrandThemeV1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "schemaVersion": null,
+  "typography": null,
+  "colors": null,
+} satisfies PortalBrandThemeV1
+
+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 PortalBrandThemeV1
+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/PortalBrandTypographyV1.md

@@ -0,0 +1,47 @@
+
+# PortalBrandTypographyV1
+
+Typography settings for a portal-owned light application theme.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fontFamily` | string
+`baseFontSizePx` | number
+`fontWeightRegular` | number
+`fontWeightMedium` | number
+`fontWeightBold` | number
+`lineHeight` | number
+`letterSpacingEm` | number
+
+## Example
+
+```typescript
+import type { PortalBrandTypographyV1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fontFamily": null,
+  "baseFontSizePx": null,
+  "fontWeightRegular": null,
+  "fontWeightMedium": null,
+  "fontWeightBold": null,
+  "lineHeight": null,
+  "letterSpacingEm": null,
+} satisfies PortalBrandTypographyV1
+
+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 PortalBrandTypographyV1
+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/PostPortal.md

@@ -9,6 +9,7 @@ Name | Type
 `name` | string
 `headerBackgroundColor` | string
 `headerTextColor` | string
+`brandingTheme` | [PortalBrandThemeV1](PortalBrandThemeV1.md)
 `slug` | string
 `clientDomain` | string
 
@@ -22,6 +23,7 @@ const example = {
   "name": null,
   "headerBackgroundColor": null,
   "headerTextColor": null,
+  "brandingTheme": null,
   "slug": null,
   "clientDomain": null,
 } satisfies PostPortal

package/docs/PutPortalBranding.md

@@ -9,6 +9,7 @@ Name | Type
 `name` | string
 `headerBackgroundColor` | string
 `headerTextColor` | string
+`brandingTheme` | [PortalBrandThemeV1](PortalBrandThemeV1.md)
 `slug` | string
 `clientDomain` | string
 
@@ -22,6 +23,7 @@ const example = {
   "name": null,
   "headerBackgroundColor": null,
   "headerTextColor": null,
+  "brandingTheme": null,
   "slug": null,
   "clientDomain": null,
 } satisfies PutPortalBranding

package/package.json

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

package/src/apis/EmailTemplateApi.ts

@@ -85,6 +85,10 @@ export interface DeleteSystemEmailTemplateDraftRequest {
 export interface GetEmailDeliveryListRequest {
     page?: number;
     pageSize?: number;
+    templateKey?: string;
+    status?: GetEmailDeliveryListStatusEnum;
+    recipient?: string;
+    isTest?: boolean;
 }
 
 export interface GetEmailTemplateRequest {
@@ -204,6 +208,10 @@ export interface PutSystemEmailTemplateDraftRequest {
     putEmailTemplateDraft: PutEmailTemplateDraft;
 }
 
+export interface ResendEmailDeliveryRequest {
+    deliveryId: string;
+}
+
 /**
  * 
  */
@@ -311,6 +319,22 @@ export class EmailTemplateApi extends runtime.BaseAPI {
             queryParameters['pageSize'] = requestParameters['pageSize'];
         }
 
+        if (requestParameters['templateKey'] != null) {
+            queryParameters['templateKey'] = requestParameters['templateKey'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['recipient'] != null) {
+            queryParameters['recipient'] = requestParameters['recipient'];
+        }
+
+        if (requestParameters['isTest'] != null) {
+            queryParameters['isTest'] = requestParameters['isTest'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -1699,4 +1723,63 @@ export class EmailTemplateApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for resendEmailDelivery without sending the request
+     */
+    async resendEmailDeliveryRequestOpts(requestParameters: ResendEmailDeliveryRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['deliveryId'] == null) {
+            throw new runtime.RequiredError(
+                'deliveryId',
+                'Required parameter "deliveryId" was null or undefined when calling resendEmailDelivery().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/email-deliveries/{deliveryId}/resend`;
+        urlPath = urlPath.replace('{deliveryId}', encodeURIComponent(String(requestParameters['deliveryId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Regenerate and queue a portal email from its current business source
+     */
+    async resendEmailDeliveryRaw(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailDelivery>> {
+        const requestOptions = await this.resendEmailDeliveryRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailDeliveryFromJSON(jsonValue));
+    }
+
+    /**
+     * Regenerate and queue a portal email from its current business source
+     */
+    async resendEmailDelivery(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailDelivery> {
+        const response = await this.resendEmailDeliveryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
+
+/**
+ * @export
+ */
+export const GetEmailDeliveryListStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+} as const;
+export type GetEmailDeliveryListStatusEnum = typeof GetEmailDeliveryListStatusEnum[keyof typeof GetEmailDeliveryListStatusEnum];

package/src/apis/PortalApi.ts

@@ -991,7 +991,7 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     async putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
         const requestOptions = await this.putPortalBrandingRequestOpts(requestParameters);
@@ -1001,7 +1001,7 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     async putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal> {
         const response = await this.putPortalBrandingRaw(requestParameters, initOverrides);

package/src/models/GetEmailDelivery.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
+import {
+    GetPortalInvitationSummaryFromJSON,
+    GetPortalInvitationSummaryFromJSONTyped,
+    GetPortalInvitationSummaryToJSON,
+    GetPortalInvitationSummaryToJSONTyped,
+} from './GetPortalInvitationSummary';
+
 /**
  * 
  * @export
@@ -43,6 +51,12 @@ export interface GetEmailDelivery {
      * @memberof GetEmailDelivery
      */
     recipient: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    subject?: string | null;
     /**
      * 
      * @type {boolean}
@@ -103,6 +117,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;
 }
 
 
@@ -132,6 +170,7 @@ export function instanceOfGetEmailDelivery(value: object): value is GetEmailDeli
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('attempts' in value) || value['attempts'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('canResend' in value) || value['canResend'] === undefined) return false;
     return true;
 }
 
@@ -149,6 +188,7 @@ export function GetEmailDeliveryFromJSONTyped(json: any, ignoreDiscriminator: bo
         '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'],
@@ -159,6 +199,10 @@ export function GetEmailDeliveryFromJSONTyped(json: any, ignoreDiscriminator: bo
         '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 : GetPortalInvitationSummaryFromJSON(json['invitation']),
     };
 }
 
@@ -177,6 +221,7 @@ export function GetEmailDeliveryToJSONTyped(value?: GetEmailDelivery | null, ign
         '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'],
@@ -187,6 +232,10 @@ export function GetEmailDeliveryToJSONTyped(value?: GetEmailDelivery | null, ign
         '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': GetPortalInvitationSummaryToJSON(value['invitation']),
     };
 }
 

package/src/models/GetPortal.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
+import {
+    PortalBrandThemeV1FromJSON,
+    PortalBrandThemeV1FromJSONTyped,
+    PortalBrandThemeV1ToJSON,
+    PortalBrandThemeV1ToJSONTyped,
+} from './PortalBrandThemeV1';
+
 /**
  * 
  * @export
@@ -62,17 +70,25 @@ export interface GetPortal {
      */
     faviconUrl?: string | null;
     /**
-     * 
+     * Deprecated compatibility alias for branding_theme.colors.header_background.
      * @type {string}
      * @memberof GetPortal
+     * @deprecated
      */
     headerBackgroundColor: string;
     /**
-     * 
+     * Deprecated compatibility alias for branding_theme.colors.header_foreground.
      * @type {string}
      * @memberof GetPortal
+     * @deprecated
      */
     headerTextColor: string;
+    /**
+     * 
+     * @type {PortalBrandThemeV1}
+     * @memberof GetPortal
+     */
+    brandingTheme: PortalBrandThemeV1;
     /**
      * The user's highest-privilege role base type for this portal
      * @type {GetPortalBaseTypeEnum}
@@ -105,6 +121,7 @@ export function instanceOfGetPortal(value: object): value is GetPortal {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('headerBackgroundColor' in value) || value['headerBackgroundColor'] === undefined) return false;
     if (!('headerTextColor' in value) || value['headerTextColor'] === undefined) return false;
+    if (!('brandingTheme' in value) || value['brandingTheme'] === undefined) return false;
     return true;
 }
 
@@ -127,6 +144,7 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
+        'brandingTheme': PortalBrandThemeV1FromJSON(json['branding_theme']),
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
     };
 }
@@ -151,6 +169,7 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
         'base_type': value['baseType'],
     };
 }