@easyedu/js-lsm-api 1.105.0 → 1.107.0

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

@@ -157,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

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

package/dist/models/CourseShare.d.ts

@@ -10,9 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- * Shape returned by `GET /course-shares/offered-to-me`. Includes joined source
- * portal name and course name so the child portal can render an inbox without
- * follow-up requests.
+ * Shared shape returned by the incoming and outgoing course-share lists. All
+ * resource identifiers are public external IDs so clients can link to the
+ * related course, portal, and catalog without exposing database keys.
  *
  * @export
  * @interface CourseShare
@@ -25,11 +25,11 @@ export interface CourseShare {
      */
     id: string;
     /**
-     * Internal ID of the offering portal
-     * @type {number}
+     * External ID of the offering portal
+     * @type {string}
      * @memberof CourseShare
      */
-    sourcePortalId: number;
+    sourcePortalId: string;
     /**
      * Display name of the offering portal
      * @type {string}
@@ -37,11 +37,23 @@ export interface CourseShare {
      */
     sourcePortalName: string;
     /**
-     * Internal ID of the offered course
-     * @type {number}
+     * External ID of the receiving portal
+     * @type {string}
+     * @memberof CourseShare
+     */
+    targetPortalId: string;
+    /**
+     * Display name of the receiving portal
+     * @type {string}
+     * @memberof CourseShare
+     */
+    targetPortalName: string;
+    /**
+     * External ID of the offered course
+     * @type {string}
      * @memberof CourseShare
      */
-    courseId: number;
+    courseId: string;
     /**
      * Display name of the offered course
      * @type {string}
@@ -66,6 +78,42 @@ export interface CourseShare {
      * @memberof CourseShare
      */
     allowResharing: boolean;
+    /**
+     * Per-share seat cap; null means unlimited
+     * @type {number}
+     * @memberof CourseShare
+     */
+    seatLimit: number | null;
+    /**
+     * External ID of the catalog that produced the offer, when applicable
+     * @type {string}
+     * @memberof CourseShare
+     */
+    originCatalogId: string | null;
+    /**
+     * Display name of the catalog that produced the offer, when applicable
+     * @type {string}
+     * @memberof CourseShare
+     */
+    originCatalogName: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CourseShare
+     */
+    offeredAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CourseShare
+     */
+    respondedAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CourseShare
+     */
+    revokedAt: Date | null;
 }
 /**
  * @export

package/dist/models/CourseShare.js

@@ -47,6 +47,10 @@ function instanceOfCourseShare(value) {
         return false;
     if (!('sourcePortalName' in value) || value['sourcePortalName'] === undefined)
         return false;
+    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined)
+        return false;
+    if (!('targetPortalName' in value) || value['targetPortalName'] === undefined)
+        return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
     if (!('courseName' in value) || value['courseName'] === undefined)
@@ -57,6 +61,18 @@ function instanceOfCourseShare(value) {
         return false;
     if (!('allowResharing' in value) || value['allowResharing'] === undefined)
         return false;
+    if (!('seatLimit' in value) || value['seatLimit'] === undefined)
+        return false;
+    if (!('originCatalogId' in value) || value['originCatalogId'] === undefined)
+        return false;
+    if (!('originCatalogName' in value) || value['originCatalogName'] === undefined)
+        return false;
+    if (!('offeredAt' in value) || value['offeredAt'] === undefined)
+        return false;
+    if (!('respondedAt' in value) || value['respondedAt'] === undefined)
+        return false;
+    if (!('revokedAt' in value) || value['revokedAt'] === undefined)
+        return false;
     return true;
 }
 function CourseShareFromJSON(json) {
@@ -70,11 +86,19 @@ function CourseShareFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'sourcePortalId': json['source_portal_id'],
         'sourcePortalName': json['source_portal_name'],
+        'targetPortalId': json['target_portal_id'],
+        'targetPortalName': json['target_portal_name'],
         'courseId': json['course_id'],
         'courseName': json['course_name'],
         'allowedMode': json['allowed_mode'],
         'state': json['state'],
         'allowResharing': json['allow_resharing'],
+        'seatLimit': json['seat_limit'],
+        'originCatalogId': json['origin_catalog_id'],
+        'originCatalogName': json['origin_catalog_name'],
+        'offeredAt': (new Date(json['offered_at'])),
+        'respondedAt': (json['responded_at'] == null ? null : new Date(json['responded_at'])),
+        'revokedAt': (json['revoked_at'] == null ? null : new Date(json['revoked_at'])),
     };
 }
 function CourseShareToJSON(json) {
@@ -88,10 +112,18 @@ function CourseShareToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'source_portal_id': value['sourcePortalId'],
         'source_portal_name': value['sourcePortalName'],
+        'target_portal_id': value['targetPortalId'],
+        'target_portal_name': value['targetPortalName'],
         'course_id': value['courseId'],
         'course_name': value['courseName'],
         'allowed_mode': value['allowedMode'],
         'state': value['state'],
         'allow_resharing': value['allowResharing'],
+        'seat_limit': value['seatLimit'],
+        'origin_catalog_id': value['originCatalogId'],
+        'origin_catalog_name': value['originCatalogName'],
+        'offered_at': value['offeredAt'].toISOString(),
+        'responded_at': value['respondedAt'] == null ? value['respondedAt'] : value['respondedAt'].toISOString(),
+        'revoked_at': value['revokedAt'] == null ? value['revokedAt'] : value['revokedAt'].toISOString(),
     };
 }

package/dist/models/GetCourseExport.d.ts

@@ -27,6 +27,12 @@ export interface GetCourseExport {
      * @memberof GetCourseExport
      */
     courseId: string;
+    /**
+     * Display name of the course being exported
+     * @type {string}
+     * @memberof GetCourseExport
+     */
+    courseName: string;
     /**
      * Immutable version used by the export; null only for historical records.
      * @type {string}

package/dist/models/GetCourseExport.js

@@ -44,6 +44,8 @@ function instanceOfGetCourseExport(value) {
         return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
+    if (!('courseName' in value) || value['courseName'] === undefined)
+        return false;
     if (!('exportType' in value) || value['exportType'] === undefined)
         return false;
     if (!('sectionIds' in value) || value['sectionIds'] === undefined)
@@ -66,6 +68,7 @@ function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'courseId': json['course_id'],
+        'courseName': json['course_name'],
         'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
         'exportType': json['export_type'],
         'sectionIds': json['section_ids'],
@@ -87,6 +90,7 @@ function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'course_id': value['courseId'],
+        'course_name': value['courseName'],
         'course_version_id': value['courseVersionId'],
         'export_type': value['exportType'],
         'section_ids': value['sectionIds'],

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

package/dist/models/GetPublicPortalBranding.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
 /**
  * Public portal branding resolved from the browser host.
  * @export
@@ -46,17 +47,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;
 }
 /**
  * Check if a given object implements the GetPublicPortalBranding interface.

package/dist/models/GetPublicPortalBranding.js

@@ -18,6 +18,7 @@ exports.GetPublicPortalBrandingFromJSON = GetPublicPortalBrandingFromJSON;
 exports.GetPublicPortalBrandingFromJSONTyped = GetPublicPortalBrandingFromJSONTyped;
 exports.GetPublicPortalBrandingToJSON = GetPublicPortalBrandingToJSON;
 exports.GetPublicPortalBrandingToJSONTyped = GetPublicPortalBrandingToJSONTyped;
+const PortalBrandThemeV1_1 = require("./PortalBrandThemeV1");
 /**
  * Check if a given object implements the GetPublicPortalBranding interface.
  */
@@ -36,6 +37,8 @@ function instanceOfGetPublicPortalBranding(value) {
         return false;
     if (!('headerTextColor' in value) || value['headerTextColor'] === undefined)
         return false;
+    if (!('brandingTheme' in value) || value['brandingTheme'] === undefined)
+        return false;
     return true;
 }
 function GetPublicPortalBrandingFromJSON(json) {
@@ -53,6 +56,7 @@ function GetPublicPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
         'faviconUrl': json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
+        'brandingTheme': (0, PortalBrandThemeV1_1.PortalBrandThemeV1FromJSON)(json['branding_theme']),
     };
 }
 function GetPublicPortalBrandingToJSON(json) {
@@ -70,5 +74,6 @@ function GetPublicPortalBrandingToJSONTyped(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']),
     };
 }

package/dist/models/PortalBrandColorsV1.d.ts

@@ -0,0 +1,194 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfPortalBrandColorsV1(value: object): value is PortalBrandColorsV1;
+export declare function PortalBrandColorsV1FromJSON(json: any): PortalBrandColorsV1;
+export declare function PortalBrandColorsV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandColorsV1;
+export declare function PortalBrandColorsV1ToJSON(json: any): PortalBrandColorsV1;
+export declare function PortalBrandColorsV1ToJSONTyped(value?: PortalBrandColorsV1 | null, ignoreDiscriminator?: boolean): any;