@easyedu/js-lsm-api 1.106.0 → 1.107.0

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/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/PostOfferCatalog.d.ts

@@ -16,7 +16,7 @@
  */
 export interface PostOfferCatalog {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCatalog
      */

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

@@ -16,7 +16,7 @@
  */
 export interface PostOfferCourse {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCourse
      */

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/PostOfferCatalog.d.ts

@@ -16,7 +16,7 @@
  */
 export interface PostOfferCatalog {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCatalog
      */

package/dist/models/PostOfferCourse.d.ts

@@ -16,7 +16,7 @@
  */
 export interface PostOfferCourse {
     /**
-     * External ID of the target (descendant) portal
+     * External ID of the target portal
      * @type {string}
      * @memberof PostOfferCourse
      */

package/docs/CourseApi.md

@@ -23,6 +23,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getCourseVersionItemLaunch**](CourseApi.md#getcourseversionitemlaunch) | **GET** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch | Resolve the exact immutable resource launch selected by a course version |
 | [**getCourseVersionList**](CourseApi.md#getcourseversionlist) | **GET** /courses/{courseId}/versions | List immutable course versions and the current draft |
 | [**getCourseVersionProgression**](CourseApi.md#getcourseversionprogression) | **GET** /courses/{courseId}/versions/{courseVersionId}/progression | Get learner-specific completion and section lock state |
+| [**getPortalCourseExports**](CourseApi.md#getportalcourseexports) | **GET** /course-exports | List SCORM exports owned by the current portal |
 | [**postCourse**](CourseApi.md#postcourse) | **POST** /courses | Post a new course |
 | [**postCourseDraft**](CourseApi.md#postcoursedraft) | **POST** /courses/{courseId}/draft | Create or return the single editable course draft |
 | [**postCourseDraftResourceUpdateAll**](CourseApi.md#postcoursedraftresourceupdateall) | **POST** /courses/{courseId}/draft/resources/update-all | Update all draft resource placements to their latest published versions |
@@ -1391,6 +1392,83 @@ 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)
 
 
+## getPortalCourseExports
+
+> GetCourseExportList getPortalCourseExports(page, pageSize, courseId, status)
+
+List SCORM exports owned by the current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalCourseExportsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Filter by an owned course external ID (optional)
+    courseId: courseId_example,
+    // 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | Filter by export status (optional)
+    status: status_example,
+  } satisfies GetPortalCourseExportsRequest;
+
+  try {
+    const data = await api.getPortalCourseExports(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **courseId** | `string` | Filter by an owned course external ID | [Optional] [Defaults to `undefined`] |
+| **status** | `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED` | Filter by export status | [Optional] [Defaults to `undefined`] [Enum: PENDING, PROCESSING, COMPLETED, FAILED] |
+
+### Return type
+
+[**GetCourseExportList**](GetCourseExportList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal-owned course exports |  -  |
+| **400** | Invalid pagination or filter |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postCourse
 
 > GetCourse postCourse(postCourse)
@@ -1734,7 +1812,7 @@ No authorization required
 
 Create a new SCORM export for a course
 
-Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Actual SCORM package generation is not yet implemented (TODO) - Export metadata should be persisted to a database table (TODO) - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
+Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
 
 ### Example