@easyedu/js-lsm-api 1.104.0 → 1.106.0

package/dist/esm/models/PortalBrandThemeV1.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 type { PortalBrandColorsV1 } from './PortalBrandColorsV1';
+import type { PortalBrandTypographyV1 } 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 declare const PortalBrandThemeV1SchemaVersionEnum: {
+    readonly V1: "v1";
+};
+export type PortalBrandThemeV1SchemaVersionEnum = typeof PortalBrandThemeV1SchemaVersionEnum[keyof typeof PortalBrandThemeV1SchemaVersionEnum];
+/**
+ * Check if a given object implements the PortalBrandThemeV1 interface.
+ */
+export declare function instanceOfPortalBrandThemeV1(value: object): value is PortalBrandThemeV1;
+export declare function PortalBrandThemeV1FromJSON(json: any): PortalBrandThemeV1;
+export declare function PortalBrandThemeV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandThemeV1;
+export declare function PortalBrandThemeV1ToJSON(json: any): PortalBrandThemeV1;
+export declare function PortalBrandThemeV1ToJSONTyped(value?: PortalBrandThemeV1 | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PortalBrandThemeV1.js

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

package/dist/esm/models/PortalBrandTypographyV1.d.ts

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

package/dist/esm/models/PortalBrandTypographyV1.js

@@ -0,0 +1,78 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PortalBrandTypographyV1FontFamilyEnum = {
+    Inter: 'Inter',
+    Roboto: 'Roboto',
+    OpenSans: 'Open Sans',
+    Montserrat: 'Montserrat',
+    SourceSans3: 'Source Sans 3',
+    NunitoSans: 'Nunito Sans'
+};
+/**
+ * Check if a given object implements the PortalBrandTypographyV1 interface.
+ */
+export function instanceOfPortalBrandTypographyV1(value) {
+    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) {
+    return PortalBrandTypographyV1FromJSONTyped(json, false);
+}
+export function PortalBrandTypographyV1FromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PortalBrandTypographyV1ToJSONTyped(json, false);
+}
+export function PortalBrandTypographyV1ToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/PostPortal.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
 /**
  *
  * @export
@@ -25,14 +26,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}

package/dist/esm/models/PostPortal.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { PortalBrandThemeV1FromJSON, PortalBrandThemeV1ToJSON, } from './PortalBrandThemeV1';
 /**
  * Check if a given object implements the PostPortal interface.
  */
@@ -30,6 +31,7 @@ export function PostPortalFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
     };
@@ -45,6 +47,7 @@ export function PostPortalToJSONTyped(value, ignoreDiscriminator = false) {
         '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/dist/esm/models/PutPortalBranding.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
 /**
  *
  * @export
@@ -25,14 +26,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}

package/dist/esm/models/PutPortalBranding.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { PortalBrandThemeV1FromJSON, PortalBrandThemeV1ToJSON, } from './PortalBrandThemeV1';
 /**
  * Check if a given object implements the PutPortalBranding interface.
  */
@@ -28,6 +29,7 @@ export function PutPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
     };
@@ -43,6 +45,7 @@ export function PutPortalBrandingToJSONTyped(value, ignoreDiscriminator = false)
         '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/dist/esm/models/index.d.ts

@@ -94,6 +94,7 @@ export * from './GetLibraryQuizVersion';
 export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalFaviconUpload';
+export * from './GetPortalInvitationSummary';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalUser';
@@ -156,6 +157,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';

package/dist/esm/models/index.js

@@ -96,6 +96,7 @@ export * from './GetLibraryQuizVersion';
 export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalFaviconUpload';
+export * from './GetPortalInvitationSummary';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalUser';
@@ -158,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';

package/dist/models/GetEmailDelivery.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
 /**
  *
  * @export
@@ -39,6 +40,12 @@ export interface GetEmailDelivery {
      * @memberof GetEmailDelivery
      */
     recipient: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    subject?: string | null;
     /**
      *
      * @type {boolean}
@@ -99,6 +106,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;
 }
 /**
  * @export

package/dist/models/GetEmailDelivery.js

@@ -19,6 +19,7 @@ exports.GetEmailDeliveryFromJSON = GetEmailDeliveryFromJSON;
 exports.GetEmailDeliveryFromJSONTyped = GetEmailDeliveryFromJSONTyped;
 exports.GetEmailDeliveryToJSON = GetEmailDeliveryToJSON;
 exports.GetEmailDeliveryToJSONTyped = GetEmailDeliveryToJSONTyped;
+const GetPortalInvitationSummary_1 = require("./GetPortalInvitationSummary");
 /**
  * @export
  */
@@ -49,6 +50,8 @@ function instanceOfGetEmailDelivery(value) {
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
+    if (!('canResend' in value) || value['canResend'] === undefined)
+        return false;
     return true;
 }
 function GetEmailDeliveryFromJSON(json) {
@@ -63,6 +66,7 @@ function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
@@ -73,6 +77,10 @@ function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
         '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 : (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryFromJSON)(json['invitation']),
     };
 }
 function GetEmailDeliveryToJSON(json) {
@@ -87,6 +95,7 @@ function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false) {
         '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'],
@@ -97,5 +106,9 @@ function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false) {
         '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': (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryToJSON)(value['invitation']),
     };
 }

package/dist/models/GetPortal.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
 /**
  *
  * @export
@@ -58,17 +59,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}

package/dist/models/GetPortal.js

@@ -19,6 +19,7 @@ exports.GetPortalFromJSON = GetPortalFromJSON;
 exports.GetPortalFromJSONTyped = GetPortalFromJSONTyped;
 exports.GetPortalToJSON = GetPortalToJSON;
 exports.GetPortalToJSONTyped = GetPortalToJSONTyped;
+const PortalBrandThemeV1_1 = require("./PortalBrandThemeV1");
 /**
  * @export
  */
@@ -43,6 +44,8 @@ function instanceOfGetPortal(value) {
         return false;
     if (!('headerTextColor' in value) || value['headerTextColor'] === undefined)
         return false;
+    if (!('brandingTheme' in value) || value['brandingTheme'] === undefined)
+        return false;
     return true;
 }
 function GetPortalFromJSON(json) {
@@ -62,6 +65,7 @@ function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
         'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
+        'brandingTheme': (0, PortalBrandThemeV1_1.PortalBrandThemeV1FromJSON)(json['branding_theme']),
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
     };
 }
@@ -82,6 +86,7 @@ function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': (0, PortalBrandThemeV1_1.PortalBrandThemeV1ToJSON)(value['brandingTheme']),
         'base_type': value['baseType'],
     };
 }