@easyedu/js-lsm-api 1.105.0 → 1.107.0

package/src/apis/CourseShareApi.ts

@@ -43,6 +43,10 @@ export interface DeleteCourseShareRequest {
     shareId: string;
 }
 
+export interface GetCourseSharesOfferedByMeRequest {
+    state?: GetCourseSharesOfferedByMeStateEnum;
+}
+
 export interface GetCourseSharesOfferedToMeRequest {
     state?: GetCourseSharesOfferedToMeStateEnum;
 }
@@ -127,9 +131,13 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedByMe without sending the request
      */
-    async getCourseSharesOfferedByMeRequestOpts(): Promise<runtime.RequestOpts> {
+    async getCourseSharesOfferedByMeRequestOpts(requestParameters: GetCourseSharesOfferedByMeRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
+        if (requestParameters['state'] != null) {
+            queryParameters['state'] = requestParameters['state'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -146,8 +154,8 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * List shares the current portal has offered out
      */
-    async getCourseSharesOfferedByMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
-        const requestOptions = await this.getCourseSharesOfferedByMeRequestOpts();
+    async getCourseSharesOfferedByMeRaw(requestParameters: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
+        const requestOptions = await this.getCourseSharesOfferedByMeRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
@@ -156,8 +164,8 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * List shares the current portal has offered out
      */
-    async getCourseSharesOfferedByMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
-        const response = await this.getCourseSharesOfferedByMeRaw(initOverrides);
+    async getCourseSharesOfferedByMe(requestParameters: GetCourseSharesOfferedByMeRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
+        const response = await this.getCourseSharesOfferedByMeRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
@@ -243,7 +251,7 @@ export class CourseShareApi extends runtime.BaseAPI {
 
     /**
      * Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`. 
-     * Offer every course in a catalog to a descendant portal
+     * Offer every course in a catalog to another portal
      */
     async postOfferCatalogRaw(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCatalogResponse>> {
         const requestOptions = await this.postOfferCatalogRequestOpts(requestParameters);
@@ -254,7 +262,7 @@ export class CourseShareApi extends runtime.BaseAPI {
 
     /**
      * Fans out one `course_share` per catalog member. Duplicates are silently skipped. The catalog link is preserved on each generated share via `origin_catalog_id`. 
-     * Offer every course in a catalog to a descendant portal
+     * Offer every course in a catalog to another portal
      */
     async postOfferCatalog(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCatalogResponse> {
         const response = await this.postOfferCatalogRaw(requestParameters, initOverrides);
@@ -299,7 +307,7 @@ export class CourseShareApi extends runtime.BaseAPI {
     }
 
     /**
-     * Offer a single course to a descendant portal
+     * Offer a single course to another portal
      */
     async postOfferCourseRaw(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCourseResponse>> {
         const requestOptions = await this.postOfferCourseRequestOpts(requestParameters);
@@ -309,7 +317,7 @@ export class CourseShareApi extends runtime.BaseAPI {
     }
 
     /**
-     * Offer a single course to a descendant portal
+     * Offer a single course to another portal
      */
     async postOfferCourse(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCourseResponse> {
         const response = await this.postOfferCourseRaw(requestParameters, initOverrides);
@@ -494,6 +502,17 @@ export class CourseShareApi extends runtime.BaseAPI {
 
 }
 
+/**
+ * @export
+ */
+export const GetCourseSharesOfferedByMeStateEnum = {
+    Offered: 'offered',
+    AcceptedMirror: 'accepted_mirror',
+    AcceptedClone: 'accepted_clone',
+    Declined: 'declined',
+    Revoked: 'revoked'
+} as const;
+export type GetCourseSharesOfferedByMeStateEnum = typeof GetCourseSharesOfferedByMeStateEnum[keyof typeof GetCourseSharesOfferedByMeStateEnum];
 /**
  * @export
  */

package/src/apis/PortalApi.ts

@@ -991,7 +991,7 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     async putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
         const requestOptions = await this.putPortalBrandingRequestOpts(requestParameters);
@@ -1001,7 +1001,7 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     async putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal> {
         const response = await this.putPortalBrandingRaw(requestParameters, initOverrides);

package/src/models/CourseShare.ts

@@ -14,9 +14,9 @@
 
 import { mapValues } from '../runtime';
 /**
- * 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
@@ -29,11 +29,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}
@@ -41,11 +41,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}
@@ -70,6 +82,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;
 }
 
 
@@ -103,11 +151,19 @@ export function instanceOfCourseShare(value: object): value is CourseShare {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('sourcePortalId' in value) || value['sourcePortalId'] === undefined) 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) return false;
     if (!('allowedMode' in value) || value['allowedMode'] === undefined) return false;
     if (!('state' in value) || value['state'] === undefined) 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;
 }
 
@@ -124,11 +180,19 @@ export function CourseShareFromJSONTyped(json: any, ignoreDiscriminator: boolean
         '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'])),
     };
 }
 
@@ -146,11 +210,19 @@ export function CourseShareToJSONTyped(value?: CourseShare | null, ignoreDiscrim
         '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/src/models/GetCourseExport.ts

@@ -31,6 +31,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}
@@ -116,6 +122,7 @@ export type GetCourseExportStatusEnum = typeof GetCourseExportStatusEnum[keyof t
 export function instanceOfGetCourseExport(value: object): value is GetCourseExport {
     if (!('id' in value) || value['id'] === undefined) 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) return false;
     if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
@@ -136,6 +143,7 @@ export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boo
         
         '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'],
@@ -161,6 +169,7 @@ export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignor
         
         '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/src/models/GetPortal.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
+import {
+    PortalBrandThemeV1FromJSON,
+    PortalBrandThemeV1FromJSONTyped,
+    PortalBrandThemeV1ToJSON,
+    PortalBrandThemeV1ToJSONTyped,
+} from './PortalBrandThemeV1';
+
 /**
  * 
  * @export
@@ -62,17 +70,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}
@@ -105,6 +121,7 @@ export function instanceOfGetPortal(value: object): value is GetPortal {
     if (!('name' in value) || value['name'] === 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;
 }
 
@@ -127,6 +144,7 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
+        'brandingTheme': PortalBrandThemeV1FromJSON(json['branding_theme']),
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
     };
 }
@@ -151,6 +169,7 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
         'base_type': value['baseType'],
     };
 }

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