@easyedu/js-lsm-api 1.52.0 → 1.54.0

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.52.0
+# @easyedu/js-lsm-api@1.54.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -107,6 +107,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *CourseApi* | [**putCourseEnrollment**](docs/CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment
 *CourseCatalogApi* | [**addCourseToCatalog**](docs/CourseCatalogApi.md#addcoursetocatalog) | **POST** /catalogs/{catalogId}/courses/{courseId} | Add a course to a catalog
 *CourseCatalogApi* | [**deleteCourseCatalog**](docs/CourseCatalogApi.md#deletecoursecatalog) | **DELETE** /catalogs/{catalogId} | Delete a catalog
+*CourseCatalogApi* | [**getCatalogCourses**](docs/CourseCatalogApi.md#getcatalogcourses) | **GET** /catalogs/{catalogId}/courses | List the courses in a catalog
 *CourseCatalogApi* | [**getCourseCatalog**](docs/CourseCatalogApi.md#getcoursecatalog) | **GET** /catalogs/{catalogId} | Get a catalog
 *CourseCatalogApi* | [**getCourseCatalogs**](docs/CourseCatalogApi.md#getcoursecatalogs) | **GET** /catalogs | List catalogs in the current portal
 *CourseCatalogApi* | [**postCourseCatalog**](docs/CourseCatalogApi.md#postcoursecatalog) | **POST** /catalogs | Create a course catalog
@@ -471,7 +472,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.52.0`
+- Package version: `1.54.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/CourseCatalogApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CourseCatalog, PostCourseCatalog, PutCourseCatalog } from '../models/index';
+import type { CourseCatalog, GetCourse, PostCourseCatalog, PutCourseCatalog } from '../models/index';
 export interface AddCourseToCatalogRequest {
     catalogId: string;
     courseId: string;
@@ -18,6 +18,9 @@ export interface AddCourseToCatalogRequest {
 export interface DeleteCourseCatalogRequest {
     catalogId: string;
 }
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
 export interface GetCourseCatalogRequest {
     catalogId: string;
 }
@@ -60,6 +63,18 @@ export declare class CourseCatalogApi extends runtime.BaseAPI {
      * Delete a catalog
      */
     deleteCourseCatalog(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>>;
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/dist/apis/CourseCatalogApi.js

@@ -109,6 +109,45 @@ class CourseCatalogApi extends runtime.BaseAPI {
             yield this.deleteCourseCatalogRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}/courses`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCatalogCoursesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetCourseFromJSON));
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCatalogCoursesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/dist/apis/CourseShareApi.d.ts

@@ -14,6 +14,9 @@ import type { CourseShare, PostOfferCatalog, PostOfferCatalogResponse, PostOffer
 export interface DeleteCourseShareRequest {
     shareId: string;
 }
+export interface GetCourseSharesOfferedToMeRequest {
+    state?: GetCourseSharesOfferedToMeStateEnum;
+}
 export interface PostOfferCatalogRequest {
     catalogId: string;
     postOfferCatalog: PostOfferCatalog;
@@ -67,15 +70,17 @@ export declare class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedToMe without sending the request
      */
-    getCourseSharesOfferedToMeRequestOpts(): Promise<runtime.RequestOpts>;
+    getCourseSharesOfferedToMeRequestOpts(requestParameters: GetCourseSharesOfferedToMeRequest): Promise<runtime.RequestOpts>;
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
+    getCourseSharesOfferedToMeRaw(requestParameters: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
+    getCourseSharesOfferedToMe(requestParameters?: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
     /**
      * Creates request options for postOfferCatalog without sending the request
      */
@@ -151,3 +156,14 @@ export declare class CourseShareApi extends runtime.BaseAPI {
      */
     putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetCourseSharesOfferedToMeStateEnum: {
+    readonly Offered: "offered";
+    readonly AcceptedMirror: "accepted_mirror";
+    readonly AcceptedClone: "accepted_clone";
+    readonly Declined: "declined";
+    readonly Revoked: "revoked";
+};
+export type GetCourseSharesOfferedToMeStateEnum = typeof GetCourseSharesOfferedToMeStateEnum[keyof typeof GetCourseSharesOfferedToMeStateEnum];

package/dist/apis/CourseShareApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CourseShareApi = void 0;
+exports.GetCourseSharesOfferedToMeStateEnum = exports.CourseShareApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -107,9 +107,12 @@ class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedToMe without sending the request
      */
-    getCourseSharesOfferedToMeRequestOpts() {
+    getCourseSharesOfferedToMeRequestOpts(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-to-me`;
             return {
@@ -121,21 +124,23 @@ class CourseShareApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMeRaw(initOverrides) {
+    getCourseSharesOfferedToMeRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.getCourseSharesOfferedToMeRequestOpts();
+            const requestOptions = yield this.getCourseSharesOfferedToMeRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.CourseShareFromJSON));
         });
     }
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMe(initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getCourseSharesOfferedToMeRaw(initOverrides);
+    getCourseSharesOfferedToMe() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getCourseSharesOfferedToMeRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -383,3 +388,13 @@ class CourseShareApi extends runtime.BaseAPI {
     }
 }
 exports.CourseShareApi = CourseShareApi;
+/**
+ * @export
+ */
+exports.GetCourseSharesOfferedToMeStateEnum = {
+    Offered: 'offered',
+    AcceptedMirror: 'accepted_mirror',
+    AcceptedClone: 'accepted_clone',
+    Declined: 'declined',
+    Revoked: 'revoked'
+};

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CourseCatalog, PostCourseCatalog, PutCourseCatalog } from '../models/index';
+import type { CourseCatalog, GetCourse, PostCourseCatalog, PutCourseCatalog } from '../models/index';
 export interface AddCourseToCatalogRequest {
     catalogId: string;
     courseId: string;
@@ -18,6 +18,9 @@ export interface AddCourseToCatalogRequest {
 export interface DeleteCourseCatalogRequest {
     catalogId: string;
 }
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
 export interface GetCourseCatalogRequest {
     catalogId: string;
 }
@@ -60,6 +63,18 @@ export declare class CourseCatalogApi extends runtime.BaseAPI {
      * Delete a catalog
      */
     deleteCourseCatalog(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>>;
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/dist/esm/apis/CourseCatalogApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CourseCatalogFromJSON, PostCourseCatalogToJSON, PutCourseCatalogToJSON, } from '../models/index';
+import { CourseCatalogFromJSON, GetCourseFromJSON, PostCourseCatalogToJSON, PutCourseCatalogToJSON, } from '../models/index';
 /**
  *
  */
@@ -106,6 +106,45 @@ export class CourseCatalogApi extends runtime.BaseAPI {
             yield this.deleteCourseCatalogRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}/courses`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCatalogCoursesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCourseFromJSON));
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCatalogCoursesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

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

@@ -14,6 +14,9 @@ import type { CourseShare, PostOfferCatalog, PostOfferCatalogResponse, PostOffer
 export interface DeleteCourseShareRequest {
     shareId: string;
 }
+export interface GetCourseSharesOfferedToMeRequest {
+    state?: GetCourseSharesOfferedToMeStateEnum;
+}
 export interface PostOfferCatalogRequest {
     catalogId: string;
     postOfferCatalog: PostOfferCatalog;
@@ -67,15 +70,17 @@ export declare class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedToMe without sending the request
      */
-    getCourseSharesOfferedToMeRequestOpts(): Promise<runtime.RequestOpts>;
+    getCourseSharesOfferedToMeRequestOpts(requestParameters: GetCourseSharesOfferedToMeRequest): Promise<runtime.RequestOpts>;
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
+    getCourseSharesOfferedToMeRaw(requestParameters: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>>;
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
+    getCourseSharesOfferedToMe(requestParameters?: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>>;
     /**
      * Creates request options for postOfferCatalog without sending the request
      */
@@ -151,3 +156,14 @@ export declare class CourseShareApi extends runtime.BaseAPI {
      */
     putDeclineShare(requestParameters: PutDeclineShareRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetCourseSharesOfferedToMeStateEnum: {
+    readonly Offered: "offered";
+    readonly AcceptedMirror: "accepted_mirror";
+    readonly AcceptedClone: "accepted_clone";
+    readonly Declined: "declined";
+    readonly Revoked: "revoked";
+};
+export type GetCourseSharesOfferedToMeStateEnum = typeof GetCourseSharesOfferedToMeStateEnum[keyof typeof GetCourseSharesOfferedToMeStateEnum];

package/dist/esm/apis/CourseShareApi.js

@@ -104,9 +104,12 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedToMe without sending the request
      */
-    getCourseSharesOfferedToMeRequestOpts() {
+    getCourseSharesOfferedToMeRequestOpts(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-to-me`;
             return {
@@ -118,21 +121,23 @@ export class CourseShareApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMeRaw(initOverrides) {
+    getCourseSharesOfferedToMeRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = yield this.getCourseSharesOfferedToMeRequestOpts();
+            const requestOptions = yield this.getCourseSharesOfferedToMeRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
         });
     }
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter.
      * List shares offered to the current portal
      */
-    getCourseSharesOfferedToMe(initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getCourseSharesOfferedToMeRaw(initOverrides);
+    getCourseSharesOfferedToMe() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getCourseSharesOfferedToMeRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
@@ -379,3 +384,13 @@ export class CourseShareApi extends runtime.BaseAPI {
         });
     }
 }
+/**
+ * @export
+ */
+export const GetCourseSharesOfferedToMeStateEnum = {
+    Offered: 'offered',
+    AcceptedMirror: 'accepted_mirror',
+    AcceptedClone: 'accepted_clone',
+    Declined: 'declined',
+    Revoked: 'revoked'
+};

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

@@ -10,6 +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.
  *
  * @export
  * @interface CourseShare
@@ -28,17 +31,23 @@ export interface CourseShare {
      */
     sourcePortalId: number;
     /**
-     * Internal ID of the receiving portal
-     * @type {number}
+     * Display name of the offering portal
+     * @type {string}
      * @memberof CourseShare
      */
-    targetPortalId: number;
+    sourcePortalName: string;
     /**
      * Internal ID of the offered course
      * @type {number}
      * @memberof CourseShare
      */
     courseId: number;
+    /**
+     * Display name of the offered course
+     * @type {string}
+     * @memberof CourseShare
+     */
+    courseName: string;
     /**
      *
      * @type {CourseShareAllowedModeEnum}

package/dist/esm/models/CourseShare.js

@@ -37,10 +37,12 @@ export function instanceOfCourseShare(value) {
         return false;
     if (!('sourcePortalId' in value) || value['sourcePortalId'] === undefined)
         return false;
-    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined)
+    if (!('sourcePortalName' in value) || value['sourcePortalName'] === 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)
@@ -59,8 +61,9 @@ export function CourseShareFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'sourcePortalId': json['source_portal_id'],
-        'targetPortalId': json['target_portal_id'],
+        'sourcePortalName': json['source_portal_name'],
         'courseId': json['course_id'],
+        'courseName': json['course_name'],
         'allowedMode': json['allowed_mode'],
         'state': json['state'],
         'allowResharing': json['allow_resharing'],
@@ -76,8 +79,9 @@ export function CourseShareToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'source_portal_id': value['sourcePortalId'],
-        'target_portal_id': value['targetPortalId'],
+        'source_portal_name': value['sourcePortalName'],
         'course_id': value['courseId'],
+        'course_name': value['courseName'],
         'allowed_mode': value['allowedMode'],
         'state': value['state'],
         'allow_resharing': value['allowResharing'],

package/dist/models/CourseShare.d.ts

@@ -10,6 +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.
  *
  * @export
  * @interface CourseShare
@@ -28,17 +31,23 @@ export interface CourseShare {
      */
     sourcePortalId: number;
     /**
-     * Internal ID of the receiving portal
-     * @type {number}
+     * Display name of the offering portal
+     * @type {string}
      * @memberof CourseShare
      */
-    targetPortalId: number;
+    sourcePortalName: string;
     /**
      * Internal ID of the offered course
      * @type {number}
      * @memberof CourseShare
      */
     courseId: number;
+    /**
+     * Display name of the offered course
+     * @type {string}
+     * @memberof CourseShare
+     */
+    courseName: string;
     /**
      *
      * @type {CourseShareAllowedModeEnum}

package/dist/models/CourseShare.js

@@ -45,10 +45,12 @@ function instanceOfCourseShare(value) {
         return false;
     if (!('sourcePortalId' in value) || value['sourcePortalId'] === undefined)
         return false;
-    if (!('targetPortalId' in value) || value['targetPortalId'] === undefined)
+    if (!('sourcePortalName' in value) || value['sourcePortalName'] === 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)
@@ -67,8 +69,9 @@ function CourseShareFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'sourcePortalId': json['source_portal_id'],
-        'targetPortalId': json['target_portal_id'],
+        'sourcePortalName': json['source_portal_name'],
         'courseId': json['course_id'],
+        'courseName': json['course_name'],
         'allowedMode': json['allowed_mode'],
         'state': json['state'],
         'allowResharing': json['allow_resharing'],
@@ -84,8 +87,9 @@ function CourseShareToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'source_portal_id': value['sourcePortalId'],
-        'target_portal_id': value['targetPortalId'],
+        'source_portal_name': value['sourcePortalName'],
         'course_id': value['courseId'],
+        'course_name': value['courseName'],
         'allowed_mode': value['allowedMode'],
         'state': value['state'],
         'allow_resharing': value['allowResharing'],

package/docs/CourseCatalogApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 |------------- | ------------- | -------------|
 | [**addCourseToCatalog**](CourseCatalogApi.md#addcoursetocatalog) | **POST** /catalogs/{catalogId}/courses/{courseId} | Add a course to a catalog |
 | [**deleteCourseCatalog**](CourseCatalogApi.md#deletecoursecatalog) | **DELETE** /catalogs/{catalogId} | Delete a catalog |
+| [**getCatalogCourses**](CourseCatalogApi.md#getcatalogcourses) | **GET** /catalogs/{catalogId}/courses | List the courses in a catalog |
 | [**getCourseCatalog**](CourseCatalogApi.md#getcoursecatalog) | **GET** /catalogs/{catalogId} | Get a catalog |
 | [**getCourseCatalogs**](CourseCatalogApi.md#getcoursecatalogs) | **GET** /catalogs | List catalogs in the current portal |
 | [**postCourseCatalog**](CourseCatalogApi.md#postcoursecatalog) | **POST** /catalogs | Create a course catalog |
@@ -149,6 +150,73 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getCatalogCourses
+
+> Array<GetCourse> getCatalogCourses(catalogId)
+
+List the courses in a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCatalogCoursesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+  } satisfies GetCatalogCoursesRequest;
+
+  try {
+    const data = await api.getCatalogCourses(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<GetCourse>**](GetCourse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Courses in the catalog |  -  |
+| **403** | Catalog not owned by your portal |  -  |
+| **404** | Catalog not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCourseCatalog
 
 > CourseCatalog getCourseCatalog(catalogId)

package/docs/CourseShare.md

@@ -1,6 +1,7 @@
 
 # CourseShare
 
+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. 
 
 ## Properties
 
@@ -8,8 +9,9 @@ Name | Type
 ------------ | -------------
 `id` | string
 `sourcePortalId` | number
-`targetPortalId` | number
+`sourcePortalName` | string
 `courseId` | number
+`courseName` | string
 `allowedMode` | string
 `state` | string
 `allowResharing` | boolean
@@ -23,8 +25,9 @@ import type { CourseShare } from '@easyedu/js-lsm-api'
 const example = {
   "id": null,
   "sourcePortalId": null,
-  "targetPortalId": null,
+  "sourcePortalName": null,
   "courseId": null,
+  "courseName": null,
   "allowedMode": null,
   "state": null,
   "allowResharing": null,

package/docs/CourseShareApi.md

@@ -144,10 +144,12 @@ No authorization required
 
 ## getCourseSharesOfferedToMe
 
-> Array<CourseShare> getCourseSharesOfferedToMe()
+> Array<CourseShare> getCourseSharesOfferedToMe(state)
 
 List shares offered to the current portal
 
+Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter. 
+
 ### Example
 
 ```ts
@@ -161,8 +163,13 @@ async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new CourseShareApi();
 
+  const body = {
+    // 'offered' | 'accepted_mirror' | 'accepted_clone' | 'declined' | 'revoked' | Filter by share state (case-insensitive) (optional)
+    state: state_example,
+  } satisfies GetCourseSharesOfferedToMeRequest;
+
   try {
-    const data = await api.getCourseSharesOfferedToMe();
+    const data = await api.getCourseSharesOfferedToMe(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -175,7 +182,10 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **state** | `offered`, `accepted_mirror`, `accepted_clone`, `declined`, `revoked` | Filter by share state (case-insensitive) | [Optional] [Defaults to `undefined`] [Enum: offered, accepted_mirror, accepted_clone, declined, revoked] |
 
 ### Return type
 
@@ -195,6 +205,7 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Shares |  -  |
+| **400** | Invalid state filter |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.52.0",
+  "version": "1.54.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/CourseCatalogApi.ts

@@ -16,12 +16,15 @@
 import * as runtime from '../runtime';
 import type {
   CourseCatalog,
+  GetCourse,
   PostCourseCatalog,
   PutCourseCatalog,
 } from '../models/index';
 import {
     CourseCatalogFromJSON,
     CourseCatalogToJSON,
+    GetCourseFromJSON,
+    GetCourseToJSON,
     PostCourseCatalogFromJSON,
     PostCourseCatalogToJSON,
     PutCourseCatalogFromJSON,
@@ -37,6 +40,10 @@ export interface DeleteCourseCatalogRequest {
     catalogId: string;
 }
 
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
+
 export interface GetCourseCatalogRequest {
     catalogId: string;
 }
@@ -156,6 +163,51 @@ export class CourseCatalogApi extends runtime.BaseAPI {
         await this.deleteCourseCatalogRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    async getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs/{catalogId}/courses`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List the courses in a catalog
+     */
+    async getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>> {
+        const requestOptions = await this.getCatalogCoursesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCourseFromJSON));
+    }
+
+    /**
+     * List the courses in a catalog
+     */
+    async getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>> {
+        const response = await this.getCatalogCoursesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/src/apis/CourseShareApi.ts

@@ -38,6 +38,10 @@ export interface DeleteCourseShareRequest {
     shareId: string;
 }
 
+export interface GetCourseSharesOfferedToMeRequest {
+    state?: GetCourseSharesOfferedToMeStateEnum;
+}
+
 export interface PostOfferCatalogRequest {
     catalogId: string;
     postOfferCatalog: PostOfferCatalog;
@@ -155,9 +159,13 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseSharesOfferedToMe without sending the request
      */
-    async getCourseSharesOfferedToMeRequestOpts(): Promise<runtime.RequestOpts> {
+    async getCourseSharesOfferedToMeRequestOpts(requestParameters: GetCourseSharesOfferedToMeRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
+        if (requestParameters['state'] != null) {
+            queryParameters['state'] = requestParameters['state'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -172,20 +180,22 @@ export class CourseShareApi extends runtime.BaseAPI {
     }
 
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter. 
      * List shares offered to the current portal
      */
-    async getCourseSharesOfferedToMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
-        const requestOptions = await this.getCourseSharesOfferedToMeRequestOpts();
+    async getCourseSharesOfferedToMeRaw(requestParameters: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
+        const requestOptions = await this.getCourseSharesOfferedToMeRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
     }
 
     /**
+     * Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter. 
      * List shares offered to the current portal
      */
-    async getCourseSharesOfferedToMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
-        const response = await this.getCourseSharesOfferedToMeRaw(initOverrides);
+    async getCourseSharesOfferedToMe(requestParameters: GetCourseSharesOfferedToMeRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
+        const response = await this.getCourseSharesOfferedToMeRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
@@ -478,3 +488,15 @@ export class CourseShareApi extends runtime.BaseAPI {
     }
 
 }
+
+/**
+ * @export
+ */
+export const GetCourseSharesOfferedToMeStateEnum = {
+    Offered: 'offered',
+    AcceptedMirror: 'accepted_mirror',
+    AcceptedClone: 'accepted_clone',
+    Declined: 'declined',
+    Revoked: 'revoked'
+} as const;
+export type GetCourseSharesOfferedToMeStateEnum = typeof GetCourseSharesOfferedToMeStateEnum[keyof typeof GetCourseSharesOfferedToMeStateEnum];

package/src/models/CourseShare.ts

@@ -14,6 +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.
  * 
  * @export
  * @interface CourseShare
@@ -32,17 +35,23 @@ export interface CourseShare {
      */
     sourcePortalId: number;
     /**
-     * Internal ID of the receiving portal
-     * @type {number}
+     * Display name of the offering portal
+     * @type {string}
      * @memberof CourseShare
      */
-    targetPortalId: number;
+    sourcePortalName: string;
     /**
      * Internal ID of the offered course
      * @type {number}
      * @memberof CourseShare
      */
     courseId: number;
+    /**
+     * Display name of the offered course
+     * @type {string}
+     * @memberof CourseShare
+     */
+    courseName: string;
     /**
      * 
      * @type {CourseShareAllowedModeEnum}
@@ -93,8 +102,9 @@ export type CourseShareStateEnum = typeof CourseShareStateEnum[keyof typeof Cour
 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 (!('targetPortalId' in value) || value['targetPortalId'] === undefined) return false;
+    if (!('sourcePortalName' in value) || value['sourcePortalName'] === 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;
@@ -113,8 +123,9 @@ export function CourseShareFromJSONTyped(json: any, ignoreDiscriminator: boolean
         
         'id': json['id'],
         'sourcePortalId': json['source_portal_id'],
-        'targetPortalId': json['target_portal_id'],
+        'sourcePortalName': json['source_portal_name'],
         'courseId': json['course_id'],
+        'courseName': json['course_name'],
         'allowedMode': json['allowed_mode'],
         'state': json['state'],
         'allowResharing': json['allow_resharing'],
@@ -134,8 +145,9 @@ export function CourseShareToJSONTyped(value?: CourseShare | null, ignoreDiscrim
         
         'id': value['id'],
         'source_portal_id': value['sourcePortalId'],
-        'target_portal_id': value['targetPortalId'],
+        'source_portal_name': value['sourcePortalName'],
         'course_id': value['courseId'],
+        'course_name': value['courseName'],
         'allowed_mode': value['allowedMode'],
         'state': value['state'],
         'allow_resharing': value['allowResharing'],