@easyedu/js-lsm-api 1.105.0 → 1.106.0

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.105.0",
+  "version": "1.106.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

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/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'],
     };
 }

package/src/models/GetPublicPortalBranding.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
+import {
+    PortalBrandThemeV1FromJSON,
+    PortalBrandThemeV1FromJSONTyped,
+    PortalBrandThemeV1ToJSON,
+    PortalBrandThemeV1ToJSONTyped,
+} from './PortalBrandThemeV1';
+
 /**
  * Public portal branding resolved from the browser host.
  * @export
@@ -50,17 +58,25 @@ export interface GetPublicPortalBranding {
      */
     faviconUrl: string | null;
     /**
-     * 
+     * Deprecated compatibility alias for branding_theme.colors.header_background.
      * @type {string}
      * @memberof GetPublicPortalBranding
+     * @deprecated
      */
     headerBackgroundColor: string;
     /**
-     * 
+     * Deprecated compatibility alias for branding_theme.colors.header_foreground.
      * @type {string}
      * @memberof GetPublicPortalBranding
+     * @deprecated
      */
     headerTextColor: string;
+    /**
+     * 
+     * @type {PortalBrandThemeV1}
+     * @memberof GetPublicPortalBranding
+     */
+    brandingTheme: PortalBrandThemeV1;
 }
 
 /**
@@ -74,6 +90,7 @@ export function instanceOfGetPublicPortalBranding(value: object): value is GetPu
     if (!('faviconUrl' in value) || value['faviconUrl'] === 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;
 }
 
@@ -94,6 +111,7 @@ export function GetPublicPortalBrandingFromJSONTyped(json: any, ignoreDiscrimina
         'faviconUrl': json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
+        'brandingTheme': PortalBrandThemeV1FromJSON(json['branding_theme']),
     };
 }
 
@@ -115,6 +133,7 @@ export function GetPublicPortalBrandingToJSONTyped(value?: GetPublicPortalBrandi
         'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
     };
 }
 

package/src/models/PortalBrandColorsV1.ts

@@ -0,0 +1,309 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Semantic colors for a portal-owned light application theme. Every value is an opaque hexadecimal color.
+ * @export
+ * @interface PortalBrandColorsV1
+ */
+export interface PortalBrandColorsV1 {
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    headerBackground: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    headerForeground: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    navigationBackground: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    navigationForeground: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    primaryAction: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    onPrimaryAction: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    secondaryAction: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    onSecondaryAction: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    pageBackground: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    surfaceBackground: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    textPrimary: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    textSecondary: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    divider: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    link: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    linkHover: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    active: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    onActive: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    focusRing: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    progress: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    progressTrack: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    success: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    onSuccess: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    warning: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    onWarning: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    error: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    onError: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    info: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalBrandColorsV1
+     */
+    onInfo: string;
+}
+
+/**
+ * Check if a given object implements the PortalBrandColorsV1 interface.
+ */
+export function instanceOfPortalBrandColorsV1(value: object): value is PortalBrandColorsV1 {
+    if (!('headerBackground' in value) || value['headerBackground'] === undefined) return false;
+    if (!('headerForeground' in value) || value['headerForeground'] === undefined) return false;
+    if (!('navigationBackground' in value) || value['navigationBackground'] === undefined) return false;
+    if (!('navigationForeground' in value) || value['navigationForeground'] === undefined) return false;
+    if (!('primaryAction' in value) || value['primaryAction'] === undefined) return false;
+    if (!('onPrimaryAction' in value) || value['onPrimaryAction'] === undefined) return false;
+    if (!('secondaryAction' in value) || value['secondaryAction'] === undefined) return false;
+    if (!('onSecondaryAction' in value) || value['onSecondaryAction'] === undefined) return false;
+    if (!('pageBackground' in value) || value['pageBackground'] === undefined) return false;
+    if (!('surfaceBackground' in value) || value['surfaceBackground'] === undefined) return false;
+    if (!('textPrimary' in value) || value['textPrimary'] === undefined) return false;
+    if (!('textSecondary' in value) || value['textSecondary'] === undefined) return false;
+    if (!('divider' in value) || value['divider'] === undefined) return false;
+    if (!('link' in value) || value['link'] === undefined) return false;
+    if (!('linkHover' in value) || value['linkHover'] === undefined) return false;
+    if (!('active' in value) || value['active'] === undefined) return false;
+    if (!('onActive' in value) || value['onActive'] === undefined) return false;
+    if (!('focusRing' in value) || value['focusRing'] === undefined) return false;
+    if (!('progress' in value) || value['progress'] === undefined) return false;
+    if (!('progressTrack' in value) || value['progressTrack'] === undefined) return false;
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('onSuccess' in value) || value['onSuccess'] === undefined) return false;
+    if (!('warning' in value) || value['warning'] === undefined) return false;
+    if (!('onWarning' in value) || value['onWarning'] === undefined) return false;
+    if (!('error' in value) || value['error'] === undefined) return false;
+    if (!('onError' in value) || value['onError'] === undefined) return false;
+    if (!('info' in value) || value['info'] === undefined) return false;
+    if (!('onInfo' in value) || value['onInfo'] === undefined) return false;
+    return true;
+}
+
+export function PortalBrandColorsV1FromJSON(json: any): PortalBrandColorsV1 {
+    return PortalBrandColorsV1FromJSONTyped(json, false);
+}
+
+export function PortalBrandColorsV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandColorsV1 {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'headerBackground': json['header_background'],
+        'headerForeground': json['header_foreground'],
+        'navigationBackground': json['navigation_background'],
+        'navigationForeground': json['navigation_foreground'],
+        'primaryAction': json['primary_action'],
+        'onPrimaryAction': json['on_primary_action'],
+        'secondaryAction': json['secondary_action'],
+        'onSecondaryAction': json['on_secondary_action'],
+        'pageBackground': json['page_background'],
+        'surfaceBackground': json['surface_background'],
+        'textPrimary': json['text_primary'],
+        'textSecondary': json['text_secondary'],
+        'divider': json['divider'],
+        'link': json['link'],
+        'linkHover': json['link_hover'],
+        'active': json['active'],
+        'onActive': json['on_active'],
+        'focusRing': json['focus_ring'],
+        'progress': json['progress'],
+        'progressTrack': json['progress_track'],
+        'success': json['success'],
+        'onSuccess': json['on_success'],
+        'warning': json['warning'],
+        'onWarning': json['on_warning'],
+        'error': json['error'],
+        'onError': json['on_error'],
+        'info': json['info'],
+        'onInfo': json['on_info'],
+    };
+}
+
+export function PortalBrandColorsV1ToJSON(json: any): PortalBrandColorsV1 {
+    return PortalBrandColorsV1ToJSONTyped(json, false);
+}
+
+export function PortalBrandColorsV1ToJSONTyped(value?: PortalBrandColorsV1 | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'header_background': value['headerBackground'],
+        'header_foreground': value['headerForeground'],
+        'navigation_background': value['navigationBackground'],
+        'navigation_foreground': value['navigationForeground'],
+        'primary_action': value['primaryAction'],
+        'on_primary_action': value['onPrimaryAction'],
+        'secondary_action': value['secondaryAction'],
+        'on_secondary_action': value['onSecondaryAction'],
+        'page_background': value['pageBackground'],
+        'surface_background': value['surfaceBackground'],
+        'text_primary': value['textPrimary'],
+        'text_secondary': value['textSecondary'],
+        'divider': value['divider'],
+        'link': value['link'],
+        'link_hover': value['linkHover'],
+        'active': value['active'],
+        'on_active': value['onActive'],
+        'focus_ring': value['focusRing'],
+        'progress': value['progress'],
+        'progress_track': value['progressTrack'],
+        'success': value['success'],
+        'on_success': value['onSuccess'],
+        'warning': value['warning'],
+        'on_warning': value['onWarning'],
+        'error': value['error'],
+        'on_error': value['onError'],
+        'info': value['info'],
+        'on_info': value['onInfo'],
+    };
+}
+