@easyedu/js-lsm-api 1.106.0 → 1.108.0

package/dist/models/GetCourseShareList.js

@@ -0,0 +1,67 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetCourseShareList = instanceOfGetCourseShareList;
+exports.GetCourseShareListFromJSON = GetCourseShareListFromJSON;
+exports.GetCourseShareListFromJSONTyped = GetCourseShareListFromJSONTyped;
+exports.GetCourseShareListToJSON = GetCourseShareListToJSON;
+exports.GetCourseShareListToJSONTyped = GetCourseShareListToJSONTyped;
+const CourseShare_1 = require("./CourseShare");
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+function instanceOfGetCourseShareList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function GetCourseShareListFromJSON(json) {
+    return GetCourseShareListFromJSONTyped(json, false);
+}
+function GetCourseShareListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(CourseShare_1.CourseShareFromJSON)),
+    };
+}
+function GetCourseShareListToJSON(json) {
+    return GetCourseShareListToJSONTyped(json, false);
+}
+function GetCourseShareListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(CourseShare_1.CourseShareToJSON)),
+    };
+}

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/dist/models/index.d.ts

@@ -56,6 +56,7 @@ export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
 export * from './GetCourse';
+export * from './GetCourseCatalogList';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
@@ -63,6 +64,7 @@ export * from './GetCourseExport';
 export * from './GetCourseExportList';
 export * from './GetCourseImageUpload';
 export * from './GetCourseList';
+export * from './GetCourseShareList';
 export * from './GetCourseVersion';
 export * from './GetCourseVersionItem';
 export * from './GetCourseVersionItemLaunch';

package/dist/models/index.js

@@ -74,6 +74,7 @@ __exportStar(require("./GetContentLibraryVersion"), exports);
 __exportStar(require("./GetConversation"), exports);
 __exportStar(require("./GetConversationList"), exports);
 __exportStar(require("./GetCourse"), exports);
+__exportStar(require("./GetCourseCatalogList"), exports);
 __exportStar(require("./GetCourseEnrollment"), exports);
 __exportStar(require("./GetCourseEnrollmentList"), exports);
 __exportStar(require("./GetCourseEnrollmentListItem"), exports);
@@ -81,6 +82,7 @@ __exportStar(require("./GetCourseExport"), exports);
 __exportStar(require("./GetCourseExportList"), exports);
 __exportStar(require("./GetCourseImageUpload"), exports);
 __exportStar(require("./GetCourseList"), exports);
+__exportStar(require("./GetCourseShareList"), exports);
 __exportStar(require("./GetCourseVersion"), exports);
 __exportStar(require("./GetCourseVersionItem"), exports);
 __exportStar(require("./GetCourseVersionItemLaunch"), exports);

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
 

package/docs/CourseCatalogApi.md

@@ -285,7 +285,7 @@ No authorization required
 
 ## getCourseCatalogs
 
-> Array<CourseCatalog> getCourseCatalogs()
+> GetCourseCatalogList getCourseCatalogs(page, pageSize)
 
 List catalogs in the current portal
 
@@ -302,8 +302,15 @@ async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new CourseCatalogApi();
 
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetCourseCatalogsRequest;
+
   try {
-    const data = await api.getCourseCatalogs();
+    const data = await api.getCourseCatalogs(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -316,11 +323,15 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 
 ### Return type
 
-[**Array<CourseCatalog>**](CourseCatalog.md)
+[**GetCourseCatalogList**](GetCourseCatalogList.md)
 
 ### Authorization
 

package/docs/CourseShare.md

@@ -1,20 +1,28 @@
 
 # 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. 
+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. 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `id` | string
-`sourcePortalId` | number
+`sourcePortalId` | string
 `sourcePortalName` | string
-`courseId` | number
+`targetPortalId` | string
+`targetPortalName` | string
+`courseId` | string
 `courseName` | string
 `allowedMode` | string
 `state` | string
 `allowResharing` | boolean
+`seatLimit` | number
+`originCatalogId` | string
+`originCatalogName` | string
+`offeredAt` | Date
+`respondedAt` | Date
+`revokedAt` | Date
 
 ## Example
 
@@ -26,11 +34,19 @@ const example = {
   "id": null,
   "sourcePortalId": null,
   "sourcePortalName": null,
+  "targetPortalId": null,
+  "targetPortalName": null,
   "courseId": null,
   "courseName": null,
   "allowedMode": null,
   "state": null,
   "allowResharing": null,
+  "seatLimit": null,
+  "originCatalogId": null,
+  "originCatalogName": null,
+  "offeredAt": null,
+  "respondedAt": null,
+  "revokedAt": null,
 } satisfies CourseShare
 
 console.log(example)

package/docs/CourseShareApi.md

@@ -7,8 +7,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deleteCourseShare**](CourseShareApi.md#deletecourseshare) | **DELETE** /course-shares/{shareId} | Revoke a share |
 | [**getCourseSharesOfferedByMe**](CourseShareApi.md#getcoursesharesofferedbyme) | **GET** /course-shares/offered-by-me | List shares the current portal has offered out |
 | [**getCourseSharesOfferedToMe**](CourseShareApi.md#getcoursesharesofferedtome) | **GET** /course-shares/offered-to-me | List shares offered to the current portal |
-| [**postOfferCatalog**](CourseShareApi.md#postoffercatalog) | **POST** /catalogs/{catalogId}/shares | Offer every course in a catalog to a descendant portal |
-| [**postOfferCourse**](CourseShareApi.md#postoffercourse) | **POST** /courses/{courseId}/shares | Offer a single course to a descendant portal |
+| [**postOfferCatalog**](CourseShareApi.md#postoffercatalog) | **POST** /catalogs/{catalogId}/shares | Offer every course in a catalog to another portal |
+| [**postOfferCourse**](CourseShareApi.md#postoffercourse) | **POST** /courses/{courseId}/shares | Offer a single course to another portal |
 | [**postUnrevokeShare**](CourseShareApi.md#postunrevokeshare) | **POST** /course-shares/{shareId}/unrevoke | Restore a previously revoked share |
 | [**putAcceptClone**](CourseShareApi.md#putacceptclone) | **PUT** /course-shares/{shareId}/accept-clone | Accept an offer as a clone (deep copy into your portal) |
 | [**putAcceptMirror**](CourseShareApi.md#putacceptmirror) | **PUT** /course-shares/{shareId}/accept-mirror | Accept an offer as a mirror (no copy, live link to source) |
@@ -87,7 +87,7 @@ No authorization required
 
 ## getCourseSharesOfferedByMe
 
-> Array<CourseShare> getCourseSharesOfferedByMe()
+> GetCourseShareList getCourseSharesOfferedByMe(page, pageSize, courseId, state)
 
 List shares the current portal has offered out
 
@@ -104,8 +104,19 @@ async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new CourseShareApi();
 
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Filter by an owned course external ID (optional)
+    courseId: courseId_example,
+    // 'offered' | 'accepted_mirror' | 'accepted_clone' | 'declined' | 'revoked' | Filter by share state (case-insensitive) (optional)
+    state: state_example,
+  } satisfies GetCourseSharesOfferedByMeRequest;
+
   try {
-    const data = await api.getCourseSharesOfferedByMe();
+    const data = await api.getCourseSharesOfferedByMe(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -118,11 +129,17 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| 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`] |
+| **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
 
-[**Array<CourseShare>**](CourseShare.md)
+[**GetCourseShareList**](GetCourseShareList.md)
 
 ### Authorization
 
@@ -138,17 +155,18 @@ 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)
 
 
 ## getCourseSharesOfferedToMe
 
-> Array<CourseShare> getCourseSharesOfferedToMe(state)
+> GetCourseShareList getCourseSharesOfferedToMe(page, pageSize, 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. 
+Returns `course_share` rows 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
 
@@ -164,6 +182,10 @@ async function example() {
   const api = new CourseShareApi();
 
   const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
     // 'offered' | 'accepted_mirror' | 'accepted_clone' | 'declined' | 'revoked' | Filter by share state (case-insensitive) (optional)
     state: state_example,
   } satisfies GetCourseSharesOfferedToMeRequest;
@@ -185,11 +207,13 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 | **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
 
-[**Array<CourseShare>**](CourseShare.md)
+[**GetCourseShareList**](GetCourseShareList.md)
 
 ### Authorization
 
@@ -214,7 +238,7 @@ No authorization required
 
 > PostOfferCatalogResponse postOfferCatalog(catalogId, postOfferCatalog)
 
-Offer every course in a catalog to a descendant portal
+Offer every course in a catalog to another portal
 
 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`. 
 
@@ -276,7 +300,8 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **201** | Catalog offered |  -  |
-| **403** | Catalog not owned by your portal, or target is not a descendant |  -  |
+| **400** | Target portal is the current portal |  -  |
+| **403** | Catalog not owned by your portal |  -  |
 | **404** | Catalog or target portal 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)
@@ -286,7 +311,7 @@ No authorization required
 
 > PostOfferCourseResponse postOfferCourse(courseId, postOfferCourse)
 
-Offer a single course to a descendant portal
+Offer a single course to another portal
 
 ### Example
 
@@ -346,7 +371,8 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **201** | Share created |  -  |
-| **403** | Course not owned by your portal, or target is not a descendant |  -  |
+| **400** | Target portal is the current portal |  -  |
+| **403** | Course not owned by your portal |  -  |
 | **404** | Course or target portal 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)

package/docs/GetCourseCatalogList.md

@@ -0,0 +1,42 @@
+
+# GetCourseCatalogList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<CourseCatalog>](CourseCatalog.md)
+
+## Example
+
+```typescript
+import type { GetCourseCatalogList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetCourseCatalogList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetCourseCatalogList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetCourseExport.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `courseId` | string
+`courseName` | string
 `courseVersionId` | string
 `exportType` | string
 `sectionIds` | Array<string>
@@ -28,6 +29,7 @@ import type { GetCourseExport } from '@easyedu/js-lsm-api'
 const example = {
   "id": null,
   "courseId": null,
+  "courseName": null,
   "courseVersionId": null,
   "exportType": null,
   "sectionIds": null,

package/docs/GetCourseShareList.md

@@ -0,0 +1,42 @@
+
+# GetCourseShareList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<CourseShare>](CourseShare.md)
+
+## Example
+
+```typescript
+import type { GetCourseShareList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetCourseShareList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetCourseShareList
+console.log(exampleParsed)
+```
+
+[[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.106.0",
+  "version": "1.108.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {