@easyedu/js-lsm-api 1.105.0 → 1.107.0

package/dist/esm/apis/CourseShareApi.d.ts

@@ -18,6 +18,9 @@ import { type PostOfferCourseResponse } from '../models/PostOfferCourseResponse'
 export interface DeleteCourseShareRequest {
     shareId: string;
 }
+export interface GetCourseSharesOfferedByMeRequest {
+    state?: GetCourseSharesOfferedByMeStateEnum;
+}
 export interface GetCourseSharesOfferedToMeRequest {
     state?: GetCourseSharesOfferedToMeStateEnum;
 }
@@ -62,15 +65,15 @@ export declare class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedByMe without sending the request
      */
-    getCourseSharesOfferedByMeRequestOpts(): Promise<runtime.RequestOpts>;
+    getCourseSharesOfferedByMeRequestOpts(requestParameters: GetCourseSharesOfferedByMeRequest): Promise<runtime.RequestOpts>;
     /**
      * List shares the current portal has offered out
      */
-    getCourseSharesOfferedByMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
+    getCourseSharesOfferedByMeRaw(requestParameters: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
     /**
      * List shares the current portal has offered out
      */
-    getCourseSharesOfferedByMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
+    getCourseSharesOfferedByMe(requestParameters?: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
     /**
      * Creates request options for getCourseSharesOfferedToMe without sending the request
      */
@@ -91,12 +94,12 @@ export declare class CourseShareApi extends runtime.BaseAPI {
     postOfferCatalogRequestOpts(requestParameters: PostOfferCatalogRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
      */
     postOfferCatalogRaw(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCatalogResponse>>;
     /**
      * 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
      */
     postOfferCatalog(requestParameters: PostOfferCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCatalogResponse>;
     /**
@@ -104,11 +107,11 @@ export declare class CourseShareApi extends runtime.BaseAPI {
      */
     postOfferCourseRequestOpts(requestParameters: PostOfferCourseRequest): Promise<runtime.RequestOpts>;
     /**
-     * Offer a single course to a descendant portal
+     * Offer a single course to another portal
      */
     postOfferCourseRaw(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostOfferCourseResponse>>;
     /**
-     * Offer a single course to a descendant portal
+     * Offer a single course to another portal
      */
     postOfferCourse(requestParameters: PostOfferCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostOfferCourseResponse>;
     /**
@@ -160,6 +163,17 @@ export declare class CourseShareApi extends runtime.BaseAPI {
      */
     putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetCourseSharesOfferedByMeStateEnum: {
+    readonly Offered: "offered";
+    readonly AcceptedMirror: "accepted_mirror";
+    readonly AcceptedClone: "accepted_clone";
+    readonly Declined: "declined";
+    readonly Revoked: "revoked";
+};
+export type GetCourseSharesOfferedByMeStateEnum = typeof GetCourseSharesOfferedByMeStateEnum[keyof typeof GetCourseSharesOfferedByMeStateEnum];
 /**
  * @export
  */

package/dist/esm/apis/CourseShareApi.js

@@ -73,9 +73,12 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedByMe without sending the request
      */
-    getCourseSharesOfferedByMeRequestOpts() {
+    getCourseSharesOfferedByMeRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
+            if (requestParameters['state'] != null) {
+                queryParameters['state'] = requestParameters['state'];
+            }
             const headerParameters = {};
             let urlPath = `/course-shares/offered-by-me`;
             return {
@@ -89,9 +92,9 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * List shares the current portal has offered out
      */
-    getCourseSharesOfferedByMeRaw(initOverrides) {
+    getCourseSharesOfferedByMeRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.getCourseSharesOfferedByMeRequestOpts();
+            const requestOptions = yield this.getCourseSharesOfferedByMeRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
         });
@@ -99,9 +102,9 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * List shares the current portal has offered out
      */
-    getCourseSharesOfferedByMe(initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getCourseSharesOfferedByMeRaw(initOverrides);
+    getCourseSharesOfferedByMe() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getCourseSharesOfferedByMeRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -172,7 +175,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
      */
     postOfferCatalogRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -183,7 +186,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
      */
     postOfferCatalog(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -217,7 +220,7 @@ export class CourseShareApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Offer a single course to a descendant portal
+     * Offer a single course to another portal
      */
     postOfferCourseRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -227,7 +230,7 @@ export class CourseShareApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Offer a single course to a descendant portal
+     * Offer a single course to another portal
      */
     postOfferCourse(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -388,6 +391,16 @@ export class CourseShareApi extends runtime.BaseAPI {
         });
     }
 }
+/**
+ * @export
+ */
+export const GetCourseSharesOfferedByMeStateEnum = {
+    Offered: 'offered',
+    AcceptedMirror: 'accepted_mirror',
+    AcceptedClone: 'accepted_clone',
+    Declined: 'declined',
+    Revoked: 'revoked'
+};
 /**
  * @export
  */

package/dist/esm/apis/PortalApi.d.ts

@@ -295,11 +295,11 @@ export declare class PortalApi extends runtime.BaseAPI {
      */
     putPortalBrandingRequestOpts(requestParameters: PutPortalBrandingRequest): Promise<runtime.RequestOpts>;
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
     /**

package/dist/esm/apis/PortalApi.js

@@ -744,7 +744,7 @@ export class PortalApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     putPortalBrandingRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -754,7 +754,7 @@ export class PortalApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Update portal branding (name, background color, text color)
+     * Update portal branding and complete application theme
      */
     putPortalBranding(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/esm/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/esm/models/CourseShare.js

@@ -39,6 +39,10 @@ export 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)
@@ -49,6 +53,18 @@ export 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;
 }
 export function CourseShareFromJSON(json) {
@@ -62,11 +78,19 @@ export 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'])),
     };
 }
 export function CourseShareToJSON(json) {
@@ -80,10 +104,18 @@ export 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/esm/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/esm/models/GetCourseExport.js

@@ -36,6 +36,8 @@ export 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)
@@ -58,6 +60,7 @@ export 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'],
@@ -79,6 +82,7 @@ export 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/esm/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/esm/models/GetPortal.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { PortalBrandThemeV1FromJSON, PortalBrandThemeV1ToJSON, } from './PortalBrandThemeV1';
 /**
  * @export
  */
@@ -35,6 +36,8 @@ export 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;
 }
 export function GetPortalFromJSON(json) {
@@ -54,6 +57,7 @@ export function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
     };
 }
@@ -74,6 +78,7 @@ export function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
         'base_type': value['baseType'],
     };
 }

package/dist/esm/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/esm/models/GetPublicPortalBranding.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 GetPublicPortalBranding interface.
  */
@@ -29,6 +30,8 @@ export 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;
 }
 export function GetPublicPortalBrandingFromJSON(json) {
@@ -46,6 +49,7 @@ export function GetPublicPortalBrandingFromJSONTyped(json, ignoreDiscriminator)
         'faviconUrl': json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
+        'brandingTheme': PortalBrandThemeV1FromJSON(json['branding_theme']),
     };
 }
 export function GetPublicPortalBrandingToJSON(json) {
@@ -63,5 +67,6 @@ export function GetPublicPortalBrandingToJSONTyped(value, ignoreDiscriminator =
         'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
     };
 }