@easyedu/js-lsm-api 1.64.0 → 1.66.0

package/docs/CourseApi.md

@@ -5,6 +5,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**deleteCourse**](CourseApi.md#deletecourse) | **DELETE** /courses/{courseId} | Delete a course by id |
+| [**deleteCourseEnrollment**](CourseApi.md#deletecourseenrollment) | **DELETE** /courses/{courseId}/enrollments/{enrollmentId} | Remove a course enrollment |
+| [**deleteCourseExport**](CourseApi.md#deletecourseexport) | **DELETE** /courses/{courseId}/exports/{exportId} | Delete a course export |
 | [**deleteCourseImage**](CourseApi.md#deletecourseimage) | **DELETE** /courses/{courseId}/image | Remove the course image |
 | [**getCourse**](CourseApi.md#getcourse) | **GET** /courses/{courseId} | get course |
 | [**getCourseEnrollment**](CourseApi.md#getcourseenrollment) | **GET** /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment |
@@ -92,6 +94,145 @@ 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)
 
 
+## deleteCourseEnrollment
+
+> deleteCourseEnrollment(courseId, enrollmentId)
+
+Remove a course enrollment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCourseEnrollmentRequest } 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,
+    // string
+    enrollmentId: enrollmentId_example,
+  } satisfies DeleteCourseEnrollmentRequest;
+
+  try {
+    const data = await api.deleteCourseEnrollment(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`] |
+| **enrollmentId** | `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** | Enrollment removed successfully |  -  |
+| **404** | Course or enrollment 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)
+
+
+## deleteCourseExport
+
+> deleteCourseExport(courseId, exportId)
+
+Delete a course export
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCourseExportRequest } 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,
+    // string
+    exportId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteCourseExportRequest;
+
+  try {
+    const data = await api.deleteCourseExport(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`] |
+| **exportId** | `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** | Export deleted successfully |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Export or 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)
+
+
 ## deleteCourseImage
 
 > deleteCourseImage(courseId)

package/docs/GetCourse.md

@@ -12,6 +12,9 @@ Name | Type
 `imageUrl` | string
 `published` | boolean
 `createdAt` | number
+`accessPolicyType` | string
+`accessDurationDays` | number
+`accessFixedEndAt` | number
 
 ## Example
 
@@ -26,6 +29,9 @@ const example = {
   "imageUrl": null,
   "published": null,
   "createdAt": null,
+  "accessPolicyType": null,
+  "accessDurationDays": null,
+  "accessFixedEndAt": null,
 } satisfies GetCourse
 
 console.log(example)

package/docs/GetCourseEnrollment.md

@@ -14,6 +14,8 @@ Name | Type
 `enrollmentDateEnd` | number
 `notes` | string
 `status` | string
+`accessState` | string
+`daysUntilExpiry` | number
 `userType` | string
 `completionDate` | number
 
@@ -31,6 +33,8 @@ const example = {
   "enrollmentDateEnd": null,
   "notes": null,
   "status": null,
+  "accessState": null,
+  "daysUntilExpiry": null,
   "userType": null,
   "completionDate": null,
 } satisfies GetCourseEnrollment

package/docs/GetCourseEnrollmentListItem.md

@@ -15,6 +15,8 @@ Name | Type
 `enrollmentDateStart` | number
 `enrollmentDateEnd` | number
 `status` | string
+`accessState` | string
+`daysUntilExpiry` | number
 `userType` | string
 `completionDate` | number
 
@@ -33,6 +35,8 @@ const example = {
   "enrollmentDateStart": null,
   "enrollmentDateEnd": null,
   "status": null,
+  "accessState": null,
+  "daysUntilExpiry": null,
   "userType": null,
   "completionDate": null,
 } satisfies GetCourseEnrollmentListItem

package/docs/PortalApi.md

@@ -15,6 +15,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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) |
+| [**removePortalUser**](PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal |
 | [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. |
 
 
@@ -761,6 +762,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)
 
 
+## removePortalUser
+
+> removePortalUser(portalId, userId)
+
+Remove a user from a portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { RemovePortalUserRequest } 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,
+    // string
+    userId: userId_example,
+  } satisfies RemovePortalUserRequest;
+
+  try {
+    const data = await api.removePortalUser(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`] |
+| **userId** | `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** | User removed from portal |  -  |
+| **400** | Cannot remove the authenticated user from the selected portal |  -  |
+| **404** | User or 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)
+
+
 ## updateSelectedPortal
 
 > UpdateSelectedPortalResponse updateSelectedPortal(portalId)

package/docs/PostCourse.md

@@ -8,6 +8,9 @@ Name | Type
 ------------ | -------------
 `name` | string
 `description` | string
+`accessPolicyType` | string
+`accessDurationDays` | number
+`accessFixedEndAt` | number
 
 ## Example
 
@@ -18,6 +21,9 @@ import type { PostCourse } from '@easyedu/js-lsm-api'
 const example = {
   "name": null,
   "description": null,
+  "accessPolicyType": null,
+  "accessDurationDays": null,
+  "accessFixedEndAt": null,
 } satisfies PostCourse
 
 console.log(example)

package/docs/PostCourseEnrollment.md

@@ -11,6 +11,7 @@ Name | Type
 `enrollmentDateEnd` | number
 `notes` | string
 `userType` | string
+`reEnrollmentMode` | string
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "enrollmentDateEnd": null,
   "notes": null,
   "userType": null,
+  "reEnrollmentMode": null,
 } satisfies PostCourseEnrollment
 
 console.log(example)

package/docs/PutCourse.md

@@ -10,6 +10,9 @@ Name | Type
 `name` | string
 `description` | string
 `published` | boolean
+`accessPolicyType` | string
+`accessDurationDays` | number
+`accessFixedEndAt` | number
 
 ## Example
 
@@ -22,6 +25,9 @@ const example = {
   "name": null,
   "description": null,
   "published": null,
+  "accessPolicyType": null,
+  "accessDurationDays": null,
+  "accessFixedEndAt": null,
 } satisfies PutCourse
 
 console.log(example)

package/docs/PutCourseEnrollment.md

@@ -9,6 +9,7 @@ Name | Type
 `status` | string
 `userType` | string
 `enrollmentDateEnd` | number
+`extensionDays` | number
 `notes` | string
 
 ## Example
@@ -21,6 +22,7 @@ const example = {
   "status": null,
   "userType": null,
   "enrollmentDateEnd": null,
+  "extensionDays": null,
   "notes": null,
 } satisfies PutCourseEnrollment
 

package/package.json

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

package/src/apis/ContentApi.ts

@@ -134,6 +134,13 @@ export interface DeleteContentRequest {
     courseId: string;
 }
 
+export interface DeleteContentVersionRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    versionId: string;
+}
+
 export interface GetContentRequest {
     contentId: string;
     moduleId: string;
@@ -385,6 +392,74 @@ export class ContentApi extends runtime.BaseAPI {
         await this.deleteContentRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for deleteContentVersion without sending the request
+     */
+    async deleteContentVersionRequestOpts(requestParameters: DeleteContentVersionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling deleteContentVersion().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling deleteContentVersion().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteContentVersion().'
+            );
+        }
+
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling deleteContentVersion().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId}`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+        urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete an inactive content version
+     */
+    async deleteContentVersionRaw(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteContentVersionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete an inactive content version
+     */
+    async deleteContentVersion(requestParameters: DeleteContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteContentVersionRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for getContent without sending the request
      */

package/src/apis/CourseApi.ts

@@ -88,6 +88,16 @@ export interface DeleteCourseRequest {
     courseId: string;
 }
 
+export interface DeleteCourseEnrollmentRequest {
+    courseId: string;
+    enrollmentId: string;
+}
+
+export interface DeleteCourseExportRequest {
+    courseId: string;
+    exportId: string;
+}
+
 export interface DeleteCourseImageRequest {
     courseId: string;
 }
@@ -217,6 +227,110 @@ export class CourseApi extends runtime.BaseAPI {
         await this.deleteCourseRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for deleteCourseEnrollment without sending the request
+     */
+    async deleteCourseEnrollmentRequestOpts(requestParameters: DeleteCourseEnrollmentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteCourseEnrollment().'
+            );
+        }
+
+        if (requestParameters['enrollmentId'] == null) {
+            throw new runtime.RequiredError(
+                'enrollmentId',
+                'Required parameter "enrollmentId" was null or undefined when calling deleteCourseEnrollment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/enrollments/{enrollmentId}`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{enrollmentId}', encodeURIComponent(String(requestParameters['enrollmentId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove a course enrollment
+     */
+    async deleteCourseEnrollmentRaw(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCourseEnrollmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove a course enrollment
+     */
+    async deleteCourseEnrollment(requestParameters: DeleteCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCourseEnrollmentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for deleteCourseExport without sending the request
+     */
+    async deleteCourseExportRequestOpts(requestParameters: DeleteCourseExportRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteCourseExport().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling deleteCourseExport().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete a course export
+     */
+    async deleteCourseExportRaw(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCourseExportRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a course export
+     */
+    async deleteCourseExport(requestParameters: DeleteCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCourseExportRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for deleteCourseImage without sending the request
      */

package/src/apis/PortalApi.ts

@@ -109,6 +109,11 @@ export interface PutPortalBrandingRequest {
     putPortalBranding: PutPortalBranding;
 }
 
+export interface RemovePortalUserRequest {
+    portalId: string;
+    userId: string;
+}
+
 export interface UpdateSelectedPortalRequest {
     portalId: string;
 }
@@ -694,6 +699,58 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for removePortalUser without sending the request
+     */
+    async removePortalUserRequestOpts(requestParameters: RemovePortalUserRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling removePortalUser().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling removePortalUser().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/portals/{portalId}/users/{userId}`;
+        urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove a user from a portal
+     */
+    async removePortalUserRaw(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.removePortalUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove a user from a portal
+     */
+    async removePortalUser(requestParameters: RemovePortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.removePortalUserRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for updateSelectedPortal without sending the request
      */