@easyedu/js-lsm-api 1.55.0 → 1.57.0

package/docs/PortalApi.md

@@ -4,18 +4,86 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deletePortalFavicon**](PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon |
 | [**deletePortalLogo**](PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo |
 | [**getPortalById**](PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal) |
 | [**getPortalList**](PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to |
 | [**getPortalUsers**](PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering |
 | [**inviteUserToPortal**](PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal |
 | [**postPortal**](PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal |
+| [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
 | [**postPortalLogoUpload**](PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding |
 | [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color) |
 | [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. |
 
 
 
+## deletePortalFavicon
+
+> deletePortalFavicon(portalId)
+
+Remove the portal favicon
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { DeletePortalFaviconRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies DeletePortalFaviconRequest;
+
+  try {
+    const data = await api.deletePortalFavicon(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Favicon removed successfully |  -  |
+| **404** | 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)
+
+
 ## deletePortalLogo
 
 > deletePortalLogo(portalId)
@@ -421,6 +489,76 @@ 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)
 
 
+## postPortalFaviconUpload
+
+> GetPortalFaviconUpload postPortalFaviconUpload(portalId, file)
+
+Upload a favicon image for portal branding
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PostPortalFaviconUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+    // Blob | Favicon image file (PNG, ICO, or SVG). Max 1MB.
+    file: BINARY_DATA_HERE,
+  } satisfies PostPortalFaviconUploadRequest;
+
+  try {
+    const data = await api.postPortalFaviconUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+| **file** | `Blob` | Favicon image file (PNG, ICO, or SVG). Max 1MB. | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortalFaviconUpload**](GetPortalFaviconUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Favicon uploaded successfully |  -  |
+| **400** | Invalid file type or file too large |  -  |
+| **404** | 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)
+
+
 ## postPortalLogoUpload
 
 > GetPortalLogoUpload postPortalLogoUpload(portalId, file)

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.55.0",
+  "version": "1.57.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
      */