@easyedu/js-lsm-api 1.63.0 → 1.64.0

package/dist/models/PostSignupRequestResponse.js

@@ -0,0 +1,50 @@
+"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.instanceOfPostSignupRequestResponse = instanceOfPostSignupRequestResponse;
+exports.PostSignupRequestResponseFromJSON = PostSignupRequestResponseFromJSON;
+exports.PostSignupRequestResponseFromJSONTyped = PostSignupRequestResponseFromJSONTyped;
+exports.PostSignupRequestResponseToJSON = PostSignupRequestResponseToJSON;
+exports.PostSignupRequestResponseToJSONTyped = PostSignupRequestResponseToJSONTyped;
+/**
+ * Check if a given object implements the PostSignupRequestResponse interface.
+ */
+function instanceOfPostSignupRequestResponse(value) {
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+function PostSignupRequestResponseFromJSON(json) {
+    return PostSignupRequestResponseFromJSONTyped(json, false);
+}
+function PostSignupRequestResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'message': json['message'],
+    };
+}
+function PostSignupRequestResponseToJSON(json) {
+    return PostSignupRequestResponseToJSONTyped(json, false);
+}
+function PostSignupRequestResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'message': value['message'],
+    };
+}

package/dist/models/index.d.ts

@@ -210,6 +210,8 @@ export * from './PostResetPassword';
 export * from './PostRevokeCertificate';
 export * from './PostRole';
 export * from './PostSendResetPassword';
+export * from './PostSignupRequest';
+export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
 export * from './PostVerifyManifest';

package/dist/models/index.js

@@ -228,6 +228,8 @@ __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostRevokeCertificate"), exports);
 __exportStar(require("./PostRole"), exports);
 __exportStar(require("./PostSendResetPassword"), exports);
+__exportStar(require("./PostSignupRequest"), exports);
+__exportStar(require("./PostSignupRequestResponse"), exports);
 __exportStar(require("./PostSupportTicket"), exports);
 __exportStar(require("./PostSupportTicketComment"), exports);
 __exportStar(require("./PostVerifyManifest"), exports);

package/docs/ContentApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**commitScormSession**](ContentApi.md#commitscormsession) | **POST** /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data |
+| [**deleteContent**](ContentApi.md#deletecontent) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Delete content by id |
 | [**getContent**](ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content |
 | [**getContentList**](ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list |
 | [**getContentSession**](ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session |
@@ -100,6 +101,81 @@ 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)
 
 
+## deleteContent
+
+> deleteContent(contentId, moduleId, courseId)
+
+Delete content by id
+
+Soft-deletes the content item.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteContentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+  } satisfies DeleteContentRequest;
+
+  try {
+    const data = await api.deleteContent(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `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** | Content deleted successfully |  -  |
+| **403** | Forbidden - parent course is not owned by the selected portal |  -  |
+| **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)
+
+
 ## getContent
 
 > GetContent getContent(contentId, moduleId, courseId)

package/docs/CourseApi.md

@@ -4,6 +4,7 @@ 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 |
 | [**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 |
@@ -22,6 +23,75 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 
 
+## deleteCourse
+
+> deleteCourse(courseId)
+
+Delete a course by id
+
+Soft-deletes the course and its modules/content.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCourseRequest } 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,
+  } satisfies DeleteCourseRequest;
+
+  try {
+    const data = await api.deleteCourse(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`] |
+
+### 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** | Course deleted successfully |  -  |
+| **403** | Forbidden - course is not owned by the selected portal |  -  |
+| **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)
+
+
 ## deleteCourseImage
 
 > deleteCourseImage(courseId)

package/docs/ModuleApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deleteModule**](ModuleApi.md#deletemodule) | **DELETE** /courses/{courseId}/modules/{moduleId} | Delete a module by id |
 | [**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 |
@@ -13,6 +14,78 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 
 
+## deleteModule
+
+> deleteModule(moduleId, courseId)
+
+Delete a module by id
+
+Soft-deletes the module and its content.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModuleApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteModuleRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ModuleApi();
+
+  const body = {
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+  } satisfies DeleteModuleRequest;
+
+  try {
+    const data = await api.deleteModule(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `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** | Module deleted successfully |  -  |
+| **403** | Forbidden - parent course is not owned by the selected portal |  -  |
+| **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)
+
+
 ## getModule
 
 > GetModule getModule(moduleId, courseId)

package/docs/PostSignupRequest.md

@@ -0,0 +1,46 @@
+
+# PostSignupRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`email` | string
+`password` | string
+`organization` | string
+`jobRole` | string
+`learnerCount` | number
+
+## Example
+
+```typescript
+import type { PostSignupRequest } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "password": null,
+  "organization": null,
+  "jobRole": null,
+  "learnerCount": null,
+} satisfies PostSignupRequest
+
+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 PostSignupRequest
+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/PostSignupRequestResponse.md

@@ -0,0 +1,34 @@
+
+# PostSignupRequestResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { PostSignupRequestResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+} satisfies PostSignupRequestResponse
+
+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 PostSignupRequestResponse
+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/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.64.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ContentApi.ts

@@ -128,6 +128,12 @@ export interface CommitScormSessionRequest {
     scormSessionId: string;
 }
 
+export interface DeleteContentRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+}
+
 export interface GetContentRequest {
     contentId: string;
     moduleId: string;
@@ -317,6 +323,68 @@ 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 getContent without sending the request
      */