@easyedu/js-lsm-api 1.104.0 → 1.106.0

package/src/models/GetPortalInvitationSummary.ts

@@ -0,0 +1,160 @@
+/* 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';
+/**
+ * Invitation lifecycle and latest email delivery state for a portal user.
+ * @export
+ * @interface GetPortalInvitationSummary
+ */
+export interface GetPortalInvitationSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    id: string;
+    /**
+     * 
+     * @type {GetPortalInvitationSummaryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    status: GetPortalInvitationSummaryStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    invitedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    expiresAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    acceptedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    lastSentAt?: number | null;
+    /**
+     * 
+     * @type {GetPortalInvitationSummaryLatestDeliveryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    latestDeliveryStatus?: GetPortalInvitationSummaryLatestDeliveryStatusEnum | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetPortalInvitationSummary
+     */
+    canResend: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    resendBlockedReason?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetPortalInvitationSummaryStatusEnum = {
+    Pending: 'pending',
+    Expired: 'expired',
+    Accepted: 'accepted'
+} as const;
+export type GetPortalInvitationSummaryStatusEnum = typeof GetPortalInvitationSummaryStatusEnum[keyof typeof GetPortalInvitationSummaryStatusEnum];
+
+/**
+ * @export
+ */
+export const GetPortalInvitationSummaryLatestDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+} as const;
+export type GetPortalInvitationSummaryLatestDeliveryStatusEnum = typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum[keyof typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+export function instanceOfGetPortalInvitationSummary(value: object): value is GetPortalInvitationSummary {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('invitedAt' in value) || value['invitedAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('canResend' in value) || value['canResend'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalInvitationSummaryFromJSON(json: any): GetPortalInvitationSummary {
+    return GetPortalInvitationSummaryFromJSONTyped(json, false);
+}
+
+export function GetPortalInvitationSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalInvitationSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'invitedAt': json['invited_at'],
+        'expiresAt': json['expires_at'],
+        'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
+        'lastSentAt': json['last_sent_at'] == null ? undefined : json['last_sent_at'],
+        'latestDeliveryStatus': json['latest_delivery_status'] == null ? undefined : json['latest_delivery_status'],
+        'canResend': json['can_resend'],
+        'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
+    };
+}
+
+export function GetPortalInvitationSummaryToJSON(json: any): GetPortalInvitationSummary {
+    return GetPortalInvitationSummaryToJSONTyped(json, false);
+}
+
+export function GetPortalInvitationSummaryToJSONTyped(value?: GetPortalInvitationSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'invited_at': value['invitedAt'],
+        'expires_at': value['expiresAt'],
+        'accepted_at': value['acceptedAt'],
+        'last_sent_at': value['lastSentAt'],
+        'latest_delivery_status': value['latestDeliveryStatus'],
+        'can_resend': value['canResend'],
+        'resend_blocked_reason': value['resendBlockedReason'],
+    };
+}
+

package/src/models/GetPortalUser.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
+import {
+    GetPortalInvitationSummaryFromJSON,
+    GetPortalInvitationSummaryFromJSONTyped,
+    GetPortalInvitationSummaryToJSON,
+    GetPortalInvitationSummaryToJSONTyped,
+} from './GetPortalInvitationSummary';
+
 /**
  * A user with their portal access information
  * @export
@@ -55,6 +63,12 @@ export interface GetPortalUser {
      * @memberof GetPortalUser
      */
     isActive: boolean;
+    /**
+     * 
+     * @type {GetPortalInvitationSummary}
+     * @memberof GetPortalUser
+     */
+    invitation?: GetPortalInvitationSummary | null;
 }
 
 /**
@@ -86,6 +100,7 @@ export function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boole
         'lastName': json['last_name'],
         'role': json['role'],
         'isActive': json['is_active'],
+        'invitation': json['invitation'] == null ? undefined : GetPortalInvitationSummaryFromJSON(json['invitation']),
     };
 }
 
@@ -106,6 +121,7 @@ export function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDis
         'last_name': value['lastName'],
         'role': value['role'],
         'is_active': value['isActive'],
+        'invitation': GetPortalInvitationSummaryToJSON(value['invitation']),
     };
 }
 

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

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