@easyedu/js-lsm-api 1.105.0 → 1.107.0

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

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/PostOfferCatalog.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface PostOfferCatalog {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCatalog
      */

package/src/models/PostOfferCourse.ts

@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
  */
 export interface PostOfferCourse {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCourse
      */

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';