@easyedu/js-lsm-api 1.63.0 → 1.65.0

package/docs/UserApi.md

@@ -10,10 +10,12 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getUser**](UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id |
 | [**postLogin**](UserApi.md#postlogin) | **POST** /auth/login | Post a new login |
 | [**postLogout**](UserApi.md#postlogout) | **POST** /auth/logout | Logout a user |
+| [**postSignupRequest**](UserApi.md#postsignuprequest) | **POST** /auth/signup-request | Request a new organization signup |
 | [**postUserAvatarUpload**](UserApi.md#postuseravatarupload) | **POST** /users/{userId}/avatar | Upload a profile photo for the current user |
 | [**putUser**](UserApi.md#putuser) | **PUT** /users/{userId} | Update a user by id |
 | [**resetPassword**](UserApi.md#resetpassword) | **POST** /auth/reset-password | Reset a users password |
 | [**sendResetPassword**](UserApi.md#sendresetpassword) | **POST** /auth/send-reset-password | Send a reset password email |
+| [**verifySignupRequest**](UserApi.md#verifysignuprequest) | **GET** /auth/signup/verify | Verify a signup request and provision the portal |
 
 
 
@@ -388,6 +390,72 @@ 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)
 
 
+## postSignupRequest
+
+> PostSignupRequestResponse postSignupRequest(postSignupRequest)
+
+Request a new organization signup
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSignupRequestRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  const body = {
+    // PostSignupRequest | Pending signup request
+    postSignupRequest: ...,
+  } satisfies PostSignupRequestRequest;
+
+  try {
+    const data = await api.postSignupRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postSignupRequest** | [PostSignupRequest](PostSignupRequest.md) | Pending signup request | |
+
+### Return type
+
+[**PostSignupRequestResponse**](PostSignupRequestResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | signup request accepted |  -  |
+| **400** | signup request validation error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postUserAvatarUpload
 
 > GetUserAvatarUpload postUserAvatarUpload(userId, file)
@@ -657,3 +725,69 @@ 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)
 
+
+## verifySignupRequest
+
+> verifySignupRequest(token)
+
+Verify a signup request and provision the portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { VerifySignupRequestRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  const body = {
+    // string
+    token: token_example,
+  } satisfies VerifySignupRequestRequest;
+
+  try {
+    const data = await api.verifySignupRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **token** | `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 |
+|-------------|-------------|------------------|
+| **303** | signup verified and redirected to portal signin |  -  |
+| **400** | invalid or expired signup verification token |  -  |
+
+[[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.63.0",
+  "version": "1.65.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ContentApi.ts

@@ -128,6 +128,19 @@ export interface CommitScormSessionRequest {
     scormSessionId: string;
 }
 
+export interface DeleteContentRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+}
+
+export interface DeleteContentVersionRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    versionId: string;
+}
+
 export interface GetContentRequest {
     contentId: string;
     moduleId: string;
@@ -317,6 +330,136 @@ export class ContentApi extends runtime.BaseAPI {
         await this.commitScormSessionRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for deleteContent without sending the request
+     */
+    async deleteContentRequestOpts(requestParameters: DeleteContentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling deleteContent().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling deleteContent().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteContent().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+        urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Soft-deletes the content item.
+     * Delete content by id
+     */
+    async deleteContentRaw(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteContentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Soft-deletes the content item.
+     * Delete content by id
+     */
+    async deleteContent(requestParameters: DeleteContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        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

@@ -84,6 +84,20 @@ import {
     PutCourseEnrollmentToJSON,
 } from '../models/PutCourseEnrollment';
 
+export interface DeleteCourseRequest {
+    courseId: string;
+}
+
+export interface DeleteCourseEnrollmentRequest {
+    courseId: string;
+    enrollmentId: string;
+}
+
+export interface DeleteCourseExportRequest {
+    courseId: string;
+    exportId: string;
+}
+
 export interface DeleteCourseImageRequest {
     courseId: string;
 }
@@ -167,6 +181,156 @@ export interface PutCourseEnrollmentRequest {
  */
 export class CourseApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deleteCourse without sending the request
+     */
+    async deleteCourseRequestOpts(requestParameters: DeleteCourseRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteCourse().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Soft-deletes the course and its modules/content.
+     * Delete a course by id
+     */
+    async deleteCourseRaw(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCourseRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Soft-deletes the course and its modules/content.
+     * Delete a course by id
+     */
+    async deleteCourse(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        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/ModuleApi.ts

@@ -44,6 +44,11 @@ import {
     PutModuleReorderToJSON,
 } from '../models/PutModuleReorder';
 
+export interface DeleteModuleRequest {
+    moduleId: string;
+    courseId: string;
+}
+
 export interface GetModuleRequest {
     moduleId: string;
     courseId: string;
@@ -80,6 +85,60 @@ export interface PutModuleReorderRequest {
  */
 export class ModuleApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deleteModule without sending the request
+     */
+    async deleteModuleRequestOpts(requestParameters: DeleteModuleRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling deleteModule().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteModule().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}`;
+        urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Soft-deletes the module and its content.
+     * Delete a module by id
+     */
+    async deleteModuleRaw(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteModuleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Soft-deletes the module and its content.
+     * Delete a module by id
+     */
+    async deleteModule(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteModuleRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for getModule 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
      */