@easyedu/js-lsm-api 1.55.0 → 1.57.0

package/dist/models/PostDuplicate1.js

@@ -0,0 +1,48 @@
+"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.instanceOfPostDuplicate1 = instanceOfPostDuplicate1;
+exports.PostDuplicate1FromJSON = PostDuplicate1FromJSON;
+exports.PostDuplicate1FromJSONTyped = PostDuplicate1FromJSONTyped;
+exports.PostDuplicate1ToJSON = PostDuplicate1ToJSON;
+exports.PostDuplicate1ToJSONTyped = PostDuplicate1ToJSONTyped;
+/**
+ * Check if a given object implements the PostDuplicate1 interface.
+ */
+function instanceOfPostDuplicate1(value) {
+    return true;
+}
+function PostDuplicate1FromJSON(json) {
+    return PostDuplicate1FromJSONTyped(json, false);
+}
+function PostDuplicate1FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+function PostDuplicate1ToJSON(json) {
+    return PostDuplicate1ToJSONTyped(json, false);
+}
+function PostDuplicate1ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+    };
+}

package/dist/models/PostDuplicate2.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Optional body for duplicating a content item
+ * @export
+ * @interface PostDuplicate2
+ */
+export interface PostDuplicate2 {
+    /**
+     * Name for the duplicated content. Defaults to "{original name} (Copy)" if omitted.
+     * @type {string}
+     * @memberof PostDuplicate2
+     */
+    name?: string;
+}
+/**
+ * Check if a given object implements the PostDuplicate2 interface.
+ */
+export declare function instanceOfPostDuplicate2(value: object): value is PostDuplicate2;
+export declare function PostDuplicate2FromJSON(json: any): PostDuplicate2;
+export declare function PostDuplicate2FromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDuplicate2;
+export declare function PostDuplicate2ToJSON(json: any): PostDuplicate2;
+export declare function PostDuplicate2ToJSONTyped(value?: PostDuplicate2 | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostDuplicate2.js

@@ -0,0 +1,48 @@
+"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.instanceOfPostDuplicate2 = instanceOfPostDuplicate2;
+exports.PostDuplicate2FromJSON = PostDuplicate2FromJSON;
+exports.PostDuplicate2FromJSONTyped = PostDuplicate2FromJSONTyped;
+exports.PostDuplicate2ToJSON = PostDuplicate2ToJSON;
+exports.PostDuplicate2ToJSONTyped = PostDuplicate2ToJSONTyped;
+/**
+ * Check if a given object implements the PostDuplicate2 interface.
+ */
+function instanceOfPostDuplicate2(value) {
+    return true;
+}
+function PostDuplicate2FromJSON(json) {
+    return PostDuplicate2FromJSONTyped(json, false);
+}
+function PostDuplicate2FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+function PostDuplicate2ToJSON(json) {
+    return PostDuplicate2ToJSONTyped(json, false);
+}
+function PostDuplicate2ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+    };
+}

package/dist/models/PutCourseEnrollment.d.ts

@@ -16,7 +16,10 @@
  */
 export interface PutCourseEnrollment {
     /**
-     * Current status of the enrollment
+     * Target status for the enrollment. System-managed statuses (InProgress, Expired)
+     * cannot be set via this endpoint. Reopening a terminal enrollment to `Enrolled`
+     * requires `enrollment_date_end` to still be in the future.
+     *
      * @type {PutCourseEnrollmentStatusEnum}
      * @memberof PutCourseEnrollment
      */
@@ -46,7 +49,10 @@ export interface PutCourseEnrollment {
 export declare const PutCourseEnrollmentStatusEnum: {
     readonly Enrolled: "Enrolled";
     readonly Completed: "Completed";
+    readonly Failed: "Failed";
+    readonly Withdrawn: "Withdrawn";
     readonly Removed: "Removed";
+    readonly Archived: "Archived";
 };
 export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
 /**

package/dist/models/PutCourseEnrollment.js

@@ -25,7 +25,10 @@ exports.PutCourseEnrollmentToJSONTyped = PutCourseEnrollmentToJSONTyped;
 exports.PutCourseEnrollmentStatusEnum = {
     Enrolled: 'Enrolled',
     Completed: 'Completed',
-    Removed: 'Removed'
+    Failed: 'Failed',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived'
 };
 /**
  * @export

package/dist/models/index.d.ts

@@ -70,6 +70,7 @@ export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
+export * from './GetPortalFaviconUpload';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';
@@ -173,6 +174,9 @@ export * from './PostCourse';
 export * from './PostCourseCatalog';
 export * from './PostCourseEnrollment';
 export * from './PostCourseExport';
+export * from './PostDuplicate';
+export * from './PostDuplicate1';
+export * from './PostDuplicate2';
 export * from './PostLogin';
 export * from './PostManualQuestionSelection';
 export * from './PostMessage';

package/dist/models/index.js

@@ -88,6 +88,7 @@ __exportStar(require("./GetPortal"), exports);
 __exportStar(require("./GetPortalBasicReporting"), exports);
 __exportStar(require("./GetPortalBasicReportingCertificates"), exports);
 __exportStar(require("./GetPortalBasicReportingPortalInfo"), exports);
+__exportStar(require("./GetPortalFaviconUpload"), exports);
 __exportStar(require("./GetPortalList"), exports);
 __exportStar(require("./GetPortalLogoUpload"), exports);
 __exportStar(require("./GetPortalStudentReporting"), exports);
@@ -191,6 +192,9 @@ __exportStar(require("./PostCourse"), exports);
 __exportStar(require("./PostCourseCatalog"), exports);
 __exportStar(require("./PostCourseEnrollment"), exports);
 __exportStar(require("./PostCourseExport"), exports);
+__exportStar(require("./PostDuplicate"), exports);
+__exportStar(require("./PostDuplicate1"), exports);
+__exportStar(require("./PostDuplicate2"), exports);
 __exportStar(require("./PostLogin"), exports);
 __exportStar(require("./PostManualQuestionSelection"), exports);
 __exportStar(require("./PostMessage"), exports);

package/docs/ContentApi.md

@@ -17,6 +17,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getScormValue**](ContentApi.md#getscormvalue) | **GET** /scorm/sessions/{scormSessionId}/get-value | Get a SCORM CMI data element value |
 | [**initializeScormSession**](ContentApi.md#initializescormsession) | **POST** /scorm/sessions/{scormSessionId}/initialize | Initialize a SCORM session |
 | [**listContentSessions**](ContentApi.md#listcontentsessions) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions | List content sessions (instructor only) |
+| [**postContentDuplicate**](ContentApi.md#postcontentduplicate) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/duplicate | Duplicate a content item |
 | [**postContentProcess**](ContentApi.md#postcontentprocess) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/process | Post a new content process |
 | [**postContentQuiz**](ContentApi.md#postcontentquiz) | **POST** /courses/{courseId}/modules/{moduleId}/contents/quiz | Create a new quiz content |
 | [**postContentSession**](ContentApi.md#postcontentsession) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | Post a new content session |
@@ -991,6 +992,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)
 
 
+## postContentDuplicate
+
+> GetContent postContentDuplicate(courseId, moduleId, contentId, postDuplicate2)
+
+Duplicate a content item
+
+Deep-clones a content item including version records, SCORM hierarchy, and quiz configuration within the same module.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PostContentDuplicateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    contentId: contentId_example,
+    // PostDuplicate2 (optional)
+    postDuplicate2: ...,
+  } satisfies PostContentDuplicateRequest;
+
+  try {
+    const data = await api.postContentDuplicate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **postDuplicate2** | [PostDuplicate2](PostDuplicate2.md) |  | [Optional] |
+
+### Return type
+
+[**GetContent**](GetContent.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Content duplicated successfully |  -  |
+| **404** | Content 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)
+
+
 ## postContentProcess
 
 > GetContent postContentProcess(moduleId, courseId, contentId)

package/docs/CourseApi.md

@@ -13,6 +13,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getCourseList**](CourseApi.md#getcourselist) | **GET** /courses | get course list |
 | [**getCourseReportingBasic**](CourseApi.md#getcoursereportingbasic) | **GET** /courses/{courseId}/reporting/basic | Get basic course reporting data |
 | [**postCourse**](CourseApi.md#postcourse) | **POST** /courses | Post a new course |
+| [**postCourseDuplicate**](CourseApi.md#postcourseduplicate) | **POST** /courses/{courseId}/duplicate | Duplicate a course |
 | [**postCourseEnrollment**](CourseApi.md#postcourseenrollment) | **POST** /courses/{courseId}/enrollments | Create a new course enrollment |
 | [**postCourseExport**](CourseApi.md#postcourseexport) | **POST** /courses/{courseId}/exports | Create a new SCORM export for a course |
 | [**postCourseImageUpload**](CourseApi.md#postcourseimageupload) | **POST** /courses/{courseId}/image | Upload a course image |
@@ -222,7 +223,7 @@ No authorization required
 
 ## getCourseEnrollments
 
-> GetCourseEnrollmentList getCourseEnrollments(courseId, type, page, pageSize)
+> GetCourseEnrollmentList getCourseEnrollments(courseId, type, status, page, pageSize)
 
 Get course enrollments
 
@@ -244,6 +245,8 @@ async function example() {
     courseId: courseId_example,
     // 'student' | 'instructor' | Filter enrollments by user type (optional)
     type: type_example,
+    // string | Comma-separated list of enrollment statuses to include. Example: `status=Enrolled,InProgress,Expired`. Unknown values are ignored.  (optional)
+    status: status_example,
     // number | Page number for pagination (optional)
     page: 56,
     // number | Number of items per page (optional)
@@ -269,6 +272,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **courseId** | `string` |  | [Defaults to `undefined`] |
 | **type** | `student`, `instructor` | Filter enrollments by user type | [Optional] [Defaults to `undefined`] [Enum: student, instructor] |
+| **status** | `string` | Comma-separated list of enrollment statuses to include. Example: `status=Enrolled,InProgress,Expired`. Unknown values are ignored.  | [Optional] [Defaults to `undefined`] |
 | **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
 | **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 
@@ -439,7 +443,7 @@ No authorization required
 
 ## getCourseList
 
-> GetCourseList getCourseList(enrolled)
+> GetCourseList getCourseList(page, pageSize, enrolled, search)
 
 get course list
 
@@ -457,8 +461,14 @@ async function example() {
   const api = new CourseApi();
 
   const body = {
+    // number | Page number (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
     // boolean | Filter to only courses the authenticated user is enrolled in (optional)
     enrolled: true,
+    // string | Case-insensitive substring match against course name or description (optional)
+    search: search_example,
   } satisfies GetCourseListRequest;
 
   try {
@@ -478,7 +488,10 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **enrolled** | `boolean` | Filter to only courses the authenticated user is enrolled in | [Optional] [Defaults to `undefined`] |
+| **search** | `string` | Case-insensitive substring match against course name or description | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -632,6 +645,77 @@ 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)
 
 
+## postCourseDuplicate
+
+> GetCourse postCourseDuplicate(courseId, postDuplicate)
+
+Duplicate a course
+
+Deep-clones a course including all modules, content, versions, SCORM hierarchy, and quiz configuration within the caller\'s portal.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseDuplicateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // PostDuplicate (optional)
+    postDuplicate: ...,
+  } satisfies PostCourseDuplicateRequest;
+
+  try {
+    const data = await api.postCourseDuplicate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **postDuplicate** | [PostDuplicate](PostDuplicate.md) |  | [Optional] |
+
+### Return type
+
+[**GetCourse**](GetCourse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Course duplicated successfully |  -  |
+| **404** | Course 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)
+
+
 ## postCourseEnrollment
 
 > GetCourseEnrollment postCourseEnrollment(courseId, postCourseEnrollment)

package/docs/GetPortal.md

@@ -10,6 +10,7 @@ Name | Type
 `name` | string
 `parentPortalId` | string
 `logoUrl` | string
+`faviconUrl` | string
 `headerBackgroundColor` | string
 `headerTextColor` | string
 `baseType` | string
@@ -25,6 +26,7 @@ const example = {
   "name": null,
   "parentPortalId": null,
   "logoUrl": null,
+  "faviconUrl": null,
   "headerBackgroundColor": null,
   "headerTextColor": null,
   "baseType": null,

package/docs/GetPortalFaviconUpload.md

@@ -0,0 +1,34 @@
+
+# GetPortalFaviconUpload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`faviconUrl` | string
+
+## Example
+
+```typescript
+import type { GetPortalFaviconUpload } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "faviconUrl": null,
+} satisfies GetPortalFaviconUpload
+
+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 GetPortalFaviconUpload
+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/ModuleApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getModule**](ModuleApi.md#getmodule) | **GET** /courses/{courseId}/modules/{moduleId} | get a course module |
 | [**getModuleList**](ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list |
 | [**postModule**](ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module |
+| [**postModuleDuplicate**](ModuleApi.md#postmoduleduplicate) | **POST** /courses/{courseId}/modules/{moduleId}/duplicate | Duplicate a module |
 | [**putModule**](ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id |
 | [**putModuleReorder**](ModuleApi.md#putmodulereorder) | **PUT** /courses/{courseId}/modules/reorder | Reorder modules in a course |
 
@@ -213,6 +214,80 @@ 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)
 
 
+## postModuleDuplicate
+
+> GetModule postModuleDuplicate(courseId, moduleId, postDuplicate1)
+
+Duplicate a module
+
+Deep-clones a module including all content, versions, SCORM hierarchy, and quiz configuration within the same course.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModuleApi,
+} from '@easyedu/js-lsm-api';
+import type { PostModuleDuplicateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ModuleApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // string
+    moduleId: moduleId_example,
+    // PostDuplicate1 (optional)
+    postDuplicate1: ...,
+  } satisfies PostModuleDuplicateRequest;
+
+  try {
+    const data = await api.postModuleDuplicate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **postDuplicate1** | [PostDuplicate1](PostDuplicate1.md) |  | [Optional] |
+
+### Return type
+
+[**GetModule**](GetModule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Module duplicated successfully |  -  |
+| **404** | Module 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)
+
+
 ## putModule
 
 > GetModule putModule(moduleId, courseId, putModule)