@easyedu/js-lsm-api 1.105.0 → 1.106.0

package/src/models/PortalBrandThemeV1.ts

@@ -0,0 +1,109 @@
+/* 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';
+import type { PortalBrandColorsV1 } from './PortalBrandColorsV1';
+import {
+    PortalBrandColorsV1FromJSON,
+    PortalBrandColorsV1FromJSONTyped,
+    PortalBrandColorsV1ToJSON,
+    PortalBrandColorsV1ToJSONTyped,
+} from './PortalBrandColorsV1';
+import type { PortalBrandTypographyV1 } from './PortalBrandTypographyV1';
+import {
+    PortalBrandTypographyV1FromJSON,
+    PortalBrandTypographyV1FromJSONTyped,
+    PortalBrandTypographyV1ToJSON,
+    PortalBrandTypographyV1ToJSONTyped,
+} 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 const PortalBrandThemeV1SchemaVersionEnum = {
+    V1: 'v1'
+} as const;
+export type PortalBrandThemeV1SchemaVersionEnum = typeof PortalBrandThemeV1SchemaVersionEnum[keyof typeof PortalBrandThemeV1SchemaVersionEnum];
+
+
+/**
+ * Check if a given object implements the PortalBrandThemeV1 interface.
+ */
+export function instanceOfPortalBrandThemeV1(value: object): value is PortalBrandThemeV1 {
+    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;
+}
+
+export function PortalBrandThemeV1FromJSON(json: any): PortalBrandThemeV1 {
+    return PortalBrandThemeV1FromJSONTyped(json, false);
+}
+
+export function PortalBrandThemeV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandThemeV1 {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'schemaVersion': json['schema_version'],
+        'typography': PortalBrandTypographyV1FromJSON(json['typography']),
+        'colors': PortalBrandColorsV1FromJSON(json['colors']),
+    };
+}
+
+export function PortalBrandThemeV1ToJSON(json: any): PortalBrandThemeV1 {
+    return PortalBrandThemeV1ToJSONTyped(json, false);
+}
+
+export function PortalBrandThemeV1ToJSONTyped(value?: PortalBrandThemeV1 | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'schema_version': value['schemaVersion'],
+        'typography': PortalBrandTypographyV1ToJSON(value['typography']),
+        'colors': PortalBrandColorsV1ToJSON(value['colors']),
+    };
+}
+

package/src/models/PortalBrandTypographyV1.ts

@@ -0,0 +1,135 @@
+/* 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';
+/**
+ * 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 const PortalBrandTypographyV1FontFamilyEnum = {
+    Inter: 'Inter',
+    Roboto: 'Roboto',
+    OpenSans: 'Open Sans',
+    Montserrat: 'Montserrat',
+    SourceSans3: 'Source Sans 3',
+    NunitoSans: 'Nunito Sans'
+} as const;
+export type PortalBrandTypographyV1FontFamilyEnum = typeof PortalBrandTypographyV1FontFamilyEnum[keyof typeof PortalBrandTypographyV1FontFamilyEnum];
+
+
+/**
+ * Check if a given object implements the PortalBrandTypographyV1 interface.
+ */
+export function instanceOfPortalBrandTypographyV1(value: object): value is PortalBrandTypographyV1 {
+    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;
+}
+
+export function PortalBrandTypographyV1FromJSON(json: any): PortalBrandTypographyV1 {
+    return PortalBrandTypographyV1FromJSONTyped(json, false);
+}
+
+export function PortalBrandTypographyV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandTypographyV1 {
+    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'],
+    };
+}
+
+export function PortalBrandTypographyV1ToJSON(json: any): PortalBrandTypographyV1 {
+    return PortalBrandTypographyV1ToJSONTyped(json, false);
+}
+
+export function PortalBrandTypographyV1ToJSONTyped(value?: PortalBrandTypographyV1 | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PostPortal.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
+import {
+    PortalBrandThemeV1FromJSON,
+    PortalBrandThemeV1FromJSONTyped,
+    PortalBrandThemeV1ToJSON,
+    PortalBrandThemeV1ToJSONTyped,
+} from './PortalBrandThemeV1';
+
 /**
  * 
  * @export
@@ -29,14 +37,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}
@@ -72,6 +88,7 @@ export function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         '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 : PortalBrandThemeV1FromJSON(json['branding_theme']),
         'slug': json['slug'] == null ? undefined : json['slug'],
         'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
     };
@@ -91,6 +108,7 @@ export function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscrimin
         'name': value['name'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
         'slug': value['slug'],
         'client_domain': value['clientDomain'],
     };

package/src/models/PutPortalBranding.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
+import {
+    PortalBrandThemeV1FromJSON,
+    PortalBrandThemeV1FromJSONTyped,
+    PortalBrandThemeV1ToJSON,
+    PortalBrandThemeV1ToJSONTyped,
+} from './PortalBrandThemeV1';
+
 /**
  * 
  * @export
@@ -29,14 +37,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}
@@ -71,6 +87,7 @@ export function PutPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: b
         '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 : PortalBrandThemeV1FromJSON(json['branding_theme']),
         'slug': json['slug'] == null ? undefined : json['slug'],
         'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
     };
@@ -90,6 +107,7 @@ export function PutPortalBrandingToJSONTyped(value?: PutPortalBranding | null, i
         'name': value['name'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
         'slug': value['slug'],
         'client_domain': value['clientDomain'],
     };

package/src/models/index.ts

@@ -159,6 +159,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';