@easyedu/js-lsm-api 1.54.0 → 1.56.0

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)

package/docs/PostDuplicate.md

@@ -0,0 +1,35 @@
+
+# PostDuplicate
+
+Optional body for duplicating a course
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+
+## Example
+
+```typescript
+import type { PostDuplicate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+} satisfies PostDuplicate
+
+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 PostDuplicate
+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/PostDuplicate1.md

@@ -0,0 +1,35 @@
+
+# PostDuplicate1
+
+Optional body for duplicating a module
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+
+## Example
+
+```typescript
+import type { PostDuplicate1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+} satisfies PostDuplicate1
+
+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 PostDuplicate1
+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/PostDuplicate2.md

@@ -0,0 +1,35 @@
+
+# PostDuplicate2
+
+Optional body for duplicating a content item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+
+## Example
+
+```typescript
+import type { PostDuplicate2 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+} satisfies PostDuplicate2
+
+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 PostDuplicate2
+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/PostOfferCatalogResponse.md

@@ -1,12 +1,16 @@
 
 # PostOfferCatalogResponse
 
+Result of fanning a catalog out into per-course offers. Outcomes are bucketed so operators can distinguish brand-new shares from reactivations of previously-revoked shares, idempotent no-ops on already-active shares, and real failures. 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `createdShareCount` | number
+`reactivatedShareCount` | number
+`unchangedShareCount` | number
+`failedShareCount` | number
 
 ## Example
 
@@ -16,6 +20,9 @@ import type { PostOfferCatalogResponse } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "createdShareCount": null,
+  "reactivatedShareCount": null,
+  "unchangedShareCount": null,
+  "failedShareCount": null,
 } satisfies PostOfferCatalogResponse
 
 console.log(example)

package/package.json

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

package/src/apis/ContentApi.ts

@@ -29,6 +29,7 @@ import type {
   PostContentQuiz,
   PostContentSession,
   PostContentUpload,
+  PostDuplicate2,
   PostVerifyManifest,
   PutContent,
   PutContentReorder,
@@ -66,6 +67,8 @@ import {
     PostContentSessionToJSON,
     PostContentUploadFromJSON,
     PostContentUploadToJSON,
+    PostDuplicate2FromJSON,
+    PostDuplicate2ToJSON,
     PostVerifyManifestFromJSON,
     PostVerifyManifestToJSON,
     PutContentFromJSON,
@@ -158,6 +161,13 @@ export interface ListContentSessionsRequest {
     pageSize?: number;
 }
 
+export interface PostContentDuplicateRequest {
+    courseId: string;
+    moduleId: string;
+    contentId: string;
+    postDuplicate2?: PostDuplicate2;
+}
+
 export interface PostContentProcessRequest {
     moduleId: string;
     courseId: string;
@@ -988,6 +998,72 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postContentDuplicate without sending the request
+     */
+    async postContentDuplicateRequestOpts(requestParameters: PostContentDuplicateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postContentDuplicate().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling postContentDuplicate().'
+            );
+        }
+
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling postContentDuplicate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/duplicate`;
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace(`{${"contentId"}}`, encodeURIComponent(String(requestParameters['contentId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostDuplicate2ToJSON(requestParameters['postDuplicate2']),
+        };
+    }
+
+    /**
+     * Deep-clones a content item including version records, SCORM hierarchy, and quiz configuration within the same module.
+     * Duplicate a content item
+     */
+    async postContentDuplicateRaw(requestParameters: PostContentDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContent>> {
+        const requestOptions = await this.postContentDuplicateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetContentFromJSON(jsonValue));
+    }
+
+    /**
+     * Deep-clones a content item including version records, SCORM hierarchy, and quiz configuration within the same module.
+     * Duplicate a content item
+     */
+    async postContentDuplicate(requestParameters: PostContentDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContent> {
+        const response = await this.postContentDuplicateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postContentProcess without sending the request
      */

package/src/apis/CourseApi.ts

@@ -26,6 +26,7 @@ import type {
   PostCourse,
   PostCourseEnrollment,
   PostCourseExport,
+  PostDuplicate,
   PutCourse,
   PutCourseEnrollment,
 } from '../models/index';
@@ -52,6 +53,8 @@ import {
     PostCourseEnrollmentToJSON,
     PostCourseExportFromJSON,
     PostCourseExportToJSON,
+    PostDuplicateFromJSON,
+    PostDuplicateToJSON,
     PutCourseFromJSON,
     PutCourseToJSON,
     PutCourseEnrollmentFromJSON,
@@ -74,6 +77,7 @@ export interface GetCourseEnrollmentRequest {
 export interface GetCourseEnrollmentsRequest {
     courseId: string;
     type?: GetCourseEnrollmentsTypeEnum;
+    status?: string;
     page?: number;
     pageSize?: number;
 }
@@ -90,7 +94,10 @@ export interface GetCourseExportsRequest {
 }
 
 export interface GetCourseListRequest {
+    page?: number;
+    pageSize?: number;
     enrolled?: boolean;
+    search?: string;
 }
 
 export interface GetCourseReportingBasicRequest {
@@ -101,6 +108,11 @@ export interface PostCourseRequest {
     postCourse: PostCourse;
 }
 
+export interface PostCourseDuplicateRequest {
+    courseId: string;
+    postDuplicate?: PostDuplicate;
+}
+
 export interface PostCourseEnrollmentRequest {
     courseId: string;
     postCourseEnrollment: PostCourseEnrollment;
@@ -291,6 +303,10 @@ export class CourseApi extends runtime.BaseAPI {
             queryParameters['type'] = requestParameters['type'];
         }
 
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
         if (requestParameters['page'] != null) {
             queryParameters['page'] = requestParameters['page'];
         }
@@ -443,10 +459,22 @@ export class CourseApi extends runtime.BaseAPI {
     async getCourseListRequestOpts(requestParameters: GetCourseListRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
         if (requestParameters['enrolled'] != null) {
             queryParameters['enrolled'] = requestParameters['enrolled'];
         }
 
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -570,6 +598,56 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postCourseDuplicate without sending the request
+     */
+    async postCourseDuplicateRequestOpts(requestParameters: PostCourseDuplicateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postCourseDuplicate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/duplicate`;
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostDuplicateToJSON(requestParameters['postDuplicate']),
+        };
+    }
+
+    /**
+     * Deep-clones a course including all modules, content, versions, SCORM hierarchy, and quiz configuration within the caller\'s portal.
+     * Duplicate a course
+     */
+    async postCourseDuplicateRaw(requestParameters: PostCourseDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourse>> {
+        const requestOptions = await this.postCourseDuplicateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseFromJSON(jsonValue));
+    }
+
+    /**
+     * Deep-clones a course including all modules, content, versions, SCORM hierarchy, and quiz configuration within the caller\'s portal.
+     * Duplicate a course
+     */
+    async postCourseDuplicate(requestParameters: PostCourseDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourse> {
+        const response = await this.postCourseDuplicateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postCourseEnrollment without sending the request
      */

package/src/apis/ModuleApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   GetModule,
   GetModuleList,
+  PostDuplicate1,
   PostModule,
   PutModule,
   PutModuleReorder,
@@ -26,6 +27,8 @@ import {
     GetModuleToJSON,
     GetModuleListFromJSON,
     GetModuleListToJSON,
+    PostDuplicate1FromJSON,
+    PostDuplicate1ToJSON,
     PostModuleFromJSON,
     PostModuleToJSON,
     PutModuleFromJSON,
@@ -48,6 +51,12 @@ export interface PostModuleRequest {
     postModule: PostModule;
 }
 
+export interface PostModuleDuplicateRequest {
+    courseId: string;
+    moduleId: string;
+    postDuplicate1?: PostDuplicate1;
+}
+
 export interface PutModuleRequest {
     moduleId: string;
     courseId: string;
@@ -217,6 +226,64 @@ export class ModuleApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postModuleDuplicate without sending the request
+     */
+    async postModuleDuplicateRequestOpts(requestParameters: PostModuleDuplicateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postModuleDuplicate().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling postModuleDuplicate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/duplicate`;
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostDuplicate1ToJSON(requestParameters['postDuplicate1']),
+        };
+    }
+
+    /**
+     * Deep-clones a module including all content, versions, SCORM hierarchy, and quiz configuration within the same course.
+     * Duplicate a module
+     */
+    async postModuleDuplicateRaw(requestParameters: PostModuleDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModule>> {
+        const requestOptions = await this.postModuleDuplicateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleFromJSON(jsonValue));
+    }
+
+    /**
+     * Deep-clones a module including all content, versions, SCORM hierarchy, and quiz configuration within the same course.
+     * Duplicate a module
+     */
+    async postModuleDuplicate(requestParameters: PostModuleDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModule> {
+        const response = await this.postModuleDuplicateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putModule without sending the request
      */

package/src/models/GetCourseEnrollment.ts

@@ -56,7 +56,16 @@ export interface GetCourseEnrollment {
      */
     notes: string | null;
     /**
-     * Current status of the enrollment
+     * Current status of the enrollment.
+     * - Enrolled: registered, no progress yet
+     * - InProgress: learner has started at least one content session
+     * - Completed: finished successfully
+     * - Failed: finished but did not pass
+     * - Expired: enrollment_date_end passed before completion
+     * - Withdrawn: learner pulled out before completion
+     * - Removed: admin-removed enrollment
+     * - Archived: historical / read-only (e.g. course share revoked)
+     * 
      * @type {GetCourseEnrollmentStatusEnum}
      * @memberof GetCourseEnrollment
      */
@@ -81,8 +90,13 @@ export interface GetCourseEnrollment {
  */
 export const GetCourseEnrollmentStatusEnum = {
     Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
     Completed: 'Completed',
-    Removed: 'Removed'
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived'
 } as const;
 export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
 

package/src/models/GetCourseEnrollmentListItem.ts

@@ -87,8 +87,13 @@ export interface GetCourseEnrollmentListItem {
  */
 export const GetCourseEnrollmentListItemStatusEnum = {
     Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
     Completed: 'Completed',
-    Removed: 'Removed'
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived'
 } as const;
 export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
 

package/src/models/PostDuplicate.ts

@@ -0,0 +1,65 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Optional body for duplicating a course
+ * @export
+ * @interface PostDuplicate
+ */
+export interface PostDuplicate {
+    /**
+     * Name for the duplicated course. Defaults to "{original name} (Copy)" if omitted.
+     * @type {string}
+     * @memberof PostDuplicate
+     */
+    name?: string;
+}
+
+/**
+ * Check if a given object implements the PostDuplicate interface.
+ */
+export function instanceOfPostDuplicate(value: object): value is PostDuplicate {
+    return true;
+}
+
+export function PostDuplicateFromJSON(json: any): PostDuplicate {
+    return PostDuplicateFromJSONTyped(json, false);
+}
+
+export function PostDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDuplicate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+
+export function PostDuplicateToJSON(json: any): PostDuplicate {
+    return PostDuplicateToJSONTyped(json, false);
+}
+
+export function PostDuplicateToJSONTyped(value?: PostDuplicate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+    };
+}
+